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/local",
1305     "title": "Creates a new User token",
1306     "examples": [
1307       {
1308         "title": "Example usage:",
1309         "content": "curl https://{domain}/api/auth/local -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/authLocal/index.js",
1338     "groupTitle": "Authentication"
1339   },
1340   {
1341     "type": "post",
1342     "url": "/api/auth/google",
1343     "title": "Creates a new User token",
1344     "examples": [
1345       {
1346         "title": "Example usage:",
1347         "content": "curl https://{domain}/api/auth/google -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/authGoogle/index.js",
1376     "groupTitle": "Authentication"
1377   },
1378   {
1379     "type": "post",
1380     "url": "/api/automations",
1381     "title": "Creates a new Automation",
1382     "examples": [
1383       {
1384         "title": "Example usage:",
1385         "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1386         "type": "json"
1387       }
1388     ],
1389     "name": "CreateAutomations",
1390     "group": "Automations",
1391     "parameter": {
1392       "fields": {
1393         "Body": [
1394           {
1395             "group": "Body",
1396             "type": "String",
1397             "optional": false,
1398             "field": "name",
1399             "description": ""
1400           },
1401           {
1402             "group": "Body",
1403             "type": "String",
1404             "optional": true,
1405             "field": "channel",
1406             "description": ""
1407           },
1408           {
1409             "group": "Body",
1410             "type": "String",
1411             "optional": true,
1412             "field": "description",
1413             "description": ""
1414           },
1415           {
1416             "group": "Body",
1417             "type": "Boolean",
1418             "optional": true,
1419             "field": "status",
1420             "description": ""
1421           },
1422           {
1423             "group": "Body",
1424             "type": "Integer",
1425             "optional": true,
1426             "field": "timeout",
1427             "description": ""
1428           }
1429         ]
1430       }
1431     },
1432     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1433     "version": "0.0.0",
1434     "filename": "server/api/automation/index.js",
1435     "groupTitle": "Automations"
1436   },
1437   {
1438     "type": "delete",
1439     "url": "/api/automations/{id}",
1440     "title": "Deletes a Automation",
1441     "examples": [
1442       {
1443         "title": "Example usage:",
1444         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1445         "type": "json"
1446       }
1447     ],
1448     "name": "DeleteAutomations",
1449     "group": "Automations",
1450     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1451     "version": "0.0.0",
1452     "filename": "server/api/automation/index.js",
1453     "groupTitle": "Automations"
1454   },
1455   {
1456     "type": "get",
1457     "url": "/api/automations",
1458     "title": "Gets a list of Automations",
1459     "examples": [
1460       {
1461         "title": "Example usage:",
1462         "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1463         "type": "json"
1464       }
1465     ],
1466     "name": "GetAutomations",
1467     "group": "Automations",
1468     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/automations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/automations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/automations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/automations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/automations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1469     "version": "0.0.0",
1470     "filename": "server/api/automation/index.js",
1471     "groupTitle": "Automations"
1472   },
1473   {
1474     "type": "get",
1475     "url": "/api/automations/{id}",
1476     "title": "Gets a single Automation",
1477     "examples": [
1478       {
1479         "title": "Example usage:",
1480         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1481         "type": "json"
1482       }
1483     ],
1484     "name": "ShowAutomations",
1485     "group": "Automations",
1486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1487     "version": "0.0.0",
1488     "filename": "server/api/automation/index.js",
1489     "groupTitle": "Automations"
1490   },
1491   {
1492     "type": "post",
1493     "url": "/api/automations/{id}/actions",
1494     "title": "Creates new actions",
1495     "examples": [
1496       {
1497         "title": "Example usage:",
1498         "content": "curl https://{domain}/api/automations/{id}/actions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1499         "type": "json"
1500       }
1501     ],
1502     "name": "addActions",
1503     "group": "Automations",
1504     "parameter": {
1505       "fields": {
1506         "Body": [
1507           {
1508             "group": "Body",
1509             "type": "Virtual",
1510             "optional": true,
1511             "field": "name",
1512             "description": ""
1513           },
1514           {
1515             "group": "Body",
1516             "type": "String",
1517             "optional": false,
1518             "field": "action",
1519             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1520           },
1521           {
1522             "group": "Body",
1523             "type": "String",
1524             "optional": true,
1525             "field": "data1",
1526             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1527           },
1528           {
1529             "group": "Body",
1530             "type": "String",
1531             "optional": true,
1532             "field": "data2",
1533             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1534           },
1535           {
1536             "group": "Body",
1537             "type": "String",
1538             "optional": true,
1539             "field": "data3",
1540             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1541           },
1542           {
1543             "group": "Body",
1544             "type": "String",
1545             "optional": true,
1546             "field": "data4",
1547             "description": ""
1548           },
1549           {
1550             "group": "Body",
1551             "type": "String",
1552             "optional": true,
1553             "field": "data5",
1554             "description": ""
1555           },
1556           {
1557             "group": "Body",
1558             "type": "String",
1559             "optional": true,
1560             "field": "data6",
1561             "description": ""
1562           },
1563           {
1564             "group": "Body",
1565             "type": "Text",
1566             "optional": true,
1567             "field": "data7",
1568             "description": ""
1569           }
1570         ]
1571       }
1572     },
1573     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1574     "version": "0.0.0",
1575     "filename": "server/api/automation/index.js",
1576     "groupTitle": "Automations"
1577   },
1578   {
1579     "type": "post",
1580     "url": "/api/automations/{id}/conditions",
1581     "title": "Creates new conditions",
1582     "examples": [
1583       {
1584         "title": "Example usage:",
1585         "content": "curl https://{domain}/api/automations/{id}/conditions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1586         "type": "json"
1587       }
1588     ],
1589     "name": "addConditions",
1590     "group": "Automations",
1591     "parameter": {
1592       "fields": {
1593         "Body": [
1594           {
1595             "group": "Body",
1596             "type": "Virtual",
1597             "optional": true,
1598             "field": "name",
1599             "description": ""
1600           },
1601           {
1602             "group": "Body",
1603             "type": "String",
1604             "optional": false,
1605             "field": "field",
1606             "description": ""
1607           },
1608           {
1609             "group": "Body",
1610             "type": "String",
1611             "optional": false,
1612             "field": "operator",
1613             "description": ""
1614           },
1615           {
1616             "group": "Body",
1617             "type": "String",
1618             "optional": false,
1619             "field": "value",
1620             "description": ""
1621           }
1622         ]
1623       }
1624     },
1625     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1626     "version": "0.0.0",
1627     "filename": "server/api/automation/index.js",
1628     "groupTitle": "Automations"
1629   },
1630   {
1631     "type": "get",
1632     "url": "/api/automations/{id}/actions",
1633     "title": "Gets Automation Actions",
1634     "examples": [
1635       {
1636         "title": "Example usage:",
1637         "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1638         "type": "json"
1639       }
1640     ],
1641     "name": "getActions",
1642     "group": "Automations",
1643     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1644     "version": "0.0.0",
1645     "filename": "server/api/automation/index.js",
1646     "groupTitle": "Automations"
1647   },
1648   {
1649     "type": "get",
1650     "url": "/api/automations/{id}/conditions",
1651     "title": "Gets Automation Conditions",
1652     "examples": [
1653       {
1654         "title": "Example usage:",
1655         "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1656         "type": "json"
1657       }
1658     ],
1659     "name": "getConditions",
1660     "group": "Automations",
1661     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1662     "version": "0.0.0",
1663     "filename": "server/api/automation/index.js",
1664     "groupTitle": "Automations"
1665   },
1666   {
1667     "type": "put",
1668     "url": "/api/automations/{id}",
1669     "title": "Update an existing Automation",
1670     "examples": [
1671       {
1672         "title": "Example usage:",
1673         "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1674         "type": "json"
1675       }
1676     ],
1677     "name": "updateAutomations",
1678     "group": "Automations",
1679     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1680     "version": "0.0.0",
1681     "filename": "server/api/automation/index.js",
1682     "groupTitle": "Automations"
1683   },
1684   {
1685     "type": "post",
1686     "url": "/api/canned_answers",
1687     "title": "Create a new canned answer",
1688     "examples": [
1689       {
1690         "title": "Example usage:",
1691         "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1692         "type": "json"
1693       }
1694     ],
1695     "name": "Create",
1696     "group": "Canned_Answers",
1697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1698     "version": "0.0.0",
1699     "filename": "server/api/cannedAnswer/index.js",
1700     "groupTitle": "Canned_Answers"
1701   },
1702   {
1703     "type": "delete",
1704     "url": "/api/canned_answers/{id}",
1705     "title": "Deletes a Canned Answer",
1706     "examples": [
1707       {
1708         "title": "Example usage:",
1709         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1710         "type": "json"
1711       }
1712     ],
1713     "name": "DeleteCanned_Answers",
1714     "group": "Canned_Answers",
1715     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1716     "version": "0.0.0",
1717     "filename": "server/api/cannedAnswer/index.js",
1718     "groupTitle": "Canned_Answers"
1719   },
1720   {
1721     "type": "get",
1722     "url": "/api/canned_answers",
1723     "title": "Gets a list of Canned Answers",
1724     "examples": [
1725       {
1726         "title": "Example usage:",
1727         "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1728         "type": "json"
1729       }
1730     ],
1731     "name": "GetCanned_Answers",
1732     "group": "Canned_Answers",
1733     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/canned_answers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/canned_answers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/canned_answers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/canned_answers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/canned_answers?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1734     "version": "0.0.0",
1735     "filename": "server/api/cannedAnswer/index.js",
1736     "groupTitle": "Canned_Answers"
1737   },
1738   {
1739     "type": "get",
1740     "url": "/api/canned_answers/{id}",
1741     "title": "Gets a single Canned Answer",
1742     "examples": [
1743       {
1744         "title": "Example usage:",
1745         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1746         "type": "json"
1747       }
1748     ],
1749     "name": "ShowCanned_Answers",
1750     "group": "Canned_Answers",
1751     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1752     "version": "0.0.0",
1753     "filename": "server/api/cannedAnswer/index.js",
1754     "groupTitle": "Canned_Answers"
1755   },
1756   {
1757     "type": "put",
1758     "url": "/api/canned_answers/{id}",
1759     "title": "Update an existing Canned Answer",
1760     "examples": [
1761       {
1762         "title": "Example usage:",
1763         "content": "curl https://{domain}/api/canned_answers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1764         "type": "json"
1765       }
1766     ],
1767     "name": "updateCanned_Answers",
1768     "group": "Canned_Answers",
1769     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1770     "version": "0.0.0",
1771     "filename": "server/api/cannedAnswer/index.js",
1772     "groupTitle": "Canned_Answers"
1773   },
1774   {
1775     "type": "get",
1776     "url": "/chat/internal/users",
1777     "title": "Gets Users Last Messages",
1778     "examples": [
1779       {
1780         "title": "Example usage:",
1781         "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password}  -X GET",
1782         "type": "json"
1783       }
1784     ],
1785     "name": "getLastUsersMessages",
1786     "group": "ChatInternalMessage",
1787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1788     "version": "0.0.0",
1789     "filename": "server/api/chatInternalMessage/index.js",
1790     "groupTitle": "ChatInternalMessage"
1791   },
1792   {
1793     "type": "delete",
1794     "url": "/api/chat/applications/{id}",
1795     "title": "Deletes a Application",
1796     "examples": [
1797       {
1798         "title": "Example usage:",
1799         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1800         "type": "json"
1801       }
1802     ],
1803     "name": "DeleteApplications",
1804     "group": "Chat_Applications",
1805     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1806     "version": "0.0.0",
1807     "filename": "server/api/chatApplication/index.js",
1808     "groupTitle": "Chat_Applications"
1809   },
1810   {
1811     "type": "get",
1812     "url": "/api/chat/applications/{id}",
1813     "title": "Gets a single Application",
1814     "examples": [
1815       {
1816         "title": "Example usage:",
1817         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1818         "type": "json"
1819       }
1820     ],
1821     "name": "ShowApplications",
1822     "group": "Chat_Applications",
1823     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1824     "version": "0.0.0",
1825     "filename": "server/api/chatApplication/index.js",
1826     "groupTitle": "Chat_Applications"
1827   },
1828   {
1829     "type": "put",
1830     "url": "/api/chat/applications/{id}",
1831     "title": "Update an existing Application",
1832     "examples": [
1833       {
1834         "title": "Example usage:",
1835         "content": "curl https://{domain}/api/chat/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1836         "type": "json"
1837       }
1838     ],
1839     "name": "updateApplications",
1840     "group": "Chat_Applications",
1841     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1842     "version": "0.0.0",
1843     "filename": "server/api/chatApplication/index.js",
1844     "groupTitle": "Chat_Applications"
1845   },
1846   {
1847     "type": "post",
1848     "url": "/api/chat/groups",
1849     "title": "Creates a new Group",
1850     "examples": [
1851       {
1852         "title": "Example usage:",
1853         "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1854         "type": "json"
1855       }
1856     ],
1857     "name": "CreateGroups",
1858     "group": "Chat_Groups",
1859     "parameter": {
1860       "fields": {
1861         "Body": [
1862           {
1863             "group": "Body",
1864             "type": "String",
1865             "optional": false,
1866             "field": "name",
1867             "description": ""
1868           },
1869           {
1870             "group": "Body",
1871             "type": "String",
1872             "optional": true,
1873             "field": "description",
1874             "description": ""
1875           },
1876           {
1877             "group": "Body",
1878             "type": "Boolean",
1879             "optional": true,
1880             "field": "write",
1881             "description": ""
1882           }
1883         ]
1884       }
1885     },
1886     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1887     "version": "0.0.0",
1888     "filename": "server/api/chatGroup/index.js",
1889     "groupTitle": "Chat_Groups"
1890   },
1891   {
1892     "type": "delete",
1893     "url": "/api/chat/groups/{id}",
1894     "title": "Deletes a Group",
1895     "examples": [
1896       {
1897         "title": "Example usage:",
1898         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1899         "type": "json"
1900       }
1901     ],
1902     "name": "DeleteGroups",
1903     "group": "Chat_Groups",
1904     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1905     "version": "0.0.0",
1906     "filename": "server/api/chatGroup/index.js",
1907     "groupTitle": "Chat_Groups"
1908   },
1909   {
1910     "type": "get",
1911     "url": "/api/chat/groups/describe",
1912     "title": "Gets table info about Groups",
1913     "examples": [
1914       {
1915         "title": "Example usage:",
1916         "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1917         "type": "json"
1918       }
1919     ],
1920     "name": "DescribeGroups",
1921     "group": "Chat_Groups",
1922     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1923     "version": "0.0.0",
1924     "filename": "server/api/chatGroup/index.js",
1925     "groupTitle": "Chat_Groups"
1926   },
1927   {
1928     "type": "get",
1929     "url": "/api/chat/groups",
1930     "title": "Gets a list of Groups",
1931     "examples": [
1932       {
1933         "title": "Example usage:",
1934         "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1935         "type": "json"
1936       }
1937     ],
1938     "name": "GetGroups",
1939     "group": "Chat_Groups",
1940     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/groups?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/groups?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/groups?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/groups?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/groups?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1941     "version": "0.0.0",
1942     "filename": "server/api/chatGroup/index.js",
1943     "groupTitle": "Chat_Groups"
1944   },
1945   {
1946     "type": "delete",
1947     "url": "/api/chat/groups/{id}/members",
1948     "title": "Removes members from a group",
1949     "examples": [
1950       {
1951         "title": "Example usage:",
1952         "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
1953         "type": "json"
1954       }
1955     ],
1956     "name": "RemoveMembers",
1957     "group": "Chat_Groups",
1958     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1959     "version": "0.0.0",
1960     "filename": "server/api/chatGroup/index.js",
1961     "groupTitle": "Chat_Groups"
1962   },
1963   {
1964     "type": "get",
1965     "url": "/api/chat/groups/{id}",
1966     "title": "Gets a single Group",
1967     "examples": [
1968       {
1969         "title": "Example usage:",
1970         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
1971         "type": "json"
1972       }
1973     ],
1974     "name": "ShowGroups",
1975     "group": "Chat_Groups",
1976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1977     "version": "0.0.0",
1978     "filename": "server/api/chatGroup/index.js",
1979     "groupTitle": "Chat_Groups"
1980   },
1981   {
1982     "type": "post",
1983     "url": "/api/chat/groups/{id}/members",
1984     "title": "Add members to chat group",
1985     "examples": [
1986       {
1987         "title": "Example usage:",
1988         "content": "curl https://{domain}/api/chat/groups/{id}/members -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1989         "type": "json"
1990       }
1991     ],
1992     "name": "addMembers",
1993     "group": "Chat_Groups",
1994     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1995     "version": "0.0.0",
1996     "filename": "server/api/chatGroup/index.js",
1997     "groupTitle": "Chat_Groups"
1998   },
1999   {
2000     "type": "post",
2001     "url": "/api/chat/groups/{id}/messages",
2002     "title": "Creates a new group message",
2003     "examples": [
2004       {
2005         "title": "Example usage:",
2006         "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2007         "type": "json"
2008       }
2009     ],
2010     "name": "addMessage",
2011     "group": "Chat_Groups",
2012     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2013     "version": "0.0.0",
2014     "filename": "server/api/chatGroup/index.js",
2015     "groupTitle": "Chat_Groups"
2016   },
2017   {
2018     "type": "get",
2019     "url": "/api/chat/groups/{id}/members",
2020     "title": "Gets Members",
2021     "examples": [
2022       {
2023         "title": "Example usage:",
2024         "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2025         "type": "json"
2026       }
2027     ],
2028     "name": "getMembers",
2029     "group": "Chat_Groups",
2030     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2031     "version": "0.0.0",
2032     "filename": "server/api/chatGroup/index.js",
2033     "groupTitle": "Chat_Groups"
2034   },
2035   {
2036     "type": "get",
2037     "url": "/api/chat/groups/{id}/messages",
2038     "title": "Gets Messages",
2039     "examples": [
2040       {
2041         "title": "Example usage:",
2042         "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2043         "type": "json"
2044       }
2045     ],
2046     "name": "getMessages",
2047     "group": "Chat_Groups",
2048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2049     "version": "0.0.0",
2050     "filename": "server/api/chatGroup/index.js",
2051     "groupTitle": "Chat_Groups"
2052   },
2053   {
2054     "type": "get",
2055     "url": "/api/chat/groups/{id}/unread",
2056     "title": "Get unread chat group messages",
2057     "examples": [
2058       {
2059         "title": "Example usage:",
2060         "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2061         "type": "json"
2062       }
2063     ],
2064     "name": "getUread",
2065     "group": "Chat_Groups",
2066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2067     "version": "0.0.0",
2068     "filename": "server/api/chatGroup/index.js",
2069     "groupTitle": "Chat_Groups"
2070   },
2071   {
2072     "type": "put",
2073     "url": "/api/chat/groups/{id}",
2074     "title": "Update an existing Group",
2075     "examples": [
2076       {
2077         "title": "Example usage:",
2078         "content": "curl https://{domain}/api/chat/groups/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2079         "type": "json"
2080       }
2081     ],
2082     "name": "updateGroups",
2083     "group": "Chat_Groups",
2084     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2085     "version": "0.0.0",
2086     "filename": "server/api/chatGroup/index.js",
2087     "groupTitle": "Chat_Groups"
2088   },
2089   {
2090     "type": "post",
2091     "url": "/api/chat/interactions/{id}/tags",
2092     "title": "Add tags to the interaction",
2093     "examples": [
2094       {
2095         "title": "Example usage:",
2096         "content": "curl https://{domain}/api/chat/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2097         "type": "json"
2098       }
2099     ],
2100     "name": "AddTags",
2101     "group": "Chat_Interactions",
2102     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2103     "version": "0.0.0",
2104     "filename": "server/api/chatInteraction/index.js",
2105     "groupTitle": "Chat_Interactions"
2106   },
2107   {
2108     "type": "post",
2109     "url": "/api/chat/interactions",
2110     "title": "Creates a new Interaction",
2111     "examples": [
2112       {
2113         "title": "Example usage:",
2114         "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2115         "type": "json"
2116       }
2117     ],
2118     "name": "CreateInteractions",
2119     "group": "Chat_Interactions",
2120     "parameter": {
2121       "fields": {
2122         "Body": [
2123           {
2124             "group": "Body",
2125             "type": "Boolean",
2126             "optional": true,
2127             "field": "closed",
2128             "description": ""
2129           },
2130           {
2131             "group": "Body",
2132             "type": "Integer",
2133             "optional": true,
2134             "field": "ratingValue",
2135             "description": ""
2136           },
2137           {
2138             "group": "Body",
2139             "type": "String",
2140             "allowedValues": [
2141               "\"star\"",
2142               "\"thumb\""
2143             ],
2144             "optional": true,
2145             "field": "ratingType",
2146             "description": ""
2147           },
2148           {
2149             "group": "Body",
2150             "type": "Text",
2151             "optional": true,
2152             "field": "ratingMessage",
2153             "description": ""
2154           },
2155           {
2156             "group": "Body",
2157             "type": "Text",
2158             "optional": true,
2159             "field": "pathTranscript",
2160             "description": ""
2161           },
2162           {
2163             "group": "Body",
2164             "type": "String",
2165             "optional": true,
2166             "field": "mailTranscript",
2167             "description": ""
2168           },
2169           {
2170             "group": "Body",
2171             "type": "String",
2172             "optional": true,
2173             "field": "closedAt",
2174             "description": ""
2175           },
2176           {
2177             "group": "Body",
2178             "type": "String",
2179             "optional": true,
2180             "field": "disposition",
2181             "description": ""
2182           },
2183           {
2184             "group": "Body",
2185             "type": "String",
2186             "optional": true,
2187             "field": "secondDisposition",
2188             "description": ""
2189           },
2190           {
2191             "group": "Body",
2192             "type": "String",
2193             "optional": true,
2194             "field": "thirdDisposition",
2195             "description": ""
2196           },
2197           {
2198             "group": "Body",
2199             "type": "String",
2200             "optional": true,
2201             "field": "note",
2202             "description": ""
2203           },
2204           {
2205             "group": "Body",
2206             "type": "String",
2207             "optional": true,
2208             "field": "browserName",
2209             "description": ""
2210           },
2211           {
2212             "group": "Body",
2213             "type": "String",
2214             "optional": true,
2215             "field": "browserVersion",
2216             "description": ""
2217           },
2218           {
2219             "group": "Body",
2220             "type": "String",
2221             "optional": true,
2222             "field": "osName",
2223             "description": ""
2224           },
2225           {
2226             "group": "Body",
2227             "type": "String",
2228             "optional": true,
2229             "field": "osVersion",
2230             "description": ""
2231           },
2232           {
2233             "group": "Body",
2234             "type": "String",
2235             "optional": true,
2236             "field": "deviceModel",
2237             "description": ""
2238           },
2239           {
2240             "group": "Body",
2241             "type": "String",
2242             "optional": true,
2243             "field": "deviceVendor",
2244             "description": ""
2245           },
2246           {
2247             "group": "Body",
2248             "type": "String",
2249             "optional": true,
2250             "field": "deviceType",
2251             "description": ""
2252           },
2253           {
2254             "group": "Body",
2255             "type": "Text",
2256             "optional": true,
2257             "field": "referer",
2258             "description": ""
2259           },
2260           {
2261             "group": "Body",
2262             "type": "String",
2263             "optional": true,
2264             "field": "customerIp",
2265             "description": ""
2266           },
2267           {
2268             "group": "Body",
2269             "type": "Text",
2270             "optional": true,
2271             "field": "formData",
2272             "description": ""
2273           },
2274           {
2275             "group": "Body",
2276             "type": "String",
2277             "optional": true,
2278             "field": "read1stAt",
2279             "description": ""
2280           },
2281           {
2282             "group": "Body",
2283             "type": "String",
2284             "optional": true,
2285             "field": "lastMsgAt",
2286             "description": ""
2287           },
2288           {
2289             "group": "Body",
2290             "type": "String",
2291             "allowedValues": [
2292               "\"in\"",
2293               "\"out\""
2294             ],
2295             "optional": false,
2296             "field": "lastMsgDirection",
2297             "description": ""
2298           },
2299           {
2300             "group": "Body",
2301             "type": "String",
2302             "optional": true,
2303             "field": "closeReason",
2304             "description": ""
2305           },
2306           {
2307             "group": "Body",
2308             "type": "String",
2309             "optional": true,
2310             "field": "customerPort",
2311             "description": ""
2312           },
2313           {
2314             "group": "Body",
2315             "type": "Text",
2316             "optional": true,
2317             "field": "vidaooSessionId",
2318             "description": ""
2319           }
2320         ]
2321       }
2322     },
2323     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2324     "version": "0.0.0",
2325     "filename": "server/api/chatInteraction/index.js",
2326     "groupTitle": "Chat_Interactions"
2327   },
2328   {
2329     "type": "delete",
2330     "url": "/api/chat/interactions/{id}",
2331     "title": "Deletes a Interaction",
2332     "examples": [
2333       {
2334         "title": "Example usage:",
2335         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2336         "type": "json"
2337       }
2338     ],
2339     "name": "DeleteInteractions",
2340     "group": "Chat_Interactions",
2341     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2342     "version": "0.0.0",
2343     "filename": "server/api/chatInteraction/index.js",
2344     "groupTitle": "Chat_Interactions"
2345   },
2346   {
2347     "type": "get",
2348     "url": "/api/chat/interactions/describe",
2349     "title": "Gets table info about Interactions",
2350     "examples": [
2351       {
2352         "title": "Example usage:",
2353         "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2354         "type": "json"
2355       }
2356     ],
2357     "name": "DescribeInteractions",
2358     "group": "Chat_Interactions",
2359     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2360     "version": "0.0.0",
2361     "filename": "server/api/chatInteraction/index.js",
2362     "groupTitle": "Chat_Interactions"
2363   },
2364   {
2365     "type": "get",
2366     "url": "/api/chat/interactions",
2367     "title": "Gets a list of Interactions",
2368     "examples": [
2369       {
2370         "title": "Example usage:",
2371         "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2372         "type": "json"
2373       }
2374     ],
2375     "name": "GetInteractions",
2376     "group": "Chat_Interactions",
2377     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2378     "version": "0.0.0",
2379     "filename": "server/api/chatInteraction/index.js",
2380     "groupTitle": "Chat_Interactions"
2381   },
2382   {
2383     "type": "delete",
2384     "url": "/api/chat/interactions/{id}/tags",
2385     "title": "Removes tags from interaction",
2386     "examples": [
2387       {
2388         "title": "Example usage:",
2389         "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2390         "type": "json"
2391       }
2392     ],
2393     "name": "RemoveTags",
2394     "group": "Chat_Interactions",
2395     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2396     "version": "0.0.0",
2397     "filename": "server/api/chatInteraction/index.js",
2398     "groupTitle": "Chat_Interactions"
2399   },
2400   {
2401     "type": "get",
2402     "url": "/api/chat/interactions/{id}",
2403     "title": "Gets a single Interaction",
2404     "examples": [
2405       {
2406         "title": "Example usage:",
2407         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2408         "type": "json"
2409       }
2410     ],
2411     "name": "ShowInteractions",
2412     "group": "Chat_Interactions",
2413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2414     "version": "0.0.0",
2415     "filename": "server/api/chatInteraction/index.js",
2416     "groupTitle": "Chat_Interactions"
2417   },
2418   {
2419     "type": "put",
2420     "url": "/api/chat/interactions/{id}/abandon",
2421     "title": "Abandon interaction",
2422     "examples": [
2423       {
2424         "title": "Example usage:",
2425         "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2426         "type": "json"
2427       }
2428     ],
2429     "name": "abandon",
2430     "group": "Chat_Interactions",
2431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to set as abandon an interaction and stop the routing.</p>",
2432     "version": "0.0.0",
2433     "filename": "server/api/chatInteraction/index.js",
2434     "groupTitle": "Chat_Interactions"
2435   },
2436   {
2437     "type": "post",
2438     "url": "/api/chat/interactions/{id}/messages",
2439     "title": "Creates new messages",
2440     "examples": [
2441       {
2442         "title": "Example usage:",
2443         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2444         "type": "json"
2445       }
2446     ],
2447     "name": "addMessage",
2448     "group": "Chat_Interactions",
2449     "parameter": {
2450       "fields": {
2451         "Body": [
2452           {
2453             "group": "Body",
2454             "type": "Text",
2455             "optional": false,
2456             "field": "body",
2457             "description": ""
2458           },
2459           {
2460             "group": "Body",
2461             "type": "Boolean",
2462             "optional": true,
2463             "field": "read",
2464             "description": ""
2465           },
2466           {
2467             "group": "Body",
2468             "type": "Boolean",
2469             "optional": true,
2470             "field": "secret",
2471             "description": ""
2472           },
2473           {
2474             "group": "Body",
2475             "type": "String",
2476             "allowedValues": [
2477               "\"in\"",
2478               "\"out\""
2479             ],
2480             "optional": false,
2481             "field": "direction",
2482             "description": ""
2483           },
2484           {
2485             "group": "Body",
2486             "type": "String",
2487             "optional": true,
2488             "field": "readAt",
2489             "description": ""
2490           },
2491           {
2492             "group": "Body",
2493             "type": "String",
2494             "optional": true,
2495             "field": "providerName",
2496             "description": ""
2497           },
2498           {
2499             "group": "Body",
2500             "type": "Text",
2501             "optional": true,
2502             "field": "providerResponse",
2503             "description": ""
2504           }
2505         ]
2506       }
2507     },
2508     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2509     "version": "0.0.0",
2510     "filename": "server/api/chatInteraction/index.js",
2511     "groupTitle": "Chat_Interactions"
2512   },
2513   {
2514     "type": "put",
2515     "url": "/api/chat/interactions/{id}/close",
2516     "title": "Close Interaction",
2517     "examples": [
2518       {
2519         "title": "Example usage:",
2520         "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2521         "type": "json"
2522       }
2523     ],
2524     "name": "addMessage",
2525     "group": "Chat_Interactions",
2526     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2527     "version": "0.0.0",
2528     "filename": "server/api/chatInteraction/index.js",
2529     "groupTitle": "Chat_Interactions"
2530   },
2531   {
2532     "type": "post",
2533     "url": "/api/chat/interactions/{id}/attachment_upload",
2534     "title": "Add attachment",
2535     "examples": [
2536       {
2537         "title": "Example usage:",
2538         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
2539         "type": "json"
2540       }
2541     ],
2542     "name": "attachmentUpload",
2543     "group": "Chat_Interactions",
2544     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2545     "version": "0.0.0",
2546     "filename": "server/api/chatInteraction/index.js",
2547     "groupTitle": "Chat_Interactions"
2548   },
2549   {
2550     "type": "post",
2551     "url": "/api/chat/interactions/{id}/vidaoo",
2552     "title": "Create Vidaoo Session",
2553     "examples": [
2554       {
2555         "title": "Example usage:",
2556         "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo  -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2557         "type": "json"
2558       }
2559     ],
2560     "name": "createVidaooSession",
2561     "group": "Chat_Interactions",
2562     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2563     "version": "0.0.0",
2564     "filename": "server/api/chatInteraction/index.js",
2565     "groupTitle": "Chat_Interactions"
2566   },
2567   {
2568     "type": "put",
2569     "url": "/api/chat/interactions/{id}/custom_update",
2570     "title": "Update interaction",
2571     "examples": [
2572       {
2573         "title": "Example usage:",
2574         "content": "curl https://{domain}/api/chat/interactions/{id}/custom_update -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2575         "type": "json"
2576       }
2577     ],
2578     "name": "customUpdate",
2579     "group": "Chat_Interactions",
2580     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to update an interaction.</p>",
2581     "version": "0.0.0",
2582     "filename": "server/api/chatInteraction/index.js",
2583     "groupTitle": "Chat_Interactions"
2584   },
2585   {
2586     "type": "get",
2587     "url": "/api/chat/interactions/{id}/download",
2588     "title": "Gets interaction",
2589     "examples": [
2590       {
2591         "title": "Example usage:",
2592         "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2593         "type": "json"
2594       }
2595     ],
2596     "name": "download",
2597     "group": "Chat_Interactions",
2598     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2599     "version": "0.0.0",
2600     "filename": "server/api/chatInteraction/index.js",
2601     "groupTitle": "Chat_Interactions"
2602   },
2603   {
2604     "type": "get",
2605     "url": "/api/chat/interactions/{id}/messages",
2606     "title": "Gets interaction messages",
2607     "examples": [
2608       {
2609         "title": "Example usage:",
2610         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2611         "type": "json"
2612       }
2613     ],
2614     "name": "getMessages",
2615     "group": "Chat_Interactions",
2616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2617     "version": "0.0.0",
2618     "filename": "server/api/chatInteraction/index.js",
2619     "groupTitle": "Chat_Interactions"
2620   },
2621   {
2622     "type": "get",
2623     "url": "/api/chat/interactions/{id}/my_messages",
2624     "title": "Gets interaction messages",
2625     "examples": [
2626       {
2627         "title": "Example usage:",
2628         "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2629         "type": "json"
2630       }
2631     ],
2632     "name": "getMyMessages",
2633     "group": "Chat_Interactions",
2634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2635     "version": "0.0.0",
2636     "filename": "server/api/chatInteraction/index.js",
2637     "groupTitle": "Chat_Interactions"
2638   },
2639   {
2640     "type": "put",
2641     "url": "/api/chat/interactions/{id}",
2642     "title": "Update an existing Interaction",
2643     "examples": [
2644       {
2645         "title": "Example usage:",
2646         "content": "curl https://{domain}/api/chat/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2647         "type": "json"
2648       }
2649     ],
2650     "name": "updateInteractions",
2651     "group": "Chat_Interactions",
2652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2653     "version": "0.0.0",
2654     "filename": "server/api/chatInteraction/index.js",
2655     "groupTitle": "Chat_Interactions"
2656   },
2657   {
2658     "type": "post",
2659     "url": "/api/chat/internal/messages",
2660     "title": "Creates a new Message",
2661     "examples": [
2662       {
2663         "title": "Example usage:",
2664         "content": "curl https://{domain}/api/chat/internal/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2665         "type": "json"
2666       }
2667     ],
2668     "name": "CreateMessages",
2669     "group": "Chat_Internal_Messages",
2670     "parameter": {
2671       "fields": {
2672         "Body": [
2673           {
2674             "group": "Body",
2675             "type": "Text",
2676             "optional": false,
2677             "field": "body",
2678             "description": ""
2679           },
2680           {
2681             "group": "Body",
2682             "type": "Boolean",
2683             "optional": true,
2684             "field": "read",
2685             "description": ""
2686           },
2687           {
2688             "group": "Body",
2689             "type": "Integer",
2690             "optional": true,
2691             "field": "ChatInternalMessageId",
2692             "description": ""
2693           }
2694         ]
2695       }
2696     },
2697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2698     "version": "0.0.0",
2699     "filename": "server/api/chatInternalMessage/index.js",
2700     "groupTitle": "Chat_Internal_Messages"
2701   },
2702   {
2703     "type": "delete",
2704     "url": "/api/chat/internal/messages/{id}",
2705     "title": "Deletes a Message",
2706     "examples": [
2707       {
2708         "title": "Example usage:",
2709         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2710         "type": "json"
2711       }
2712     ],
2713     "name": "DeleteMessages",
2714     "group": "Chat_Internal_Messages",
2715     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2716     "version": "0.0.0",
2717     "filename": "server/api/chatInternalMessage/index.js",
2718     "groupTitle": "Chat_Internal_Messages"
2719   },
2720   {
2721     "type": "get",
2722     "url": "/api/chat/internal/messages/describe",
2723     "title": "Gets table info about Messages",
2724     "examples": [
2725       {
2726         "title": "Example usage:",
2727         "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2728         "type": "json"
2729       }
2730     ],
2731     "name": "DescribeMessages",
2732     "group": "Chat_Internal_Messages",
2733     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2734     "version": "0.0.0",
2735     "filename": "server/api/chatInternalMessage/index.js",
2736     "groupTitle": "Chat_Internal_Messages"
2737   },
2738   {
2739     "type": "get",
2740     "url": "/api/chat/internal/messages",
2741     "title": "Gets a list of Messages",
2742     "examples": [
2743       {
2744         "title": "Example usage:",
2745         "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2746         "type": "json"
2747       }
2748     ],
2749     "name": "GetMessages",
2750     "group": "Chat_Internal_Messages",
2751     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/internal/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/internal/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/internal/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/internal/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/internal/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2752     "version": "0.0.0",
2753     "filename": "server/api/chatInternalMessage/index.js",
2754     "groupTitle": "Chat_Internal_Messages"
2755   },
2756   {
2757     "type": "get",
2758     "url": "/api/chat/internal/messages/{id}",
2759     "title": "Gets a single Message",
2760     "examples": [
2761       {
2762         "title": "Example usage:",
2763         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2764         "type": "json"
2765       }
2766     ],
2767     "name": "ShowMessages",
2768     "group": "Chat_Internal_Messages",
2769     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2770     "version": "0.0.0",
2771     "filename": "server/api/chatInternalMessage/index.js",
2772     "groupTitle": "Chat_Internal_Messages"
2773   },
2774   {
2775     "type": "put",
2776     "url": "/api/chat/internal/messages/{id}",
2777     "title": "Update an existing Message",
2778     "examples": [
2779       {
2780         "title": "Example usage:",
2781         "content": "curl https://{domain}/api/chat/internal/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2782         "type": "json"
2783       }
2784     ],
2785     "name": "updateMessages",
2786     "group": "Chat_Internal_Messages",
2787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2788     "version": "0.0.0",
2789     "filename": "server/api/chatInternalMessage/index.js",
2790     "groupTitle": "Chat_Internal_Messages"
2791   },
2792   {
2793     "type": "post",
2794     "url": "/api/chat/messages",
2795     "title": "Creates a new Message",
2796     "examples": [
2797       {
2798         "title": "Example usage:",
2799         "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2800         "type": "json"
2801       }
2802     ],
2803     "name": "CreateMessages",
2804     "group": "Chat_Messages",
2805     "parameter": {
2806       "fields": {
2807         "Body": [
2808           {
2809             "group": "Body",
2810             "type": "Text",
2811             "optional": false,
2812             "field": "body",
2813             "description": ""
2814           },
2815           {
2816             "group": "Body",
2817             "type": "Boolean",
2818             "optional": true,
2819             "field": "read",
2820             "description": ""
2821           },
2822           {
2823             "group": "Body",
2824             "type": "Boolean",
2825             "optional": true,
2826             "field": "secret",
2827             "description": ""
2828           },
2829           {
2830             "group": "Body",
2831             "type": "String",
2832             "allowedValues": [
2833               "\"in\"",
2834               "\"out\""
2835             ],
2836             "optional": false,
2837             "field": "direction",
2838             "description": ""
2839           },
2840           {
2841             "group": "Body",
2842             "type": "String",
2843             "optional": true,
2844             "field": "readAt",
2845             "description": ""
2846           },
2847           {
2848             "group": "Body",
2849             "type": "String",
2850             "optional": true,
2851             "field": "providerName",
2852             "description": ""
2853           },
2854           {
2855             "group": "Body",
2856             "type": "Text",
2857             "optional": true,
2858             "field": "providerResponse",
2859             "description": ""
2860           }
2861         ]
2862       }
2863     },
2864     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2865     "version": "0.0.0",
2866     "filename": "server/api/chatMessage/index.js",
2867     "groupTitle": "Chat_Messages"
2868   },
2869   {
2870     "type": "delete",
2871     "url": "/api/chat/messages/{id}",
2872     "title": "Deletes a Message",
2873     "examples": [
2874       {
2875         "title": "Example usage:",
2876         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2877         "type": "json"
2878       }
2879     ],
2880     "name": "DeleteMessages",
2881     "group": "Chat_Messages",
2882     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2883     "version": "0.0.0",
2884     "filename": "server/api/chatMessage/index.js",
2885     "groupTitle": "Chat_Messages"
2886   },
2887   {
2888     "type": "get",
2889     "url": "/api/chat/messages/describe",
2890     "title": "Gets table info about Messages",
2891     "examples": [
2892       {
2893         "title": "Example usage:",
2894         "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2895         "type": "json"
2896       }
2897     ],
2898     "name": "DescribeMessages",
2899     "group": "Chat_Messages",
2900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2901     "version": "0.0.0",
2902     "filename": "server/api/chatMessage/index.js",
2903     "groupTitle": "Chat_Messages"
2904   },
2905   {
2906     "type": "get",
2907     "url": "/api/chat/messages",
2908     "title": "Gets a list of Messages",
2909     "examples": [
2910       {
2911         "title": "Example usage:",
2912         "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2913         "type": "json"
2914       }
2915     ],
2916     "name": "GetMessages",
2917     "group": "Chat_Messages",
2918     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2919     "version": "0.0.0",
2920     "filename": "server/api/chatMessage/index.js",
2921     "groupTitle": "Chat_Messages"
2922   },
2923   {
2924     "type": "get",
2925     "url": "/api/chat/messages/{id}",
2926     "title": "Gets a single Message",
2927     "examples": [
2928       {
2929         "title": "Example usage:",
2930         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2931         "type": "json"
2932       }
2933     ],
2934     "name": "ShowMessages",
2935     "group": "Chat_Messages",
2936     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2937     "version": "0.0.0",
2938     "filename": "server/api/chatMessage/index.js",
2939     "groupTitle": "Chat_Messages"
2940   },
2941   {
2942     "type": "put",
2943     "url": "/api/chat/messages/{id}",
2944     "title": "Update an existing Message",
2945     "examples": [
2946       {
2947         "title": "Example usage:",
2948         "content": "curl https://{domain}/api/chat/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2949         "type": "json"
2950       }
2951     ],
2952     "name": "updateMessages",
2953     "group": "Chat_Messages",
2954     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2955     "version": "0.0.0",
2956     "filename": "server/api/chatMessage/index.js",
2957     "groupTitle": "Chat_Messages"
2958   },
2959   {
2960     "type": "post",
2961     "url": "/api/chat/offline_messages",
2962     "title": "Creates a new OfflineMessage",
2963     "examples": [
2964       {
2965         "title": "Example usage:",
2966         "content": "curl https://{domain}/api/chat/offline_messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2967         "type": "json"
2968       }
2969     ],
2970     "name": "CreateOfflineMessages",
2971     "group": "Chat_Offline_Messages",
2972     "parameter": {
2973       "fields": {
2974         "Body": [
2975           {
2976             "group": "Body",
2977             "type": "Text",
2978             "optional": false,
2979             "field": "body",
2980             "description": ""
2981           }
2982         ]
2983       }
2984     },
2985     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2986     "version": "0.0.0",
2987     "filename": "server/api/chatOfflineMessage/index.js",
2988     "groupTitle": "Chat_Offline_Messages"
2989   },
2990   {
2991     "type": "delete",
2992     "url": "/api/chat/offline_messages/{id}",
2993     "title": "Deletes a OfflineMessage",
2994     "examples": [
2995       {
2996         "title": "Example usage:",
2997         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
2998         "type": "json"
2999       }
3000     ],
3001     "name": "DeleteOfflineMessages",
3002     "group": "Chat_Offline_Messages",
3003     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3004     "version": "0.0.0",
3005     "filename": "server/api/chatOfflineMessage/index.js",
3006     "groupTitle": "Chat_Offline_Messages"
3007   },
3008   {
3009     "type": "get",
3010     "url": "/api/chat/offline_messages/describe",
3011     "title": "Gets table info about OfflineMessages",
3012     "examples": [
3013       {
3014         "title": "Example usage:",
3015         "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3016         "type": "json"
3017       }
3018     ],
3019     "name": "DescribeOfflineMessages",
3020     "group": "Chat_Offline_Messages",
3021     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3022     "version": "0.0.0",
3023     "filename": "server/api/chatOfflineMessage/index.js",
3024     "groupTitle": "Chat_Offline_Messages"
3025   },
3026   {
3027     "type": "get",
3028     "url": "/api/chat/offline_messages",
3029     "title": "Gets a list of OfflineMessages",
3030     "examples": [
3031       {
3032         "title": "Example usage:",
3033         "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3034         "type": "json"
3035       }
3036     ],
3037     "name": "GetOfflineMessages",
3038     "group": "Chat_Offline_Messages",
3039     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/offline_messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/offline_messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/offline_messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/offline_messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/offline_messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3040     "version": "0.0.0",
3041     "filename": "server/api/chatOfflineMessage/index.js",
3042     "groupTitle": "Chat_Offline_Messages"
3043   },
3044   {
3045     "type": "get",
3046     "url": "/api/chat/offline_messages/{id}",
3047     "title": "Gets a single OfflineMessage",
3048     "examples": [
3049       {
3050         "title": "Example usage:",
3051         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3052         "type": "json"
3053       }
3054     ],
3055     "name": "ShowOfflineMessages",
3056     "group": "Chat_Offline_Messages",
3057     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3058     "version": "0.0.0",
3059     "filename": "server/api/chatOfflineMessage/index.js",
3060     "groupTitle": "Chat_Offline_Messages"
3061   },
3062   {
3063     "type": "put",
3064     "url": "/api/chat/offline_messages/{id}",
3065     "title": "Update an existing OfflineMessage",
3066     "examples": [
3067       {
3068         "title": "Example usage:",
3069         "content": "curl https://{domain}/api/chat/offline_messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3070         "type": "json"
3071       }
3072     ],
3073     "name": "updateOfflineMessages",
3074     "group": "Chat_Offline_Messages",
3075     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3076     "version": "0.0.0",
3077     "filename": "server/api/chatOfflineMessage/index.js",
3078     "groupTitle": "Chat_Offline_Messages"
3079   },
3080   {
3081     "type": "post",
3082     "url": "/api/chat/proactive_actions",
3083     "title": "Creates a new Proactive Action",
3084     "examples": [
3085       {
3086         "title": "Example usage:",
3087         "content": "curl https://{domain}/api/chat/proactive_actions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3088         "type": "json"
3089       }
3090     ],
3091     "name": "CreateProactive_Actions",
3092     "group": "Chat_Proactive_Actions",
3093     "parameter": {
3094       "fields": {
3095         "Body": [
3096           {
3097             "group": "Body",
3098             "type": "String",
3099             "optional": false,
3100             "field": "name",
3101             "description": ""
3102           },
3103           {
3104             "group": "Body",
3105             "type": "String",
3106             "allowedValues": [
3107               "\"mouseOver\"",
3108               "\"timeout\""
3109             ],
3110             "optional": true,
3111             "field": "type",
3112             "description": ""
3113           },
3114           {
3115             "group": "Body",
3116             "type": "String",
3117             "optional": true,
3118             "field": "selector",
3119             "description": ""
3120           },
3121           {
3122             "group": "Body",
3123             "type": "Integer",
3124             "optional": true,
3125             "field": "timeout",
3126             "description": ""
3127           }
3128         ]
3129       }
3130     },
3131     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3132     "version": "0.0.0",
3133     "filename": "server/api/chatProactiveAction/index.js",
3134     "groupTitle": "Chat_Proactive_Actions"
3135   },
3136   {
3137     "type": "delete",
3138     "url": "/api/chat/proactive_actions/{id}",
3139     "title": "Deletes a Proactive Action",
3140     "examples": [
3141       {
3142         "title": "Example usage:",
3143         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3144         "type": "json"
3145       }
3146     ],
3147     "name": "DeleteProactive_Actions",
3148     "group": "Chat_Proactive_Actions",
3149     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3150     "version": "0.0.0",
3151     "filename": "server/api/chatProactiveAction/index.js",
3152     "groupTitle": "Chat_Proactive_Actions"
3153   },
3154   {
3155     "type": "get",
3156     "url": "/api/chat/proactive_actions/{id}",
3157     "title": "Gets a single Proactive Action",
3158     "examples": [
3159       {
3160         "title": "Example usage:",
3161         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3162         "type": "json"
3163       }
3164     ],
3165     "name": "ShowProactive_Actions",
3166     "group": "Chat_Proactive_Actions",
3167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3168     "version": "0.0.0",
3169     "filename": "server/api/chatProactiveAction/index.js",
3170     "groupTitle": "Chat_Proactive_Actions"
3171   },
3172   {
3173     "type": "put",
3174     "url": "/api/chat/proactive_actions/{id}",
3175     "title": "Update an existing Proactive Action",
3176     "examples": [
3177       {
3178         "title": "Example usage:",
3179         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3180         "type": "json"
3181       }
3182     ],
3183     "name": "updateProactive_Actions",
3184     "group": "Chat_Proactive_Actions",
3185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3186     "version": "0.0.0",
3187     "filename": "server/api/chatProactiveAction/index.js",
3188     "groupTitle": "Chat_Proactive_Actions"
3189   },
3190   {
3191     "type": "post",
3192     "url": "/api/chat/reports/queue",
3193     "title": "Creates a new Chat Queue Report",
3194     "examples": [
3195       {
3196         "title": "Example usage:",
3197         "content": "curl https://{domain}/api/chat/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3198         "type": "json"
3199       }
3200     ],
3201     "name": "CreateChat_Queue_Reports",
3202     "group": "Chat_Queue_Reports",
3203     "parameter": {
3204       "fields": {
3205         "Body": [
3206           {
3207             "group": "Body",
3208             "type": "String",
3209             "optional": false,
3210             "field": "uniqueid",
3211             "description": ""
3212           },
3213           {
3214             "group": "Body",
3215             "type": "String",
3216             "optional": true,
3217             "field": "from",
3218             "description": ""
3219           },
3220           {
3221             "group": "Body",
3222             "type": "String",
3223             "optional": true,
3224             "field": "joinAt",
3225             "description": ""
3226           },
3227           {
3228             "group": "Body",
3229             "type": "String",
3230             "optional": true,
3231             "field": "leaveAt",
3232             "description": ""
3233           },
3234           {
3235             "group": "Body",
3236             "type": "String",
3237             "optional": true,
3238             "field": "acceptAt",
3239             "description": ""
3240           },
3241           {
3242             "group": "Body",
3243             "type": "String",
3244             "optional": true,
3245             "field": "exitAt",
3246             "description": ""
3247           },
3248           {
3249             "group": "Body",
3250             "type": "String",
3251             "optional": true,
3252             "field": "reason",
3253             "description": ""
3254           }
3255         ]
3256       }
3257     },
3258     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3259     "version": "0.0.0",
3260     "filename": "server/api/chatQueueReport/index.js",
3261     "groupTitle": "Chat_Queue_Reports"
3262   },
3263   {
3264     "type": "delete",
3265     "url": "/api/chat/reports/queue/{id}",
3266     "title": "Deletes a Chat Queue Report",
3267     "examples": [
3268       {
3269         "title": "Example usage:",
3270         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3271         "type": "json"
3272       }
3273     ],
3274     "name": "DeleteChat_Queue_Reports",
3275     "group": "Chat_Queue_Reports",
3276     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3277     "version": "0.0.0",
3278     "filename": "server/api/chatQueueReport/index.js",
3279     "groupTitle": "Chat_Queue_Reports"
3280   },
3281   {
3282     "type": "get",
3283     "url": "/api/chat/reports/queue/describe",
3284     "title": "Gets table info about Chat Queue Reports",
3285     "examples": [
3286       {
3287         "title": "Example usage:",
3288         "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3289         "type": "json"
3290       }
3291     ],
3292     "name": "DescribeChat_Queue_Reports",
3293     "group": "Chat_Queue_Reports",
3294     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3295     "version": "0.0.0",
3296     "filename": "server/api/chatQueueReport/index.js",
3297     "groupTitle": "Chat_Queue_Reports"
3298   },
3299   {
3300     "type": "get",
3301     "url": "/api/chat/reports/queue",
3302     "title": "Gets a list of Chat Queue Reports",
3303     "examples": [
3304       {
3305         "title": "Example usage:",
3306         "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3307         "type": "json"
3308       }
3309     ],
3310     "name": "GetChat_Queue_Reports",
3311     "group": "Chat_Queue_Reports",
3312     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3313     "version": "0.0.0",
3314     "filename": "server/api/chatQueueReport/index.js",
3315     "groupTitle": "Chat_Queue_Reports"
3316   },
3317   {
3318     "type": "get",
3319     "url": "/api/chat/reports/queue/{id}",
3320     "title": "Gets a single Chat Queue Report",
3321     "examples": [
3322       {
3323         "title": "Example usage:",
3324         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3325         "type": "json"
3326       }
3327     ],
3328     "name": "ShowChat_Queue_Reports",
3329     "group": "Chat_Queue_Reports",
3330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3331     "version": "0.0.0",
3332     "filename": "server/api/chatQueueReport/index.js",
3333     "groupTitle": "Chat_Queue_Reports"
3334   },
3335   {
3336     "type": "put",
3337     "url": "/api/chat/reports/queue/{id}",
3338     "title": "Update an existing Chat Queue Report",
3339     "examples": [
3340       {
3341         "title": "Example usage:",
3342         "content": "curl https://{domain}/api/chat/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3343         "type": "json"
3344       }
3345     ],
3346     "name": "updateChat_Queue_Reports",
3347     "group": "Chat_Queue_Reports",
3348     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3349     "version": "0.0.0",
3350     "filename": "server/api/chatQueueReport/index.js",
3351     "groupTitle": "Chat_Queue_Reports"
3352   },
3353   {
3354     "type": "post",
3355     "url": "/api/chat/queues/{id}/users",
3356     "title": "Add agents to a queue",
3357     "examples": [
3358       {
3359         "title": "Example usage:",
3360         "content": "curl https://{domain}/api/chat/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3361         "type": "json"
3362       }
3363     ],
3364     "name": "AddAgents",
3365     "group": "Chat_Queues",
3366     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3367     "version": "0.0.0",
3368     "filename": "server/api/chatQueue/index.js",
3369     "groupTitle": "Chat_Queues"
3370   },
3371   {
3372     "type": "post",
3373     "url": "/api/chat/queues/{id}/teams",
3374     "title": "Add teams to a queue",
3375     "examples": [
3376       {
3377         "title": "Example usage:",
3378         "content": "curl https://{domain}/api/chat/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3379         "type": "json"
3380       }
3381     ],
3382     "name": "AddTeams",
3383     "group": "Chat_Queues",
3384     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3385     "version": "0.0.0",
3386     "filename": "server/api/chatQueue/index.js",
3387     "groupTitle": "Chat_Queues"
3388   },
3389   {
3390     "type": "post",
3391     "url": "/api/chat/queues",
3392     "title": "Creates a new Queue",
3393     "examples": [
3394       {
3395         "title": "Example usage:",
3396         "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3397         "type": "json"
3398       }
3399     ],
3400     "name": "CreateQueues",
3401     "group": "Chat_Queues",
3402     "parameter": {
3403       "fields": {
3404         "Body": [
3405           {
3406             "group": "Body",
3407             "type": "String",
3408             "optional": false,
3409             "field": "name",
3410             "description": ""
3411           },
3412           {
3413             "group": "Body",
3414             "type": "String",
3415             "optional": true,
3416             "field": "description",
3417             "description": ""
3418           },
3419           {
3420             "group": "Body",
3421             "type": "Integer",
3422             "optional": true,
3423             "field": "timeout",
3424             "description": ""
3425           },
3426           {
3427             "group": "Body",
3428             "type": "String",
3429             "allowedValues": [
3430               "\"rrmemory\"",
3431               "\"beepall\"",
3432               "\"roundrobin\""
3433             ],
3434             "optional": true,
3435             "field": "strategy",
3436             "description": ""
3437           }
3438         ]
3439       }
3440     },
3441     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3442     "version": "0.0.0",
3443     "filename": "server/api/chatQueue/index.js",
3444     "groupTitle": "Chat_Queues"
3445   },
3446   {
3447     "type": "delete",
3448     "url": "/api/chat/queues/{id}",
3449     "title": "Deletes a Queue",
3450     "examples": [
3451       {
3452         "title": "Example usage:",
3453         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3454         "type": "json"
3455       }
3456     ],
3457     "name": "DeleteQueues",
3458     "group": "Chat_Queues",
3459     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3460     "version": "0.0.0",
3461     "filename": "server/api/chatQueue/index.js",
3462     "groupTitle": "Chat_Queues"
3463   },
3464   {
3465     "type": "get",
3466     "url": "/api/chat/queues/describe",
3467     "title": "Gets table info about Queues",
3468     "examples": [
3469       {
3470         "title": "Example usage:",
3471         "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3472         "type": "json"
3473       }
3474     ],
3475     "name": "DescribeQueues",
3476     "group": "Chat_Queues",
3477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3478     "version": "0.0.0",
3479     "filename": "server/api/chatQueue/index.js",
3480     "groupTitle": "Chat_Queues"
3481   },
3482   {
3483     "type": "get",
3484     "url": "/api/chat/queues/{id}/users",
3485     "title": "Gets queue agents",
3486     "examples": [
3487       {
3488         "title": "Example usage:",
3489         "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3490         "type": "json"
3491       }
3492     ],
3493     "name": "GetAgents",
3494     "group": "Chat_Queues",
3495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3496     "version": "0.0.0",
3497     "filename": "server/api/chatQueue/index.js",
3498     "groupTitle": "Chat_Queues"
3499   },
3500   {
3501     "type": "get",
3502     "url": "/api/chat/queues/{id}/members",
3503     "title": "GetMembers",
3504     "examples": [
3505       {
3506         "title": "Example usage:",
3507         "content": "curl https://{domain}/api/chat/queues/{id}/members  -v -u {name}:{password}",
3508         "type": "json"
3509       }
3510     ],
3511     "name": "GetMembers",
3512     "group": "Chat_Queues",
3513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3514     "version": "0.0.0",
3515     "filename": "server/api/chatQueue/index.js",
3516     "groupTitle": "Chat_Queues"
3517   },
3518   {
3519     "type": "get",
3520     "url": "/api/chat/queues",
3521     "title": "Gets a list of Queues",
3522     "examples": [
3523       {
3524         "title": "Example usage:",
3525         "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3526         "type": "json"
3527       }
3528     ],
3529     "name": "GetQueues",
3530     "group": "Chat_Queues",
3531     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3532     "version": "0.0.0",
3533     "filename": "server/api/chatQueue/index.js",
3534     "groupTitle": "Chat_Queues"
3535   },
3536   {
3537     "type": "get",
3538     "url": "/api/chat/queues/{id}/teams",
3539     "title": "Gets queues list",
3540     "examples": [
3541       {
3542         "title": "Example usage:",
3543         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3544         "type": "json"
3545       }
3546     ],
3547     "name": "GetTeams",
3548     "group": "Chat_Queues",
3549     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3550     "version": "0.0.0",
3551     "filename": "server/api/chatQueue/index.js",
3552     "groupTitle": "Chat_Queues"
3553   },
3554   {
3555     "type": "delete",
3556     "url": "/api/chat/queues/{id}/users",
3557     "title": "Removes agents from a queue",
3558     "examples": [
3559       {
3560         "title": "Example usage:",
3561         "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3562         "type": "json"
3563       }
3564     ],
3565     "name": "RemoveAgents",
3566     "group": "Chat_Queues",
3567     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3568     "version": "0.0.0",
3569     "filename": "server/api/chatQueue/index.js",
3570     "groupTitle": "Chat_Queues"
3571   },
3572   {
3573     "type": "get",
3574     "url": "/api/chat/queues/{id}",
3575     "title": "Gets a single Queue",
3576     "examples": [
3577       {
3578         "title": "Example usage:",
3579         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3580         "type": "json"
3581       }
3582     ],
3583     "name": "ShowQueues",
3584     "group": "Chat_Queues",
3585     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3586     "version": "0.0.0",
3587     "filename": "server/api/chatQueue/index.js",
3588     "groupTitle": "Chat_Queues"
3589   },
3590   {
3591     "type": "put",
3592     "url": "/api/chat/queues/{id}",
3593     "title": "Update an existing Queue",
3594     "examples": [
3595       {
3596         "title": "Example usage:",
3597         "content": "curl https://{domain}/api/chat/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3598         "type": "json"
3599       }
3600     ],
3601     "name": "updateQueues",
3602     "group": "Chat_Queues",
3603     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3604     "version": "0.0.0",
3605     "filename": "server/api/chatQueue/index.js",
3606     "groupTitle": "Chat_Queues"
3607   },
3608   {
3609     "type": "post",
3610     "url": "/api/chat/reports/transfer",
3611     "title": "Creates a new Chat Transfer Report",
3612     "examples": [
3613       {
3614         "title": "Example usage:",
3615         "content": "curl https://{domain}/api/chat/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3616         "type": "json"
3617       }
3618     ],
3619     "name": "CreateChat_Transfer_Reports",
3620     "group": "Chat_Transfer_Reports",
3621     "parameter": {
3622       "fields": {
3623         "Body": [
3624           {
3625             "group": "Body",
3626             "type": "String",
3627             "optional": false,
3628             "field": "uniqueid",
3629             "description": ""
3630           },
3631           {
3632             "group": "Body",
3633             "type": "String",
3634             "allowedValues": [
3635               "\"account\"",
3636               "\"agent\"",
3637               "\"queue\""
3638             ],
3639             "optional": false,
3640             "field": "type",
3641             "description": ""
3642           },
3643           {
3644             "group": "Body",
3645             "type": "String",
3646             "optional": false,
3647             "field": "transferredAt",
3648             "description": ""
3649           }
3650         ]
3651       }
3652     },
3653     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3654     "version": "0.0.0",
3655     "filename": "server/api/chatTransferReport/index.js",
3656     "groupTitle": "Chat_Transfer_Reports"
3657   },
3658   {
3659     "type": "delete",
3660     "url": "/api/chat/reports/transfer/{id}",
3661     "title": "Deletes a Chat Transfer Report",
3662     "examples": [
3663       {
3664         "title": "Example usage:",
3665         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3666         "type": "json"
3667       }
3668     ],
3669     "name": "DeleteChat_Transfer_Reports",
3670     "group": "Chat_Transfer_Reports",
3671     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3672     "version": "0.0.0",
3673     "filename": "server/api/chatTransferReport/index.js",
3674     "groupTitle": "Chat_Transfer_Reports"
3675   },
3676   {
3677     "type": "get",
3678     "url": "/api/chat/reports/transfer/describe",
3679     "title": "Gets table info about Chat Transfer Reports",
3680     "examples": [
3681       {
3682         "title": "Example usage:",
3683         "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3684         "type": "json"
3685       }
3686     ],
3687     "name": "DescribeChat_Transfer_Reports",
3688     "group": "Chat_Transfer_Reports",
3689     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3690     "version": "0.0.0",
3691     "filename": "server/api/chatTransferReport/index.js",
3692     "groupTitle": "Chat_Transfer_Reports"
3693   },
3694   {
3695     "type": "get",
3696     "url": "/api/chat/reports/transfer",
3697     "title": "Gets a list of Chat Transfer Reports",
3698     "examples": [
3699       {
3700         "title": "Example usage:",
3701         "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3702         "type": "json"
3703       }
3704     ],
3705     "name": "GetChat_Transfer_Reports",
3706     "group": "Chat_Transfer_Reports",
3707     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3708     "version": "0.0.0",
3709     "filename": "server/api/chatTransferReport/index.js",
3710     "groupTitle": "Chat_Transfer_Reports"
3711   },
3712   {
3713     "type": "get",
3714     "url": "/api/chat/reports/transfer/{id}",
3715     "title": "Gets a single Chat Transfer Report",
3716     "examples": [
3717       {
3718         "title": "Example usage:",
3719         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3720         "type": "json"
3721       }
3722     ],
3723     "name": "ShowChat_Transfer_Reports",
3724     "group": "Chat_Transfer_Reports",
3725     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3726     "version": "0.0.0",
3727     "filename": "server/api/chatTransferReport/index.js",
3728     "groupTitle": "Chat_Transfer_Reports"
3729   },
3730   {
3731     "type": "put",
3732     "url": "/api/chat/reports/transfer/{id}",
3733     "title": "Update an existing Chat Transfer Report",
3734     "examples": [
3735       {
3736         "title": "Example usage:",
3737         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3738         "type": "json"
3739       }
3740     ],
3741     "name": "updateChat_Transfer_Reports",
3742     "group": "Chat_Transfer_Reports",
3743     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3744     "version": "0.0.0",
3745     "filename": "server/api/chatTransferReport/index.js",
3746     "groupTitle": "Chat_Transfer_Reports"
3747   },
3748   {
3749     "type": "post",
3750     "url": "/api/chat/websites/{id}/users",
3751     "title": "Add agents to a website",
3752     "examples": [
3753       {
3754         "title": "Example usage:",
3755         "content": "curl https://{domain}/api/chat/websites/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3756         "type": "json"
3757       }
3758     ],
3759     "name": "AddAgents",
3760     "group": "Chat_Websites",
3761     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3762     "version": "0.0.0",
3763     "filename": "server/api/chatWebsite/index.js",
3764     "groupTitle": "Chat_Websites"
3765   },
3766   {
3767     "type": "post",
3768     "url": "/api/chat/websites",
3769     "title": "Creates a new Website",
3770     "examples": [
3771       {
3772         "title": "Example usage:",
3773         "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3774         "type": "json"
3775       }
3776     ],
3777     "name": "CreateWebsites",
3778     "group": "Chat_Websites",
3779     "parameter": {
3780       "fields": {
3781         "Body": [
3782           {
3783             "group": "Body",
3784             "type": "String",
3785             "optional": false,
3786             "field": "name",
3787             "description": ""
3788           },
3789           {
3790             "group": "Body",
3791             "type": "String",
3792             "optional": false,
3793             "field": "address",
3794             "description": ""
3795           },
3796           {
3797             "group": "Body",
3798             "type": "String",
3799             "optional": true,
3800             "field": "description",
3801             "description": ""
3802           },
3803           {
3804             "group": "Body",
3805             "type": "String",
3806             "optional": true,
3807             "field": "mapKey",
3808             "description": ""
3809           },
3810           {
3811             "group": "Body",
3812             "type": "String",
3813             "optional": true,
3814             "field": "mapKeyOffline",
3815             "description": ""
3816           },
3817           {
3818             "group": "Body",
3819             "type": "String",
3820             "optional": false,
3821             "field": "key",
3822             "description": ""
3823           },
3824           {
3825             "group": "Body",
3826             "type": "String",
3827             "optional": true,
3828             "field": "agentAlias",
3829             "description": ""
3830           },
3831           {
3832             "group": "Body",
3833             "type": "String",
3834             "optional": true,
3835             "field": "customerAlias",
3836             "description": ""
3837           },
3838           {
3839             "group": "Body",
3840             "type": "String",
3841             "optional": false,
3842             "field": "color",
3843             "description": ""
3844           },
3845           {
3846             "group": "Body",
3847             "type": "String",
3848             "optional": false,
3849             "field": "color_button",
3850             "description": ""
3851           },
3852           {
3853             "group": "Body",
3854             "type": "String",
3855             "optional": false,
3856             "field": "textColor",
3857             "description": ""
3858           },
3859           {
3860             "group": "Body",
3861             "type": "Integer",
3862             "optional": true,
3863             "field": "fontSize",
3864             "description": ""
3865           },
3866           {
3867             "group": "Body",
3868             "type": "String",
3869             "optional": true,
3870             "field": "remote",
3871             "description": ""
3872           },
3873           {
3874             "group": "Body",
3875             "type": "Boolean",
3876             "optional": true,
3877             "field": "animation",
3878             "description": ""
3879           },
3880           {
3881             "group": "Body",
3882             "type": "String",
3883             "allowedValues": [
3884               "\"rounded\"",
3885               "\"squared\""
3886             ],
3887             "optional": true,
3888             "field": "header_shape",
3889             "description": ""
3890           },
3891           {
3892             "group": "Body",
3893             "type": "String",
3894             "optional": true,
3895             "field": "header_online",
3896             "description": ""
3897           },
3898           {
3899             "group": "Body",
3900             "type": "String",
3901             "optional": true,
3902             "field": "start_chat_button",
3903             "description": ""
3904           },
3905           {
3906             "group": "Body",
3907             "type": "String",
3908             "optional": true,
3909             "field": "offline_chat_button",
3910             "description": ""
3911           },
3912           {
3913             "group": "Body",
3914             "type": "String",
3915             "optional": true,
3916             "field": "header_offline",
3917             "description": ""
3918           },
3919           {
3920             "group": "Body",
3921             "type": "Boolean",
3922             "optional": true,
3923             "field": "download_transcript",
3924             "description": ""
3925           },
3926           {
3927             "group": "Body",
3928             "type": "Integer",
3929             "optional": true,
3930             "field": "timeout",
3931             "description": ""
3932           },
3933           {
3934             "group": "Body",
3935             "type": "String",
3936             "optional": true,
3937             "field": "whiteLabel",
3938             "description": ""
3939           },
3940           {
3941             "group": "Body",
3942             "type": "Boolean",
3943             "optional": true,
3944             "field": "defaultWhiteLabel",
3945             "description": ""
3946           },
3947           {
3948             "group": "Body",
3949             "type": "Text",
3950             "optional": true,
3951             "field": "sitepic",
3952             "description": ""
3953           },
3954           {
3955             "group": "Body",
3956             "type": "String",
3957             "optional": true,
3958             "field": "closingQuestion",
3959             "description": ""
3960           },
3961           {
3962             "group": "Body",
3963             "type": "String",
3964             "optional": true,
3965             "field": "formSubmitSuccessMessage",
3966             "description": ""
3967           },
3968           {
3969             "group": "Body",
3970             "type": "String",
3971             "optional": true,
3972             "field": "formSubmitFailureMessage",
3973             "description": ""
3974           },
3975           {
3976             "group": "Body",
3977             "type": "String",
3978             "optional": true,
3979             "field": "noteTitle",
3980             "description": ""
3981           },
3982           {
3983             "group": "Body",
3984             "type": "String",
3985             "optional": true,
3986             "field": "placeholderMessage",
3987             "description": ""
3988           },
3989           {
3990             "group": "Body",
3991             "type": "String",
3992             "optional": true,
3993             "field": "closingMessage",
3994             "description": ""
3995           },
3996           {
3997             "group": "Body",
3998             "type": "String",
3999             "optional": true,
4000             "field": "closingMessageButton",
4001             "description": ""
4002           },
4003           {
4004             "group": "Body",
4005             "type": "String",
4006             "optional": true,
4007             "field": "skipMessageButton",
4008             "description": ""
4009           },
4010           {
4011             "group": "Body",
4012             "type": "Boolean",
4013             "optional": true,
4014             "field": "conditionAgreement",
4015             "description": ""
4016           },
4017           {
4018             "group": "Body",
4019             "type": "Boolean",
4020             "optional": true,
4021             "field": "enableRating",
4022             "description": ""
4023           },
4024           {
4025             "group": "Body",
4026             "type": "Boolean",
4027             "optional": true,
4028             "field": "enableFeedback",
4029             "description": ""
4030           },
4031           {
4032             "group": "Body",
4033             "type": "Boolean",
4034             "optional": true,
4035             "field": "enableSendButton",
4036             "description": ""
4037           },
4038           {
4039             "group": "Body",
4040             "type": "String",
4041             "optional": true,
4042             "field": "feedbackTitle",
4043             "description": ""
4044           },
4045           {
4046             "group": "Body",
4047             "type": "String",
4048             "allowedValues": [
4049               "\"star\"",
4050               "\"thumb\""
4051             ],
4052             "optional": true,
4053             "field": "ratingType",
4054             "description": ""
4055           },
4056           {
4057             "group": "Body",
4058             "type": "Integer",
4059             "optional": true,
4060             "field": "ratingStarsNumber",
4061             "description": ""
4062           },
4063           {
4064             "group": "Body",
4065             "type": "Text",
4066             "optional": true,
4067             "field": "onlineForm",
4068             "description": ""
4069           },
4070           {
4071             "group": "Body",
4072             "type": "Text",
4073             "optional": true,
4074             "field": "offlineForm",
4075             "description": ""
4076           },
4077           {
4078             "group": "Body",
4079             "type": "String",
4080             "optional": true,
4081             "field": "token",
4082             "description": ""
4083           },
4084           {
4085             "group": "Body",
4086             "type": "Boolean",
4087             "optional": true,
4088             "field": "autoclose",
4089             "description": ""
4090           },
4091           {
4092             "group": "Body",
4093             "type": "Boolean",
4094             "optional": true,
4095             "field": "enableCustomerWriting",
4096             "description": ""
4097           },
4098           {
4099             "group": "Body",
4100             "type": "Boolean",
4101             "optional": true,
4102             "field": "forwardTranscript",
4103             "description": ""
4104           },
4105           {
4106             "group": "Body",
4107             "type": "String",
4108             "optional": true,
4109             "field": "forwardTranscriptMessage",
4110             "description": ""
4111           },
4112           {
4113             "group": "Body",
4114             "type": "Boolean",
4115             "optional": true,
4116             "field": "forwardOffline",
4117             "description": ""
4118           },
4119           {
4120             "group": "Body",
4121             "type": "String",
4122             "optional": true,
4123             "field": "forwardOfflineAddress",
4124             "description": ""
4125           },
4126           {
4127             "group": "Body",
4128             "type": "String",
4129             "optional": true,
4130             "field": "waitingTitle",
4131             "description": ""
4132           },
4133           {
4134             "group": "Body",
4135             "type": "String",
4136             "optional": true,
4137             "field": "waitingMessage",
4138             "description": ""
4139           },
4140           {
4141             "group": "Body",
4142             "type": "String",
4143             "optional": true,
4144             "field": "offlineMessageSubject",
4145             "description": ""
4146           },
4147           {
4148             "group": "Body",
4149             "type": "String",
4150             "optional": true,
4151             "field": "offlineMessageBody",
4152             "description": ""
4153           },
4154           {
4155             "group": "Body",
4156             "type": "Boolean",
4157             "optional": true,
4158             "field": "enableUnmanagedNote",
4159             "description": ""
4160           },
4161           {
4162             "group": "Body",
4163             "type": "String",
4164             "optional": true,
4165             "field": "unmanagedMessage",
4166             "description": ""
4167           },
4168           {
4169             "group": "Body",
4170             "type": "String",
4171             "optional": true,
4172             "field": "skipUnmanaged",
4173             "description": ""
4174           },
4175           {
4176             "group": "Body",
4177             "type": "String",
4178             "optional": true,
4179             "field": "sendUnmanaged",
4180             "description": ""
4181           },
4182           {
4183             "group": "Body",
4184             "type": "Boolean",
4185             "optional": true,
4186             "field": "enableCustomerAttachment",
4187             "description": ""
4188           },
4189           {
4190             "group": "Body",
4191             "type": "Boolean",
4192             "optional": true,
4193             "field": "enableCustomerCheckmarks",
4194             "description": ""
4195           },
4196           {
4197             "group": "Body",
4198             "type": "Text",
4199             "optional": true,
4200             "field": "agentAvatar",
4201             "description": ""
4202           },
4203           {
4204             "group": "Body",
4205             "type": "Boolean",
4206             "optional": true,
4207             "field": "showAgentAvatar",
4208             "description": ""
4209           },
4210           {
4211             "group": "Body",
4212             "type": "String",
4213             "optional": true,
4214             "field": "timezone",
4215             "description": ""
4216           },
4217           {
4218             "group": "Body",
4219             "type": "Text",
4220             "optional": true,
4221             "field": "notificationTemplate",
4222             "description": ""
4223           },
4224           {
4225             "group": "Body",
4226             "type": "Boolean",
4227             "optional": true,
4228             "field": "notificationSound",
4229             "description": ""
4230           },
4231           {
4232             "group": "Body",
4233             "type": "Boolean",
4234             "optional": true,
4235             "field": "notificationShake",
4236             "description": ""
4237           },
4238           {
4239             "group": "Body",
4240             "type": "Boolean",
4241             "optional": true,
4242             "field": "hideWhenOffline",
4243             "description": ""
4244           },
4245           {
4246             "group": "Body",
4247             "type": "String",
4248             "optional": true,
4249             "field": "agentIdentifier",
4250             "description": ""
4251           },
4252           {
4253             "group": "Body",
4254             "type": "Integer",
4255             "optional": true,
4256             "field": "waitForTheAssignedAgent",
4257             "description": ""
4258           },
4259           {
4260             "group": "Body",
4261             "type": "String",
4262             "optional": true,
4263             "field": "alignment",
4264             "description": ""
4265           },
4266           {
4267             "group": "Body",
4268             "type": "Integer",
4269             "optional": true,
4270             "field": "verticalAlignment",
4271             "description": ""
4272           },
4273           {
4274             "group": "Body",
4275             "type": "String",
4276             "optional": true,
4277             "field": "messagesAlignment",
4278             "description": ""
4279           },
4280           {
4281             "group": "Body",
4282             "type": "String",
4283             "optional": true,
4284             "field": "defaultTitle",
4285             "description": ""
4286           },
4287           {
4288             "group": "Body",
4289             "type": "Text",
4290             "optional": true,
4291             "field": "customerAvatar",
4292             "description": ""
4293           },
4294           {
4295             "group": "Body",
4296             "type": "Boolean",
4297             "optional": true,
4298             "field": "showCustomerAvatar",
4299             "description": ""
4300           },
4301           {
4302             "group": "Body",
4303             "type": "Integer",
4304             "optional": true,
4305             "field": "messageFontSize",
4306             "description": ""
4307           },
4308           {
4309             "group": "Body",
4310             "type": "String",
4311             "optional": false,
4312             "field": "backgroundColor",
4313             "description": ""
4314           },
4315           {
4316             "group": "Body",
4317             "type": "Boolean",
4318             "optional": true,
4319             "field": "queueTransfer",
4320             "description": ""
4321           },
4322           {
4323             "group": "Body",
4324             "type": "Integer",
4325             "optional": true,
4326             "field": "queueTransferTimeout",
4327             "description": ""
4328           },
4329           {
4330             "group": "Body",
4331             "type": "Boolean",
4332             "optional": true,
4333             "field": "agentTransfer",
4334             "description": ""
4335           },
4336           {
4337             "group": "Body",
4338             "type": "Integer",
4339             "optional": true,
4340             "field": "agentTransferTimeout",
4341             "description": ""
4342           },
4343           {
4344             "group": "Body",
4345             "type": "String",
4346             "optional": true,
4347             "field": "systemAlias",
4348             "description": ""
4349           },
4350           {
4351             "group": "Body",
4352             "type": "Text",
4353             "optional": true,
4354             "field": "systemAvatar",
4355             "description": ""
4356           },
4357           {
4358             "group": "Body",
4359             "type": "Integer",
4360             "optional": true,
4361             "field": "mandatoryDispositionPauseId",
4362             "description": "<p>Status to put when mandatory disposition is enabled</p>"
4363           },
4364           {
4365             "group": "Body",
4366             "type": "Boolean",
4367             "optional": true,
4368             "field": "mandatoryDisposition",
4369             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4370           },
4371           {
4372             "group": "Body",
4373             "type": "Boolean",
4374             "optional": true,
4375             "field": "vidaooEscalation",
4376             "description": ""
4377           },
4378           {
4379             "group": "Body",
4380             "type": "String",
4381             "optional": true,
4382             "field": "vidaooApiKey",
4383             "description": ""
4384           },
4385           {
4386             "group": "Body",
4387             "type": "Boolean",
4388             "optional": true,
4389             "field": "openNewInteraction",
4390             "description": ""
4391           },
4392           {
4393             "group": "Body",
4394             "type": "Text",
4395             "optional": true,
4396             "field": "subjectOffline",
4397             "description": ""
4398           }
4399         ]
4400       }
4401     },
4402     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4403     "version": "0.0.0",
4404     "filename": "server/api/chatWebsite/index.js",
4405     "groupTitle": "Chat_Websites"
4406   },
4407   {
4408     "type": "delete",
4409     "url": "/api/chat/websites/{id}",
4410     "title": "Deletes a Website",
4411     "examples": [
4412       {
4413         "title": "Example usage:",
4414         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4415         "type": "json"
4416       }
4417     ],
4418     "name": "DeleteWebsites",
4419     "group": "Chat_Websites",
4420     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4421     "version": "0.0.0",
4422     "filename": "server/api/chatWebsite/index.js",
4423     "groupTitle": "Chat_Websites"
4424   },
4425   {
4426     "type": "get",
4427     "url": "/api/chat/websites/describe",
4428     "title": "Gets table info about Websites",
4429     "examples": [
4430       {
4431         "title": "Example usage:",
4432         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4433         "type": "json"
4434       }
4435     ],
4436     "name": "DescribeWebsites",
4437     "group": "Chat_Websites",
4438     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4439     "version": "0.0.0",
4440     "filename": "server/api/chatWebsite/index.js",
4441     "groupTitle": "Chat_Websites"
4442   },
4443   {
4444     "type": "get",
4445     "url": "/api/chat/websites/{id}/users",
4446     "title": "Gets agents from website",
4447     "examples": [
4448       {
4449         "title": "Example usage:",
4450         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4451         "type": "json"
4452       }
4453     ],
4454     "name": "GetAgents",
4455     "group": "Chat_Websites",
4456     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4457     "version": "0.0.0",
4458     "filename": "server/api/chatWebsite/index.js",
4459     "groupTitle": "Chat_Websites"
4460   },
4461   {
4462     "type": "get",
4463     "url": "/api/chat/websites",
4464     "title": "Gets a list of Websites",
4465     "examples": [
4466       {
4467         "title": "Example usage:",
4468         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4469         "type": "json"
4470       }
4471     ],
4472     "name": "GetWebsites",
4473     "group": "Chat_Websites",
4474     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4475     "version": "0.0.0",
4476     "filename": "server/api/chatWebsite/index.js",
4477     "groupTitle": "Chat_Websites"
4478   },
4479   {
4480     "type": "delete",
4481     "url": "/api/chat/websites/{id}/users",
4482     "title": "Removes agents from a website",
4483     "examples": [
4484       {
4485         "title": "Example usage:",
4486         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4487         "type": "json"
4488       }
4489     ],
4490     "name": "RemoveAgents",
4491     "group": "Chat_Websites",
4492     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4493     "version": "0.0.0",
4494     "filename": "server/api/chatWebsite/index.js",
4495     "groupTitle": "Chat_Websites"
4496   },
4497   {
4498     "type": "delete",
4499     "url": "/api/chat/websites/{id}/canned_answers",
4500     "title": "Removes canned answers from account",
4501     "examples": [
4502       {
4503         "title": "Example usage:",
4504         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4505         "type": "json"
4506       }
4507     ],
4508     "name": "RemoveAnswers",
4509     "group": "Chat_Websites",
4510     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4511     "version": "0.0.0",
4512     "filename": "server/api/chatWebsite/index.js",
4513     "groupTitle": "Chat_Websites"
4514   },
4515   {
4516     "type": "delete",
4517     "url": "/api/chat/websites/{id}/dispositions",
4518     "title": "Removes canned answers from account",
4519     "examples": [
4520       {
4521         "title": "Example usage:",
4522         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4523         "type": "json"
4524       }
4525     ],
4526     "name": "RemoveDispositions",
4527     "group": "Chat_Websites",
4528     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4529     "version": "0.0.0",
4530     "filename": "server/api/chatWebsite/index.js",
4531     "groupTitle": "Chat_Websites"
4532   },
4533   {
4534     "type": "get",
4535     "url": "/api/chat/websites/{id}",
4536     "title": "Gets a single Website",
4537     "examples": [
4538       {
4539         "title": "Example usage:",
4540         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4541         "type": "json"
4542       }
4543     ],
4544     "name": "ShowWebsites",
4545     "group": "Chat_Websites",
4546     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4547     "version": "0.0.0",
4548     "filename": "server/api/chatWebsite/index.js",
4549     "groupTitle": "Chat_Websites"
4550   },
4551   {
4552     "type": "put",
4553     "url": "/api/chat/messages/{id}/accept",
4554     "title": "Accepts message",
4555     "examples": [
4556       {
4557         "title": "Example usage:",
4558         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4559         "type": "json"
4560       }
4561     ],
4562     "name": "acceptMessage",
4563     "group": "Chat_Websites",
4564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4565     "version": "0.0.0",
4566     "filename": "server/api/chatMessage/index.js",
4567     "groupTitle": "Chat_Websites"
4568   },
4569   {
4570     "type": "post",
4571     "url": "/api/chat/websites/{id}/canned_answers",
4572     "title": "Creates new canned answer",
4573     "examples": [
4574       {
4575         "title": "Example usage:",
4576         "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",
4577         "type": "json"
4578       }
4579     ],
4580     "name": "addAnswer",
4581     "group": "Chat_Websites",
4582     "parameter": {
4583       "fields": {
4584         "Body": [
4585           {
4586             "group": "Body",
4587             "type": "String",
4588             "optional": false,
4589             "field": "key",
4590             "description": ""
4591           },
4592           {
4593             "group": "Body",
4594             "type": "Text",
4595             "optional": false,
4596             "field": "value",
4597             "description": ""
4598           },
4599           {
4600             "group": "Body",
4601             "type": "String",
4602             "optional": true,
4603             "field": "description",
4604             "description": ""
4605           },
4606           {
4607             "group": "Body",
4608             "type": "Virtual",
4609             "optional": true,
4610             "field": "name",
4611             "description": ""
4612           }
4613         ]
4614       }
4615     },
4616     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4617     "version": "0.0.0",
4618     "filename": "server/api/chatWebsite/index.js",
4619     "groupTitle": "Chat_Websites"
4620   },
4621   {
4622     "type": "post",
4623     "url": "/api/chat/websites/{id}/applications",
4624     "title": "Creates new applications",
4625     "examples": [
4626       {
4627         "title": "Example usage:",
4628         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4629         "type": "json"
4630       }
4631     ],
4632     "name": "addApplications",
4633     "group": "Chat_Websites",
4634     "parameter": {
4635       "fields": {
4636         "Body": [
4637           {
4638             "group": "Body",
4639             "type": "Integer",
4640             "optional": false,
4641             "field": "priority",
4642             "description": ""
4643           },
4644           {
4645             "group": "Body",
4646             "type": "String",
4647             "optional": false,
4648             "field": "app",
4649             "description": ""
4650           },
4651           {
4652             "group": "Body",
4653             "type": "Text",
4654             "optional": true,
4655             "field": "appdata",
4656             "description": ""
4657           },
4658           {
4659             "group": "Body",
4660             "type": "String",
4661             "optional": true,
4662             "field": "description",
4663             "description": ""
4664           },
4665           {
4666             "group": "Body",
4667             "type": "String",
4668             "optional": true,
4669             "field": "interval",
4670             "description": ""
4671           }
4672         ]
4673       }
4674     },
4675     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4676     "version": "0.0.0",
4677     "filename": "server/api/chatWebsite/index.js",
4678     "groupTitle": "Chat_Websites"
4679   },
4680   {
4681     "type": "post",
4682     "url": "/api/chat/websites/{id}/avatar",
4683     "title": "Add avatar",
4684     "examples": [
4685       {
4686         "title": "Example usage:",
4687         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4688         "type": "json"
4689       }
4690     ],
4691     "name": "addAvatar",
4692     "group": "Chat_Websites",
4693     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4694     "version": "0.0.0",
4695     "filename": "server/api/chatWebsite/index.js",
4696     "groupTitle": "Chat_Websites"
4697   },
4698   {
4699     "type": "post",
4700     "url": "/api/chat/websites/{id}/customer_avatar",
4701     "title": "Add customer avatar",
4702     "examples": [
4703       {
4704         "title": "Example usage:",
4705         "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",
4706         "type": "json"
4707       }
4708     ],
4709     "name": "addCustomerAvatar",
4710     "group": "Chat_Websites",
4711     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4712     "version": "0.0.0",
4713     "filename": "server/api/chatWebsite/index.js",
4714     "groupTitle": "Chat_Websites"
4715   },
4716   {
4717     "type": "post",
4718     "url": "/api/chat/websites/{id}/dispositions",
4719     "title": "Creates new disposition",
4720     "examples": [
4721       {
4722         "title": "Example usage:",
4723         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4724         "type": "json"
4725       }
4726     ],
4727     "name": "addDisposition",
4728     "group": "Chat_Websites",
4729     "parameter": {
4730       "fields": {
4731         "Body": [
4732           {
4733             "group": "Body",
4734             "type": "String",
4735             "optional": false,
4736             "field": "name",
4737             "description": ""
4738           },
4739           {
4740             "group": "Body",
4741             "type": "String",
4742             "allowedValues": [
4743               "\"first\"",
4744               "\"second\"",
4745               "\"third\""
4746             ],
4747             "optional": false,
4748             "field": "level",
4749             "description": ""
4750           },
4751           {
4752             "group": "Body",
4753             "type": "String",
4754             "optional": true,
4755             "field": "description",
4756             "description": ""
4757           }
4758         ]
4759       }
4760     },
4761     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4762     "version": "0.0.0",
4763     "filename": "server/api/chatWebsite/index.js",
4764     "groupTitle": "Chat_Websites"
4765   },
4766   {
4767     "type": "post",
4768     "url": "/api/chat/accounts/{id}/interactions",
4769     "title": "Creates new interactions",
4770     "examples": [
4771       {
4772         "title": "Example usage:",
4773         "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",
4774         "type": "json"
4775       }
4776     ],
4777     "name": "addInteraction",
4778     "group": "Chat_Websites",
4779     "parameter": {
4780       "fields": {
4781         "Body": [
4782           {
4783             "group": "Body",
4784             "type": "Boolean",
4785             "optional": true,
4786             "field": "closed",
4787             "description": ""
4788           },
4789           {
4790             "group": "Body",
4791             "type": "Integer",
4792             "optional": true,
4793             "field": "ratingValue",
4794             "description": ""
4795           },
4796           {
4797             "group": "Body",
4798             "type": "String",
4799             "allowedValues": [
4800               "\"star\"",
4801               "\"thumb\""
4802             ],
4803             "optional": true,
4804             "field": "ratingType",
4805             "description": ""
4806           },
4807           {
4808             "group": "Body",
4809             "type": "Text",
4810             "optional": true,
4811             "field": "ratingMessage",
4812             "description": ""
4813           },
4814           {
4815             "group": "Body",
4816             "type": "Text",
4817             "optional": true,
4818             "field": "pathTranscript",
4819             "description": ""
4820           },
4821           {
4822             "group": "Body",
4823             "type": "String",
4824             "optional": true,
4825             "field": "mailTranscript",
4826             "description": ""
4827           },
4828           {
4829             "group": "Body",
4830             "type": "String",
4831             "optional": true,
4832             "field": "closedAt",
4833             "description": ""
4834           },
4835           {
4836             "group": "Body",
4837             "type": "String",
4838             "optional": true,
4839             "field": "disposition",
4840             "description": ""
4841           },
4842           {
4843             "group": "Body",
4844             "type": "String",
4845             "optional": true,
4846             "field": "secondDisposition",
4847             "description": ""
4848           },
4849           {
4850             "group": "Body",
4851             "type": "String",
4852             "optional": true,
4853             "field": "thirdDisposition",
4854             "description": ""
4855           },
4856           {
4857             "group": "Body",
4858             "type": "String",
4859             "optional": true,
4860             "field": "note",
4861             "description": ""
4862           },
4863           {
4864             "group": "Body",
4865             "type": "String",
4866             "optional": true,
4867             "field": "browserName",
4868             "description": ""
4869           },
4870           {
4871             "group": "Body",
4872             "type": "String",
4873             "optional": true,
4874             "field": "browserVersion",
4875             "description": ""
4876           },
4877           {
4878             "group": "Body",
4879             "type": "String",
4880             "optional": true,
4881             "field": "osName",
4882             "description": ""
4883           },
4884           {
4885             "group": "Body",
4886             "type": "String",
4887             "optional": true,
4888             "field": "osVersion",
4889             "description": ""
4890           },
4891           {
4892             "group": "Body",
4893             "type": "String",
4894             "optional": true,
4895             "field": "deviceModel",
4896             "description": ""
4897           },
4898           {
4899             "group": "Body",
4900             "type": "String",
4901             "optional": true,
4902             "field": "deviceVendor",
4903             "description": ""
4904           },
4905           {
4906             "group": "Body",
4907             "type": "String",
4908             "optional": true,
4909             "field": "deviceType",
4910             "description": ""
4911           },
4912           {
4913             "group": "Body",
4914             "type": "Text",
4915             "optional": true,
4916             "field": "referer",
4917             "description": ""
4918           },
4919           {
4920             "group": "Body",
4921             "type": "String",
4922             "optional": true,
4923             "field": "customerIp",
4924             "description": ""
4925           },
4926           {
4927             "group": "Body",
4928             "type": "Text",
4929             "optional": true,
4930             "field": "formData",
4931             "description": ""
4932           },
4933           {
4934             "group": "Body",
4935             "type": "String",
4936             "optional": true,
4937             "field": "read1stAt",
4938             "description": ""
4939           },
4940           {
4941             "group": "Body",
4942             "type": "String",
4943             "optional": true,
4944             "field": "lastMsgAt",
4945             "description": ""
4946           },
4947           {
4948             "group": "Body",
4949             "type": "String",
4950             "allowedValues": [
4951               "\"in\"",
4952               "\"out\""
4953             ],
4954             "optional": false,
4955             "field": "lastMsgDirection",
4956             "description": ""
4957           },
4958           {
4959             "group": "Body",
4960             "type": "String",
4961             "optional": true,
4962             "field": "closeReason",
4963             "description": ""
4964           },
4965           {
4966             "group": "Body",
4967             "type": "String",
4968             "optional": true,
4969             "field": "customerPort",
4970             "description": ""
4971           },
4972           {
4973             "group": "Body",
4974             "type": "Text",
4975             "optional": true,
4976             "field": "vidaooSessionId",
4977             "description": ""
4978           }
4979         ]
4980       }
4981     },
4982     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4983     "version": "0.0.0",
4984     "filename": "server/api/chatWebsite/index.js",
4985     "groupTitle": "Chat_Websites"
4986   },
4987   {
4988     "type": "post",
4989     "url": "/api/chat/websites/{id}/logo",
4990     "title": "Add logo",
4991     "examples": [
4992       {
4993         "title": "Example usage:",
4994         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4995         "type": "json"
4996       }
4997     ],
4998     "name": "addLogo",
4999     "group": "Chat_Websites",
5000     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5001     "version": "0.0.0",
5002     "filename": "server/api/chatWebsite/index.js",
5003     "groupTitle": "Chat_Websites"
5004   },
5005   {
5006     "type": "post",
5007     "url": "/api/chat/websites/{id}/proactive_actions",
5008     "title": "Creates new Proactive Actions",
5009     "examples": [
5010       {
5011         "title": "Example usage:",
5012         "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",
5013         "type": "json"
5014       }
5015     ],
5016     "name": "addProactiveActions",
5017     "group": "Chat_Websites",
5018     "parameter": {
5019       "fields": {
5020         "Body": [
5021           {
5022             "group": "Body",
5023             "type": "String",
5024             "optional": false,
5025             "field": "name",
5026             "description": ""
5027           },
5028           {
5029             "group": "Body",
5030             "type": "String",
5031             "allowedValues": [
5032               "\"mouseOver\"",
5033               "\"timeout\""
5034             ],
5035             "optional": true,
5036             "field": "type",
5037             "description": ""
5038           },
5039           {
5040             "group": "Body",
5041             "type": "String",
5042             "optional": true,
5043             "field": "selector",
5044             "description": ""
5045           },
5046           {
5047             "group": "Body",
5048             "type": "Integer",
5049             "optional": true,
5050             "field": "timeout",
5051             "description": ""
5052           }
5053         ]
5054       }
5055     },
5056     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5057     "version": "0.0.0",
5058     "filename": "server/api/chatWebsite/index.js",
5059     "groupTitle": "Chat_Websites"
5060   },
5061   {
5062     "type": "post",
5063     "url": "/api/chat/websites/{id}/system_avatar",
5064     "title": "Add system avatar",
5065     "examples": [
5066       {
5067         "title": "Example usage:",
5068         "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",
5069         "type": "json"
5070       }
5071     ],
5072     "name": "addSystemAvatar",
5073     "group": "Chat_Websites",
5074     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5075     "version": "0.0.0",
5076     "filename": "server/api/chatWebsite/index.js",
5077     "groupTitle": "Chat_Websites"
5078   },
5079   {
5080     "type": "get",
5081     "url": "/api/chat/websites/{id}/canned_answers",
5082     "title": "Gets account canned answers",
5083     "examples": [
5084       {
5085         "title": "Example usage:",
5086         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5087         "type": "json"
5088       }
5089     ],
5090     "name": "getAnswers",
5091     "group": "Chat_Websites",
5092     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5093     "version": "0.0.0",
5094     "filename": "server/api/chatWebsite/index.js",
5095     "groupTitle": "Chat_Websites"
5096   },
5097   {
5098     "type": "get",
5099     "url": "/api/chat/websites/{id}/applications",
5100     "title": "Gets Website Applications",
5101     "examples": [
5102       {
5103         "title": "Example usage:",
5104         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5105         "type": "json"
5106       }
5107     ],
5108     "name": "getApplications",
5109     "group": "Chat_Websites",
5110     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5111     "version": "0.0.0",
5112     "filename": "server/api/chatWebsite/index.js",
5113     "groupTitle": "Chat_Websites"
5114   },
5115   {
5116     "type": "get",
5117     "url": "/api/chat/websites/{id}/avatar",
5118     "title": "Get avatar",
5119     "examples": [
5120       {
5121         "title": "Example usage:",
5122         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5123         "type": "json"
5124       }
5125     ],
5126     "name": "getAvatar",
5127     "group": "Chat_Websites",
5128     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5129     "version": "0.0.0",
5130     "filename": "server/api/chatWebsite/index.js",
5131     "groupTitle": "Chat_Websites"
5132   },
5133   {
5134     "type": "get",
5135     "url": "/api/chat/websites/{id}/customer_avatar",
5136     "title": "Get Customer Avatar",
5137     "examples": [
5138       {
5139         "title": "Example usage:",
5140         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5141         "type": "json"
5142       }
5143     ],
5144     "name": "getCustomerAvatar",
5145     "group": "Chat_Websites",
5146     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5147     "version": "0.0.0",
5148     "filename": "server/api/chatWebsite/index.js",
5149     "groupTitle": "Chat_Websites"
5150   },
5151   {
5152     "type": "get",
5153     "url": "/api/chat/websites/{id}/dispositions",
5154     "title": "Gets account dispositions",
5155     "examples": [
5156       {
5157         "title": "Example usage:",
5158         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5159         "type": "json"
5160       }
5161     ],
5162     "name": "getDispositions",
5163     "group": "Chat_Websites",
5164     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5165     "version": "0.0.0",
5166     "filename": "server/api/chatWebsite/index.js",
5167     "groupTitle": "Chat_Websites"
5168   },
5169   {
5170     "type": "get",
5171     "url": "/api/chat/websites/{id}/fields",
5172     "title": "Gets Website Fields",
5173     "examples": [
5174       {
5175         "title": "Example usage:",
5176         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5177         "type": "json"
5178       }
5179     ],
5180     "name": "getFields",
5181     "group": "Chat_Websites",
5182     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5183     "version": "0.0.0",
5184     "filename": "server/api/chatWebsite/index.js",
5185     "groupTitle": "Chat_Websites"
5186   },
5187   {
5188     "type": "get",
5189     "url": "/api/chat/websites/{id}/interactions",
5190     "title": "Gets Website Interactions",
5191     "examples": [
5192       {
5193         "title": "Example usage:",
5194         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5195         "type": "json"
5196       }
5197     ],
5198     "name": "getInteraction",
5199     "group": "Chat_Websites",
5200     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5201     "version": "0.0.0",
5202     "filename": "server/api/chatWebsite/index.js",
5203     "groupTitle": "Chat_Websites"
5204   },
5205   {
5206     "type": "get",
5207     "url": "/api/chat/websites/{id}/logo",
5208     "title": "Get logo",
5209     "examples": [
5210       {
5211         "title": "Example usage:",
5212         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5213         "type": "json"
5214       }
5215     ],
5216     "name": "getLogo",
5217     "group": "Chat_Websites",
5218     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5219     "version": "0.0.0",
5220     "filename": "server/api/chatWebsite/index.js",
5221     "groupTitle": "Chat_Websites"
5222   },
5223   {
5224     "type": "get",
5225     "url": "/api/chat/websites/{id}/offline_messages",
5226     "title": "Gets Website Offline Messages",
5227     "examples": [
5228       {
5229         "title": "Example usage:",
5230         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5231         "type": "json"
5232       }
5233     ],
5234     "name": "getOfflineMessages",
5235     "group": "Chat_Websites",
5236     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5237     "version": "0.0.0",
5238     "filename": "server/api/chatWebsite/index.js",
5239     "groupTitle": "Chat_Websites"
5240   },
5241   {
5242     "type": "get",
5243     "url": "/api/chat/websites/{id}/proactive_actions",
5244     "title": "Gets Website Proactive Actions",
5245     "examples": [
5246       {
5247         "title": "Example usage:",
5248         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5249         "type": "json"
5250       }
5251     ],
5252     "name": "getProactiveActions",
5253     "group": "Chat_Websites",
5254     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5255     "version": "0.0.0",
5256     "filename": "server/api/chatWebsite/index.js",
5257     "groupTitle": "Chat_Websites"
5258   },
5259   {
5260     "type": "get",
5261     "url": "/api/chat/websites/{id}/snippet",
5262     "title": "Gets Website Snippet",
5263     "examples": [
5264       {
5265         "title": "Example usage:",
5266         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5267         "type": "json"
5268       }
5269     ],
5270     "name": "getSnippet",
5271     "group": "Chat_Websites",
5272     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5273     "version": "0.0.0",
5274     "filename": "server/api/chatWebsite/index.js",
5275     "groupTitle": "Chat_Websites"
5276   },
5277   {
5278     "type": "get",
5279     "url": "/api/chat/websites/{id}/system_avatar",
5280     "title": "Get System Avatar",
5281     "examples": [
5282       {
5283         "title": "Example usage:",
5284         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5285         "type": "json"
5286       }
5287     ],
5288     "name": "getSystemAvatar",
5289     "group": "Chat_Websites",
5290     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5291     "version": "0.0.0",
5292     "filename": "server/api/chatWebsite/index.js",
5293     "groupTitle": "Chat_Websites"
5294   },
5295   {
5296     "type": "post",
5297     "url": "/api/chat/websites/{id}/notify",
5298     "title": "Notify new message",
5299     "examples": [
5300       {
5301         "title": "Example usage:",
5302         "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",
5303         "type": "json"
5304       }
5305     ],
5306     "name": "notify",
5307     "group": "Chat_Websites",
5308     "description": "<p>Motion 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>",
5309     "version": "0.0.0",
5310     "filename": "server/api/chatWebsite/index.js",
5311     "groupTitle": "Chat_Websites"
5312   },
5313   {
5314     "type": "post",
5315     "url": "/api/chat/websites/{id}/offline",
5316     "title": "Offline message",
5317     "examples": [
5318       {
5319         "title": "Example usage:",
5320         "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",
5321         "type": "json"
5322       }
5323     ],
5324     "name": "offline",
5325     "group": "Chat_Websites",
5326     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5327     "version": "0.0.0",
5328     "filename": "server/api/chatWebsite/index.js",
5329     "groupTitle": "Chat_Websites"
5330   },
5331   {
5332     "type": "put",
5333     "url": "/api/chat/messages/{id}/reject",
5334     "title": "Rejects message",
5335     "examples": [
5336       {
5337         "title": "Example usage:",
5338         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5339         "type": "json"
5340       }
5341     ],
5342     "name": "rejectMessage",
5343     "group": "Chat_Websites",
5344     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5345     "version": "0.0.0",
5346     "filename": "server/api/chatMessage/index.js",
5347     "groupTitle": "Chat_Websites"
5348   },
5349   {
5350     "type": "put",
5351     "url": "/api/chat/websites/{id}",
5352     "title": "Update an existing Website",
5353     "examples": [
5354       {
5355         "title": "Example usage:",
5356         "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",
5357         "type": "json"
5358       }
5359     ],
5360     "name": "updateWebsites",
5361     "group": "Chat_Websites",
5362     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5363     "version": "0.0.0",
5364     "filename": "server/api/chatWebsite/index.js",
5365     "groupTitle": "Chat_Websites"
5366   },
5367   {
5368     "type": "post",
5369     "url": "/api/cloudProviders",
5370     "title": "Creates a new CloudProvider",
5371     "examples": [
5372       {
5373         "title": "Example usage:",
5374         "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5375         "type": "json"
5376       }
5377     ],
5378     "name": "CreateCloudProviders",
5379     "group": "CloudProviders",
5380     "parameter": {
5381       "fields": {
5382         "Body": [
5383           {
5384             "group": "Body",
5385             "type": "String",
5386             "optional": false,
5387             "field": "name",
5388             "description": ""
5389           },
5390           {
5391             "group": "Body",
5392             "type": "String",
5393             "allowedValues": [
5394               "\"AmazonAWS\"",
5395               "\"Google\""
5396             ],
5397             "optional": false,
5398             "field": "service",
5399             "description": ""
5400           },
5401           {
5402             "group": "Body",
5403             "type": "String",
5404             "optional": true,
5405             "field": "data1",
5406             "description": ""
5407           },
5408           {
5409             "group": "Body",
5410             "type": "String",
5411             "optional": true,
5412             "field": "data2",
5413             "description": ""
5414           }
5415         ]
5416       }
5417     },
5418     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5419     "version": "0.0.0",
5420     "filename": "server/api/cloudProvider/index.js",
5421     "groupTitle": "CloudProviders"
5422   },
5423   {
5424     "type": "delete",
5425     "url": "/api/cloudProviders/{id}",
5426     "title": "Deletes a CloudProvider",
5427     "examples": [
5428       {
5429         "title": "Example usage:",
5430         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5431         "type": "json"
5432       }
5433     ],
5434     "name": "DeleteCloudProviders",
5435     "group": "CloudProviders",
5436     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5437     "version": "0.0.0",
5438     "filename": "server/api/cloudProvider/index.js",
5439     "groupTitle": "CloudProviders"
5440   },
5441   {
5442     "type": "get",
5443     "url": "/api/cloudProviders",
5444     "title": "Gets a list of CloudProviders",
5445     "examples": [
5446       {
5447         "title": "Example usage:",
5448         "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5449         "type": "json"
5450       }
5451     ],
5452     "name": "GetCloudProviders",
5453     "group": "CloudProviders",
5454     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5455     "version": "0.0.0",
5456     "filename": "server/api/cloudProvider/index.js",
5457     "groupTitle": "CloudProviders"
5458   },
5459   {
5460     "type": "get",
5461     "url": "/api/cloudProviders/{id}",
5462     "title": "Gets a single CloudProvider",
5463     "examples": [
5464       {
5465         "title": "Example usage:",
5466         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5467         "type": "json"
5468       }
5469     ],
5470     "name": "ShowCloudProviders",
5471     "group": "CloudProviders",
5472     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5473     "version": "0.0.0",
5474     "filename": "server/api/cloudProvider/index.js",
5475     "groupTitle": "CloudProviders"
5476   },
5477   {
5478     "type": "put",
5479     "url": "/api/cloudProviders/{id}",
5480     "title": "Update an existing CloudProvider",
5481     "examples": [
5482       {
5483         "title": "Example usage:",
5484         "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5485         "type": "json"
5486       }
5487     ],
5488     "name": "updateCloudProviders",
5489     "group": "CloudProviders",
5490     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5491     "version": "0.0.0",
5492     "filename": "server/api/cloudProvider/index.js",
5493     "groupTitle": "CloudProviders"
5494   },
5495   {
5496     "type": "post",
5497     "url": "/api/cm/companies",
5498     "title": "Creates a new Company",
5499     "examples": [
5500       {
5501         "title": "Example usage:",
5502         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5503         "type": "json"
5504       }
5505     ],
5506     "name": "CreateCompanies",
5507     "group": "Cm_Companies",
5508     "parameter": {
5509       "fields": {
5510         "Body": [
5511           {
5512             "group": "Body",
5513             "type": "String",
5514             "optional": false,
5515             "field": "name",
5516             "description": ""
5517           },
5518           {
5519             "group": "Body",
5520             "type": "String",
5521             "optional": true,
5522             "field": "vat",
5523             "description": ""
5524           },
5525           {
5526             "group": "Body",
5527             "type": "String",
5528             "optional": true,
5529             "field": "companyId",
5530             "description": ""
5531           },
5532           {
5533             "group": "Body",
5534             "type": "String",
5535             "optional": true,
5536             "field": "website",
5537             "description": ""
5538           },
5539           {
5540             "group": "Body",
5541             "type": "String",
5542             "optional": true,
5543             "field": "phone",
5544             "description": ""
5545           },
5546           {
5547             "group": "Body",
5548             "type": "String",
5549             "optional": true,
5550             "field": "fax",
5551             "description": ""
5552           },
5553           {
5554             "group": "Body",
5555             "type": "String",
5556             "optional": true,
5557             "field": "type",
5558             "description": ""
5559           },
5560           {
5561             "group": "Body",
5562             "type": "String",
5563             "optional": true,
5564             "field": "street",
5565             "description": ""
5566           },
5567           {
5568             "group": "Body",
5569             "type": "String",
5570             "optional": true,
5571             "field": "postalCode",
5572             "description": ""
5573           },
5574           {
5575             "group": "Body",
5576             "type": "String",
5577             "optional": true,
5578             "field": "city",
5579             "description": ""
5580           },
5581           {
5582             "group": "Body",
5583             "type": "String",
5584             "optional": true,
5585             "field": "country",
5586             "description": ""
5587           },
5588           {
5589             "group": "Body",
5590             "type": "String",
5591             "optional": true,
5592             "field": "email",
5593             "description": ""
5594           },
5595           {
5596             "group": "Body",
5597             "type": "String",
5598             "optional": true,
5599             "field": "emailDomain",
5600             "description": ""
5601           },
5602           {
5603             "group": "Body",
5604             "type": "String",
5605             "optional": true,
5606             "field": "sStreet",
5607             "description": ""
5608           },
5609           {
5610             "group": "Body",
5611             "type": "String",
5612             "optional": true,
5613             "field": "sPostalCode",
5614             "description": ""
5615           },
5616           {
5617             "group": "Body",
5618             "type": "String",
5619             "optional": true,
5620             "field": "sCity",
5621             "description": ""
5622           },
5623           {
5624             "group": "Body",
5625             "type": "String",
5626             "optional": true,
5627             "field": "sCountry",
5628             "description": ""
5629           },
5630           {
5631             "group": "Body",
5632             "type": "String",
5633             "optional": true,
5634             "field": "description",
5635             "description": ""
5636           }
5637         ]
5638       }
5639     },
5640     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5641     "version": "0.0.0",
5642     "filename": "server/api/cmCompany/index.js",
5643     "groupTitle": "Cm_Companies"
5644   },
5645   {
5646     "type": "delete",
5647     "url": "/api/cm/companies/{id}",
5648     "title": "Deletes a Company",
5649     "examples": [
5650       {
5651         "title": "Example usage:",
5652         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5653         "type": "json"
5654       }
5655     ],
5656     "name": "DeleteCompanies",
5657     "group": "Cm_Companies",
5658     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5659     "version": "0.0.0",
5660     "filename": "server/api/cmCompany/index.js",
5661     "groupTitle": "Cm_Companies"
5662   },
5663   {
5664     "type": "get",
5665     "url": "/api/cm/companies/describe",
5666     "title": "Gets table info about Companies",
5667     "examples": [
5668       {
5669         "title": "Example usage:",
5670         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5671         "type": "json"
5672       }
5673     ],
5674     "name": "DescribeCompanies",
5675     "group": "Cm_Companies",
5676     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5677     "version": "0.0.0",
5678     "filename": "server/api/cmCompany/index.js",
5679     "groupTitle": "Cm_Companies"
5680   },
5681   {
5682     "type": "get",
5683     "url": "/api/cm/companies",
5684     "title": "Gets a list of Companies",
5685     "examples": [
5686       {
5687         "title": "Example usage:",
5688         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5689         "type": "json"
5690       }
5691     ],
5692     "name": "GetCompanies",
5693     "group": "Cm_Companies",
5694     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5695     "version": "0.0.0",
5696     "filename": "server/api/cmCompany/index.js",
5697     "groupTitle": "Cm_Companies"
5698   },
5699   {
5700     "type": "get",
5701     "url": "/api/cm/companies/{id}",
5702     "title": "Gets a single Company",
5703     "examples": [
5704       {
5705         "title": "Example usage:",
5706         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5707         "type": "json"
5708       }
5709     ],
5710     "name": "ShowCompanies",
5711     "group": "Cm_Companies",
5712     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5713     "version": "0.0.0",
5714     "filename": "server/api/cmCompany/index.js",
5715     "groupTitle": "Cm_Companies"
5716   },
5717   {
5718     "type": "post",
5719     "url": "/api/cm/companies/{id}/contacts",
5720     "title": "Creates new contacts",
5721     "examples": [
5722       {
5723         "title": "Example usage:",
5724         "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",
5725         "type": "json"
5726       }
5727     ],
5728     "name": "addContacts",
5729     "group": "Cm_Companies",
5730     "parameter": {
5731       "fields": {
5732         "Body": [
5733           {
5734             "group": "Body",
5735             "type": "String",
5736             "optional": false,
5737             "field": "firstName",
5738             "description": ""
5739           },
5740           {
5741             "group": "Body",
5742             "type": "String",
5743             "optional": true,
5744             "field": "lastName",
5745             "description": ""
5746           },
5747           {
5748             "group": "Body",
5749             "type": "String",
5750             "optional": true,
5751             "field": "street",
5752             "description": ""
5753           },
5754           {
5755             "group": "Body",
5756             "type": "String",
5757             "optional": true,
5758             "field": "postalCode",
5759             "description": ""
5760           },
5761           {
5762             "group": "Body",
5763             "type": "String",
5764             "optional": true,
5765             "field": "city",
5766             "description": ""
5767           },
5768           {
5769             "group": "Body",
5770             "type": "String",
5771             "optional": true,
5772             "field": "country",
5773             "description": ""
5774           },
5775           {
5776             "group": "Body",
5777             "type": "String",
5778             "optional": true,
5779             "field": "dateOfBirth",
5780             "description": ""
5781           },
5782           {
5783             "group": "Body",
5784             "type": "Text",
5785             "optional": true,
5786             "field": "description",
5787             "description": ""
5788           },
5789           {
5790             "group": "Body",
5791             "type": "String",
5792             "optional": true,
5793             "field": "phone",
5794             "description": ""
5795           },
5796           {
5797             "group": "Body",
5798             "type": "String",
5799             "optional": true,
5800             "field": "mobile",
5801             "description": ""
5802           },
5803           {
5804             "group": "Body",
5805             "type": "String",
5806             "optional": true,
5807             "field": "fax",
5808             "description": ""
5809           },
5810           {
5811             "group": "Body",
5812             "type": "String",
5813             "optional": true,
5814             "field": "email",
5815             "description": ""
5816           },
5817           {
5818             "group": "Body",
5819             "type": "String",
5820             "optional": true,
5821             "field": "url",
5822             "description": ""
5823           },
5824           {
5825             "group": "Body",
5826             "type": "String",
5827             "optional": true,
5828             "field": "facebook",
5829             "description": ""
5830           },
5831           {
5832             "group": "Body",
5833             "type": "String",
5834             "optional": true,
5835             "field": "fb_data",
5836             "description": ""
5837           },
5838           {
5839             "group": "Body",
5840             "type": "String",
5841             "optional": true,
5842             "field": "twitter",
5843             "description": ""
5844           },
5845           {
5846             "group": "Body",
5847             "type": "String",
5848             "optional": true,
5849             "field": "skype",
5850             "description": ""
5851           },
5852           {
5853             "group": "Body",
5854             "type": "String",
5855             "optional": true,
5856             "field": "teams",
5857             "description": ""
5858           },
5859           {
5860             "group": "Body",
5861             "type": "String",
5862             "optional": true,
5863             "field": "viber",
5864             "description": ""
5865           },
5866           {
5867             "group": "Body",
5868             "type": "String",
5869             "optional": true,
5870             "field": "line",
5871             "description": ""
5872           },
5873           {
5874             "group": "Body",
5875             "type": "String",
5876             "optional": true,
5877             "field": "wechat",
5878             "description": ""
5879           },
5880           {
5881             "group": "Body",
5882             "type": "String",
5883             "optional": true,
5884             "field": "telegram",
5885             "description": ""
5886           },
5887           {
5888             "group": "Body",
5889             "type": "Integer",
5890             "optional": true,
5891             "field": "UserId",
5892             "description": ""
5893           },
5894           {
5895             "group": "Body",
5896             "type": "Integer",
5897             "optional": true,
5898             "field": "priority",
5899             "description": ""
5900           },
5901           {
5902             "group": "Body",
5903             "type": "String",
5904             "optional": true,
5905             "field": "scheduledat",
5906             "description": ""
5907           }
5908         ]
5909       }
5910     },
5911     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5912     "version": "0.0.0",
5913     "filename": "server/api/cmCompany/index.js",
5914     "groupTitle": "Cm_Companies"
5915   },
5916   {
5917     "type": "get",
5918     "url": "/api/cm/companies/{id}/contacts",
5919     "title": "Gets List Contacts",
5920     "examples": [
5921       {
5922         "title": "Example usage:",
5923         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5924         "type": "json"
5925       }
5926     ],
5927     "name": "getContacts",
5928     "group": "Cm_Companies",
5929     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5930     "version": "0.0.0",
5931     "filename": "server/api/cmCompany/index.js",
5932     "groupTitle": "Cm_Companies"
5933   },
5934   {
5935     "type": "put",
5936     "url": "/api/cm/companies/{id}",
5937     "title": "Update an existing Company",
5938     "examples": [
5939       {
5940         "title": "Example usage:",
5941         "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",
5942         "type": "json"
5943       }
5944     ],
5945     "name": "updateCompanies",
5946     "group": "Cm_Companies",
5947     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5948     "version": "0.0.0",
5949     "filename": "server/api/cmCompany/index.js",
5950     "groupTitle": "Cm_Companies"
5951   },
5952   {
5953     "type": "delete",
5954     "url": "/api/cm/contacts/{id}",
5955     "title": "Deletes a Contact",
5956     "examples": [
5957       {
5958         "title": "Example usage:",
5959         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5960         "type": "json"
5961       }
5962     ],
5963     "name": "DeleteContacts",
5964     "group": "Cm_Contacts",
5965     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5966     "version": "0.0.0",
5967     "filename": "server/api/cmContact/index.js",
5968     "groupTitle": "Cm_Contacts"
5969   },
5970   {
5971     "type": "get",
5972     "url": "/api/cm/contacts/describe",
5973     "title": "Gets table info about Contacts",
5974     "examples": [
5975       {
5976         "title": "Example usage:",
5977         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
5978         "type": "json"
5979       }
5980     ],
5981     "name": "DescribeContacts",
5982     "group": "Cm_Contacts",
5983     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5984     "version": "0.0.0",
5985     "filename": "server/api/cmContact/index.js",
5986     "groupTitle": "Cm_Contacts"
5987   },
5988   {
5989     "type": "get",
5990     "url": "/api/cm/contacts",
5991     "title": "Gets a list of Contacts",
5992     "examples": [
5993       {
5994         "title": "Example usage:",
5995         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
5996         "type": "json"
5997       }
5998     ],
5999     "name": "GetContacts",
6000     "group": "Cm_Contacts",
6001     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6002     "version": "0.0.0",
6003     "filename": "server/api/cmContact/index.js",
6004     "groupTitle": "Cm_Contacts"
6005   },
6006   {
6007     "type": "get",
6008     "url": "/api/cm/contacts/{id}/finals",
6009     "title": "Gets contact hopper finals",
6010     "examples": [
6011       {
6012         "title": "Example usage:",
6013         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
6014         "type": "json"
6015       }
6016     ],
6017     "name": "GetHopperFinals",
6018     "group": "Cm_Contacts",
6019     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6020     "version": "0.0.0",
6021     "filename": "server/api/cmContact/index.js",
6022     "groupTitle": "Cm_Contacts"
6023   },
6024   {
6025     "type": "get",
6026     "url": "/api/cm/contacts/{id}/hopper_histories",
6027     "title": "Gets contact hopper histories",
6028     "examples": [
6029       {
6030         "title": "Example usage:",
6031         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6032         "type": "json"
6033       }
6034     ],
6035     "name": "GetHopperHistories",
6036     "group": "Cm_Contacts",
6037     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6038     "version": "0.0.0",
6039     "filename": "server/api/cmContact/index.js",
6040     "groupTitle": "Cm_Contacts"
6041   },
6042   {
6043     "type": "get",
6044     "url": "/api/cm/contacts/{id}/hoppers",
6045     "title": "Gets contact hoppers",
6046     "examples": [
6047       {
6048         "title": "Example usage:",
6049         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6050         "type": "json"
6051       }
6052     ],
6053     "name": "GetHoppers",
6054     "group": "Cm_Contacts",
6055     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6056     "version": "0.0.0",
6057     "filename": "server/api/cmContact/index.js",
6058     "groupTitle": "Cm_Contacts"
6059   },
6060   {
6061     "type": "post",
6062     "url": "/api/cm/contacts/create_many",
6063     "title": "Create Contacts",
6064     "examples": [
6065       {
6066         "title": "Example usage:",
6067         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6068         "type": "json"
6069       }
6070     ],
6071     "name": "bulkCreate",
6072     "group": "Cm_Contacts",
6073     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6074     "version": "0.0.0",
6075     "filename": "server/api/cmContact/index.js",
6076     "groupTitle": "Cm_Contacts"
6077   },
6078   {
6079     "type": "post",
6080     "url": "/api/cm/contacts",
6081     "title": "Create Contact",
6082     "examples": [
6083       {
6084         "title": "Example usage:",
6085         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6086         "type": "json"
6087       }
6088     ],
6089     "name": "create",
6090     "group": "Cm_Contacts",
6091     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6092     "version": "0.0.0",
6093     "filename": "server/api/cmContact/index.js",
6094     "groupTitle": "Cm_Contacts"
6095   },
6096   {
6097     "type": "get",
6098     "url": "/api/cm/contacts/{id}/journey",
6099     "title": "Gets customer journey",
6100     "examples": [
6101       {
6102         "title": "Example usage:",
6103         "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password}  -X GET",
6104         "type": "json"
6105       }
6106     ],
6107     "name": "getJourney",
6108     "group": "Cm_Contacts",
6109     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6110     "version": "0.0.0",
6111     "filename": "server/api/cmContact/index.js",
6112     "groupTitle": "Cm_Contacts"
6113   },
6114   {
6115     "type": "get",
6116     "url": "/api/cm/contacts/{id}/jscripty_sessions",
6117     "title": "Gets contact hopper blacks",
6118     "examples": [
6119       {
6120         "title": "Example usage:",
6121         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
6122         "type": "json"
6123       }
6124     ],
6125     "name": "getJscriptySessions",
6126     "group": "Cm_Contacts",
6127     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6128     "version": "0.0.0",
6129     "filename": "server/api/cmContact/index.js",
6130     "groupTitle": "Cm_Contacts"
6131   },
6132   {
6133     "type": "get",
6134     "url": "/api/cm/contacts/{id}/tags",
6135     "title": "Gets configurations tags",
6136     "examples": [
6137       {
6138         "title": "Example usage:",
6139         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6140         "type": "json"
6141       }
6142     ],
6143     "name": "getTags",
6144     "group": "Cm_Contacts",
6145     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6146     "version": "0.0.0",
6147     "filename": "server/api/cmContact/index.js",
6148     "groupTitle": "Cm_Contacts"
6149   },
6150   {
6151     "type": "post",
6152     "url": "/api/cm/contacts/merge",
6153     "title": "Merge Contact",
6154     "examples": [
6155       {
6156         "title": "Example usage:",
6157         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6158         "type": "json"
6159       }
6160     ],
6161     "name": "merge",
6162     "group": "Cm_Contacts",
6163     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6164     "version": "0.0.0",
6165     "filename": "server/api/cmContact/index.js",
6166     "groupTitle": "Cm_Contacts"
6167   },
6168   {
6169     "type": "post",
6170     "url": "/api/cm/contacts/{id}/tags",
6171     "title": "Sets new tags",
6172     "examples": [
6173       {
6174         "title": "Example usage:",
6175         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6176         "type": "json"
6177       }
6178     ],
6179     "name": "setTags",
6180     "group": "Cm_Contacts",
6181     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6182     "version": "0.0.0",
6183     "filename": "server/api/cmContact/index.js",
6184     "groupTitle": "Cm_Contacts"
6185   },
6186   {
6187     "type": "get",
6188     "url": "/api/cm/contacts/{id}",
6189     "title": "Gets a single Contact",
6190     "examples": [
6191       {
6192         "title": "Example usage:",
6193         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6194         "type": "json"
6195       }
6196     ],
6197     "name": "show",
6198     "group": "Cm_Contacts",
6199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6200     "version": "0.0.0",
6201     "filename": "server/api/cmContact/index.js",
6202     "groupTitle": "Cm_Contacts"
6203   },
6204   {
6205     "type": "put",
6206     "url": "/api/cm/contacts/{id}",
6207     "title": "Update a single Contact",
6208     "examples": [
6209       {
6210         "title": "Example usage:",
6211         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6212         "type": "json"
6213       }
6214     ],
6215     "name": "update",
6216     "group": "Cm_Contacts",
6217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6218     "version": "0.0.0",
6219     "filename": "server/api/cmContact/index.js",
6220     "groupTitle": "Cm_Contacts"
6221   },
6222   {
6223     "type": "delete",
6224     "url": "/api/cm/custom_fields/{id}",
6225     "title": "Deletes a Custom Field",
6226     "examples": [
6227       {
6228         "title": "Example usage:",
6229         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6230         "type": "json"
6231       }
6232     ],
6233     "name": "DeleteCustom_Fields",
6234     "group": "Cm_Custom_Fields",
6235     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6236     "version": "0.0.0",
6237     "filename": "server/api/cmCustomField/index.js",
6238     "groupTitle": "Cm_Custom_Fields"
6239   },
6240   {
6241     "type": "get",
6242     "url": "/api/cm/custom_fields",
6243     "title": "Gets a list of Custom Fields",
6244     "examples": [
6245       {
6246         "title": "Example usage:",
6247         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6248         "type": "json"
6249       }
6250     ],
6251     "name": "GetCustom_Fields",
6252     "group": "Cm_Custom_Fields",
6253     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6254     "version": "0.0.0",
6255     "filename": "server/api/cmCustomField/index.js",
6256     "groupTitle": "Cm_Custom_Fields"
6257   },
6258   {
6259     "type": "get",
6260     "url": "/api/cm/custom_fields/{id}",
6261     "title": "Gets a single Custom Field",
6262     "examples": [
6263       {
6264         "title": "Example usage:",
6265         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6266         "type": "json"
6267       }
6268     ],
6269     "name": "ShowCustom_Fields",
6270     "group": "Cm_Custom_Fields",
6271     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6272     "version": "0.0.0",
6273     "filename": "server/api/cmCustomField/index.js",
6274     "groupTitle": "Cm_Custom_Fields"
6275   },
6276   {
6277     "type": "put",
6278     "url": "/api/cm/custom_fields/{id}",
6279     "title": "Update an existing Custom Field",
6280     "examples": [
6281       {
6282         "title": "Example usage:",
6283         "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",
6284         "type": "json"
6285       }
6286     ],
6287     "name": "updateCustom_Fields",
6288     "group": "Cm_Custom_Fields",
6289     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6290     "version": "0.0.0",
6291     "filename": "server/api/cmCustomField/index.js",
6292     "groupTitle": "Cm_Custom_Fields"
6293   },
6294   {
6295     "type": "post",
6296     "url": "/api/cm/hopper",
6297     "title": "Creates a new Hopper",
6298     "examples": [
6299       {
6300         "title": "Example usage:",
6301         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6302         "type": "json"
6303       }
6304     ],
6305     "name": "CreateHopper",
6306     "group": "Cm_Hopper",
6307     "parameter": {
6308       "fields": {
6309         "Body": [
6310           {
6311             "group": "Body",
6312             "type": "String",
6313             "optional": false,
6314             "field": "phone",
6315             "description": ""
6316           },
6317           {
6318             "group": "Body",
6319             "type": "Boolean",
6320             "optional": true,
6321             "field": "active",
6322             "description": ""
6323           },
6324           {
6325             "group": "Body",
6326             "type": "String",
6327             "optional": true,
6328             "field": "scheduledat",
6329             "description": ""
6330           },
6331           {
6332             "group": "Body",
6333             "type": "Integer",
6334             "optional": true,
6335             "field": "countbusyretry",
6336             "description": ""
6337           },
6338           {
6339             "group": "Body",
6340             "type": "Integer",
6341             "optional": true,
6342             "field": "countcongestionretry",
6343             "description": ""
6344           },
6345           {
6346             "group": "Body",
6347             "type": "Integer",
6348             "optional": true,
6349             "field": "countnoanswerretry",
6350             "description": ""
6351           },
6352           {
6353             "group": "Body",
6354             "type": "Boolean",
6355             "optional": true,
6356             "field": "callback",
6357             "description": ""
6358           },
6359           {
6360             "group": "Body",
6361             "type": "String",
6362             "optional": true,
6363             "field": "callbackuniqueid",
6364             "description": ""
6365           },
6366           {
6367             "group": "Body",
6368             "type": "String",
6369             "optional": true,
6370             "field": "callbackat",
6371             "description": ""
6372           },
6373           {
6374             "group": "Body",
6375             "type": "Integer",
6376             "optional": true,
6377             "field": "priority",
6378             "description": ""
6379           },
6380           {
6381             "group": "Body",
6382             "type": "Boolean",
6383             "optional": true,
6384             "field": "recallme",
6385             "description": ""
6386           },
6387           {
6388             "group": "Body",
6389             "type": "Integer",
6390             "optional": true,
6391             "field": "ContactId",
6392             "description": ""
6393           },
6394           {
6395             "group": "Body",
6396             "type": "Integer",
6397             "optional": true,
6398             "field": "ListId",
6399             "description": ""
6400           },
6401           {
6402             "group": "Body",
6403             "type": "Integer",
6404             "optional": true,
6405             "field": "UserId",
6406             "description": ""
6407           },
6408           {
6409             "group": "Body",
6410             "type": "Integer",
6411             "optional": true,
6412             "field": "VoiceQueueId",
6413             "description": ""
6414           },
6415           {
6416             "group": "Body",
6417             "type": "Integer",
6418             "optional": true,
6419             "field": "CampaignId",
6420             "description": ""
6421           },
6422           {
6423             "group": "Body",
6424             "type": "Integer",
6425             "optional": true,
6426             "field": "countnosuchnumberretry",
6427             "description": ""
6428           },
6429           {
6430             "group": "Body",
6431             "type": "Integer",
6432             "optional": true,
6433             "field": "countdropretry",
6434             "description": ""
6435           },
6436           {
6437             "group": "Body",
6438             "type": "Integer",
6439             "optional": true,
6440             "field": "countabandonedretry",
6441             "description": ""
6442           },
6443           {
6444             "group": "Body",
6445             "type": "Integer",
6446             "optional": true,
6447             "field": "countmachineretry",
6448             "description": ""
6449           },
6450           {
6451             "group": "Body",
6452             "type": "Integer",
6453             "optional": true,
6454             "field": "countagentrejectretry",
6455             "description": ""
6456           }
6457         ]
6458       }
6459     },
6460     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6461     "version": "0.0.0",
6462     "filename": "server/api/cmHopper/index.js",
6463     "groupTitle": "Cm_Hopper"
6464   },
6465   {
6466     "type": "get",
6467     "url": "/api/cm/hopper/describe",
6468     "title": "Gets table info about Hopper",
6469     "examples": [
6470       {
6471         "title": "Example usage:",
6472         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6473         "type": "json"
6474       }
6475     ],
6476     "name": "DescribeHopper",
6477     "group": "Cm_Hopper",
6478     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6479     "version": "0.0.0",
6480     "filename": "server/api/cmHopper/index.js",
6481     "groupTitle": "Cm_Hopper"
6482   },
6483   {
6484     "type": "get",
6485     "url": "/api/cm/hopper",
6486     "title": "Gets a list of Hopper",
6487     "examples": [
6488       {
6489         "title": "Example usage:",
6490         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6491         "type": "json"
6492       }
6493     ],
6494     "name": "GetHopper",
6495     "group": "Cm_Hopper",
6496     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6497     "version": "0.0.0",
6498     "filename": "server/api/cmHopper/index.js",
6499     "groupTitle": "Cm_Hopper"
6500   },
6501   {
6502     "type": "get",
6503     "url": "/api/cm/hopper/{id}",
6504     "title": "Gets a single Hopper",
6505     "examples": [
6506       {
6507         "title": "Example usage:",
6508         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6509         "type": "json"
6510       }
6511     ],
6512     "name": "ShowHopper",
6513     "group": "Cm_Hopper",
6514     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6515     "version": "0.0.0",
6516     "filename": "server/api/cmHopper/index.js",
6517     "groupTitle": "Cm_Hopper"
6518   },
6519   {
6520     "type": "delete",
6521     "url": "/api/cm/hopper_black/{id}",
6522     "title": "Deletes a Hopper Black",
6523     "examples": [
6524       {
6525         "title": "Example usage:",
6526         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6527         "type": "json"
6528       }
6529     ],
6530     "name": "DeleteHopper_Black",
6531     "group": "Cm_Hopper_Black",
6532     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6533     "version": "0.0.0",
6534     "filename": "server/api/cmHopperBlack/index.js",
6535     "groupTitle": "Cm_Hopper_Black"
6536   },
6537   {
6538     "type": "get",
6539     "url": "/api/cm/hopper_black/describe",
6540     "title": "Gets table info about Hopper Black",
6541     "examples": [
6542       {
6543         "title": "Example usage:",
6544         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6545         "type": "json"
6546       }
6547     ],
6548     "name": "DescribeHopper_Black",
6549     "group": "Cm_Hopper_Black",
6550     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6551     "version": "0.0.0",
6552     "filename": "server/api/cmHopperBlack/index.js",
6553     "groupTitle": "Cm_Hopper_Black"
6554   },
6555   {
6556     "type": "get",
6557     "url": "/api/cm/hopper_black",
6558     "title": "Gets a list of Hopper Black",
6559     "examples": [
6560       {
6561         "title": "Example usage:",
6562         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6563         "type": "json"
6564       }
6565     ],
6566     "name": "GetHopper_Black",
6567     "group": "Cm_Hopper_Black",
6568     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6569     "version": "0.0.0",
6570     "filename": "server/api/cmHopperBlack/index.js",
6571     "groupTitle": "Cm_Hopper_Black"
6572   },
6573   {
6574     "type": "get",
6575     "url": "/api/cm/hopper_black/{id}",
6576     "title": "Gets a single Hopper Black",
6577     "examples": [
6578       {
6579         "title": "Example usage:",
6580         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6581         "type": "json"
6582       }
6583     ],
6584     "name": "ShowHopper_Black",
6585     "group": "Cm_Hopper_Black",
6586     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6587     "version": "0.0.0",
6588     "filename": "server/api/cmHopperBlack/index.js",
6589     "groupTitle": "Cm_Hopper_Black"
6590   },
6591   {
6592     "type": "put",
6593     "url": "/api/cm/hopper_black/{id}",
6594     "title": "Update an existing Hopper Black",
6595     "examples": [
6596       {
6597         "title": "Example usage:",
6598         "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",
6599         "type": "json"
6600       }
6601     ],
6602     "name": "updateHopper_Black",
6603     "group": "Cm_Hopper_Black",
6604     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6605     "version": "0.0.0",
6606     "filename": "server/api/cmHopperBlack/index.js",
6607     "groupTitle": "Cm_Hopper_Black"
6608   },
6609   {
6610     "type": "post",
6611     "url": "/api/cm/hopper_final/checkContactHopper",
6612     "title": "Check if contact is in hopper",
6613     "examples": [
6614       {
6615         "title": "Example usage:",
6616         "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",
6617         "type": "json"
6618       }
6619     ],
6620     "name": "/checkContactHopper",
6621     "group": "Cm_Hopper_Final",
6622     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6623     "version": "0.0.0",
6624     "filename": "server/api/cmHopperFinal/index.js",
6625     "groupTitle": "Cm_Hopper_Final"
6626   },
6627   {
6628     "type": "get",
6629     "url": "/api/cm/hopper_final/describe",
6630     "title": "Gets table info about HopperFinal",
6631     "examples": [
6632       {
6633         "title": "Example usage:",
6634         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6635         "type": "json"
6636       }
6637     ],
6638     "name": "DescribeHopperFinal",
6639     "group": "Cm_Hopper_Final",
6640     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6641     "version": "0.0.0",
6642     "filename": "server/api/cmHopperFinal/index.js",
6643     "groupTitle": "Cm_Hopper_Final"
6644   },
6645   {
6646     "type": "get",
6647     "url": "/api/cm/hopper_final",
6648     "title": "Gets a list of HopperFinal",
6649     "examples": [
6650       {
6651         "title": "Example usage:",
6652         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6653         "type": "json"
6654       }
6655     ],
6656     "name": "GetHopperFinal",
6657     "group": "Cm_Hopper_Final",
6658     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6659     "version": "0.0.0",
6660     "filename": "server/api/cmHopperFinal/index.js",
6661     "groupTitle": "Cm_Hopper_Final"
6662   },
6663   {
6664     "type": "get",
6665     "url": "/api/cm/hopper_final/{id}",
6666     "title": "Gets a single HopperFinal",
6667     "examples": [
6668       {
6669         "title": "Example usage:",
6670         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6671         "type": "json"
6672       }
6673     ],
6674     "name": "ShowHopperFinal",
6675     "group": "Cm_Hopper_Final",
6676     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6677     "version": "0.0.0",
6678     "filename": "server/api/cmHopperFinal/index.js",
6679     "groupTitle": "Cm_Hopper_Final"
6680   },
6681   {
6682     "type": "get",
6683     "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6684     "title": "Return number contacts for attributes",
6685     "examples": [
6686       {
6687         "title": "Example usage:",
6688         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6689         "type": "json"
6690       }
6691     ],
6692     "name": "countContactsIvrCampaignHopperFinal",
6693     "group": "Cm_Hopper_Final",
6694     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6695     "version": "0.0.0",
6696     "filename": "server/api/cmHopperFinal/index.js",
6697     "groupTitle": "Cm_Hopper_Final"
6698   },
6699   {
6700     "type": "get",
6701     "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6702     "title": "Return number contacts for attributes",
6703     "examples": [
6704       {
6705         "title": "Example usage:",
6706         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6707         "type": "json"
6708       }
6709     ],
6710     "name": "countContactsQueueCampaignHopperFinal",
6711     "group": "Cm_Hopper_Final",
6712     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6713     "version": "0.0.0",
6714     "filename": "server/api/cmHopperFinal/index.js",
6715     "groupTitle": "Cm_Hopper_Final"
6716   },
6717   {
6718     "type": "post",
6719     "url": "/api/cm/hopper_final/campaign/{id}",
6720     "title": "Move contacts in hopper",
6721     "examples": [
6722       {
6723         "title": "Example usage:",
6724         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6725         "type": "json"
6726       }
6727     ],
6728     "name": "moveContactsIvrCampaignHopperFinal",
6729     "group": "Cm_Hopper_Final",
6730     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6731     "version": "0.0.0",
6732     "filename": "server/api/cmHopperFinal/index.js",
6733     "groupTitle": "Cm_Hopper_Final"
6734   },
6735   {
6736     "type": "post",
6737     "url": "/api/cm/hopper_final/voice/queue/{id}",
6738     "title": "Move contacts in hopper",
6739     "examples": [
6740       {
6741         "title": "Example usage:",
6742         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6743         "type": "json"
6744       }
6745     ],
6746     "name": "moveContactsQueueCampaignHopperFinal",
6747     "group": "Cm_Hopper_Final",
6748     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6749     "version": "0.0.0",
6750     "filename": "server/api/cmHopperFinal/index.js",
6751     "groupTitle": "Cm_Hopper_Final"
6752   },
6753   {
6754     "type": "put",
6755     "url": "/api/cm/hopper_final/{id}",
6756     "title": "Update a single hopper final",
6757     "examples": [
6758       {
6759         "title": "Example usage:",
6760         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6761         "type": "json"
6762       }
6763     ],
6764     "name": "update",
6765     "group": "Cm_Hopper_Final",
6766     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6767     "version": "0.0.0",
6768     "filename": "server/api/cmHopperFinal/index.js",
6769     "groupTitle": "Cm_Hopper_Final"
6770   },
6771   {
6772     "type": "post",
6773     "url": "/api/cm/hopper_history",
6774     "title": "Creates a new HopperHistory",
6775     "examples": [
6776       {
6777         "title": "Example usage:",
6778         "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",
6779         "type": "json"
6780       }
6781     ],
6782     "name": "CreateHopperHistory",
6783     "group": "Cm_Hopper_History",
6784     "parameter": {
6785       "fields": {
6786         "Body": [
6787           {
6788             "group": "Body",
6789             "type": "Integer",
6790             "optional": true,
6791             "field": "state",
6792             "description": ""
6793           },
6794           {
6795             "group": "Body",
6796             "type": "String",
6797             "optional": true,
6798             "field": "statedesc",
6799             "description": ""
6800           },
6801           {
6802             "group": "Body",
6803             "type": "String",
6804             "optional": true,
6805             "field": "scheduledat",
6806             "description": ""
6807           },
6808           {
6809             "group": "Body",
6810             "type": "Integer",
6811             "optional": true,
6812             "field": "countbusyretry",
6813             "description": ""
6814           },
6815           {
6816             "group": "Body",
6817             "type": "Integer",
6818             "optional": true,
6819             "field": "countcongestionretry",
6820             "description": ""
6821           },
6822           {
6823             "group": "Body",
6824             "type": "Integer",
6825             "optional": true,
6826             "field": "countnoanswerretry",
6827             "description": ""
6828           },
6829           {
6830             "group": "Body",
6831             "type": "Integer",
6832             "optional": true,
6833             "field": "countglobal",
6834             "description": ""
6835           },
6836           {
6837             "group": "Body",
6838             "type": "String",
6839             "optional": true,
6840             "field": "uniqueid",
6841             "description": ""
6842           },
6843           {
6844             "group": "Body",
6845             "type": "String",
6846             "optional": true,
6847             "field": "originatecalleridnum",
6848             "description": ""
6849           },
6850           {
6851             "group": "Body",
6852             "type": "String",
6853             "optional": true,
6854             "field": "originatecalleridname",
6855             "description": ""
6856           },
6857           {
6858             "group": "Body",
6859             "type": "String",
6860             "optional": true,
6861             "field": "calleridnum",
6862             "description": ""
6863           },
6864           {
6865             "group": "Body",
6866             "type": "String",
6867             "optional": true,
6868             "field": "calleridname",
6869             "description": ""
6870           },
6871           {
6872             "group": "Body",
6873             "type": "String",
6874             "optional": true,
6875             "field": "starttime",
6876             "description": ""
6877           },
6878           {
6879             "group": "Body",
6880             "type": "String",
6881             "optional": true,
6882             "field": "responsetime",
6883             "description": ""
6884           },
6885           {
6886             "group": "Body",
6887             "type": "String",
6888             "optional": true,
6889             "field": "answertime",
6890             "description": ""
6891           },
6892           {
6893             "group": "Body",
6894             "type": "String",
6895             "optional": true,
6896             "field": "droptime",
6897             "description": ""
6898           },
6899           {
6900             "group": "Body",
6901             "type": "String",
6902             "optional": true,
6903             "field": "endtime",
6904             "description": ""
6905           },
6906           {
6907             "group": "Body",
6908             "type": "Integer",
6909             "optional": true,
6910             "field": "ringtime",
6911             "description": ""
6912           },
6913           {
6914             "group": "Body",
6915             "type": "Integer",
6916             "optional": true,
6917             "field": "holdtime",
6918             "description": ""
6919           },
6920           {
6921             "group": "Body",
6922             "type": "Integer",
6923             "optional": true,
6924             "field": "talktime",
6925             "description": ""
6926           },
6927           {
6928             "group": "Body",
6929             "type": "Integer",
6930             "optional": true,
6931             "field": "followuptime",
6932             "description": ""
6933           },
6934           {
6935             "group": "Body",
6936             "type": "String",
6937             "optional": true,
6938             "field": "dropreason",
6939             "description": ""
6940           },
6941           {
6942             "group": "Body",
6943             "type": "String",
6944             "optional": true,
6945             "field": "campaign",
6946             "description": ""
6947           },
6948           {
6949             "group": "Body",
6950             "type": "String",
6951             "optional": true,
6952             "field": "campaigntype",
6953             "description": ""
6954           },
6955           {
6956             "group": "Body",
6957             "type": "String",
6958             "optional": true,
6959             "field": "membername",
6960             "description": ""
6961           },
6962           {
6963             "group": "Body",
6964             "type": "String",
6965             "optional": true,
6966             "field": "reason",
6967             "description": ""
6968           },
6969           {
6970             "group": "Body",
6971             "type": "Boolean",
6972             "optional": true,
6973             "field": "amd",
6974             "description": ""
6975           },
6976           {
6977             "group": "Body",
6978             "type": "Boolean",
6979             "optional": true,
6980             "field": "fax",
6981             "description": ""
6982           },
6983           {
6984             "group": "Body",
6985             "type": "Boolean",
6986             "optional": true,
6987             "field": "callback",
6988             "description": ""
6989           },
6990           {
6991             "group": "Body",
6992             "type": "String",
6993             "optional": true,
6994             "field": "callbackuniqueid",
6995             "description": ""
6996           },
6997           {
6998             "group": "Body",
6999             "type": "String",
7000             "optional": true,
7001             "field": "callbackat",
7002             "description": ""
7003           },
7004           {
7005             "group": "Body",
7006             "type": "Boolean",
7007             "optional": true,
7008             "field": "recallme",
7009             "description": ""
7010           },
7011           {
7012             "group": "Body",
7013             "type": "String",
7014             "optional": true,
7015             "field": "editedat",
7016             "description": ""
7017           },
7018           {
7019             "group": "Body",
7020             "type": "Boolean",
7021             "optional": true,
7022             "field": "edited",
7023             "description": ""
7024           },
7025           {
7026             "group": "Body",
7027             "type": "Integer",
7028             "optional": true,
7029             "field": "countnosuchnumberretry",
7030             "description": ""
7031           },
7032           {
7033             "group": "Body",
7034             "type": "Integer",
7035             "optional": true,
7036             "field": "countdropretry",
7037             "description": ""
7038           },
7039           {
7040             "group": "Body",
7041             "type": "Integer",
7042             "optional": true,
7043             "field": "countabandonedretry",
7044             "description": ""
7045           },
7046           {
7047             "group": "Body",
7048             "type": "Integer",
7049             "optional": true,
7050             "field": "countmachineretry",
7051             "description": ""
7052           },
7053           {
7054             "group": "Body",
7055             "type": "Integer",
7056             "optional": true,
7057             "field": "countagentrejectretry",
7058             "description": ""
7059           }
7060         ]
7061       }
7062     },
7063     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7064     "version": "0.0.0",
7065     "filename": "server/api/cmHopperHistory/index.js",
7066     "groupTitle": "Cm_Hopper_History"
7067   },
7068   {
7069     "type": "get",
7070     "url": "/api/cm/hopper_history/describe",
7071     "title": "Gets table info about HopperHistory",
7072     "examples": [
7073       {
7074         "title": "Example usage:",
7075         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7076         "type": "json"
7077       }
7078     ],
7079     "name": "DescribeHopperHistory",
7080     "group": "Cm_Hopper_History",
7081     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7082     "version": "0.0.0",
7083     "filename": "server/api/cmHopperHistory/index.js",
7084     "groupTitle": "Cm_Hopper_History"
7085   },
7086   {
7087     "type": "get",
7088     "url": "/api/cm/hopper_history",
7089     "title": "Gets a list of HopperHistory",
7090     "examples": [
7091       {
7092         "title": "Example usage:",
7093         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7094         "type": "json"
7095       }
7096     ],
7097     "name": "GetHopperHistory",
7098     "group": "Cm_Hopper_History",
7099     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7100     "version": "0.0.0",
7101     "filename": "server/api/cmHopperHistory/index.js",
7102     "groupTitle": "Cm_Hopper_History"
7103   },
7104   {
7105     "type": "get",
7106     "url": "/api/cm/hopper_history/{id}",
7107     "title": "Gets a single HopperHistory",
7108     "examples": [
7109       {
7110         "title": "Example usage:",
7111         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7112         "type": "json"
7113       }
7114     ],
7115     "name": "ShowHopperHistory",
7116     "group": "Cm_Hopper_History",
7117     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7118     "version": "0.0.0",
7119     "filename": "server/api/cmHopperHistory/index.js",
7120     "groupTitle": "Cm_Hopper_History"
7121   },
7122   {
7123     "type": "put",
7124     "url": "/api/cm/hopper_history/{id}",
7125     "title": "Update a single hopper history",
7126     "examples": [
7127       {
7128         "title": "Example usage:",
7129         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7130         "type": "json"
7131       }
7132     ],
7133     "name": "update",
7134     "group": "Cm_Hopper_History",
7135     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7136     "version": "0.0.0",
7137     "filename": "server/api/cmHopperHistory/index.js",
7138     "groupTitle": "Cm_Hopper_History"
7139   },
7140   {
7141     "type": "delete",
7142     "url": "/api/cm/hopper/{id}",
7143     "title": "Delete Hopper",
7144     "examples": [
7145       {
7146         "title": "Example usage:",
7147         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7148         "type": "json"
7149       }
7150     ],
7151     "name": "destroy",
7152     "group": "Cm_Hopper",
7153     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7154     "version": "0.0.0",
7155     "filename": "server/api/cmHopper/index.js",
7156     "groupTitle": "Cm_Hopper"
7157   },
7158   {
7159     "type": "get",
7160     "url": "/api/cm/hopper/opencontacts",
7161     "title": "Gets Open Contacts",
7162     "examples": [
7163       {
7164         "title": "Example usage:",
7165         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7166         "type": "json"
7167       }
7168     ],
7169     "name": "getOpenContacts",
7170     "group": "Cm_Hopper",
7171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7172     "version": "0.0.0",
7173     "filename": "server/api/cmHopper/index.js",
7174     "groupTitle": "Cm_Hopper"
7175   },
7176   {
7177     "type": "post",
7178     "url": "/api/cm/hopper/preview",
7179     "title": "Gets Preview Dialer Contacts",
7180     "examples": [
7181       {
7182         "title": "Example usage:",
7183         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7184         "type": "json"
7185       }
7186     ],
7187     "name": "getPreview",
7188     "group": "Cm_Hopper",
7189     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7190     "version": "0.0.0",
7191     "filename": "server/api/cmHopper/index.js",
7192     "groupTitle": "Cm_Hopper"
7193   },
7194   {
7195     "type": "put",
7196     "url": "/api/cm/hopper/{id}",
7197     "title": "Update an existing Hopper",
7198     "examples": [
7199       {
7200         "title": "Example usage:",
7201         "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",
7202         "type": "json"
7203       }
7204     ],
7205     "name": "updateHopper",
7206     "group": "Cm_Hopper",
7207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7208     "version": "0.0.0",
7209     "filename": "server/api/cmHopper/index.js",
7210     "groupTitle": "Cm_Hopper"
7211   },
7212   {
7213     "type": "post",
7214     "url": "/api/cm/lists",
7215     "title": "Creates a new List",
7216     "examples": [
7217       {
7218         "title": "Example usage:",
7219         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7220         "type": "json"
7221       }
7222     ],
7223     "name": "CreateLists",
7224     "group": "Cm_Lists",
7225     "parameter": {
7226       "fields": {
7227         "Body": [
7228           {
7229             "group": "Body",
7230             "type": "String",
7231             "optional": false,
7232             "field": "name",
7233             "description": ""
7234           },
7235           {
7236             "group": "Body",
7237             "type": "String",
7238             "optional": true,
7239             "field": "description",
7240             "description": ""
7241           },
7242           {
7243             "group": "Body",
7244             "type": "String",
7245             "optional": true,
7246             "field": "dialPrefix",
7247             "description": ""
7248           }
7249         ]
7250       }
7251     },
7252     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7253     "version": "0.0.0",
7254     "filename": "server/api/cmList/index.js",
7255     "groupTitle": "Cm_Lists"
7256   },
7257   {
7258     "type": "delete",
7259     "url": "/api/cm/lists/{id}",
7260     "title": "Deletes a List",
7261     "examples": [
7262       {
7263         "title": "Example usage:",
7264         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7265         "type": "json"
7266       }
7267     ],
7268     "name": "DeleteLists",
7269     "group": "Cm_Lists",
7270     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7271     "version": "0.0.0",
7272     "filename": "server/api/cmList/index.js",
7273     "groupTitle": "Cm_Lists"
7274   },
7275   {
7276     "type": "get",
7277     "url": "/api/cm/lists/describe",
7278     "title": "Gets table info about Lists",
7279     "examples": [
7280       {
7281         "title": "Example usage:",
7282         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7283         "type": "json"
7284       }
7285     ],
7286     "name": "DescribeLists",
7287     "group": "Cm_Lists",
7288     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7289     "version": "0.0.0",
7290     "filename": "server/api/cmList/index.js",
7291     "groupTitle": "Cm_Lists"
7292   },
7293   {
7294     "type": "get",
7295     "url": "/api/cm/lists/{id}/users",
7296     "title": "Gets agents from list",
7297     "examples": [
7298       {
7299         "title": "Example usage:",
7300         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7301         "type": "json"
7302       }
7303     ],
7304     "name": "GetAgents",
7305     "group": "Cm_Lists",
7306     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7307     "version": "0.0.0",
7308     "filename": "server/api/cmList/index.js",
7309     "groupTitle": "Cm_Lists"
7310   },
7311   {
7312     "type": "get",
7313     "url": "/api/cm/lists",
7314     "title": "Gets a list of Lists",
7315     "examples": [
7316       {
7317         "title": "Example usage:",
7318         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7319         "type": "json"
7320       }
7321     ],
7322     "name": "GetLists",
7323     "group": "Cm_Lists",
7324     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7325     "version": "0.0.0",
7326     "filename": "server/api/cmList/index.js",
7327     "groupTitle": "Cm_Lists"
7328   },
7329   {
7330     "type": "delete",
7331     "url": "/api/cm/lists/{id}/users",
7332     "title": "Removes agents from a list",
7333     "examples": [
7334       {
7335         "title": "Example usage:",
7336         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7337         "type": "json"
7338       }
7339     ],
7340     "name": "RemoveAgents",
7341     "group": "Cm_Lists",
7342     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7343     "version": "0.0.0",
7344     "filename": "server/api/cmList/index.js",
7345     "groupTitle": "Cm_Lists"
7346   },
7347   {
7348     "type": "delete",
7349     "url": "/api/cm/lists/{id}/dispositions",
7350     "title": "Removes dispositions from account",
7351     "examples": [
7352       {
7353         "title": "Example usage:",
7354         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7355         "type": "json"
7356       }
7357     ],
7358     "name": "RemoveDispositions",
7359     "group": "Cm_Lists",
7360     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7361     "version": "0.0.0",
7362     "filename": "server/api/cmList/index.js",
7363     "groupTitle": "Cm_Lists"
7364   },
7365   {
7366     "type": "get",
7367     "url": "/api/cm/lists/{id}",
7368     "title": "Gets a single List",
7369     "examples": [
7370       {
7371         "title": "Example usage:",
7372         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7373         "type": "json"
7374       }
7375     ],
7376     "name": "ShowLists",
7377     "group": "Cm_Lists",
7378     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7379     "version": "0.0.0",
7380     "filename": "server/api/cmList/index.js",
7381     "groupTitle": "Cm_Lists"
7382   },
7383   {
7384     "type": "post",
7385     "url": "/api/cm/lists/{id}/users",
7386     "title": "Adds agents to a list",
7387     "examples": [
7388       {
7389         "title": "Example usage:",
7390         "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",
7391         "type": "json"
7392       }
7393     ],
7394     "name": "addAgents",
7395     "group": "Cm_Lists",
7396     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7397     "version": "0.0.0",
7398     "filename": "server/api/cmList/index.js",
7399     "groupTitle": "Cm_Lists"
7400   },
7401   {
7402     "type": "post",
7403     "url": "/api/cm/lists/{id}/contacts",
7404     "title": "Creates new contacts",
7405     "examples": [
7406       {
7407         "title": "Example usage:",
7408         "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",
7409         "type": "json"
7410       }
7411     ],
7412     "name": "addContacts",
7413     "group": "Cm_Lists",
7414     "parameter": {
7415       "fields": {
7416         "Body": [
7417           {
7418             "group": "Body",
7419             "type": "String",
7420             "optional": false,
7421             "field": "firstName",
7422             "description": ""
7423           },
7424           {
7425             "group": "Body",
7426             "type": "String",
7427             "optional": true,
7428             "field": "lastName",
7429             "description": ""
7430           },
7431           {
7432             "group": "Body",
7433             "type": "String",
7434             "optional": true,
7435             "field": "street",
7436             "description": ""
7437           },
7438           {
7439             "group": "Body",
7440             "type": "String",
7441             "optional": true,
7442             "field": "postalCode",
7443             "description": ""
7444           },
7445           {
7446             "group": "Body",
7447             "type": "String",
7448             "optional": true,
7449             "field": "city",
7450             "description": ""
7451           },
7452           {
7453             "group": "Body",
7454             "type": "String",
7455             "optional": true,
7456             "field": "country",
7457             "description": ""
7458           },
7459           {
7460             "group": "Body",
7461             "type": "String",
7462             "optional": true,
7463             "field": "dateOfBirth",
7464             "description": ""
7465           },
7466           {
7467             "group": "Body",
7468             "type": "Text",
7469             "optional": true,
7470             "field": "description",
7471             "description": ""
7472           },
7473           {
7474             "group": "Body",
7475             "type": "String",
7476             "optional": true,
7477             "field": "phone",
7478             "description": ""
7479           },
7480           {
7481             "group": "Body",
7482             "type": "String",
7483             "optional": true,
7484             "field": "mobile",
7485             "description": ""
7486           },
7487           {
7488             "group": "Body",
7489             "type": "String",
7490             "optional": true,
7491             "field": "fax",
7492             "description": ""
7493           },
7494           {
7495             "group": "Body",
7496             "type": "String",
7497             "optional": true,
7498             "field": "email",
7499             "description": ""
7500           },
7501           {
7502             "group": "Body",
7503             "type": "String",
7504             "optional": true,
7505             "field": "url",
7506             "description": ""
7507           },
7508           {
7509             "group": "Body",
7510             "type": "String",
7511             "optional": true,
7512             "field": "facebook",
7513             "description": ""
7514           },
7515           {
7516             "group": "Body",
7517             "type": "String",
7518             "optional": true,
7519             "field": "fb_data",
7520             "description": ""
7521           },
7522           {
7523             "group": "Body",
7524             "type": "String",
7525             "optional": true,
7526             "field": "twitter",
7527             "description": ""
7528           },
7529           {
7530             "group": "Body",
7531             "type": "String",
7532             "optional": true,
7533             "field": "skype",
7534             "description": ""
7535           },
7536           {
7537             "group": "Body",
7538             "type": "String",
7539             "optional": true,
7540             "field": "teams",
7541             "description": ""
7542           },
7543           {
7544             "group": "Body",
7545             "type": "String",
7546             "optional": true,
7547             "field": "viber",
7548             "description": ""
7549           },
7550           {
7551             "group": "Body",
7552             "type": "String",
7553             "optional": true,
7554             "field": "line",
7555             "description": ""
7556           },
7557           {
7558             "group": "Body",
7559             "type": "String",
7560             "optional": true,
7561             "field": "wechat",
7562             "description": ""
7563           },
7564           {
7565             "group": "Body",
7566             "type": "String",
7567             "optional": true,
7568             "field": "telegram",
7569             "description": ""
7570           },
7571           {
7572             "group": "Body",
7573             "type": "Integer",
7574             "optional": true,
7575             "field": "UserId",
7576             "description": ""
7577           },
7578           {
7579             "group": "Body",
7580             "type": "Integer",
7581             "optional": true,
7582             "field": "priority",
7583             "description": ""
7584           },
7585           {
7586             "group": "Body",
7587             "type": "String",
7588             "optional": true,
7589             "field": "scheduledat",
7590             "description": ""
7591           }
7592         ]
7593       }
7594     },
7595     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7596     "version": "0.0.0",
7597     "filename": "server/api/cmList/index.js",
7598     "groupTitle": "Cm_Lists"
7599   },
7600   {
7601     "type": "post",
7602     "url": "/api/cm/lists/{id}/fields",
7603     "title": "Creates a new custom field",
7604     "examples": [
7605       {
7606         "title": "Example usage:",
7607         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7608         "type": "json"
7609       }
7610     ],
7611     "name": "addCustomField",
7612     "group": "Cm_Lists",
7613     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7614     "version": "0.0.0",
7615     "filename": "server/api/cmList/index.js",
7616     "groupTitle": "Cm_Lists"
7617   },
7618   {
7619     "type": "post",
7620     "url": "/api/cm/lists/{id}/dispositions",
7621     "title": "Creates new disposition",
7622     "examples": [
7623       {
7624         "title": "Example usage:",
7625         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7626         "type": "json"
7627       }
7628     ],
7629     "name": "addDisposition",
7630     "group": "Cm_Lists",
7631     "parameter": {
7632       "fields": {
7633         "Body": [
7634           {
7635             "group": "Body",
7636             "type": "String",
7637             "optional": false,
7638             "field": "name",
7639             "description": ""
7640           },
7641           {
7642             "group": "Body",
7643             "type": "String",
7644             "allowedValues": [
7645               "\"first\"",
7646               "\"second\"",
7647               "\"third\""
7648             ],
7649             "optional": false,
7650             "field": "level",
7651             "description": ""
7652           },
7653           {
7654             "group": "Body",
7655             "type": "String",
7656             "optional": true,
7657             "field": "description",
7658             "description": ""
7659           }
7660         ]
7661       }
7662     },
7663     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7664     "version": "0.0.0",
7665     "filename": "server/api/cmList/index.js",
7666     "groupTitle": "Cm_Lists"
7667   },
7668   {
7669     "type": "get",
7670     "url": "/api/cm/lists/{id}/contacts",
7671     "title": "Gets List Contacts",
7672     "examples": [
7673       {
7674         "title": "Example usage:",
7675         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7676         "type": "json"
7677       }
7678     ],
7679     "name": "getContacts",
7680     "group": "Cm_Lists",
7681     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7682     "version": "0.0.0",
7683     "filename": "server/api/cmList/index.js",
7684     "groupTitle": "Cm_Lists"
7685   },
7686   {
7687     "type": "get",
7688     "url": "/api/cm/lists/{id}/fields",
7689     "title": "Gets Custom Fields",
7690     "examples": [
7691       {
7692         "title": "Example usage:",
7693         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7694         "type": "json"
7695       }
7696     ],
7697     "name": "getCustomFields",
7698     "group": "Cm_Lists",
7699     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7700     "version": "0.0.0",
7701     "filename": "server/api/cmList/index.js",
7702     "groupTitle": "Cm_Lists"
7703   },
7704   {
7705     "type": "get",
7706     "url": "/api/cm/lists/{id}/dispositions",
7707     "title": "Gets list dispositions",
7708     "examples": [
7709       {
7710         "title": "Example usage:",
7711         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7712         "type": "json"
7713       }
7714     ],
7715     "name": "getDispositions",
7716     "group": "Cm_Lists",
7717     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7718     "version": "0.0.0",
7719     "filename": "server/api/cmList/index.js",
7720     "groupTitle": "Cm_Lists"
7721   },
7722   {
7723     "type": "get",
7724     "url": "/api/cm/lists/{id}/contacts/csv",
7725     "title": "Gets CSV List Contacts",
7726     "examples": [
7727       {
7728         "title": "Example usage:",
7729         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7730         "type": "json"
7731       }
7732     ],
7733     "name": "grunt",
7734     "group": "Cm_Lists",
7735     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7736     "version": "0.0.0",
7737     "filename": "server/api/cmList/index.js",
7738     "groupTitle": "Cm_Lists"
7739   },
7740   {
7741     "type": "put",
7742     "url": "/api/cm/lists/{id}",
7743     "title": "Update an existing List",
7744     "examples": [
7745       {
7746         "title": "Example usage:",
7747         "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",
7748         "type": "json"
7749       }
7750     ],
7751     "name": "updateLists",
7752     "group": "Cm_Lists",
7753     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7754     "version": "0.0.0",
7755     "filename": "server/api/cmList/index.js",
7756     "groupTitle": "Cm_Lists"
7757   },
7758   {
7759     "type": "post",
7760     "url": "/api/cm/contacts/upload/:id",
7761     "title": "Import new contacts by csv",
7762     "examples": [
7763       {
7764         "title": "Example usage:",
7765         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7766         "type": "json"
7767       }
7768     ],
7769     "name": "import",
7770     "group": "Cm_contacts",
7771     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7772     "version": "0.0.0",
7773     "filename": "server/api/cmContact/index.js",
7774     "groupTitle": "Cm_contacts"
7775   },
7776   {
7777     "type": "post",
7778     "url": "/api/cm/contacts/upload",
7779     "title": "Upload csv",
7780     "examples": [
7781       {
7782         "title": "Example usage:",
7783         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7784         "type": "json"
7785       }
7786     ],
7787     "name": "upload",
7788     "group": "Cm_contacts",
7789     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7790     "version": "0.0.0",
7791     "filename": "server/api/cmContact/index.js",
7792     "groupTitle": "Cm_contacts"
7793   },
7794   {
7795     "type": "post",
7796     "url": "/api/cm/contacts/csv",
7797     "title": "Create new contacts by csv",
7798     "examples": [
7799       {
7800         "title": "Example usage:",
7801         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7802         "type": "json"
7803       }
7804     ],
7805     "name": "uploadCsv",
7806     "group": "Cm_contacts",
7807     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7808     "version": "0.0.0",
7809     "filename": "server/api/cmContact/index.js",
7810     "groupTitle": "Cm_contacts"
7811   },
7812   {
7813     "type": "delete",
7814     "url": "/api/conditions/{id}",
7815     "title": "Deletes a Condition",
7816     "examples": [
7817       {
7818         "title": "Example usage:",
7819         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7820         "type": "json"
7821       }
7822     ],
7823     "name": "DeleteConditions",
7824     "group": "Conditions",
7825     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7826     "version": "0.0.0",
7827     "filename": "server/api/condition/index.js",
7828     "groupTitle": "Conditions"
7829   },
7830   {
7831     "type": "put",
7832     "url": "/api/conditions/{id}",
7833     "title": "Update an existing Condition",
7834     "examples": [
7835       {
7836         "title": "Example usage:",
7837         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7838         "type": "json"
7839       }
7840     ],
7841     "name": "updateConditions",
7842     "group": "Conditions",
7843     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7844     "version": "0.0.0",
7845     "filename": "server/api/condition/index.js",
7846     "groupTitle": "Conditions"
7847   },
7848   {
7849     "type": "post",
7850     "url": "/api/cm/custom_field",
7851     "title": "Create a new custom field",
7852     "examples": [
7853       {
7854         "title": "Example usage:",
7855         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7856         "type": "json"
7857       }
7858     ],
7859     "name": "CreateCustomField",
7860     "group": "Custom_Fields",
7861     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7862     "version": "0.0.0",
7863     "filename": "server/api/cmCustomField/index.js",
7864     "groupTitle": "Custom_Fields"
7865   },
7866   {
7867     "type": "post",
7868     "url": "/api/dashboards/items",
7869     "title": "Create dasboard item",
7870     "examples": [
7871       {
7872         "title": "Example usage:",
7873         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7874         "type": "json"
7875       }
7876     ],
7877     "name": "Create",
7878     "group": "Dashboard_Items",
7879     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7880     "version": "0.0.0",
7881     "filename": "server/api/dashboardItem/index.js",
7882     "groupTitle": "Dashboard_Items"
7883   },
7884   {
7885     "type": "delete",
7886     "url": "/api/dashboards/items/{id}",
7887     "title": "Deletes a Dashboard Item",
7888     "examples": [
7889       {
7890         "title": "Example usage:",
7891         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7892         "type": "json"
7893       }
7894     ],
7895     "name": "DeleteDashboard_Items",
7896     "group": "Dashboard_Items",
7897     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7898     "version": "0.0.0",
7899     "filename": "server/api/dashboardItem/index.js",
7900     "groupTitle": "Dashboard_Items"
7901   },
7902   {
7903     "type": "get",
7904     "url": "/api/dashboards/items/{id}",
7905     "title": "Gets a single Dashboard Item",
7906     "examples": [
7907       {
7908         "title": "Example usage:",
7909         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7910         "type": "json"
7911       }
7912     ],
7913     "name": "ShowDashboard_Items",
7914     "group": "Dashboard_Items",
7915     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7916     "version": "0.0.0",
7917     "filename": "server/api/dashboardItem/index.js",
7918     "groupTitle": "Dashboard_Items"
7919   },
7920   {
7921     "type": "put",
7922     "url": "/api/dashboards/items/{id}",
7923     "title": "Update an existing item",
7924     "examples": [
7925       {
7926         "title": "Example usage:",
7927         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7928         "type": "json"
7929       }
7930     ],
7931     "name": "Update",
7932     "group": "Dashboard_Items",
7933     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7934     "version": "0.0.0",
7935     "filename": "server/api/dashboardItem/index.js",
7936     "groupTitle": "Dashboard_Items"
7937   },
7938   {
7939     "type": "post",
7940     "url": "/api/dashboards/clone",
7941     "title": "Clone an existing Dashboard",
7942     "examples": [
7943       {
7944         "title": "Example usage:",
7945         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7946         "type": "json"
7947       }
7948     ],
7949     "name": "CloneDashboards",
7950     "group": "Dashboards",
7951     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7952     "version": "0.0.0",
7953     "filename": "server/api/dashboard/index.js",
7954     "groupTitle": "Dashboards"
7955   },
7956   {
7957     "type": "post",
7958     "url": "/api/dashboards",
7959     "title": "Creates a new Dashboard",
7960     "examples": [
7961       {
7962         "title": "Example usage:",
7963         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7964         "type": "json"
7965       }
7966     ],
7967     "name": "CreateDashboards",
7968     "group": "Dashboards",
7969     "parameter": {
7970       "fields": {
7971         "Body": [
7972           {
7973             "group": "Body",
7974             "type": "String",
7975             "optional": false,
7976             "field": "name",
7977             "description": ""
7978           },
7979           {
7980             "group": "Body",
7981             "type": "String",
7982             "optional": true,
7983             "field": "description",
7984             "description": ""
7985           }
7986         ]
7987       }
7988     },
7989     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7990     "version": "0.0.0",
7991     "filename": "server/api/dashboard/index.js",
7992     "groupTitle": "Dashboards"
7993   },
7994   {
7995     "type": "delete",
7996     "url": "/api/dashboards/{id}",
7997     "title": "Deletes a Dashboard",
7998     "examples": [
7999       {
8000         "title": "Example usage:",
8001         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8002         "type": "json"
8003       }
8004     ],
8005     "name": "DeleteDashboards",
8006     "group": "Dashboards",
8007     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8008     "version": "0.0.0",
8009     "filename": "server/api/dashboard/index.js",
8010     "groupTitle": "Dashboards"
8011   },
8012   {
8013     "type": "get",
8014     "url": "/api/dashboards",
8015     "title": "Gets a list of Dashboards",
8016     "examples": [
8017       {
8018         "title": "Example usage:",
8019         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8020         "type": "json"
8021       }
8022     ],
8023     "name": "GetDashboards",
8024     "group": "Dashboards",
8025     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8026     "version": "0.0.0",
8027     "filename": "server/api/dashboard/index.js",
8028     "groupTitle": "Dashboards"
8029   },
8030   {
8031     "type": "get",
8032     "url": "/api/dashboards/{id}",
8033     "title": "Gets a single Dashboard",
8034     "examples": [
8035       {
8036         "title": "Example usage:",
8037         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8038         "type": "json"
8039       }
8040     ],
8041     "name": "ShowDashboards",
8042     "group": "Dashboards",
8043     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8044     "version": "0.0.0",
8045     "filename": "server/api/dashboard/index.js",
8046     "groupTitle": "Dashboards"
8047   },
8048   {
8049     "type": "post",
8050     "url": "/api/dashboards/{id}/items",
8051     "title": "Creates new item",
8052     "examples": [
8053       {
8054         "title": "Example usage:",
8055         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8056         "type": "json"
8057       }
8058     ],
8059     "name": "addItem",
8060     "group": "Dashboards",
8061     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8062     "version": "0.0.0",
8063     "filename": "server/api/dashboard/index.js",
8064     "groupTitle": "Dashboards"
8065   },
8066   {
8067     "type": "get",
8068     "url": "/api/dashboards/{id}/items",
8069     "title": "Gets items",
8070     "examples": [
8071       {
8072         "title": "Example usage:",
8073         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8074         "type": "json"
8075       }
8076     ],
8077     "name": "getItems",
8078     "group": "Dashboards",
8079     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8080     "version": "0.0.0",
8081     "filename": "server/api/dashboard/index.js",
8082     "groupTitle": "Dashboards"
8083   },
8084   {
8085     "type": "put",
8086     "url": "/api/dashboards/{id}",
8087     "title": "Update an existing Dashboard",
8088     "examples": [
8089       {
8090         "title": "Example usage:",
8091         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8092         "type": "json"
8093       }
8094     ],
8095     "name": "updateDashboards",
8096     "group": "Dashboards",
8097     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8098     "version": "0.0.0",
8099     "filename": "server/api/dashboard/index.js",
8100     "groupTitle": "Dashboards"
8101   },
8102   {
8103     "type": "post",
8104     "url": "/api/integrations/desk/accounts",
8105     "title": "Creates a new Desk Account",
8106     "examples": [
8107       {
8108         "title": "Example usage:",
8109         "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",
8110         "type": "json"
8111       }
8112     ],
8113     "name": "CreateDesk_Accounts",
8114     "group": "Desk_Accounts",
8115     "parameter": {
8116       "fields": {
8117         "Body": [
8118           {
8119             "group": "Body",
8120             "type": "String",
8121             "optional": true,
8122             "field": "name",
8123             "description": ""
8124           },
8125           {
8126             "group": "Body",
8127             "type": "String",
8128             "optional": true,
8129             "field": "description",
8130             "description": ""
8131           },
8132           {
8133             "group": "Body",
8134             "type": "String",
8135             "optional": true,
8136             "field": "username",
8137             "description": ""
8138           },
8139           {
8140             "group": "Body",
8141             "type": "String",
8142             "optional": true,
8143             "field": "remoteUri",
8144             "description": ""
8145           },
8146           {
8147             "group": "Body",
8148             "type": "String",
8149             "allowedValues": [
8150               "\"basic\""
8151             ],
8152             "optional": true,
8153             "field": "authType",
8154             "description": ""
8155           },
8156           {
8157             "group": "Body",
8158             "type": "String",
8159             "optional": true,
8160             "field": "password",
8161             "description": ""
8162           },
8163           {
8164             "group": "Body",
8165             "type": "String",
8166             "optional": true,
8167             "field": "consumerKey",
8168             "description": ""
8169           },
8170           {
8171             "group": "Body",
8172             "type": "String",
8173             "optional": true,
8174             "field": "consumerSecret",
8175             "description": ""
8176           },
8177           {
8178             "group": "Body",
8179             "type": "String",
8180             "optional": true,
8181             "field": "token",
8182             "description": ""
8183           },
8184           {
8185             "group": "Body",
8186             "type": "String",
8187             "optional": true,
8188             "field": "tokenSecret",
8189             "description": ""
8190           },
8191           {
8192             "group": "Body",
8193             "type": "String",
8194             "optional": false,
8195             "field": "serverUrl",
8196             "description": ""
8197           },
8198           {
8199             "group": "Body",
8200             "type": "String",
8201             "allowedValues": [
8202               "\"integrationTab\"",
8203               "\"newTab\""
8204             ],
8205             "optional": true,
8206             "field": "type",
8207             "description": ""
8208           }
8209         ]
8210       }
8211     },
8212     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8213     "version": "0.0.0",
8214     "filename": "server/api/intDeskAccount/index.js",
8215     "groupTitle": "Desk_Accounts"
8216   },
8217   {
8218     "type": "delete",
8219     "url": "/api/integrations/desk/accounts/{id}",
8220     "title": "Deletes a Desk Account",
8221     "examples": [
8222       {
8223         "title": "Example usage:",
8224         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8225         "type": "json"
8226       }
8227     ],
8228     "name": "DeleteDesk_Accounts",
8229     "group": "Desk_Accounts",
8230     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8231     "version": "0.0.0",
8232     "filename": "server/api/intDeskAccount/index.js",
8233     "groupTitle": "Desk_Accounts"
8234   },
8235   {
8236     "type": "get",
8237     "url": "/api/integrations/desk/accounts",
8238     "title": "Gets a list of Desk Accounts",
8239     "examples": [
8240       {
8241         "title": "Example usage:",
8242         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8243         "type": "json"
8244       }
8245     ],
8246     "name": "GetDesk_Accounts",
8247     "group": "Desk_Accounts",
8248     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8249     "version": "0.0.0",
8250     "filename": "server/api/intDeskAccount/index.js",
8251     "groupTitle": "Desk_Accounts"
8252   },
8253   {
8254     "type": "get",
8255     "url": "/api/integrations/desk/accounts/{id}",
8256     "title": "Gets a single Desk Account",
8257     "examples": [
8258       {
8259         "title": "Example usage:",
8260         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8261         "type": "json"
8262       }
8263     ],
8264     "name": "ShowDesk_Accounts",
8265     "group": "Desk_Accounts",
8266     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8267     "version": "0.0.0",
8268     "filename": "server/api/intDeskAccount/index.js",
8269     "groupTitle": "Desk_Accounts"
8270   },
8271   {
8272     "type": "post",
8273     "url": "/api/integrations/desk/accounts/{id}/configurations",
8274     "title": "Creates new configuration",
8275     "examples": [
8276       {
8277         "title": "Example usage:",
8278         "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",
8279         "type": "json"
8280       }
8281     ],
8282     "name": "addConfiguration",
8283     "group": "Desk_Accounts",
8284     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8285     "version": "0.0.0",
8286     "filename": "server/api/intDeskAccount/index.js",
8287     "groupTitle": "Desk_Accounts"
8288   },
8289   {
8290     "type": "get",
8291     "url": "/api/integrations/desk/accounts/{id}/configurations",
8292     "title": "Gets account configurations",
8293     "examples": [
8294       {
8295         "title": "Example usage:",
8296         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8297         "type": "json"
8298       }
8299     ],
8300     "name": "getConfigurations",
8301     "group": "Desk_Accounts",
8302     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8303     "version": "0.0.0",
8304     "filename": "server/api/intDeskAccount/index.js",
8305     "groupTitle": "Desk_Accounts"
8306   },
8307   {
8308     "type": "get",
8309     "url": "/api/integrations/desk/accounts/{id}/fields",
8310     "title": "Gets account fields",
8311     "examples": [
8312       {
8313         "title": "Example usage:",
8314         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8315         "type": "json"
8316       }
8317     ],
8318     "name": "getFields",
8319     "group": "Desk_Accounts",
8320     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8321     "version": "0.0.0",
8322     "filename": "server/api/intDeskAccount/index.js",
8323     "groupTitle": "Desk_Accounts"
8324   },
8325   {
8326     "type": "put",
8327     "url": "/api/integrations/desk/accounts/{id}",
8328     "title": "Update an existing Desk Account",
8329     "examples": [
8330       {
8331         "title": "Example usage:",
8332         "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",
8333         "type": "json"
8334       }
8335     ],
8336     "name": "updateDesk_Accounts",
8337     "group": "Desk_Accounts",
8338     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8339     "version": "0.0.0",
8340     "filename": "server/api/intDeskAccount/index.js",
8341     "groupTitle": "Desk_Accounts"
8342   },
8343   {
8344     "type": "post",
8345     "url": "/api/integrations/desk/configurations",
8346     "title": "Creates a new Desk Configuration",
8347     "examples": [
8348       {
8349         "title": "Example usage:",
8350         "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",
8351         "type": "json"
8352       }
8353     ],
8354     "name": "CreateDesk_Configurations",
8355     "group": "Desk_Configurations",
8356     "parameter": {
8357       "fields": {
8358         "Body": [
8359           {
8360             "group": "Body",
8361             "type": "String",
8362             "optional": true,
8363             "field": "name",
8364             "description": ""
8365           },
8366           {
8367             "group": "Body",
8368             "type": "String",
8369             "optional": true,
8370             "field": "description",
8371             "description": ""
8372           }
8373         ]
8374       }
8375     },
8376     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8377     "version": "0.0.0",
8378     "filename": "server/api/intDeskConfiguration/index.js",
8379     "groupTitle": "Desk_Configurations"
8380   },
8381   {
8382     "type": "delete",
8383     "url": "/api/integrations/desk/configurations/{id}",
8384     "title": "Deletes a Desk Configuration",
8385     "examples": [
8386       {
8387         "title": "Example usage:",
8388         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8389         "type": "json"
8390       }
8391     ],
8392     "name": "DeleteDesk_Configurations",
8393     "group": "Desk_Configurations",
8394     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8395     "version": "0.0.0",
8396     "filename": "server/api/intDeskConfiguration/index.js",
8397     "groupTitle": "Desk_Configurations"
8398   },
8399   {
8400     "type": "get",
8401     "url": "/api/integrations/desk/configurations",
8402     "title": "Gets a list of Desk Configurations",
8403     "examples": [
8404       {
8405         "title": "Example usage:",
8406         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8407         "type": "json"
8408       }
8409     ],
8410     "name": "GetDesk_Configurations",
8411     "group": "Desk_Configurations",
8412     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8413     "version": "0.0.0",
8414     "filename": "server/api/intDeskConfiguration/index.js",
8415     "groupTitle": "Desk_Configurations"
8416   },
8417   {
8418     "type": "get",
8419     "url": "/api/integrations/desk/configurations/{id}",
8420     "title": "Gets a single Desk Configuration",
8421     "examples": [
8422       {
8423         "title": "Example usage:",
8424         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8425         "type": "json"
8426       }
8427     ],
8428     "name": "ShowDesk_Configurations",
8429     "group": "Desk_Configurations",
8430     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8431     "version": "0.0.0",
8432     "filename": "server/api/intDeskConfiguration/index.js",
8433     "groupTitle": "Desk_Configurations"
8434   },
8435   {
8436     "type": "get",
8437     "url": "/api/integrations/desk/configurations/{id}/descriptions",
8438     "title": "Gets configurations descriptions",
8439     "examples": [
8440       {
8441         "title": "Example usage:",
8442         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8443         "type": "json"
8444       }
8445     ],
8446     "name": "getDescriptions",
8447     "group": "Desk_Configurations",
8448     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8449     "version": "0.0.0",
8450     "filename": "server/api/intDeskConfiguration/index.js",
8451     "groupTitle": "Desk_Configurations"
8452   },
8453   {
8454     "type": "get",
8455     "url": "/api/integrations/desk/configurations/{id}/fields",
8456     "title": "Gets configurations fields",
8457     "examples": [
8458       {
8459         "title": "Example usage:",
8460         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8461         "type": "json"
8462       }
8463     ],
8464     "name": "getFields",
8465     "group": "Desk_Configurations",
8466     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8467     "version": "0.0.0",
8468     "filename": "server/api/intDeskConfiguration/index.js",
8469     "groupTitle": "Desk_Configurations"
8470   },
8471   {
8472     "type": "get",
8473     "url": "/api/integrations/desk/configurations/{id}/subjects",
8474     "title": "Gets configurations subjects",
8475     "examples": [
8476       {
8477         "title": "Example usage:",
8478         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8479         "type": "json"
8480       }
8481     ],
8482     "name": "getSubjects",
8483     "group": "Desk_Configurations",
8484     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8485     "version": "0.0.0",
8486     "filename": "server/api/intDeskConfiguration/index.js",
8487     "groupTitle": "Desk_Configurations"
8488   },
8489   {
8490     "type": "get",
8491     "url": "/api/integrations/desk/configurations/{id}/tags",
8492     "title": "Gets configurations tags",
8493     "examples": [
8494       {
8495         "title": "Example usage:",
8496         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8497         "type": "json"
8498       }
8499     ],
8500     "name": "getTags",
8501     "group": "Desk_Configurations",
8502     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8503     "version": "0.0.0",
8504     "filename": "server/api/intDeskConfiguration/index.js",
8505     "groupTitle": "Desk_Configurations"
8506   },
8507   {
8508     "type": "post",
8509     "url": "/api/integrations/desk/configurations/{id}/tags",
8510     "title": "Sets new tags",
8511     "examples": [
8512       {
8513         "title": "Example usage:",
8514         "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",
8515         "type": "json"
8516       }
8517     ],
8518     "name": "setTags",
8519     "group": "Desk_Configurations",
8520     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8521     "version": "0.0.0",
8522     "filename": "server/api/intDeskConfiguration/index.js",
8523     "groupTitle": "Desk_Configurations"
8524   },
8525   {
8526     "type": "put",
8527     "url": "/api/integrations/desk/configurations/{id}",
8528     "title": "Update an existing Desk Configuration",
8529     "examples": [
8530       {
8531         "title": "Example usage:",
8532         "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",
8533         "type": "json"
8534       }
8535     ],
8536     "name": "updateDesk_Configurations",
8537     "group": "Desk_Configurations",
8538     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8539     "version": "0.0.0",
8540     "filename": "server/api/intDeskConfiguration/index.js",
8541     "groupTitle": "Desk_Configurations"
8542   },
8543   {
8544     "type": "post",
8545     "url": "/api/integrations/desk/fields",
8546     "title": "Creates a new Desk Field",
8547     "examples": [
8548       {
8549         "title": "Example usage:",
8550         "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",
8551         "type": "json"
8552       }
8553     ],
8554     "name": "CreateDesk_Fields",
8555     "group": "Desk_Fields",
8556     "parameter": {
8557       "fields": {
8558         "Body": [
8559           {
8560             "group": "Body",
8561             "type": "String",
8562             "allowedValues": [
8563               "\"string\"",
8564               "\"variable\"",
8565               "\"customVariable\"",
8566               "\"keyValue\"",
8567               "\"picklist\""
8568             ],
8569             "optional": true,
8570             "field": "type",
8571             "description": ""
8572           },
8573           {
8574             "group": "Body",
8575             "type": "String",
8576             "optional": true,
8577             "field": "content",
8578             "description": ""
8579           },
8580           {
8581             "group": "Body",
8582             "type": "String",
8583             "optional": true,
8584             "field": "key",
8585             "description": ""
8586           },
8587           {
8588             "group": "Body",
8589             "type": "String",
8590             "allowedValues": [
8591               "\"string\"",
8592               "\"variable\"",
8593               "\"customVariable\""
8594             ],
8595             "optional": true,
8596             "field": "keyType",
8597             "description": ""
8598           },
8599           {
8600             "group": "Body",
8601             "type": "String",
8602             "optional": true,
8603             "field": "keyContent",
8604             "description": ""
8605           },
8606           {
8607             "group": "Body",
8608             "type": "String",
8609             "optional": true,
8610             "field": "idField",
8611             "description": ""
8612           },
8613           {
8614             "group": "Body",
8615             "type": "String",
8616             "optional": true,
8617             "field": "nameField",
8618             "description": ""
8619           },
8620           {
8621             "group": "Body",
8622             "type": "Boolean",
8623             "optional": true,
8624             "field": "customField",
8625             "description": ""
8626           },
8627           {
8628             "group": "Body",
8629             "type": "String",
8630             "optional": true,
8631             "field": "variableName",
8632             "description": ""
8633           }
8634         ]
8635       }
8636     },
8637     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8638     "version": "0.0.0",
8639     "filename": "server/api/intDeskField/index.js",
8640     "groupTitle": "Desk_Fields"
8641   },
8642   {
8643     "type": "delete",
8644     "url": "/api/integrations/desk/fields/{id}",
8645     "title": "Deletes a Desk Field",
8646     "examples": [
8647       {
8648         "title": "Example usage:",
8649         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8650         "type": "json"
8651       }
8652     ],
8653     "name": "DeleteDesk_Fields",
8654     "group": "Desk_Fields",
8655     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8656     "version": "0.0.0",
8657     "filename": "server/api/intDeskField/index.js",
8658     "groupTitle": "Desk_Fields"
8659   },
8660   {
8661     "type": "get",
8662     "url": "/api/integrations/desk/fields",
8663     "title": "Gets a list of Desk Fields",
8664     "examples": [
8665       {
8666         "title": "Example usage:",
8667         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8668         "type": "json"
8669       }
8670     ],
8671     "name": "GetDesk_Fields",
8672     "group": "Desk_Fields",
8673     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8674     "version": "0.0.0",
8675     "filename": "server/api/intDeskField/index.js",
8676     "groupTitle": "Desk_Fields"
8677   },
8678   {
8679     "type": "get",
8680     "url": "/api/integrations/desk/fields/{id}",
8681     "title": "Gets a single Desk Field",
8682     "examples": [
8683       {
8684         "title": "Example usage:",
8685         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8686         "type": "json"
8687       }
8688     ],
8689     "name": "ShowDesk_Fields",
8690     "group": "Desk_Fields",
8691     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8692     "version": "0.0.0",
8693     "filename": "server/api/intDeskField/index.js",
8694     "groupTitle": "Desk_Fields"
8695   },
8696   {
8697     "type": "put",
8698     "url": "/api/integrations/desk/fields/{id}",
8699     "title": "Update an existing Desk Field",
8700     "examples": [
8701       {
8702         "title": "Example usage:",
8703         "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",
8704         "type": "json"
8705       }
8706     ],
8707     "name": "updateDesk_Fields",
8708     "group": "Desk_Fields",
8709     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8710     "version": "0.0.0",
8711     "filename": "server/api/intDeskField/index.js",
8712     "groupTitle": "Desk_Fields"
8713   },
8714   {
8715     "type": "post",
8716     "url": "/api/dispositions",
8717     "title": "Creates a new Disposition",
8718     "examples": [
8719       {
8720         "title": "Example usage:",
8721         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8722         "type": "json"
8723       }
8724     ],
8725     "name": "CreateDispositions",
8726     "group": "Dispositions",
8727     "parameter": {
8728       "fields": {
8729         "Body": [
8730           {
8731             "group": "Body",
8732             "type": "String",
8733             "optional": false,
8734             "field": "name",
8735             "description": ""
8736           },
8737           {
8738             "group": "Body",
8739             "type": "String",
8740             "allowedValues": [
8741               "\"first\"",
8742               "\"second\"",
8743               "\"third\""
8744             ],
8745             "optional": false,
8746             "field": "level",
8747             "description": ""
8748           },
8749           {
8750             "group": "Body",
8751             "type": "String",
8752             "optional": true,
8753             "field": "description",
8754             "description": ""
8755           }
8756         ]
8757       }
8758     },
8759     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8760     "version": "0.0.0",
8761     "filename": "server/api/disposition/index.js",
8762     "groupTitle": "Dispositions"
8763   },
8764   {
8765     "type": "delete",
8766     "url": "/api/dispositions/{id}",
8767     "title": "Deletes a Disposition",
8768     "examples": [
8769       {
8770         "title": "Example usage:",
8771         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8772         "type": "json"
8773       }
8774     ],
8775     "name": "DeleteDispositions",
8776     "group": "Dispositions",
8777     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8778     "version": "0.0.0",
8779     "filename": "server/api/disposition/index.js",
8780     "groupTitle": "Dispositions"
8781   },
8782   {
8783     "type": "get",
8784     "url": "/api/dispositions",
8785     "title": "Gets a list of Dispositions",
8786     "examples": [
8787       {
8788         "title": "Example usage:",
8789         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8790         "type": "json"
8791       }
8792     ],
8793     "name": "GetDispositions",
8794     "group": "Dispositions",
8795     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8796     "version": "0.0.0",
8797     "filename": "server/api/disposition/index.js",
8798     "groupTitle": "Dispositions"
8799   },
8800   {
8801     "type": "get",
8802     "url": "/api/dispositions/{id}",
8803     "title": "Gets a single Disposition",
8804     "examples": [
8805       {
8806         "title": "Example usage:",
8807         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8808         "type": "json"
8809       }
8810     ],
8811     "name": "ShowDispositions",
8812     "group": "Dispositions",
8813     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8814     "version": "0.0.0",
8815     "filename": "server/api/disposition/index.js",
8816     "groupTitle": "Dispositions"
8817   },
8818   {
8819     "type": "put",
8820     "url": "/api/dispositions/{id}",
8821     "title": "Update an existing Disposition",
8822     "examples": [
8823       {
8824         "title": "Example usage:",
8825         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8826         "type": "json"
8827       }
8828     ],
8829     "name": "updateDispositions",
8830     "group": "Dispositions",
8831     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8832     "version": "0.0.0",
8833     "filename": "server/api/disposition/index.js",
8834     "groupTitle": "Dispositions"
8835   },
8836   {
8837     "type": "post",
8838     "url": "/api/integrations/dynamics365/accounts",
8839     "title": "Creates a new Dynamics365 Account",
8840     "examples": [
8841       {
8842         "title": "Example usage:",
8843         "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",
8844         "type": "json"
8845       }
8846     ],
8847     "name": "CreateDynamics365_Accounts",
8848     "group": "Dynamics365_Accounts",
8849     "parameter": {
8850       "fields": {
8851         "Body": [
8852           {
8853             "group": "Body",
8854             "type": "String",
8855             "optional": true,
8856             "field": "name",
8857             "description": ""
8858           },
8859           {
8860             "group": "Body",
8861             "type": "String",
8862             "optional": true,
8863             "field": "username",
8864             "description": ""
8865           },
8866           {
8867             "group": "Body",
8868             "type": "String",
8869             "optional": true,
8870             "field": "password",
8871             "description": ""
8872           },
8873           {
8874             "group": "Body",
8875             "type": "String",
8876             "optional": true,
8877             "field": "remoteUri",
8878             "description": ""
8879           },
8880           {
8881             "group": "Body",
8882             "type": "String",
8883             "optional": true,
8884             "field": "tenantId",
8885             "description": ""
8886           },
8887           {
8888             "group": "Body",
8889             "type": "String",
8890             "optional": true,
8891             "field": "clientId",
8892             "description": ""
8893           },
8894           {
8895             "group": "Body",
8896             "type": "String",
8897             "optional": true,
8898             "field": "clientSecret",
8899             "description": ""
8900           },
8901           {
8902             "group": "Body",
8903             "type": "String",
8904             "optional": false,
8905             "field": "serverUrl",
8906             "description": ""
8907           },
8908           {
8909             "group": "Body",
8910             "type": "String",
8911             "optional": true,
8912             "field": "description",
8913             "description": ""
8914           }
8915         ]
8916       }
8917     },
8918     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8919     "version": "0.0.0",
8920     "filename": "server/api/intDynamics365Account/index.js",
8921     "groupTitle": "Dynamics365_Accounts"
8922   },
8923   {
8924     "type": "delete",
8925     "url": "/api/integrations/dynamics365/accounts/{id}",
8926     "title": "Deletes a Dynamics365 Account",
8927     "examples": [
8928       {
8929         "title": "Example usage:",
8930         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8931         "type": "json"
8932       }
8933     ],
8934     "name": "DeleteDynamics365_Accounts",
8935     "group": "Dynamics365_Accounts",
8936     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8937     "version": "0.0.0",
8938     "filename": "server/api/intDynamics365Account/index.js",
8939     "groupTitle": "Dynamics365_Accounts"
8940   },
8941   {
8942     "type": "get",
8943     "url": "/api/integrations/dynamics365/accounts",
8944     "title": "Gets a list of Dynamics365 Accounts",
8945     "examples": [
8946       {
8947         "title": "Example usage:",
8948         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8949         "type": "json"
8950       }
8951     ],
8952     "name": "GetDynamics365_Accounts",
8953     "group": "Dynamics365_Accounts",
8954     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8955     "version": "0.0.0",
8956     "filename": "server/api/intDynamics365Account/index.js",
8957     "groupTitle": "Dynamics365_Accounts"
8958   },
8959   {
8960     "type": "get",
8961     "url": "/api/integrations/dynamics365/accounts/{id}",
8962     "title": "Gets a single Dynamics365 Account",
8963     "examples": [
8964       {
8965         "title": "Example usage:",
8966         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8967         "type": "json"
8968       }
8969     ],
8970     "name": "ShowDynamics365_Accounts",
8971     "group": "Dynamics365_Accounts",
8972     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8973     "version": "0.0.0",
8974     "filename": "server/api/intDynamics365Account/index.js",
8975     "groupTitle": "Dynamics365_Accounts"
8976   },
8977   {
8978     "type": "post",
8979     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8980     "title": "Creates new configuration",
8981     "examples": [
8982       {
8983         "title": "Example usage:",
8984         "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",
8985         "type": "json"
8986       }
8987     ],
8988     "name": "addConfiguration",
8989     "group": "Dynamics365_Accounts",
8990     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8991     "version": "0.0.0",
8992     "filename": "server/api/intDynamics365Account/index.js",
8993     "groupTitle": "Dynamics365_Accounts"
8994   },
8995   {
8996     "type": "get",
8997     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8998     "title": "Gets account configurations",
8999     "examples": [
9000       {
9001         "title": "Example usage:",
9002         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9003         "type": "json"
9004       }
9005     ],
9006     "name": "getConfigurations",
9007     "group": "Dynamics365_Accounts",
9008     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9009     "version": "0.0.0",
9010     "filename": "server/api/intDynamics365Account/index.js",
9011     "groupTitle": "Dynamics365_Accounts"
9012   },
9013   {
9014     "type": "get",
9015     "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9016     "title": "Gets account fields",
9017     "examples": [
9018       {
9019         "title": "Example usage:",
9020         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9021         "type": "json"
9022       }
9023     ],
9024     "name": "getFields",
9025     "group": "Dynamics365_Accounts",
9026     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9027     "version": "0.0.0",
9028     "filename": "server/api/intDynamics365Account/index.js",
9029     "groupTitle": "Dynamics365_Accounts"
9030   },
9031   {
9032     "type": "put",
9033     "url": "/api/integrations/dynamics365/accounts/{id}",
9034     "title": "Update an existing Dynamics365 Account",
9035     "examples": [
9036       {
9037         "title": "Example usage:",
9038         "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",
9039         "type": "json"
9040       }
9041     ],
9042     "name": "updateDynamics365_Accounts",
9043     "group": "Dynamics365_Accounts",
9044     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9045     "version": "0.0.0",
9046     "filename": "server/api/intDynamics365Account/index.js",
9047     "groupTitle": "Dynamics365_Accounts"
9048   },
9049   {
9050     "type": "post",
9051     "url": "/api/integrations/dynamics365/configurations",
9052     "title": "Creates a new Dynamics365 Configuration",
9053     "examples": [
9054       {
9055         "title": "Example usage:",
9056         "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",
9057         "type": "json"
9058       }
9059     ],
9060     "name": "CreateDynamics365_Configurations",
9061     "group": "Dynamics365_Configurations",
9062     "parameter": {
9063       "fields": {
9064         "Body": [
9065           {
9066             "group": "Body",
9067             "type": "String",
9068             "optional": true,
9069             "field": "name",
9070             "description": ""
9071           },
9072           {
9073             "group": "Body",
9074             "type": "String",
9075             "optional": true,
9076             "field": "description",
9077             "description": ""
9078           },
9079           {
9080             "group": "Body",
9081             "type": "String",
9082             "allowedValues": [
9083               "\"incident\"",
9084               "\"phonecall\""
9085             ],
9086             "optional": true,
9087             "field": "ticketType",
9088             "description": ""
9089           }
9090         ]
9091       }
9092     },
9093     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9094     "version": "0.0.0",
9095     "filename": "server/api/intDynamics365Configuration/index.js",
9096     "groupTitle": "Dynamics365_Configurations"
9097   },
9098   {
9099     "type": "delete",
9100     "url": "/api/integrations/dynamics365/configurations/{id}",
9101     "title": "Deletes a Dynamics365 Configuration",
9102     "examples": [
9103       {
9104         "title": "Example usage:",
9105         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9106         "type": "json"
9107       }
9108     ],
9109     "name": "DeleteDynamics365_Configurations",
9110     "group": "Dynamics365_Configurations",
9111     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9112     "version": "0.0.0",
9113     "filename": "server/api/intDynamics365Configuration/index.js",
9114     "groupTitle": "Dynamics365_Configurations"
9115   },
9116   {
9117     "type": "get",
9118     "url": "/api/integrations/dynamics365/configurations",
9119     "title": "Gets a list of Dynamics365 Configurations",
9120     "examples": [
9121       {
9122         "title": "Example usage:",
9123         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9124         "type": "json"
9125       }
9126     ],
9127     "name": "GetDynamics365_Configurations",
9128     "group": "Dynamics365_Configurations",
9129     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9130     "version": "0.0.0",
9131     "filename": "server/api/intDynamics365Configuration/index.js",
9132     "groupTitle": "Dynamics365_Configurations"
9133   },
9134   {
9135     "type": "get",
9136     "url": "/api/integrations/dynamics365/configurations/{id}",
9137     "title": "Gets a single Dynamics365 Configuration",
9138     "examples": [
9139       {
9140         "title": "Example usage:",
9141         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9142         "type": "json"
9143       }
9144     ],
9145     "name": "ShowDynamics365_Configurations",
9146     "group": "Dynamics365_Configurations",
9147     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9148     "version": "0.0.0",
9149     "filename": "server/api/intDynamics365Configuration/index.js",
9150     "groupTitle": "Dynamics365_Configurations"
9151   },
9152   {
9153     "type": "get",
9154     "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9155     "title": "Gets configurations descriptions",
9156     "examples": [
9157       {
9158         "title": "Example usage:",
9159         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9160         "type": "json"
9161       }
9162     ],
9163     "name": "getDescriptions",
9164     "group": "Dynamics365_Configurations",
9165     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9166     "version": "0.0.0",
9167     "filename": "server/api/intDynamics365Configuration/index.js",
9168     "groupTitle": "Dynamics365_Configurations"
9169   },
9170   {
9171     "type": "get",
9172     "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9173     "title": "Gets configurations fields",
9174     "examples": [
9175       {
9176         "title": "Example usage:",
9177         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9178         "type": "json"
9179       }
9180     ],
9181     "name": "getFields",
9182     "group": "Dynamics365_Configurations",
9183     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9184     "version": "0.0.0",
9185     "filename": "server/api/intDynamics365Configuration/index.js",
9186     "groupTitle": "Dynamics365_Configurations"
9187   },
9188   {
9189     "type": "get",
9190     "url": "/api/integrations/zoho/configurations/{id}/subjects",
9191     "title": "Gets configurations subjects",
9192     "examples": [
9193       {
9194         "title": "Example usage:",
9195         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9196         "type": "json"
9197       }
9198     ],
9199     "name": "getSubjects",
9200     "group": "Dynamics365_Configurations",
9201     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9202     "version": "0.0.0",
9203     "filename": "server/api/intDynamics365Configuration/index.js",
9204     "groupTitle": "Dynamics365_Configurations"
9205   },
9206   {
9207     "type": "put",
9208     "url": "/api/integrations/dynamics365/configurations/{id}",
9209     "title": "Update an existing Dynamics365 Configuration",
9210     "examples": [
9211       {
9212         "title": "Example usage:",
9213         "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",
9214         "type": "json"
9215       }
9216     ],
9217     "name": "updateDynamics365_Configurations",
9218     "group": "Dynamics365_Configurations",
9219     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9220     "version": "0.0.0",
9221     "filename": "server/api/intDynamics365Configuration/index.js",
9222     "groupTitle": "Dynamics365_Configurations"
9223   },
9224   {
9225     "type": "post",
9226     "url": "/api/integrations/dynamics365/fields",
9227     "title": "Creates a new Dynamics365 Field",
9228     "examples": [
9229       {
9230         "title": "Example usage:",
9231         "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",
9232         "type": "json"
9233       }
9234     ],
9235     "name": "CreateDynamics365_Fields",
9236     "group": "Dynamics365_Fields",
9237     "parameter": {
9238       "fields": {
9239         "Body": [
9240           {
9241             "group": "Body",
9242             "type": "String",
9243             "allowedValues": [
9244               "\"string\"",
9245               "\"variable\"",
9246               "\"customVariable\"",
9247               "\"keyValue\"",
9248               "\"picklist\""
9249             ],
9250             "optional": true,
9251             "field": "type",
9252             "description": ""
9253           },
9254           {
9255             "group": "Body",
9256             "type": "String",
9257             "optional": true,
9258             "field": "content",
9259             "description": ""
9260           },
9261           {
9262             "group": "Body",
9263             "type": "String",
9264             "optional": true,
9265             "field": "key",
9266             "description": ""
9267           },
9268           {
9269             "group": "Body",
9270             "type": "String",
9271             "allowedValues": [
9272               "\"string\"",
9273               "\"variable\"",
9274               "\"customVariable\""
9275             ],
9276             "optional": true,
9277             "field": "keyType",
9278             "description": ""
9279           },
9280           {
9281             "group": "Body",
9282             "type": "String",
9283             "optional": true,
9284             "field": "keyContent",
9285             "description": ""
9286           },
9287           {
9288             "group": "Body",
9289             "type": "String",
9290             "optional": true,
9291             "field": "idField",
9292             "description": ""
9293           },
9294           {
9295             "group": "Body",
9296             "type": "String",
9297             "optional": true,
9298             "field": "nameField",
9299             "description": ""
9300           },
9301           {
9302             "group": "Body",
9303             "type": "Boolean",
9304             "optional": true,
9305             "field": "customField",
9306             "description": ""
9307           },
9308           {
9309             "group": "Body",
9310             "type": "String",
9311             "optional": true,
9312             "field": "variableName",
9313             "description": ""
9314           }
9315         ]
9316       }
9317     },
9318     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9319     "version": "0.0.0",
9320     "filename": "server/api/intDynamics365Field/index.js",
9321     "groupTitle": "Dynamics365_Fields"
9322   },
9323   {
9324     "type": "delete",
9325     "url": "/api/integrations/dynamics365/fields/{id}",
9326     "title": "Deletes a Dynamics365 Field",
9327     "examples": [
9328       {
9329         "title": "Example usage:",
9330         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9331         "type": "json"
9332       }
9333     ],
9334     "name": "DeleteDynamics365_Fields",
9335     "group": "Dynamics365_Fields",
9336     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9337     "version": "0.0.0",
9338     "filename": "server/api/intDynamics365Field/index.js",
9339     "groupTitle": "Dynamics365_Fields"
9340   },
9341   {
9342     "type": "get",
9343     "url": "/api/integrations/dynamics365/fields",
9344     "title": "Gets a list of Dynamics365 Fields",
9345     "examples": [
9346       {
9347         "title": "Example usage:",
9348         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9349         "type": "json"
9350       }
9351     ],
9352     "name": "GetDynamics365_Fields",
9353     "group": "Dynamics365_Fields",
9354     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9355     "version": "0.0.0",
9356     "filename": "server/api/intDynamics365Field/index.js",
9357     "groupTitle": "Dynamics365_Fields"
9358   },
9359   {
9360     "type": "get",
9361     "url": "/api/integrations/dynamics365/fields/{id}",
9362     "title": "Gets a single Dynamics365 Field",
9363     "examples": [
9364       {
9365         "title": "Example usage:",
9366         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9367         "type": "json"
9368       }
9369     ],
9370     "name": "ShowDynamics365_Fields",
9371     "group": "Dynamics365_Fields",
9372     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9373     "version": "0.0.0",
9374     "filename": "server/api/intDynamics365Field/index.js",
9375     "groupTitle": "Dynamics365_Fields"
9376   },
9377   {
9378     "type": "put",
9379     "url": "/api/integrations/dynamics365/fields/{id}",
9380     "title": "Update an existing Dynamics365 Field",
9381     "examples": [
9382       {
9383         "title": "Example usage:",
9384         "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",
9385         "type": "json"
9386       }
9387     ],
9388     "name": "updateDynamics365_Fields",
9389     "group": "Dynamics365_Fields",
9390     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9391     "version": "0.0.0",
9392     "filename": "server/api/intDynamics365Field/index.js",
9393     "groupTitle": "Dynamics365_Fields"
9394   },
9395   {
9396     "type": "post",
9397     "url": "/api/fax/accounts/{id}/users",
9398     "title": "Add agents to a fax account",
9399     "examples": [
9400       {
9401         "title": "Example usage:",
9402         "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",
9403         "type": "json"
9404       }
9405     ],
9406     "name": "AddAgents",
9407     "group": "Fax_Accounts",
9408     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9409     "version": "0.0.0",
9410     "filename": "server/api/faxAccount/index.js",
9411     "groupTitle": "Fax_Accounts"
9412   },
9413   {
9414     "type": "post",
9415     "url": "/api/fax/accounts",
9416     "title": "Creates a new Account",
9417     "examples": [
9418       {
9419         "title": "Example usage:",
9420         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9421         "type": "json"
9422       }
9423     ],
9424     "name": "CreateAccounts",
9425     "group": "Fax_Accounts",
9426     "parameter": {
9427       "fields": {
9428         "Body": [
9429           {
9430             "group": "Body",
9431             "type": "String",
9432             "optional": false,
9433             "field": "name",
9434             "description": ""
9435           },
9436           {
9437             "group": "Body",
9438             "type": "String",
9439             "optional": true,
9440             "field": "description",
9441             "description": ""
9442           },
9443           {
9444             "group": "Body",
9445             "type": "String",
9446             "allowedValues": [
9447               "\"yes\"",
9448               "\"no\""
9449             ],
9450             "optional": true,
9451             "field": "ecm",
9452             "description": ""
9453           },
9454           {
9455             "group": "Body",
9456             "type": "String",
9457             "optional": true,
9458             "field": "headerinfo",
9459             "description": ""
9460           },
9461           {
9462             "group": "Body",
9463             "type": "String",
9464             "optional": true,
9465             "field": "localstationid",
9466             "description": ""
9467           },
9468           {
9469             "group": "Body",
9470             "type": "String",
9471             "allowedValues": [
9472               "\"2400\"",
9473               "\"4800\"",
9474               "\"7200\"",
9475               "\"9600\"",
9476               "\"12000\"",
9477               "\"14400\""
9478             ],
9479             "optional": true,
9480             "field": "minrate",
9481             "description": ""
9482           },
9483           {
9484             "group": "Body",
9485             "type": "String",
9486             "allowedValues": [
9487               "\"2400\"",
9488               "\"4800\"",
9489               "\"7200\"",
9490               "\"9600\"",
9491               "\"12000\"",
9492               "\"14400\""
9493             ],
9494             "optional": true,
9495             "field": "maxrate",
9496             "description": ""
9497           },
9498           {
9499             "group": "Body",
9500             "type": "String",
9501             "optional": true,
9502             "field": "modem",
9503             "description": ""
9504           },
9505           {
9506             "group": "Body",
9507             "type": "String",
9508             "optional": true,
9509             "field": "gateway",
9510             "description": ""
9511           },
9512           {
9513             "group": "Body",
9514             "type": "String",
9515             "optional": true,
9516             "field": "faxdetect",
9517             "description": ""
9518           },
9519           {
9520             "group": "Body",
9521             "type": "Integer",
9522             "optional": true,
9523             "field": "t38timeout",
9524             "description": ""
9525           },
9526           {
9527             "group": "Body",
9528             "type": "String",
9529             "allowedValues": [
9530               "\"SIP\"",
9531               "\"IAX\"",
9532               "\"DADHI\"",
9533               "\"KHOMP\""
9534             ],
9535             "optional": true,
9536             "field": "tech",
9537             "description": ""
9538           },
9539           {
9540             "group": "Body",
9541             "type": "String",
9542             "optional": false,
9543             "field": "key",
9544             "description": ""
9545           },
9546           {
9547             "group": "Body",
9548             "type": "Text",
9549             "optional": true,
9550             "field": "notificationTemplate",
9551             "description": ""
9552           },
9553           {
9554             "group": "Body",
9555             "type": "Boolean",
9556             "optional": true,
9557             "field": "notificationSound",
9558             "description": ""
9559           },
9560           {
9561             "group": "Body",
9562             "type": "Boolean",
9563             "optional": true,
9564             "field": "notificationShake",
9565             "description": ""
9566           },
9567           {
9568             "group": "Body",
9569             "type": "Integer",
9570             "optional": true,
9571             "field": "waitForTheAssignedAgent",
9572             "description": ""
9573           },
9574           {
9575             "group": "Body",
9576             "type": "Boolean",
9577             "optional": true,
9578             "field": "queueTransfer",
9579             "description": ""
9580           },
9581           {
9582             "group": "Body",
9583             "type": "Integer",
9584             "optional": true,
9585             "field": "queueTransferTimeout",
9586             "description": ""
9587           },
9588           {
9589             "group": "Body",
9590             "type": "Boolean",
9591             "optional": true,
9592             "field": "agentTransfer",
9593             "description": ""
9594           },
9595           {
9596             "group": "Body",
9597             "type": "Integer",
9598             "optional": true,
9599             "field": "agentTransferTimeout",
9600             "description": ""
9601           },
9602           {
9603             "group": "Body",
9604             "type": "Integer",
9605             "optional": true,
9606             "field": "mandatoryDispositionPauseId",
9607             "description": "<p>Status to put when mandatory disposition is enabled</p>"
9608           },
9609           {
9610             "group": "Body",
9611             "type": "Boolean",
9612             "optional": true,
9613             "field": "mandatoryDisposition",
9614             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9615           }
9616         ]
9617       }
9618     },
9619     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9620     "version": "0.0.0",
9621     "filename": "server/api/faxAccount/index.js",
9622     "groupTitle": "Fax_Accounts"
9623   },
9624   {
9625     "type": "delete",
9626     "url": "/api/fax/accounts/{id}",
9627     "title": "Deletes a Account",
9628     "examples": [
9629       {
9630         "title": "Example usage:",
9631         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9632         "type": "json"
9633       }
9634     ],
9635     "name": "DeleteAccounts",
9636     "group": "Fax_Accounts",
9637     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9638     "version": "0.0.0",
9639     "filename": "server/api/faxAccount/index.js",
9640     "groupTitle": "Fax_Accounts"
9641   },
9642   {
9643     "type": "get",
9644     "url": "/api/fax/accounts/describe",
9645     "title": "Gets table info about Accounts",
9646     "examples": [
9647       {
9648         "title": "Example usage:",
9649         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9650         "type": "json"
9651       }
9652     ],
9653     "name": "DescribeAccounts",
9654     "group": "Fax_Accounts",
9655     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9656     "version": "0.0.0",
9657     "filename": "server/api/faxAccount/index.js",
9658     "groupTitle": "Fax_Accounts"
9659   },
9660   {
9661     "type": "get",
9662     "url": "/api/fax/accounts",
9663     "title": "Gets a list of Accounts",
9664     "examples": [
9665       {
9666         "title": "Example usage:",
9667         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9668         "type": "json"
9669       }
9670     ],
9671     "name": "GetAccounts",
9672     "group": "Fax_Accounts",
9673     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9674     "version": "0.0.0",
9675     "filename": "server/api/faxAccount/index.js",
9676     "groupTitle": "Fax_Accounts"
9677   },
9678   {
9679     "type": "get",
9680     "url": "/api/fax/accounts/{id}/users",
9681     "title": "Gets agents from fax account",
9682     "examples": [
9683       {
9684         "title": "Example usage:",
9685         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9686         "type": "json"
9687       }
9688     ],
9689     "name": "GetAgents",
9690     "group": "Fax_Accounts",
9691     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9692     "version": "0.0.0",
9693     "filename": "server/api/faxAccount/index.js",
9694     "groupTitle": "Fax_Accounts"
9695   },
9696   {
9697     "type": "delete",
9698     "url": "/api/fax/accounts/{id}/users",
9699     "title": "Removes agents from a fax account",
9700     "examples": [
9701       {
9702         "title": "Example usage:",
9703         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9704         "type": "json"
9705       }
9706     ],
9707     "name": "RemoveAgents",
9708     "group": "Fax_Accounts",
9709     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9710     "version": "0.0.0",
9711     "filename": "server/api/faxAccount/index.js",
9712     "groupTitle": "Fax_Accounts"
9713   },
9714   {
9715     "type": "delete",
9716     "url": "/api/fax/accounts/{id}/canned_answers",
9717     "title": "Removes canned answers from account",
9718     "examples": [
9719       {
9720         "title": "Example usage:",
9721         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9722         "type": "json"
9723       }
9724     ],
9725     "name": "RemoveAnswers",
9726     "group": "Fax_Accounts",
9727     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9728     "version": "0.0.0",
9729     "filename": "server/api/faxAccount/index.js",
9730     "groupTitle": "Fax_Accounts"
9731   },
9732   {
9733     "type": "delete",
9734     "url": "/api/fax/accounts/{id}/dispositions",
9735     "title": "Removes dispositions from account",
9736     "examples": [
9737       {
9738         "title": "Example usage:",
9739         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9740         "type": "json"
9741       }
9742     ],
9743     "name": "RemoveDispositions",
9744     "group": "Fax_Accounts",
9745     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9746     "version": "0.0.0",
9747     "filename": "server/api/faxAccount/index.js",
9748     "groupTitle": "Fax_Accounts"
9749   },
9750   {
9751     "type": "get",
9752     "url": "/api/fax/accounts/{id}",
9753     "title": "Gets a single Account",
9754     "examples": [
9755       {
9756         "title": "Example usage:",
9757         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9758         "type": "json"
9759       }
9760     ],
9761     "name": "ShowAccounts",
9762     "group": "Fax_Accounts",
9763     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9764     "version": "0.0.0",
9765     "filename": "server/api/faxAccount/index.js",
9766     "groupTitle": "Fax_Accounts"
9767   },
9768   {
9769     "type": "post",
9770     "url": "/api/fax/accounts/{id}/canned_answers",
9771     "title": "Creates new canned answer",
9772     "examples": [
9773       {
9774         "title": "Example usage:",
9775         "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",
9776         "type": "json"
9777       }
9778     ],
9779     "name": "addAnswer",
9780     "group": "Fax_Accounts",
9781     "parameter": {
9782       "fields": {
9783         "Body": [
9784           {
9785             "group": "Body",
9786             "type": "String",
9787             "optional": false,
9788             "field": "key",
9789             "description": ""
9790           },
9791           {
9792             "group": "Body",
9793             "type": "Text",
9794             "optional": false,
9795             "field": "value",
9796             "description": ""
9797           },
9798           {
9799             "group": "Body",
9800             "type": "String",
9801             "optional": true,
9802             "field": "description",
9803             "description": ""
9804           },
9805           {
9806             "group": "Body",
9807             "type": "Virtual",
9808             "optional": true,
9809             "field": "name",
9810             "description": ""
9811           }
9812         ]
9813       }
9814     },
9815     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9816     "version": "0.0.0",
9817     "filename": "server/api/faxAccount/index.js",
9818     "groupTitle": "Fax_Accounts"
9819   },
9820   {
9821     "type": "post",
9822     "url": "/api/fax/accounts/addaccountapplications",
9823     "title": "Creates new account and applications",
9824     "examples": [
9825       {
9826         "title": "Example usage:",
9827         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9828         "type": "json"
9829       }
9830     ],
9831     "name": "addApplications",
9832     "group": "Fax_Accounts",
9833     "parameter": {
9834       "fields": {
9835         "Body": [
9836           {
9837             "group": "Body",
9838             "type": "Integer",
9839             "optional": false,
9840             "field": "priority",
9841             "description": ""
9842           },
9843           {
9844             "group": "Body",
9845             "type": "String",
9846             "optional": false,
9847             "field": "app",
9848             "description": ""
9849           },
9850           {
9851             "group": "Body",
9852             "type": "Text",
9853             "optional": true,
9854             "field": "appdata",
9855             "description": ""
9856           },
9857           {
9858             "group": "Body",
9859             "type": "String",
9860             "optional": true,
9861             "field": "description",
9862             "description": ""
9863           },
9864           {
9865             "group": "Body",
9866             "type": "String",
9867             "optional": true,
9868             "field": "interval",
9869             "description": ""
9870           }
9871         ]
9872       }
9873     },
9874     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9875     "version": "0.0.0",
9876     "filename": "server/api/faxAccount/index.js",
9877     "groupTitle": "Fax_Accounts"
9878   },
9879   {
9880     "type": "post",
9881     "url": "/api/fax/accounts/{id}/applications",
9882     "title": "Creates new applications",
9883     "examples": [
9884       {
9885         "title": "Example usage:",
9886         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9887         "type": "json"
9888       }
9889     ],
9890     "name": "addApplications",
9891     "group": "Fax_Accounts",
9892     "parameter": {
9893       "fields": {
9894         "Body": [
9895           {
9896             "group": "Body",
9897             "type": "Integer",
9898             "optional": false,
9899             "field": "priority",
9900             "description": ""
9901           },
9902           {
9903             "group": "Body",
9904             "type": "String",
9905             "optional": false,
9906             "field": "app",
9907             "description": ""
9908           },
9909           {
9910             "group": "Body",
9911             "type": "Text",
9912             "optional": true,
9913             "field": "appdata",
9914             "description": ""
9915           },
9916           {
9917             "group": "Body",
9918             "type": "String",
9919             "optional": true,
9920             "field": "description",
9921             "description": ""
9922           },
9923           {
9924             "group": "Body",
9925             "type": "String",
9926             "optional": true,
9927             "field": "interval",
9928             "description": ""
9929           }
9930         ]
9931       }
9932     },
9933     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9934     "version": "0.0.0",
9935     "filename": "server/api/faxAccount/index.js",
9936     "groupTitle": "Fax_Accounts"
9937   },
9938   {
9939     "type": "post",
9940     "url": "/api/fax/accounts/{id}/dispositions",
9941     "title": "Creates new disposition",
9942     "examples": [
9943       {
9944         "title": "Example usage:",
9945         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9946         "type": "json"
9947       }
9948     ],
9949     "name": "addDisposition",
9950     "group": "Fax_Accounts",
9951     "parameter": {
9952       "fields": {
9953         "Body": [
9954           {
9955             "group": "Body",
9956             "type": "String",
9957             "optional": false,
9958             "field": "name",
9959             "description": ""
9960           },
9961           {
9962             "group": "Body",
9963             "type": "String",
9964             "allowedValues": [
9965               "\"first\"",
9966               "\"second\"",
9967               "\"third\""
9968             ],
9969             "optional": false,
9970             "field": "level",
9971             "description": ""
9972           },
9973           {
9974             "group": "Body",
9975             "type": "String",
9976             "optional": true,
9977             "field": "description",
9978             "description": ""
9979           }
9980         ]
9981       }
9982     },
9983     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9984     "version": "0.0.0",
9985     "filename": "server/api/faxAccount/index.js",
9986     "groupTitle": "Fax_Accounts"
9987   },
9988   {
9989     "type": "post",
9990     "url": "/api/fax/accounts/{id}/interactions",
9991     "title": "Creates new interactions",
9992     "examples": [
9993       {
9994         "title": "Example usage:",
9995         "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",
9996         "type": "json"
9997       }
9998     ],
9999     "name": "addInteraction",
10000     "group": "Fax_Accounts",
10001     "parameter": {
10002       "fields": {
10003         "Body": [
10004           {
10005             "group": "Body",
10006             "type": "Boolean",
10007             "optional": true,
10008             "field": "closed",
10009             "description": ""
10010           },
10011           {
10012             "group": "Body",
10013             "type": "String",
10014             "optional": true,
10015             "field": "closedAt",
10016             "description": ""
10017           },
10018           {
10019             "group": "Body",
10020             "type": "String",
10021             "optional": true,
10022             "field": "disposition",
10023             "description": ""
10024           },
10025           {
10026             "group": "Body",
10027             "type": "String",
10028             "optional": true,
10029             "field": "secondDisposition",
10030             "description": ""
10031           },
10032           {
10033             "group": "Body",
10034             "type": "String",
10035             "optional": true,
10036             "field": "thirdDisposition",
10037             "description": ""
10038           },
10039           {
10040             "group": "Body",
10041             "type": "String",
10042             "optional": true,
10043             "field": "note",
10044             "description": ""
10045           },
10046           {
10047             "group": "Body",
10048             "type": "String",
10049             "optional": true,
10050             "field": "read1stAt",
10051             "description": ""
10052           },
10053           {
10054             "group": "Body",
10055             "type": "String",
10056             "optional": true,
10057             "field": "fax",
10058             "description": ""
10059           },
10060           {
10061             "group": "Body",
10062             "type": "String",
10063             "allowedValues": [
10064               "\"in\"",
10065               "\"out\""
10066             ],
10067             "optional": false,
10068             "field": "firstMsgDirection",
10069             "description": ""
10070           },
10071           {
10072             "group": "Body",
10073             "type": "String",
10074             "optional": true,
10075             "field": "lastMsgAt",
10076             "description": ""
10077           },
10078           {
10079             "group": "Body",
10080             "type": "String",
10081             "allowedValues": [
10082               "\"in\"",
10083               "\"out\""
10084             ],
10085             "optional": false,
10086             "field": "lastMsgDirection",
10087             "description": ""
10088           }
10089         ]
10090       }
10091     },
10092     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10093     "version": "0.0.0",
10094     "filename": "server/api/faxAccount/index.js",
10095     "groupTitle": "Fax_Accounts"
10096   },
10097   {
10098     "type": "get",
10099     "url": "/api/fax/accounts/{id}/canned_answers",
10100     "title": "Gets account canned answers",
10101     "examples": [
10102       {
10103         "title": "Example usage:",
10104         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10105         "type": "json"
10106       }
10107     ],
10108     "name": "getAnswers",
10109     "group": "Fax_Accounts",
10110     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10111     "version": "0.0.0",
10112     "filename": "server/api/faxAccount/index.js",
10113     "groupTitle": "Fax_Accounts"
10114   },
10115   {
10116     "type": "get",
10117     "url": "/api/fax/accounts/{id}/applications",
10118     "title": "Gets account pplications",
10119     "examples": [
10120       {
10121         "title": "Example usage:",
10122         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10123         "type": "json"
10124       }
10125     ],
10126     "name": "getApplications",
10127     "group": "Fax_Accounts",
10128     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10129     "version": "0.0.0",
10130     "filename": "server/api/faxAccount/index.js",
10131     "groupTitle": "Fax_Accounts"
10132   },
10133   {
10134     "type": "get",
10135     "url": "/api/fax/accounts/{id}/dispositions",
10136     "title": "Gets account dispositions",
10137     "examples": [
10138       {
10139         "title": "Example usage:",
10140         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10141         "type": "json"
10142       }
10143     ],
10144     "name": "getDispositions",
10145     "group": "Fax_Accounts",
10146     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10147     "version": "0.0.0",
10148     "filename": "server/api/faxAccount/index.js",
10149     "groupTitle": "Fax_Accounts"
10150   },
10151   {
10152     "type": "get",
10153     "url": "/api/fax/accounts/{id}/interactions",
10154     "title": "Gets account interactions",
10155     "examples": [
10156       {
10157         "title": "Example usage:",
10158         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10159         "type": "json"
10160       }
10161     ],
10162     "name": "getInteraction",
10163     "group": "Fax_Accounts",
10164     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10165     "version": "0.0.0",
10166     "filename": "server/api/faxAccount/index.js",
10167     "groupTitle": "Fax_Accounts"
10168   },
10169   {
10170     "type": "get",
10171     "url": "/api/fax/accounts/{id}/messages",
10172     "title": "Gets account messages",
10173     "examples": [
10174       {
10175         "title": "Example usage:",
10176         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10177         "type": "json"
10178       }
10179     ],
10180     "name": "getMessages",
10181     "group": "Fax_Accounts",
10182     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10183     "version": "0.0.0",
10184     "filename": "server/api/faxAccount/index.js",
10185     "groupTitle": "Fax_Accounts"
10186   },
10187   {
10188     "type": "post",
10189     "url": "/api/fax/accounts/{id}/send",
10190     "title": "Send new fax",
10191     "examples": [
10192       {
10193         "title": "Example usage:",
10194         "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",
10195         "type": "json"
10196       }
10197     ],
10198     "name": "sendFax",
10199     "group": "Fax_Accounts",
10200     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10201     "version": "0.0.0",
10202     "filename": "server/api/faxAccount/index.js",
10203     "groupTitle": "Fax_Accounts"
10204   },
10205   {
10206     "type": "put",
10207     "url": "/api/fax/accounts/{id}",
10208     "title": "Update an existing Account",
10209     "examples": [
10210       {
10211         "title": "Example usage:",
10212         "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",
10213         "type": "json"
10214       }
10215     ],
10216     "name": "updateAccounts",
10217     "group": "Fax_Accounts",
10218     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10219     "version": "0.0.0",
10220     "filename": "server/api/faxAccount/index.js",
10221     "groupTitle": "Fax_Accounts"
10222   },
10223   {
10224     "type": "post",
10225     "url": "/api/fax/accounts/updateaccountapplications",
10226     "title": "Update account and applications",
10227     "examples": [
10228       {
10229         "title": "Example usage:",
10230         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10231         "type": "json"
10232       }
10233     ],
10234     "name": "updateApplications",
10235     "group": "Fax_Accounts",
10236     "parameter": {
10237       "fields": {
10238         "Body": [
10239           {
10240             "group": "Body",
10241             "type": "Integer",
10242             "optional": false,
10243             "field": "priority",
10244             "description": ""
10245           },
10246           {
10247             "group": "Body",
10248             "type": "String",
10249             "optional": false,
10250             "field": "app",
10251             "description": ""
10252           },
10253           {
10254             "group": "Body",
10255             "type": "Text",
10256             "optional": true,
10257             "field": "appdata",
10258             "description": ""
10259           },
10260           {
10261             "group": "Body",
10262             "type": "String",
10263             "optional": true,
10264             "field": "description",
10265             "description": ""
10266           },
10267           {
10268             "group": "Body",
10269             "type": "String",
10270             "optional": true,
10271             "field": "interval",
10272             "description": ""
10273           }
10274         ]
10275       }
10276     },
10277     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10278     "version": "0.0.0",
10279     "filename": "server/api/faxAccount/index.js",
10280     "groupTitle": "Fax_Accounts"
10281   },
10282   {
10283     "type": "post",
10284     "url": "/api/fax/applications",
10285     "title": "Creates a new Application",
10286     "examples": [
10287       {
10288         "title": "Example usage:",
10289         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10290         "type": "json"
10291       }
10292     ],
10293     "name": "CreateApplications",
10294     "group": "Fax_Applications",
10295     "parameter": {
10296       "fields": {
10297         "Body": [
10298           {
10299             "group": "Body",
10300             "type": "Integer",
10301             "optional": false,
10302             "field": "priority",
10303             "description": ""
10304           },
10305           {
10306             "group": "Body",
10307             "type": "String",
10308             "optional": false,
10309             "field": "app",
10310             "description": ""
10311           },
10312           {
10313             "group": "Body",
10314             "type": "Text",
10315             "optional": true,
10316             "field": "appdata",
10317             "description": ""
10318           },
10319           {
10320             "group": "Body",
10321             "type": "String",
10322             "optional": true,
10323             "field": "description",
10324             "description": ""
10325           },
10326           {
10327             "group": "Body",
10328             "type": "String",
10329             "optional": true,
10330             "field": "interval",
10331             "description": ""
10332           }
10333         ]
10334       }
10335     },
10336     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10337     "version": "0.0.0",
10338     "filename": "server/api/faxApplication/index.js",
10339     "groupTitle": "Fax_Applications"
10340   },
10341   {
10342     "type": "delete",
10343     "url": "/api/fax/applications/{id}",
10344     "title": "Deletes a Application",
10345     "examples": [
10346       {
10347         "title": "Example usage:",
10348         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10349         "type": "json"
10350       }
10351     ],
10352     "name": "DeleteApplications",
10353     "group": "Fax_Applications",
10354     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10355     "version": "0.0.0",
10356     "filename": "server/api/faxApplication/index.js",
10357     "groupTitle": "Fax_Applications"
10358   },
10359   {
10360     "type": "get",
10361     "url": "/api/fax/applications",
10362     "title": "Gets a list of Applications",
10363     "examples": [
10364       {
10365         "title": "Example usage:",
10366         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10367         "type": "json"
10368       }
10369     ],
10370     "name": "GetApplications",
10371     "group": "Fax_Applications",
10372     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10373     "version": "0.0.0",
10374     "filename": "server/api/faxApplication/index.js",
10375     "groupTitle": "Fax_Applications"
10376   },
10377   {
10378     "type": "get",
10379     "url": "/api/fax/applications/{id}",
10380     "title": "Gets a single Application",
10381     "examples": [
10382       {
10383         "title": "Example usage:",
10384         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10385         "type": "json"
10386       }
10387     ],
10388     "name": "ShowApplications",
10389     "group": "Fax_Applications",
10390     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10391     "version": "0.0.0",
10392     "filename": "server/api/faxApplication/index.js",
10393     "groupTitle": "Fax_Applications"
10394   },
10395   {
10396     "type": "put",
10397     "url": "/api/fax/applications/{id}",
10398     "title": "Update an existing Application",
10399     "examples": [
10400       {
10401         "title": "Example usage:",
10402         "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",
10403         "type": "json"
10404       }
10405     ],
10406     "name": "updateApplications",
10407     "group": "Fax_Applications",
10408     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10409     "version": "0.0.0",
10410     "filename": "server/api/faxApplication/index.js",
10411     "groupTitle": "Fax_Applications"
10412   },
10413   {
10414     "type": "post",
10415     "url": "/api/fax/interactions/{id}/tags",
10416     "title": "Add tags to the interaction",
10417     "examples": [
10418       {
10419         "title": "Example usage:",
10420         "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",
10421         "type": "json"
10422       }
10423     ],
10424     "name": "AddTags",
10425     "group": "Fax_Interactions",
10426     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10427     "version": "0.0.0",
10428     "filename": "server/api/faxInteraction/index.js",
10429     "groupTitle": "Fax_Interactions"
10430   },
10431   {
10432     "type": "post",
10433     "url": "/api/fax/interactions",
10434     "title": "Creates a new Interaction",
10435     "examples": [
10436       {
10437         "title": "Example usage:",
10438         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10439         "type": "json"
10440       }
10441     ],
10442     "name": "CreateInteractions",
10443     "group": "Fax_Interactions",
10444     "parameter": {
10445       "fields": {
10446         "Body": [
10447           {
10448             "group": "Body",
10449             "type": "Boolean",
10450             "optional": true,
10451             "field": "closed",
10452             "description": ""
10453           },
10454           {
10455             "group": "Body",
10456             "type": "String",
10457             "optional": true,
10458             "field": "closedAt",
10459             "description": ""
10460           },
10461           {
10462             "group": "Body",
10463             "type": "String",
10464             "optional": true,
10465             "field": "disposition",
10466             "description": ""
10467           },
10468           {
10469             "group": "Body",
10470             "type": "String",
10471             "optional": true,
10472             "field": "secondDisposition",
10473             "description": ""
10474           },
10475           {
10476             "group": "Body",
10477             "type": "String",
10478             "optional": true,
10479             "field": "thirdDisposition",
10480             "description": ""
10481           },
10482           {
10483             "group": "Body",
10484             "type": "String",
10485             "optional": true,
10486             "field": "note",
10487             "description": ""
10488           },
10489           {
10490             "group": "Body",
10491             "type": "String",
10492             "optional": true,
10493             "field": "read1stAt",
10494             "description": ""
10495           },
10496           {
10497             "group": "Body",
10498             "type": "String",
10499             "optional": true,
10500             "field": "fax",
10501             "description": ""
10502           },
10503           {
10504             "group": "Body",
10505             "type": "String",
10506             "allowedValues": [
10507               "\"in\"",
10508               "\"out\""
10509             ],
10510             "optional": false,
10511             "field": "firstMsgDirection",
10512             "description": ""
10513           },
10514           {
10515             "group": "Body",
10516             "type": "String",
10517             "optional": true,
10518             "field": "lastMsgAt",
10519             "description": ""
10520           },
10521           {
10522             "group": "Body",
10523             "type": "String",
10524             "allowedValues": [
10525               "\"in\"",
10526               "\"out\""
10527             ],
10528             "optional": false,
10529             "field": "lastMsgDirection",
10530             "description": ""
10531           }
10532         ]
10533       }
10534     },
10535     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10536     "version": "0.0.0",
10537     "filename": "server/api/faxInteraction/index.js",
10538     "groupTitle": "Fax_Interactions"
10539   },
10540   {
10541     "type": "delete",
10542     "url": "/api/fax/interactions/{id}",
10543     "title": "Deletes a Interaction",
10544     "examples": [
10545       {
10546         "title": "Example usage:",
10547         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10548         "type": "json"
10549       }
10550     ],
10551     "name": "DeleteInteractions",
10552     "group": "Fax_Interactions",
10553     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10554     "version": "0.0.0",
10555     "filename": "server/api/faxInteraction/index.js",
10556     "groupTitle": "Fax_Interactions"
10557   },
10558   {
10559     "type": "get",
10560     "url": "/api/fax/interactions/describe",
10561     "title": "Gets table info about Interactions",
10562     "examples": [
10563       {
10564         "title": "Example usage:",
10565         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10566         "type": "json"
10567       }
10568     ],
10569     "name": "DescribeInteractions",
10570     "group": "Fax_Interactions",
10571     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10572     "version": "0.0.0",
10573     "filename": "server/api/faxInteraction/index.js",
10574     "groupTitle": "Fax_Interactions"
10575   },
10576   {
10577     "type": "get",
10578     "url": "/api/fax/interactions",
10579     "title": "Gets a list of Interactions",
10580     "examples": [
10581       {
10582         "title": "Example usage:",
10583         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10584         "type": "json"
10585       }
10586     ],
10587     "name": "GetInteractions",
10588     "group": "Fax_Interactions",
10589     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10590     "version": "0.0.0",
10591     "filename": "server/api/faxInteraction/index.js",
10592     "groupTitle": "Fax_Interactions"
10593   },
10594   {
10595     "type": "delete",
10596     "url": "/api/fax/interactions/{id}/tags",
10597     "title": "Removes tags from interaction",
10598     "examples": [
10599       {
10600         "title": "Example usage:",
10601         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10602         "type": "json"
10603       }
10604     ],
10605     "name": "RemoveTags",
10606     "group": "Fax_Interactions",
10607     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10608     "version": "0.0.0",
10609     "filename": "server/api/faxInteraction/index.js",
10610     "groupTitle": "Fax_Interactions"
10611   },
10612   {
10613     "type": "get",
10614     "url": "/api/fax/interactions/{id}",
10615     "title": "Gets a single Interaction",
10616     "examples": [
10617       {
10618         "title": "Example usage:",
10619         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10620         "type": "json"
10621       }
10622     ],
10623     "name": "ShowInteractions",
10624     "group": "Fax_Interactions",
10625     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10626     "version": "0.0.0",
10627     "filename": "server/api/faxInteraction/index.js",
10628     "groupTitle": "Fax_Interactions"
10629   },
10630   {
10631     "type": "post",
10632     "url": "/api/fax/interactions/{id}/messages",
10633     "title": "Creates new messages",
10634     "examples": [
10635       {
10636         "title": "Example usage:",
10637         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10638         "type": "json"
10639       }
10640     ],
10641     "name": "addMessage",
10642     "group": "Fax_Interactions",
10643     "parameter": {
10644       "fields": {
10645         "Body": [
10646           {
10647             "group": "Body",
10648             "type": "Text",
10649             "optional": false,
10650             "field": "body",
10651             "description": ""
10652           },
10653           {
10654             "group": "Body",
10655             "type": "Boolean",
10656             "optional": true,
10657             "field": "read",
10658             "description": ""
10659           },
10660           {
10661             "group": "Body",
10662             "type": "String",
10663             "allowedValues": [
10664               "\"in\"",
10665               "\"out\""
10666             ],
10667             "optional": false,
10668             "field": "direction",
10669             "description": ""
10670           },
10671           {
10672             "group": "Body",
10673             "type": "Text",
10674             "optional": true,
10675             "field": "failMessage",
10676             "description": ""
10677           },
10678           {
10679             "group": "Body",
10680             "type": "String",
10681             "optional": true,
10682             "field": "readAt",
10683             "description": ""
10684           }
10685         ]
10686       }
10687     },
10688     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10689     "version": "0.0.0",
10690     "filename": "server/api/faxInteraction/index.js",
10691     "groupTitle": "Fax_Interactions"
10692   },
10693   {
10694     "type": "get",
10695     "url": "/api/fax/interactions/{id}/download",
10696     "title": "Get interactions",
10697     "examples": [
10698       {
10699         "title": "Example usage:",
10700         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10701         "type": "json"
10702       }
10703     ],
10704     "name": "download",
10705     "group": "Fax_Interactions",
10706     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10707     "version": "0.0.0",
10708     "filename": "server/api/faxInteraction/index.js",
10709     "groupTitle": "Fax_Interactions"
10710   },
10711   {
10712     "type": "get",
10713     "url": "/api/fax/interactions/{id}/messages",
10714     "title": "Gets interaction messages",
10715     "examples": [
10716       {
10717         "title": "Example usage:",
10718         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10719         "type": "json"
10720       }
10721     ],
10722     "name": "getMessages",
10723     "group": "Fax_Interactions",
10724     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10725     "version": "0.0.0",
10726     "filename": "server/api/faxInteraction/index.js",
10727     "groupTitle": "Fax_Interactions"
10728   },
10729   {
10730     "type": "put",
10731     "url": "/api/fax/interactions/{id}",
10732     "title": "Update an existing Interaction",
10733     "examples": [
10734       {
10735         "title": "Example usage:",
10736         "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",
10737         "type": "json"
10738       }
10739     ],
10740     "name": "updateInteractions",
10741     "group": "Fax_Interactions",
10742     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10743     "version": "0.0.0",
10744     "filename": "server/api/faxInteraction/index.js",
10745     "groupTitle": "Fax_Interactions"
10746   },
10747   {
10748     "type": "get",
10749     "url": "/api/fax/messages/{id}/download",
10750     "title": "Get message",
10751     "examples": [
10752       {
10753         "title": "Example usage:",
10754         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10755         "type": "json"
10756       }
10757     ],
10758     "name": "download",
10759     "group": "Fax_Message",
10760     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10761     "version": "0.0.0",
10762     "filename": "server/api/faxMessage/index.js",
10763     "groupTitle": "Fax_Message"
10764   },
10765   {
10766     "type": "delete",
10767     "url": "/api/fax/messages/{id}",
10768     "title": "Deletes a Message",
10769     "examples": [
10770       {
10771         "title": "Example usage:",
10772         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10773         "type": "json"
10774       }
10775     ],
10776     "name": "DeleteMessages",
10777     "group": "Fax_Messages",
10778     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10779     "version": "0.0.0",
10780     "filename": "server/api/faxMessage/index.js",
10781     "groupTitle": "Fax_Messages"
10782   },
10783   {
10784     "type": "get",
10785     "url": "/api/fax/messages/describe",
10786     "title": "Gets table info about Messages",
10787     "examples": [
10788       {
10789         "title": "Example usage:",
10790         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10791         "type": "json"
10792       }
10793     ],
10794     "name": "DescribeMessages",
10795     "group": "Fax_Messages",
10796     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10797     "version": "0.0.0",
10798     "filename": "server/api/faxMessage/index.js",
10799     "groupTitle": "Fax_Messages"
10800   },
10801   {
10802     "type": "get",
10803     "url": "/api/fax/messages",
10804     "title": "Gets a list of Messages",
10805     "examples": [
10806       {
10807         "title": "Example usage:",
10808         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10809         "type": "json"
10810       }
10811     ],
10812     "name": "GetMessages",
10813     "group": "Fax_Messages",
10814     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10815     "version": "0.0.0",
10816     "filename": "server/api/faxMessage/index.js",
10817     "groupTitle": "Fax_Messages"
10818   },
10819   {
10820     "type": "get",
10821     "url": "/api/fax/messages/{id}",
10822     "title": "Gets a single Message",
10823     "examples": [
10824       {
10825         "title": "Example usage:",
10826         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10827         "type": "json"
10828       }
10829     ],
10830     "name": "ShowMessages",
10831     "group": "Fax_Messages",
10832     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10833     "version": "0.0.0",
10834     "filename": "server/api/faxMessage/index.js",
10835     "groupTitle": "Fax_Messages"
10836   },
10837   {
10838     "type": "put",
10839     "url": "/api/fax/messages/{id}/accept",
10840     "title": "Accepts message",
10841     "examples": [
10842       {
10843         "title": "Example usage:",
10844         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10845         "type": "json"
10846       }
10847     ],
10848     "name": "acceptMessage",
10849     "group": "Fax_Messages",
10850     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10851     "version": "0.0.0",
10852     "filename": "server/api/faxMessage/index.js",
10853     "groupTitle": "Fax_Messages"
10854   },
10855   {
10856     "type": "post",
10857     "url": "/api/fax/messages",
10858     "title": "Create message and send Fax",
10859     "examples": [
10860       {
10861         "title": "Example usage:",
10862         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10863         "type": "json"
10864       }
10865     ],
10866     "name": "rejectMessage",
10867     "group": "Fax_Messages",
10868     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10869     "version": "0.0.0",
10870     "filename": "server/api/faxMessage/index.js",
10871     "groupTitle": "Fax_Messages"
10872   },
10873   {
10874     "type": "put",
10875     "url": "/api/fax/messages/{id}/reject",
10876     "title": "Rejects message",
10877     "examples": [
10878       {
10879         "title": "Example usage:",
10880         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10881         "type": "json"
10882       }
10883     ],
10884     "name": "rejectMessage",
10885     "group": "Fax_Messages",
10886     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10887     "version": "0.0.0",
10888     "filename": "server/api/faxMessage/index.js",
10889     "groupTitle": "Fax_Messages"
10890   },
10891   {
10892     "type": "put",
10893     "url": "/api/fax/messages/{id}",
10894     "title": "Update an existing Message",
10895     "examples": [
10896       {
10897         "title": "Example usage:",
10898         "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",
10899         "type": "json"
10900       }
10901     ],
10902     "name": "updateMessages",
10903     "group": "Fax_Messages",
10904     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10905     "version": "0.0.0",
10906     "filename": "server/api/faxMessage/index.js",
10907     "groupTitle": "Fax_Messages"
10908   },
10909   {
10910     "type": "post",
10911     "url": "/api/fax/reports/queue",
10912     "title": "Creates a new Fax Queue Report",
10913     "examples": [
10914       {
10915         "title": "Example usage:",
10916         "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",
10917         "type": "json"
10918       }
10919     ],
10920     "name": "CreateFax_Queue_Reports",
10921     "group": "Fax_Queue_Reports",
10922     "parameter": {
10923       "fields": {
10924         "Body": [
10925           {
10926             "group": "Body",
10927             "type": "String",
10928             "optional": false,
10929             "field": "uniqueid",
10930             "description": ""
10931           },
10932           {
10933             "group": "Body",
10934             "type": "String",
10935             "optional": true,
10936             "field": "from",
10937             "description": ""
10938           },
10939           {
10940             "group": "Body",
10941             "type": "String",
10942             "optional": true,
10943             "field": "joinAt",
10944             "description": ""
10945           },
10946           {
10947             "group": "Body",
10948             "type": "String",
10949             "optional": true,
10950             "field": "leaveAt",
10951             "description": ""
10952           },
10953           {
10954             "group": "Body",
10955             "type": "String",
10956             "optional": true,
10957             "field": "acceptAt",
10958             "description": ""
10959           },
10960           {
10961             "group": "Body",
10962             "type": "String",
10963             "optional": true,
10964             "field": "exitAt",
10965             "description": ""
10966           },
10967           {
10968             "group": "Body",
10969             "type": "String",
10970             "optional": true,
10971             "field": "reason",
10972             "description": ""
10973           }
10974         ]
10975       }
10976     },
10977     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10978     "version": "0.0.0",
10979     "filename": "server/api/faxQueueReport/index.js",
10980     "groupTitle": "Fax_Queue_Reports"
10981   },
10982   {
10983     "type": "delete",
10984     "url": "/api/fax/reports/queue/{id}",
10985     "title": "Deletes a Fax Queue Report",
10986     "examples": [
10987       {
10988         "title": "Example usage:",
10989         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
10990         "type": "json"
10991       }
10992     ],
10993     "name": "DeleteFax_Queue_Reports",
10994     "group": "Fax_Queue_Reports",
10995     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10996     "version": "0.0.0",
10997     "filename": "server/api/faxQueueReport/index.js",
10998     "groupTitle": "Fax_Queue_Reports"
10999   },
11000   {
11001     "type": "get",
11002     "url": "/api/fax/reports/queue/describe",
11003     "title": "Gets table info about Fax Queue Reports",
11004     "examples": [
11005       {
11006         "title": "Example usage:",
11007         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11008         "type": "json"
11009       }
11010     ],
11011     "name": "DescribeFax_Queue_Reports",
11012     "group": "Fax_Queue_Reports",
11013     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11014     "version": "0.0.0",
11015     "filename": "server/api/faxQueueReport/index.js",
11016     "groupTitle": "Fax_Queue_Reports"
11017   },
11018   {
11019     "type": "get",
11020     "url": "/api/fax/reports/queue",
11021     "title": "Gets a list of Fax Queue Reports",
11022     "examples": [
11023       {
11024         "title": "Example usage:",
11025         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11026         "type": "json"
11027       }
11028     ],
11029     "name": "GetFax_Queue_Reports",
11030     "group": "Fax_Queue_Reports",
11031     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11032     "version": "0.0.0",
11033     "filename": "server/api/faxQueueReport/index.js",
11034     "groupTitle": "Fax_Queue_Reports"
11035   },
11036   {
11037     "type": "get",
11038     "url": "/api/fax/reports/queue/{id}",
11039     "title": "Gets a single Fax Queue Report",
11040     "examples": [
11041       {
11042         "title": "Example usage:",
11043         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11044         "type": "json"
11045       }
11046     ],
11047     "name": "ShowFax_Queue_Reports",
11048     "group": "Fax_Queue_Reports",
11049     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11050     "version": "0.0.0",
11051     "filename": "server/api/faxQueueReport/index.js",
11052     "groupTitle": "Fax_Queue_Reports"
11053   },
11054   {
11055     "type": "put",
11056     "url": "/api/fax/reports/queue/{id}",
11057     "title": "Update an existing Fax Queue Report",
11058     "examples": [
11059       {
11060         "title": "Example usage:",
11061         "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",
11062         "type": "json"
11063       }
11064     ],
11065     "name": "updateFax_Queue_Reports",
11066     "group": "Fax_Queue_Reports",
11067     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11068     "version": "0.0.0",
11069     "filename": "server/api/faxQueueReport/index.js",
11070     "groupTitle": "Fax_Queue_Reports"
11071   },
11072   {
11073     "type": "post",
11074     "url": "/api/fax/queues/{id}/users",
11075     "title": "Add agents to a queue",
11076     "examples": [
11077       {
11078         "title": "Example usage:",
11079         "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",
11080         "type": "json"
11081       }
11082     ],
11083     "name": "AddAgents",
11084     "group": "Fax_Queues",
11085     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11086     "version": "0.0.0",
11087     "filename": "server/api/faxQueue/index.js",
11088     "groupTitle": "Fax_Queues"
11089   },
11090   {
11091     "type": "post",
11092     "url": "/api/fax/queues/{id}/teams",
11093     "title": "Add teams to a queue",
11094     "examples": [
11095       {
11096         "title": "Example usage:",
11097         "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",
11098         "type": "json"
11099       }
11100     ],
11101     "name": "AddTeams",
11102     "group": "Fax_Queues",
11103     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11104     "version": "0.0.0",
11105     "filename": "server/api/faxQueue/index.js",
11106     "groupTitle": "Fax_Queues"
11107   },
11108   {
11109     "type": "post",
11110     "url": "/api/fax/queues",
11111     "title": "Creates a new Queue",
11112     "examples": [
11113       {
11114         "title": "Example usage:",
11115         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11116         "type": "json"
11117       }
11118     ],
11119     "name": "CreateQueues",
11120     "group": "Fax_Queues",
11121     "parameter": {
11122       "fields": {
11123         "Body": [
11124           {
11125             "group": "Body",
11126             "type": "String",
11127             "optional": false,
11128             "field": "name",
11129             "description": ""
11130           },
11131           {
11132             "group": "Body",
11133             "type": "String",
11134             "optional": true,
11135             "field": "description",
11136             "description": ""
11137           },
11138           {
11139             "group": "Body",
11140             "type": "Integer",
11141             "optional": false,
11142             "field": "timeout",
11143             "description": ""
11144           },
11145           {
11146             "group": "Body",
11147             "type": "String",
11148             "allowedValues": [
11149               "\"rrmemory\"",
11150               "\"beepall\"",
11151               "\"roundrobin\""
11152             ],
11153             "optional": false,
11154             "field": "strategy",
11155             "description": ""
11156           },
11157           {
11158             "group": "Body",
11159             "type": "Integer",
11160             "optional": true,
11161             "field": "lastAgent",
11162             "description": ""
11163           }
11164         ]
11165       }
11166     },
11167     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11168     "version": "0.0.0",
11169     "filename": "server/api/faxQueue/index.js",
11170     "groupTitle": "Fax_Queues"
11171   },
11172   {
11173     "type": "delete",
11174     "url": "/api/fax/queues/{id}",
11175     "title": "Deletes a Queue",
11176     "examples": [
11177       {
11178         "title": "Example usage:",
11179         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11180         "type": "json"
11181       }
11182     ],
11183     "name": "DeleteQueues",
11184     "group": "Fax_Queues",
11185     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11186     "version": "0.0.0",
11187     "filename": "server/api/faxQueue/index.js",
11188     "groupTitle": "Fax_Queues"
11189   },
11190   {
11191     "type": "get",
11192     "url": "/api/fax/queues/describe",
11193     "title": "Gets table info about Queues",
11194     "examples": [
11195       {
11196         "title": "Example usage:",
11197         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11198         "type": "json"
11199       }
11200     ],
11201     "name": "DescribeQueues",
11202     "group": "Fax_Queues",
11203     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11204     "version": "0.0.0",
11205     "filename": "server/api/faxQueue/index.js",
11206     "groupTitle": "Fax_Queues"
11207   },
11208   {
11209     "type": "get",
11210     "url": "/api/fax/queues/{id}/users",
11211     "title": "Gets queue agents",
11212     "examples": [
11213       {
11214         "title": "Example usage:",
11215         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11216         "type": "json"
11217       }
11218     ],
11219     "name": "GetAgents",
11220     "group": "Fax_Queues",
11221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11222     "version": "0.0.0",
11223     "filename": "server/api/faxQueue/index.js",
11224     "groupTitle": "Fax_Queues"
11225   },
11226   {
11227     "type": "get",
11228     "url": "/api/fax/queues/{id}/members",
11229     "title": "GetMembers",
11230     "examples": [
11231       {
11232         "title": "Example usage:",
11233         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
11234         "type": "json"
11235       }
11236     ],
11237     "name": "GetMembers",
11238     "group": "Fax_Queues",
11239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11240     "version": "0.0.0",
11241     "filename": "server/api/faxQueue/index.js",
11242     "groupTitle": "Fax_Queues"
11243   },
11244   {
11245     "type": "get",
11246     "url": "/api/fax/queues",
11247     "title": "Gets a list of Queues",
11248     "examples": [
11249       {
11250         "title": "Example usage:",
11251         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11252         "type": "json"
11253       }
11254     ],
11255     "name": "GetQueues",
11256     "group": "Fax_Queues",
11257     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11258     "version": "0.0.0",
11259     "filename": "server/api/faxQueue/index.js",
11260     "groupTitle": "Fax_Queues"
11261   },
11262   {
11263     "type": "get",
11264     "url": "/api/fax/queues/{id}/teams",
11265     "title": "Gets queues list",
11266     "examples": [
11267       {
11268         "title": "Example usage:",
11269         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11270         "type": "json"
11271       }
11272     ],
11273     "name": "GetTeams",
11274     "group": "Fax_Queues",
11275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11276     "version": "0.0.0",
11277     "filename": "server/api/faxQueue/index.js",
11278     "groupTitle": "Fax_Queues"
11279   },
11280   {
11281     "type": "delete",
11282     "url": "/api/fax/queues/{id}/users",
11283     "title": "Removes agents from a queue",
11284     "examples": [
11285       {
11286         "title": "Example usage:",
11287         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11288         "type": "json"
11289       }
11290     ],
11291     "name": "RemoveAgents",
11292     "group": "Fax_Queues",
11293     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11294     "version": "0.0.0",
11295     "filename": "server/api/faxQueue/index.js",
11296     "groupTitle": "Fax_Queues"
11297   },
11298   {
11299     "type": "get",
11300     "url": "/api/fax/queues/{id}",
11301     "title": "Gets a single Queue",
11302     "examples": [
11303       {
11304         "title": "Example usage:",
11305         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11306         "type": "json"
11307       }
11308     ],
11309     "name": "ShowQueues",
11310     "group": "Fax_Queues",
11311     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11312     "version": "0.0.0",
11313     "filename": "server/api/faxQueue/index.js",
11314     "groupTitle": "Fax_Queues"
11315   },
11316   {
11317     "type": "put",
11318     "url": "/api/fax/queues/{id}",
11319     "title": "Update an existing Queue",
11320     "examples": [
11321       {
11322         "title": "Example usage:",
11323         "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",
11324         "type": "json"
11325       }
11326     ],
11327     "name": "updateQueues",
11328     "group": "Fax_Queues",
11329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11330     "version": "0.0.0",
11331     "filename": "server/api/faxQueue/index.js",
11332     "groupTitle": "Fax_Queues"
11333   },
11334   {
11335     "type": "post",
11336     "url": "/api/fax/reports/transfer",
11337     "title": "Creates a new Fax Transfer Report",
11338     "examples": [
11339       {
11340         "title": "Example usage:",
11341         "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",
11342         "type": "json"
11343       }
11344     ],
11345     "name": "CreateFax_Transfer_Reports",
11346     "group": "Fax_Transfer_Reports",
11347     "parameter": {
11348       "fields": {
11349         "Body": [
11350           {
11351             "group": "Body",
11352             "type": "String",
11353             "optional": false,
11354             "field": "uniqueid",
11355             "description": ""
11356           },
11357           {
11358             "group": "Body",
11359             "type": "String",
11360             "allowedValues": [
11361               "\"account\"",
11362               "\"agent\"",
11363               "\"queue\""
11364             ],
11365             "optional": false,
11366             "field": "type",
11367             "description": ""
11368           },
11369           {
11370             "group": "Body",
11371             "type": "String",
11372             "optional": false,
11373             "field": "transferredAt",
11374             "description": ""
11375           }
11376         ]
11377       }
11378     },
11379     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11380     "version": "0.0.0",
11381     "filename": "server/api/faxTransferReport/index.js",
11382     "groupTitle": "Fax_Transfer_Reports"
11383   },
11384   {
11385     "type": "delete",
11386     "url": "/api/fax/reports/transfer/{id}",
11387     "title": "Deletes a Fax Transfer Report",
11388     "examples": [
11389       {
11390         "title": "Example usage:",
11391         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11392         "type": "json"
11393       }
11394     ],
11395     "name": "DeleteFax_Transfer_Reports",
11396     "group": "Fax_Transfer_Reports",
11397     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11398     "version": "0.0.0",
11399     "filename": "server/api/faxTransferReport/index.js",
11400     "groupTitle": "Fax_Transfer_Reports"
11401   },
11402   {
11403     "type": "get",
11404     "url": "/api/fax/reports/transfer/describe",
11405     "title": "Gets table info about Fax Transfer Reports",
11406     "examples": [
11407       {
11408         "title": "Example usage:",
11409         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11410         "type": "json"
11411       }
11412     ],
11413     "name": "DescribeFax_Transfer_Reports",
11414     "group": "Fax_Transfer_Reports",
11415     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11416     "version": "0.0.0",
11417     "filename": "server/api/faxTransferReport/index.js",
11418     "groupTitle": "Fax_Transfer_Reports"
11419   },
11420   {
11421     "type": "get",
11422     "url": "/api/fax/reports/transfer",
11423     "title": "Gets a list of Fax Transfer Reports",
11424     "examples": [
11425       {
11426         "title": "Example usage:",
11427         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11428         "type": "json"
11429       }
11430     ],
11431     "name": "GetFax_Transfer_Reports",
11432     "group": "Fax_Transfer_Reports",
11433     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11434     "version": "0.0.0",
11435     "filename": "server/api/faxTransferReport/index.js",
11436     "groupTitle": "Fax_Transfer_Reports"
11437   },
11438   {
11439     "type": "get",
11440     "url": "/api/fax/reports/transfer/{id}",
11441     "title": "Gets a single Fax Transfer Report",
11442     "examples": [
11443       {
11444         "title": "Example usage:",
11445         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11446         "type": "json"
11447       }
11448     ],
11449     "name": "ShowFax_Transfer_Reports",
11450     "group": "Fax_Transfer_Reports",
11451     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11452     "version": "0.0.0",
11453     "filename": "server/api/faxTransferReport/index.js",
11454     "groupTitle": "Fax_Transfer_Reports"
11455   },
11456   {
11457     "type": "put",
11458     "url": "/api/fax/reports/transfer/{id}",
11459     "title": "Update an existing Fax Transfer Report",
11460     "examples": [
11461       {
11462         "title": "Example usage:",
11463         "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",
11464         "type": "json"
11465       }
11466     ],
11467     "name": "updateFax_Transfer_Reports",
11468     "group": "Fax_Transfer_Reports",
11469     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11470     "version": "0.0.0",
11471     "filename": "server/api/faxTransferReport/index.js",
11472     "groupTitle": "Fax_Transfer_Reports"
11473   },
11474   {
11475     "type": "post",
11476     "url": "/api/integrations/freshdesk/accounts",
11477     "title": "Creates a new Freshdesk Account",
11478     "examples": [
11479       {
11480         "title": "Example usage:",
11481         "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",
11482         "type": "json"
11483       }
11484     ],
11485     "name": "CreateFreshdesk_Accounts",
11486     "group": "Freshdesk_Accounts",
11487     "parameter": {
11488       "fields": {
11489         "Body": [
11490           {
11491             "group": "Body",
11492             "type": "String",
11493             "optional": true,
11494             "field": "name",
11495             "description": ""
11496           },
11497           {
11498             "group": "Body",
11499             "type": "String",
11500             "optional": true,
11501             "field": "description",
11502             "description": ""
11503           },
11504           {
11505             "group": "Body",
11506             "type": "String",
11507             "optional": true,
11508             "field": "username",
11509             "description": ""
11510           },
11511           {
11512             "group": "Body",
11513             "type": "String",
11514             "optional": true,
11515             "field": "apiKey",
11516             "description": ""
11517           },
11518           {
11519             "group": "Body",
11520             "type": "String",
11521             "optional": true,
11522             "field": "remoteUri",
11523             "description": ""
11524           },
11525           {
11526             "group": "Body",
11527             "type": "String",
11528             "optional": false,
11529             "field": "serverUrl",
11530             "description": ""
11531           }
11532         ]
11533       }
11534     },
11535     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11536     "version": "0.0.0",
11537     "filename": "server/api/intFreshdeskAccount/index.js",
11538     "groupTitle": "Freshdesk_Accounts"
11539   },
11540   {
11541     "type": "delete",
11542     "url": "/api/integrations/freshdesk/accounts/{id}",
11543     "title": "Deletes a Freshdesk Account",
11544     "examples": [
11545       {
11546         "title": "Example usage:",
11547         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11548         "type": "json"
11549       }
11550     ],
11551     "name": "DeleteFreshdesk_Accounts",
11552     "group": "Freshdesk_Accounts",
11553     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11554     "version": "0.0.0",
11555     "filename": "server/api/intFreshdeskAccount/index.js",
11556     "groupTitle": "Freshdesk_Accounts"
11557   },
11558   {
11559     "type": "get",
11560     "url": "/api/integrations/freshdesk/accounts",
11561     "title": "Gets a list of Freshdesk Accounts",
11562     "examples": [
11563       {
11564         "title": "Example usage:",
11565         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11566         "type": "json"
11567       }
11568     ],
11569     "name": "GetFreshdesk_Accounts",
11570     "group": "Freshdesk_Accounts",
11571     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11572     "version": "0.0.0",
11573     "filename": "server/api/intFreshdeskAccount/index.js",
11574     "groupTitle": "Freshdesk_Accounts"
11575   },
11576   {
11577     "type": "get",
11578     "url": "/api/integrations/freshdesk/accounts/{id}",
11579     "title": "Gets a single Freshdesk Account",
11580     "examples": [
11581       {
11582         "title": "Example usage:",
11583         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11584         "type": "json"
11585       }
11586     ],
11587     "name": "ShowFreshdesk_Accounts",
11588     "group": "Freshdesk_Accounts",
11589     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11590     "version": "0.0.0",
11591     "filename": "server/api/intFreshdeskAccount/index.js",
11592     "groupTitle": "Freshdesk_Accounts"
11593   },
11594   {
11595     "type": "post",
11596     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11597     "title": "Creates new configuration",
11598     "examples": [
11599       {
11600         "title": "Example usage:",
11601         "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",
11602         "type": "json"
11603       }
11604     ],
11605     "name": "addConfiguration",
11606     "group": "Freshdesk_Accounts",
11607     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11608     "version": "0.0.0",
11609     "filename": "server/api/intFreshdeskAccount/index.js",
11610     "groupTitle": "Freshdesk_Accounts"
11611   },
11612   {
11613     "type": "get",
11614     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11615     "title": "Gets account configurations",
11616     "examples": [
11617       {
11618         "title": "Example usage:",
11619         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11620         "type": "json"
11621       }
11622     ],
11623     "name": "getConfigurations",
11624     "group": "Freshdesk_Accounts",
11625     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11626     "version": "0.0.0",
11627     "filename": "server/api/intFreshdeskAccount/index.js",
11628     "groupTitle": "Freshdesk_Accounts"
11629   },
11630   {
11631     "type": "get",
11632     "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11633     "title": "Gets account fields",
11634     "examples": [
11635       {
11636         "title": "Example usage:",
11637         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11638         "type": "json"
11639       }
11640     ],
11641     "name": "getFields",
11642     "group": "Freshdesk_Accounts",
11643     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11644     "version": "0.0.0",
11645     "filename": "server/api/intFreshdeskAccount/index.js",
11646     "groupTitle": "Freshdesk_Accounts"
11647   },
11648   {
11649     "type": "put",
11650     "url": "/api/integrations/freshdesk/accounts/{id}",
11651     "title": "Update an existing Freshdesk Account",
11652     "examples": [
11653       {
11654         "title": "Example usage:",
11655         "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",
11656         "type": "json"
11657       }
11658     ],
11659     "name": "updateFreshdesk_Accounts",
11660     "group": "Freshdesk_Accounts",
11661     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11662     "version": "0.0.0",
11663     "filename": "server/api/intFreshdeskAccount/index.js",
11664     "groupTitle": "Freshdesk_Accounts"
11665   },
11666   {
11667     "type": "post",
11668     "url": "/api/integrations/freshdesk/configurations",
11669     "title": "Creates a new Freshdesk Configuration",
11670     "examples": [
11671       {
11672         "title": "Example usage:",
11673         "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",
11674         "type": "json"
11675       }
11676     ],
11677     "name": "CreateFreshdesk_Configurations",
11678     "group": "Freshdesk_Configurations",
11679     "parameter": {
11680       "fields": {
11681         "Body": [
11682           {
11683             "group": "Body",
11684             "type": "String",
11685             "optional": true,
11686             "field": "name",
11687             "description": ""
11688           },
11689           {
11690             "group": "Body",
11691             "type": "String",
11692             "optional": true,
11693             "field": "description",
11694             "description": ""
11695           }
11696         ]
11697       }
11698     },
11699     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11700     "version": "0.0.0",
11701     "filename": "server/api/intFreshdeskConfiguration/index.js",
11702     "groupTitle": "Freshdesk_Configurations"
11703   },
11704   {
11705     "type": "delete",
11706     "url": "/api/integrations/freshdesk/configurations/{id}",
11707     "title": "Deletes a Freshdesk Configuration",
11708     "examples": [
11709       {
11710         "title": "Example usage:",
11711         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11712         "type": "json"
11713       }
11714     ],
11715     "name": "DeleteFreshdesk_Configurations",
11716     "group": "Freshdesk_Configurations",
11717     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11718     "version": "0.0.0",
11719     "filename": "server/api/intFreshdeskConfiguration/index.js",
11720     "groupTitle": "Freshdesk_Configurations"
11721   },
11722   {
11723     "type": "get",
11724     "url": "/api/integrations/freshdesk/configurations",
11725     "title": "Gets a list of Freshdesk Configurations",
11726     "examples": [
11727       {
11728         "title": "Example usage:",
11729         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11730         "type": "json"
11731       }
11732     ],
11733     "name": "GetFreshdesk_Configurations",
11734     "group": "Freshdesk_Configurations",
11735     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11736     "version": "0.0.0",
11737     "filename": "server/api/intFreshdeskConfiguration/index.js",
11738     "groupTitle": "Freshdesk_Configurations"
11739   },
11740   {
11741     "type": "get",
11742     "url": "/api/integrations/freshdesk/configurations/{id}",
11743     "title": "Gets a single Freshdesk Configuration",
11744     "examples": [
11745       {
11746         "title": "Example usage:",
11747         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11748         "type": "json"
11749       }
11750     ],
11751     "name": "ShowFreshdesk_Configurations",
11752     "group": "Freshdesk_Configurations",
11753     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11754     "version": "0.0.0",
11755     "filename": "server/api/intFreshdeskConfiguration/index.js",
11756     "groupTitle": "Freshdesk_Configurations"
11757   },
11758   {
11759     "type": "get",
11760     "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11761     "title": "Gets configurations descriptions",
11762     "examples": [
11763       {
11764         "title": "Example usage:",
11765         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11766         "type": "json"
11767       }
11768     ],
11769     "name": "getDescriptions",
11770     "group": "Freshdesk_Configurations",
11771     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11772     "version": "0.0.0",
11773     "filename": "server/api/intFreshdeskConfiguration/index.js",
11774     "groupTitle": "Freshdesk_Configurations"
11775   },
11776   {
11777     "type": "get",
11778     "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11779     "title": "Gets configurations fields",
11780     "examples": [
11781       {
11782         "title": "Example usage:",
11783         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11784         "type": "json"
11785       }
11786     ],
11787     "name": "getFields",
11788     "group": "Freshdesk_Configurations",
11789     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11790     "version": "0.0.0",
11791     "filename": "server/api/intFreshdeskConfiguration/index.js",
11792     "groupTitle": "Freshdesk_Configurations"
11793   },
11794   {
11795     "type": "get",
11796     "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11797     "title": "Gets configurations subjects",
11798     "examples": [
11799       {
11800         "title": "Example usage:",
11801         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11802         "type": "json"
11803       }
11804     ],
11805     "name": "getSubjects",
11806     "group": "Freshdesk_Configurations",
11807     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11808     "version": "0.0.0",
11809     "filename": "server/api/intFreshdeskConfiguration/index.js",
11810     "groupTitle": "Freshdesk_Configurations"
11811   },
11812   {
11813     "type": "get",
11814     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11815     "title": "Gets configurations tags",
11816     "examples": [
11817       {
11818         "title": "Example usage:",
11819         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11820         "type": "json"
11821       }
11822     ],
11823     "name": "getTags",
11824     "group": "Freshdesk_Configurations",
11825     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11826     "version": "0.0.0",
11827     "filename": "server/api/intFreshdeskConfiguration/index.js",
11828     "groupTitle": "Freshdesk_Configurations"
11829   },
11830   {
11831     "type": "post",
11832     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11833     "title": "Sets new tags",
11834     "examples": [
11835       {
11836         "title": "Example usage:",
11837         "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",
11838         "type": "json"
11839       }
11840     ],
11841     "name": "setTags",
11842     "group": "Freshdesk_Configurations",
11843     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11844     "version": "0.0.0",
11845     "filename": "server/api/intFreshdeskConfiguration/index.js",
11846     "groupTitle": "Freshdesk_Configurations"
11847   },
11848   {
11849     "type": "put",
11850     "url": "/api/integrations/freshdesk/configurations/{id}",
11851     "title": "Update an existing Freshdesk Configuration",
11852     "examples": [
11853       {
11854         "title": "Example usage:",
11855         "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",
11856         "type": "json"
11857       }
11858     ],
11859     "name": "updateFreshdesk_Configurations",
11860     "group": "Freshdesk_Configurations",
11861     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11862     "version": "0.0.0",
11863     "filename": "server/api/intFreshdeskConfiguration/index.js",
11864     "groupTitle": "Freshdesk_Configurations"
11865   },
11866   {
11867     "type": "post",
11868     "url": "/api/integrations/freshdesk/fields",
11869     "title": "Creates a new Freshdesk Field",
11870     "examples": [
11871       {
11872         "title": "Example usage:",
11873         "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",
11874         "type": "json"
11875       }
11876     ],
11877     "name": "CreateFreshdesk_Fields",
11878     "group": "Freshdesk_Fields",
11879     "parameter": {
11880       "fields": {
11881         "Body": [
11882           {
11883             "group": "Body",
11884             "type": "String",
11885             "allowedValues": [
11886               "\"string\"",
11887               "\"variable\"",
11888               "\"customVariable\"",
11889               "\"keyValue\"",
11890               "\"picklist\""
11891             ],
11892             "optional": true,
11893             "field": "type",
11894             "description": ""
11895           },
11896           {
11897             "group": "Body",
11898             "type": "String",
11899             "optional": true,
11900             "field": "content",
11901             "description": ""
11902           },
11903           {
11904             "group": "Body",
11905             "type": "String",
11906             "optional": true,
11907             "field": "key",
11908             "description": ""
11909           },
11910           {
11911             "group": "Body",
11912             "type": "String",
11913             "allowedValues": [
11914               "\"string\"",
11915               "\"variable\"",
11916               "\"customVariable\""
11917             ],
11918             "optional": true,
11919             "field": "keyType",
11920             "description": ""
11921           },
11922           {
11923             "group": "Body",
11924             "type": "String",
11925             "optional": true,
11926             "field": "keyContent",
11927             "description": ""
11928           },
11929           {
11930             "group": "Body",
11931             "type": "String",
11932             "optional": true,
11933             "field": "idField",
11934             "description": ""
11935           },
11936           {
11937             "group": "Body",
11938             "type": "String",
11939             "optional": true,
11940             "field": "nameField",
11941             "description": ""
11942           },
11943           {
11944             "group": "Body",
11945             "type": "Boolean",
11946             "optional": true,
11947             "field": "customField",
11948             "description": ""
11949           },
11950           {
11951             "group": "Body",
11952             "type": "String",
11953             "optional": true,
11954             "field": "variableName",
11955             "description": ""
11956           }
11957         ]
11958       }
11959     },
11960     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11961     "version": "0.0.0",
11962     "filename": "server/api/intFreshdeskField/index.js",
11963     "groupTitle": "Freshdesk_Fields"
11964   },
11965   {
11966     "type": "delete",
11967     "url": "/api/integrations/freshdesk/fields/{id}",
11968     "title": "Deletes a Freshdesk Field",
11969     "examples": [
11970       {
11971         "title": "Example usage:",
11972         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11973         "type": "json"
11974       }
11975     ],
11976     "name": "DeleteFreshdesk_Fields",
11977     "group": "Freshdesk_Fields",
11978     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11979     "version": "0.0.0",
11980     "filename": "server/api/intFreshdeskField/index.js",
11981     "groupTitle": "Freshdesk_Fields"
11982   },
11983   {
11984     "type": "get",
11985     "url": "/api/integrations/freshdesk/fields",
11986     "title": "Gets a list of Freshdesk Fields",
11987     "examples": [
11988       {
11989         "title": "Example usage:",
11990         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
11991         "type": "json"
11992       }
11993     ],
11994     "name": "GetFreshdesk_Fields",
11995     "group": "Freshdesk_Fields",
11996     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11997     "version": "0.0.0",
11998     "filename": "server/api/intFreshdeskField/index.js",
11999     "groupTitle": "Freshdesk_Fields"
12000   },
12001   {
12002     "type": "get",
12003     "url": "/api/integrations/freshdesk/fields/{id}",
12004     "title": "Gets a single Freshdesk Field",
12005     "examples": [
12006       {
12007         "title": "Example usage:",
12008         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12009         "type": "json"
12010       }
12011     ],
12012     "name": "ShowFreshdesk_Fields",
12013     "group": "Freshdesk_Fields",
12014     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12015     "version": "0.0.0",
12016     "filename": "server/api/intFreshdeskField/index.js",
12017     "groupTitle": "Freshdesk_Fields"
12018   },
12019   {
12020     "type": "put",
12021     "url": "/api/integrations/freshdesk/fields/{id}",
12022     "title": "Update an existing Freshdesk Field",
12023     "examples": [
12024       {
12025         "title": "Example usage:",
12026         "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",
12027         "type": "json"
12028       }
12029     ],
12030     "name": "updateFreshdesk_Fields",
12031     "group": "Freshdesk_Fields",
12032     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12033     "version": "0.0.0",
12034     "filename": "server/api/intFreshdeskField/index.js",
12035     "groupTitle": "Freshdesk_Fields"
12036   },
12037   {
12038     "type": "post",
12039     "url": "/api/integrations/freshsales/accounts",
12040     "title": "Creates a new Freshsales Account",
12041     "examples": [
12042       {
12043         "title": "Example usage:",
12044         "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",
12045         "type": "json"
12046       }
12047     ],
12048     "name": "CreateFreshsales_Accounts",
12049     "group": "Freshsales_Accounts",
12050     "parameter": {
12051       "fields": {
12052         "Body": [
12053           {
12054             "group": "Body",
12055             "type": "String",
12056             "optional": true,
12057             "field": "name",
12058             "description": ""
12059           },
12060           {
12061             "group": "Body",
12062             "type": "String",
12063             "optional": true,
12064             "field": "description",
12065             "description": ""
12066           },
12067           {
12068             "group": "Body",
12069             "type": "String",
12070             "optional": true,
12071             "field": "username",
12072             "description": ""
12073           },
12074           {
12075             "group": "Body",
12076             "type": "String",
12077             "optional": true,
12078             "field": "apiKey",
12079             "description": ""
12080           },
12081           {
12082             "group": "Body",
12083             "type": "String",
12084             "optional": true,
12085             "field": "remoteUri",
12086             "description": ""
12087           },
12088           {
12089             "group": "Body",
12090             "type": "String",
12091             "optional": false,
12092             "field": "serverUrl",
12093             "description": ""
12094           }
12095         ]
12096       }
12097     },
12098     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12099     "version": "0.0.0",
12100     "filename": "server/api/intFreshsalesAccount/index.js",
12101     "groupTitle": "Freshsales_Accounts"
12102   },
12103   {
12104     "type": "delete",
12105     "url": "/api/integrations/freshsales/accounts/{id}",
12106     "title": "Deletes a Freshsales Account",
12107     "examples": [
12108       {
12109         "title": "Example usage:",
12110         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12111         "type": "json"
12112       }
12113     ],
12114     "name": "DeleteFreshsales_Accounts",
12115     "group": "Freshsales_Accounts",
12116     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12117     "version": "0.0.0",
12118     "filename": "server/api/intFreshsalesAccount/index.js",
12119     "groupTitle": "Freshsales_Accounts"
12120   },
12121   {
12122     "type": "get",
12123     "url": "/api/integrations/freshsales/accounts",
12124     "title": "Gets a list of Freshsales Accounts",
12125     "examples": [
12126       {
12127         "title": "Example usage:",
12128         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12129         "type": "json"
12130       }
12131     ],
12132     "name": "GetFreshsales_Accounts",
12133     "group": "Freshsales_Accounts",
12134     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12135     "version": "0.0.0",
12136     "filename": "server/api/intFreshsalesAccount/index.js",
12137     "groupTitle": "Freshsales_Accounts"
12138   },
12139   {
12140     "type": "get",
12141     "url": "/api/integrations/freshsales/accounts/{id}",
12142     "title": "Gets a single Freshsales Account",
12143     "examples": [
12144       {
12145         "title": "Example usage:",
12146         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12147         "type": "json"
12148       }
12149     ],
12150     "name": "ShowFreshsales_Accounts",
12151     "group": "Freshsales_Accounts",
12152     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12153     "version": "0.0.0",
12154     "filename": "server/api/intFreshsalesAccount/index.js",
12155     "groupTitle": "Freshsales_Accounts"
12156   },
12157   {
12158     "type": "post",
12159     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12160     "title": "Creates new configuration",
12161     "examples": [
12162       {
12163         "title": "Example usage:",
12164         "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",
12165         "type": "json"
12166       }
12167     ],
12168     "name": "addConfiguration",
12169     "group": "Freshsales_Accounts",
12170     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12171     "version": "0.0.0",
12172     "filename": "server/api/intFreshsalesAccount/index.js",
12173     "groupTitle": "Freshsales_Accounts"
12174   },
12175   {
12176     "type": "get",
12177     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12178     "title": "Gets account configurations",
12179     "examples": [
12180       {
12181         "title": "Example usage:",
12182         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12183         "type": "json"
12184       }
12185     ],
12186     "name": "getConfigurations",
12187     "group": "Freshsales_Accounts",
12188     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12189     "version": "0.0.0",
12190     "filename": "server/api/intFreshsalesAccount/index.js",
12191     "groupTitle": "Freshsales_Accounts"
12192   },
12193   {
12194     "type": "get",
12195     "url": "/api/integrations/freshsales/accounts/{id}/fields",
12196     "title": "Gets account fields",
12197     "examples": [
12198       {
12199         "title": "Example usage:",
12200         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12201         "type": "json"
12202       }
12203     ],
12204     "name": "getFields",
12205     "group": "Freshsales_Accounts",
12206     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12207     "version": "0.0.0",
12208     "filename": "server/api/intFreshsalesAccount/index.js",
12209     "groupTitle": "Freshsales_Accounts"
12210   },
12211   {
12212     "type": "put",
12213     "url": "/api/integrations/freshsales/accounts/{id}",
12214     "title": "Update an existing Freshsales Account",
12215     "examples": [
12216       {
12217         "title": "Example usage:",
12218         "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",
12219         "type": "json"
12220       }
12221     ],
12222     "name": "updateFreshsales_Accounts",
12223     "group": "Freshsales_Accounts",
12224     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12225     "version": "0.0.0",
12226     "filename": "server/api/intFreshsalesAccount/index.js",
12227     "groupTitle": "Freshsales_Accounts"
12228   },
12229   {
12230     "type": "post",
12231     "url": "/api/integrations/freshsales/configurations",
12232     "title": "Creates a new Freshsales Configuration",
12233     "examples": [
12234       {
12235         "title": "Example usage:",
12236         "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",
12237         "type": "json"
12238       }
12239     ],
12240     "name": "CreateFreshsales_Configurations",
12241     "group": "Freshsales_Configurations",
12242     "parameter": {
12243       "fields": {
12244         "Body": [
12245           {
12246             "group": "Body",
12247             "type": "String",
12248             "optional": true,
12249             "field": "name",
12250             "description": ""
12251           },
12252           {
12253             "group": "Body",
12254             "type": "String",
12255             "optional": true,
12256             "field": "description",
12257             "description": ""
12258           }
12259         ]
12260       }
12261     },
12262     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12263     "version": "0.0.0",
12264     "filename": "server/api/intFreshsalesConfiguration/index.js",
12265     "groupTitle": "Freshsales_Configurations"
12266   },
12267   {
12268     "type": "delete",
12269     "url": "/api/integrations/freshsales/configurations/{id}",
12270     "title": "Deletes a Freshsales Configuration",
12271     "examples": [
12272       {
12273         "title": "Example usage:",
12274         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12275         "type": "json"
12276       }
12277     ],
12278     "name": "DeleteFreshsales_Configurations",
12279     "group": "Freshsales_Configurations",
12280     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12281     "version": "0.0.0",
12282     "filename": "server/api/intFreshsalesConfiguration/index.js",
12283     "groupTitle": "Freshsales_Configurations"
12284   },
12285   {
12286     "type": "get",
12287     "url": "/api/integrations/freshsales/configurations",
12288     "title": "Gets a list of Freshsales Configurations",
12289     "examples": [
12290       {
12291         "title": "Example usage:",
12292         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12293         "type": "json"
12294       }
12295     ],
12296     "name": "GetFreshsales_Configurations",
12297     "group": "Freshsales_Configurations",
12298     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12299     "version": "0.0.0",
12300     "filename": "server/api/intFreshsalesConfiguration/index.js",
12301     "groupTitle": "Freshsales_Configurations"
12302   },
12303   {
12304     "type": "get",
12305     "url": "/api/integrations/freshsales/configurations/{id}",
12306     "title": "Gets a single Freshsales Configuration",
12307     "examples": [
12308       {
12309         "title": "Example usage:",
12310         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12311         "type": "json"
12312       }
12313     ],
12314     "name": "ShowFreshsales_Configurations",
12315     "group": "Freshsales_Configurations",
12316     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12317     "version": "0.0.0",
12318     "filename": "server/api/intFreshsalesConfiguration/index.js",
12319     "groupTitle": "Freshsales_Configurations"
12320   },
12321   {
12322     "type": "get",
12323     "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12324     "title": "Gets configurations descriptions",
12325     "examples": [
12326       {
12327         "title": "Example usage:",
12328         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12329         "type": "json"
12330       }
12331     ],
12332     "name": "getDescriptions",
12333     "group": "Freshsales_Configurations",
12334     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12335     "version": "0.0.0",
12336     "filename": "server/api/intFreshsalesConfiguration/index.js",
12337     "groupTitle": "Freshsales_Configurations"
12338   },
12339   {
12340     "type": "get",
12341     "url": "/api/integrations/freshsales/configurations/{id}/fields",
12342     "title": "Gets configurations fields",
12343     "examples": [
12344       {
12345         "title": "Example usage:",
12346         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12347         "type": "json"
12348       }
12349     ],
12350     "name": "getFields",
12351     "group": "Freshsales_Configurations",
12352     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12353     "version": "0.0.0",
12354     "filename": "server/api/intFreshsalesConfiguration/index.js",
12355     "groupTitle": "Freshsales_Configurations"
12356   },
12357   {
12358     "type": "get",
12359     "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12360     "title": "Gets configurations subjects",
12361     "examples": [
12362       {
12363         "title": "Example usage:",
12364         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12365         "type": "json"
12366       }
12367     ],
12368     "name": "getSubjects",
12369     "group": "Freshsales_Configurations",
12370     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12371     "version": "0.0.0",
12372     "filename": "server/api/intFreshsalesConfiguration/index.js",
12373     "groupTitle": "Freshsales_Configurations"
12374   },
12375   {
12376     "type": "put",
12377     "url": "/api/integrations/freshsales/configurations/{id}",
12378     "title": "Update an existing Freshsales Configuration",
12379     "examples": [
12380       {
12381         "title": "Example usage:",
12382         "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",
12383         "type": "json"
12384       }
12385     ],
12386     "name": "updateFreshsales_Configurations",
12387     "group": "Freshsales_Configurations",
12388     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12389     "version": "0.0.0",
12390     "filename": "server/api/intFreshsalesConfiguration/index.js",
12391     "groupTitle": "Freshsales_Configurations"
12392   },
12393   {
12394     "type": "post",
12395     "url": "/api/integrations/freshsales/fields",
12396     "title": "Creates a new Freshsales Field",
12397     "examples": [
12398       {
12399         "title": "Example usage:",
12400         "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",
12401         "type": "json"
12402       }
12403     ],
12404     "name": "CreateFreshsales_Fields",
12405     "group": "Freshsales_Fields",
12406     "parameter": {
12407       "fields": {
12408         "Body": [
12409           {
12410             "group": "Body",
12411             "type": "String",
12412             "allowedValues": [
12413               "\"string\"",
12414               "\"variable\"",
12415               "\"customVariable\"",
12416               "\"keyValue\"",
12417               "\"picklist\""
12418             ],
12419             "optional": true,
12420             "field": "type",
12421             "description": ""
12422           },
12423           {
12424             "group": "Body",
12425             "type": "String",
12426             "optional": true,
12427             "field": "content",
12428             "description": ""
12429           },
12430           {
12431             "group": "Body",
12432             "type": "String",
12433             "optional": true,
12434             "field": "key",
12435             "description": ""
12436           },
12437           {
12438             "group": "Body",
12439             "type": "String",
12440             "allowedValues": [
12441               "\"string\"",
12442               "\"variable\"",
12443               "\"customVariable\""
12444             ],
12445             "optional": true,
12446             "field": "keyType",
12447             "description": ""
12448           },
12449           {
12450             "group": "Body",
12451             "type": "String",
12452             "optional": true,
12453             "field": "keyContent",
12454             "description": ""
12455           },
12456           {
12457             "group": "Body",
12458             "type": "String",
12459             "optional": true,
12460             "field": "idField",
12461             "description": ""
12462           },
12463           {
12464             "group": "Body",
12465             "type": "String",
12466             "optional": true,
12467             "field": "nameField",
12468             "description": ""
12469           },
12470           {
12471             "group": "Body",
12472             "type": "Boolean",
12473             "optional": true,
12474             "field": "customField",
12475             "description": ""
12476           },
12477           {
12478             "group": "Body",
12479             "type": "String",
12480             "optional": true,
12481             "field": "variableName",
12482             "description": ""
12483           }
12484         ]
12485       }
12486     },
12487     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12488     "version": "0.0.0",
12489     "filename": "server/api/intFreshsalesField/index.js",
12490     "groupTitle": "Freshsales_Fields"
12491   },
12492   {
12493     "type": "delete",
12494     "url": "/api/integrations/freshsales/fields/{id}",
12495     "title": "Deletes a Freshsales Field",
12496     "examples": [
12497       {
12498         "title": "Example usage:",
12499         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12500         "type": "json"
12501       }
12502     ],
12503     "name": "DeleteFreshsales_Fields",
12504     "group": "Freshsales_Fields",
12505     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12506     "version": "0.0.0",
12507     "filename": "server/api/intFreshsalesField/index.js",
12508     "groupTitle": "Freshsales_Fields"
12509   },
12510   {
12511     "type": "get",
12512     "url": "/api/integrations/freshsales/fields",
12513     "title": "Gets a list of Freshsales Fields",
12514     "examples": [
12515       {
12516         "title": "Example usage:",
12517         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12518         "type": "json"
12519       }
12520     ],
12521     "name": "GetFreshsales_Fields",
12522     "group": "Freshsales_Fields",
12523     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12524     "version": "0.0.0",
12525     "filename": "server/api/intFreshsalesField/index.js",
12526     "groupTitle": "Freshsales_Fields"
12527   },
12528   {
12529     "type": "get",
12530     "url": "/api/integrations/freshsales/fields/{id}",
12531     "title": "Gets a single Freshsales Field",
12532     "examples": [
12533       {
12534         "title": "Example usage:",
12535         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12536         "type": "json"
12537       }
12538     ],
12539     "name": "ShowFreshsales_Fields",
12540     "group": "Freshsales_Fields",
12541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12542     "version": "0.0.0",
12543     "filename": "server/api/intFreshsalesField/index.js",
12544     "groupTitle": "Freshsales_Fields"
12545   },
12546   {
12547     "type": "put",
12548     "url": "/api/integrations/freshsales/fields/{id}",
12549     "title": "Update an existing Freshsales Field",
12550     "examples": [
12551       {
12552         "title": "Example usage:",
12553         "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",
12554         "type": "json"
12555       }
12556     ],
12557     "name": "updateFreshsales_Fields",
12558     "group": "Freshsales_Fields",
12559     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12560     "version": "0.0.0",
12561     "filename": "server/api/intFreshsalesField/index.js",
12562     "groupTitle": "Freshsales_Fields"
12563   },
12564   {
12565     "type": "post",
12566     "url": "/api/campaigns/{id}/blacklists",
12567     "title": "Add blacklists to an IVR campaign",
12568     "examples": [
12569       {
12570         "title": "Example usage:",
12571         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12572         "type": "json"
12573       }
12574     ],
12575     "name": "AddBlackLists",
12576     "group": "IVR_Campaigns",
12577     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12578     "version": "0.0.0",
12579     "filename": "server/api/campaign/index.js",
12580     "groupTitle": "IVR_Campaigns"
12581   },
12582   {
12583     "type": "post",
12584     "url": "/api/campaigns/{id}/lists",
12585     "title": "Add lists to an IVR campaign",
12586     "examples": [
12587       {
12588         "title": "Example usage:",
12589         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12590         "type": "json"
12591       }
12592     ],
12593     "name": "AddLists",
12594     "group": "IVR_Campaigns",
12595     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12596     "version": "0.0.0",
12597     "filename": "server/api/campaign/index.js",
12598     "groupTitle": "IVR_Campaigns"
12599   },
12600   {
12601     "type": "post",
12602     "url": "/api/campaigns/clone",
12603     "title": "Clone an existing IVR Campaign",
12604     "examples": [
12605       {
12606         "title": "Example usage:",
12607         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12608         "type": "json"
12609       }
12610     ],
12611     "name": "CloneIVR_Campaigns",
12612     "group": "IVR_Campaigns",
12613     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12614     "version": "0.0.0",
12615     "filename": "server/api/campaign/index.js",
12616     "groupTitle": "IVR_Campaigns"
12617   },
12618   {
12619     "type": "post",
12620     "url": "/api/campaigns",
12621     "title": "Creates a new IVR Campaign",
12622     "examples": [
12623       {
12624         "title": "Example usage:",
12625         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12626         "type": "json"
12627       }
12628     ],
12629     "name": "CreateIVR_Campaigns",
12630     "group": "IVR_Campaigns",
12631     "parameter": {
12632       "fields": {
12633         "Body": [
12634           {
12635             "group": "Body",
12636             "type": "String",
12637             "optional": false,
12638             "field": "name",
12639             "description": ""
12640           },
12641           {
12642             "group": "Body",
12643             "type": "String",
12644             "allowedValues": [
12645               "\"ivr\""
12646             ],
12647             "optional": false,
12648             "field": "type",
12649             "description": ""
12650           },
12651           {
12652             "group": "Body",
12653             "type": "String",
12654             "optional": true,
12655             "field": "description",
12656             "description": ""
12657           },
12658           {
12659             "group": "Body",
12660             "type": "Boolean",
12661             "optional": true,
12662             "field": "active",
12663             "description": "<p>Active/Disactive Campaign</p>"
12664           },
12665           {
12666             "group": "Body",
12667             "type": "Integer",
12668             "optional": true,
12669             "field": "limitCalls",
12670             "description": "<p>Max 200 calls.</p>"
12671           },
12672           {
12673             "group": "Body",
12674             "type": "String",
12675             "optional": true,
12676             "field": "dialOriginateCallerIdName",
12677             "description": ""
12678           },
12679           {
12680             "group": "Body",
12681             "type": "String",
12682             "optional": true,
12683             "field": "dialOriginateCallerIdNumber",
12684             "description": ""
12685           },
12686           {
12687             "group": "Body",
12688             "type": "Integer",
12689             "optional": true,
12690             "field": "dialOriginateTimeout",
12691             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12692           },
12693           {
12694             "group": "Body",
12695             "type": "Integer",
12696             "optional": true,
12697             "field": "dialCongestionMaxRetry",
12698             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12699           },
12700           {
12701             "group": "Body",
12702             "type": "Integer",
12703             "optional": true,
12704             "field": "dialCongestionRetryFrequency",
12705             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12706           },
12707           {
12708             "group": "Body",
12709             "type": "Integer",
12710             "optional": true,
12711             "field": "dialBusyMaxRetry",
12712             "description": "<p>#Busy Retry (min:1, max:999)</p>"
12713           },
12714           {
12715             "group": "Body",
12716             "type": "Integer",
12717             "optional": true,
12718             "field": "dialBusyRetryFrequency",
12719             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12720           },
12721           {
12722             "group": "Body",
12723             "type": "Integer",
12724             "optional": true,
12725             "field": "dialNoAnswerMaxRetry",
12726             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12727           },
12728           {
12729             "group": "Body",
12730             "type": "Integer",
12731             "optional": true,
12732             "field": "dialNoAnswerRetryFrequency",
12733             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12734           },
12735           {
12736             "group": "Body",
12737             "type": "Integer",
12738             "optional": true,
12739             "field": "dialGlobalMaxRetry",
12740             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12741           },
12742           {
12743             "group": "Body",
12744             "type": "String",
12745             "optional": true,
12746             "field": "dialTimezone",
12747             "description": ""
12748           },
12749           {
12750             "group": "Body",
12751             "type": "String",
12752             "optional": true,
12753             "field": "dialGlobalInterval",
12754             "description": ""
12755           },
12756           {
12757             "group": "Body",
12758             "type": "String",
12759             "allowedValues": [
12760               "\"always\"",
12761               "\"never\"",
12762               "\"onlyIfOpen\""
12763             ],
12764             "optional": true,
12765             "field": "dialCheckDuplicateType",
12766             "description": ""
12767           },
12768           {
12769             "group": "Body",
12770             "type": "Boolean",
12771             "optional": true,
12772             "field": "dialAMDActive",
12773             "description": "<p>Active/Disactive AMD</p>"
12774           },
12775           {
12776             "group": "Body",
12777             "type": "Integer",
12778             "optional": true,
12779             "field": "dialAMDInitialSilence",
12780             "description": "<p>#AMD Initial Silence</p>"
12781           },
12782           {
12783             "group": "Body",
12784             "type": "Integer",
12785             "optional": true,
12786             "field": "dialAMDGreeting",
12787             "description": "<p>#AMD Greeting</p>"
12788           },
12789           {
12790             "group": "Body",
12791             "type": "Integer",
12792             "optional": true,
12793             "field": "dialAMDAfterGreetingSilence",
12794             "description": "<p>#AMD After Greeting Silence</p>"
12795           },
12796           {
12797             "group": "Body",
12798             "type": "Integer",
12799             "optional": true,
12800             "field": "dialAMDTotalAnalysisTime",
12801             "description": "<p>#AMD Total Analysis Time</p>"
12802           },
12803           {
12804             "group": "Body",
12805             "type": "Integer",
12806             "optional": true,
12807             "field": "dialAMDMinWordLength",
12808             "description": "<p>#AMD Min Word Length</p>"
12809           },
12810           {
12811             "group": "Body",
12812             "type": "Integer",
12813             "optional": true,
12814             "field": "dialAMDBetweenWordsSilence",
12815             "description": "<p>#AMD Between Words Silence</p>"
12816           },
12817           {
12818             "group": "Body",
12819             "type": "Integer",
12820             "optional": true,
12821             "field": "dialAMDMaximumNumberOfWords",
12822             "description": "<p>#AMD Maximum Number Of Words</p>"
12823           },
12824           {
12825             "group": "Body",
12826             "type": "Integer",
12827             "optional": true,
12828             "field": "dialAMDSilenceThreshold",
12829             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12830           },
12831           {
12832             "group": "Body",
12833             "type": "Integer",
12834             "optional": true,
12835             "field": "dialAMDMaximumWordLength",
12836             "description": "<p>#AMD Maximum Word Length</p>"
12837           },
12838           {
12839             "group": "Body",
12840             "type": "String",
12841             "allowedValues": [
12842               "\"DESC\"",
12843               "\"ASC\""
12844             ],
12845             "optional": true,
12846             "field": "dialOrderByScheduledAt",
12847             "description": ""
12848           },
12849           {
12850             "group": "Body",
12851             "type": "String",
12852             "optional": true,
12853             "field": "dialPrefix",
12854             "description": ""
12855           },
12856           {
12857             "group": "Body",
12858             "type": "Integer",
12859             "optional": true,
12860             "field": "dialRandomLastDigitCallerIdNumber",
12861             "description": "<p>Random Last Digit (min:1, max:15)</p>"
12862           },
12863           {
12864             "group": "Body",
12865             "type": "Integer",
12866             "optional": true,
12867             "field": "dialCutDigit",
12868             "description": "<p>Cut Digit (min:1, max:15)</p>"
12869           },
12870           {
12871             "group": "Body",
12872             "type": "Integer",
12873             "optional": true,
12874             "field": "dialNoSuchNumberMaxRetry",
12875             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12876           },
12877           {
12878             "group": "Body",
12879             "type": "Integer",
12880             "optional": true,
12881             "field": "dialNoSuchNumberRetryFrequency",
12882             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12883           },
12884           {
12885             "group": "Body",
12886             "type": "Integer",
12887             "optional": true,
12888             "field": "dialDropMaxRetry",
12889             "description": "<p>#Drop Retry (min:1, max:999)</p>"
12890           },
12891           {
12892             "group": "Body",
12893             "type": "Integer",
12894             "optional": true,
12895             "field": "dialDropRetryFrequency",
12896             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12897           },
12898           {
12899             "group": "Body",
12900             "type": "Integer",
12901             "optional": true,
12902             "field": "dialAbandonedMaxRetry",
12903             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12904           },
12905           {
12906             "group": "Body",
12907             "type": "Integer",
12908             "optional": true,
12909             "field": "dialAbandonedRetryFrequency",
12910             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12911           },
12912           {
12913             "group": "Body",
12914             "type": "Integer",
12915             "optional": true,
12916             "field": "dialMachineMaxRetry",
12917             "description": "<p>#Machine Retry (min:1, max:999)</p>"
12918           },
12919           {
12920             "group": "Body",
12921             "type": "Integer",
12922             "optional": true,
12923             "field": "dialMachineRetryFrequency",
12924             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12925           },
12926           {
12927             "group": "Body",
12928             "type": "Integer",
12929             "optional": true,
12930             "field": "dialAgentRejectMaxRetry",
12931             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12932           },
12933           {
12934             "group": "Body",
12935             "type": "Integer",
12936             "optional": true,
12937             "field": "dialAgentRejectRetryFrequency",
12938             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12939           }
12940         ]
12941       }
12942     },
12943     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12944     "version": "0.0.0",
12945     "filename": "server/api/campaign/index.js",
12946     "groupTitle": "IVR_Campaigns"
12947   },
12948   {
12949     "type": "delete",
12950     "url": "/api/campaigns/{id}",
12951     "title": "Deletes a IVR Campaign",
12952     "examples": [
12953       {
12954         "title": "Example usage:",
12955         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12956         "type": "json"
12957       }
12958     ],
12959     "name": "DeleteIVR_Campaigns",
12960     "group": "IVR_Campaigns",
12961     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12962     "version": "0.0.0",
12963     "filename": "server/api/campaign/index.js",
12964     "groupTitle": "IVR_Campaigns"
12965   },
12966   {
12967     "type": "get",
12968     "url": "/api/campaigns/{id}/blacklists",
12969     "title": "Get IVR campaign blacklists",
12970     "examples": [
12971       {
12972         "title": "Example usage:",
12973         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12974         "type": "json"
12975       }
12976     ],
12977     "name": "GetBlackLists",
12978     "group": "IVR_Campaigns",
12979     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12980     "version": "0.0.0",
12981     "filename": "server/api/campaign/index.js",
12982     "groupTitle": "IVR_Campaigns"
12983   },
12984   {
12985     "type": "get",
12986     "url": "/api/campaigns/{id}/finals",
12987     "title": "Gets IVR campaign hopper finals",
12988     "examples": [
12989       {
12990         "title": "Example usage:",
12991         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
12992         "type": "json"
12993       }
12994     ],
12995     "name": "GetHopperFinals",
12996     "group": "IVR_Campaigns",
12997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12998     "version": "0.0.0",
12999     "filename": "server/api/campaign/index.js",
13000     "groupTitle": "IVR_Campaigns"
13001   },
13002   {
13003     "type": "get",
13004     "url": "/api/campaigns/{id}/hopper_histories",
13005     "title": "Gets IVR campaign hopper histories",
13006     "examples": [
13007       {
13008         "title": "Example usage:",
13009         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13010         "type": "json"
13011       }
13012     ],
13013     "name": "GetHopperHistories",
13014     "group": "IVR_Campaigns",
13015     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13016     "version": "0.0.0",
13017     "filename": "server/api/campaign/index.js",
13018     "groupTitle": "IVR_Campaigns"
13019   },
13020   {
13021     "type": "get",
13022     "url": "/api/campaigns/{id}/hoppers",
13023     "title": "Gets IVR campaign hoppers",
13024     "examples": [
13025       {
13026         "title": "Example usage:",
13027         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13028         "type": "json"
13029       }
13030     ],
13031     "name": "GetHoppers",
13032     "group": "IVR_Campaigns",
13033     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13034     "version": "0.0.0",
13035     "filename": "server/api/campaign/index.js",
13036     "groupTitle": "IVR_Campaigns"
13037   },
13038   {
13039     "type": "get",
13040     "url": "/api/campaigns",
13041     "title": "Gets a list of IVR Campaigns",
13042     "examples": [
13043       {
13044         "title": "Example usage:",
13045         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13046         "type": "json"
13047       }
13048     ],
13049     "name": "GetIVR_Campaigns",
13050     "group": "IVR_Campaigns",
13051     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13052     "version": "0.0.0",
13053     "filename": "server/api/campaign/index.js",
13054     "groupTitle": "IVR_Campaigns"
13055   },
13056   {
13057     "type": "get",
13058     "url": "/api/campaigns/{id}/lists",
13059     "title": "Get IVR campaign lists",
13060     "examples": [
13061       {
13062         "title": "Example usage:",
13063         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13064         "type": "json"
13065       }
13066     ],
13067     "name": "GetLists",
13068     "group": "IVR_Campaigns",
13069     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13070     "version": "0.0.0",
13071     "filename": "server/api/campaign/index.js",
13072     "groupTitle": "IVR_Campaigns"
13073   },
13074   {
13075     "type": "delete",
13076     "url": "/api/campaigns/{id}/blacklists",
13077     "title": "Remove blacklists from an IVR Campaign",
13078     "examples": [
13079       {
13080         "title": "Example usage:",
13081         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13082         "type": "json"
13083       }
13084     ],
13085     "name": "RemoveBlackLists",
13086     "group": "IVR_Campaigns",
13087     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13088     "version": "0.0.0",
13089     "filename": "server/api/campaign/index.js",
13090     "groupTitle": "IVR_Campaigns"
13091   },
13092   {
13093     "type": "delete",
13094     "url": "/api/campaigns/{id}/lists",
13095     "title": "Remove lists from an IVR Campaign",
13096     "examples": [
13097       {
13098         "title": "Example usage:",
13099         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13100         "type": "json"
13101       }
13102     ],
13103     "name": "RemoveLists",
13104     "group": "IVR_Campaigns",
13105     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13106     "version": "0.0.0",
13107     "filename": "server/api/campaign/index.js",
13108     "groupTitle": "IVR_Campaigns"
13109   },
13110   {
13111     "type": "get",
13112     "url": "/api/campaigns/{id}",
13113     "title": "Gets a single IVR Campaign",
13114     "examples": [
13115       {
13116         "title": "Example usage:",
13117         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13118         "type": "json"
13119       }
13120     ],
13121     "name": "ShowIVR_Campaigns",
13122     "group": "IVR_Campaigns",
13123     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13124     "version": "0.0.0",
13125     "filename": "server/api/campaign/index.js",
13126     "groupTitle": "IVR_Campaigns"
13127   },
13128   {
13129     "type": "get",
13130     "url": "/api/campaigns/{id}/blacks",
13131     "title": "Gets IVR campaign hopper blacks",
13132     "examples": [
13133       {
13134         "title": "Example usage:",
13135         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
13136         "type": "json"
13137       }
13138     ],
13139     "name": "getHopperBlacks",
13140     "group": "IVR_Campaigns",
13141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13142     "version": "0.0.0",
13143     "filename": "server/api/campaign/index.js",
13144     "groupTitle": "IVR_Campaigns"
13145   },
13146   {
13147     "type": "put",
13148     "url": "/api/campaigns/{id}",
13149     "title": "Update an existing IVR Campaign",
13150     "examples": [
13151       {
13152         "title": "Example usage:",
13153         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13154         "type": "json"
13155       }
13156     ],
13157     "name": "updateIVR_Campaigns",
13158     "group": "IVR_Campaigns",
13159     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13160     "version": "0.0.0",
13161     "filename": "server/api/campaign/index.js",
13162     "groupTitle": "IVR_Campaigns"
13163   },
13164   {
13165     "type": "post",
13166     "url": "/api/integrations/reports",
13167     "title": "Creates a new Integration Report",
13168     "examples": [
13169       {
13170         "title": "Example usage:",
13171         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13172         "type": "json"
13173       }
13174     ],
13175     "name": "CreateIntegration_Reports",
13176     "group": "Integration_Reports",
13177     "parameter": {
13178       "fields": {
13179         "Body": [
13180           {
13181             "group": "Body",
13182             "type": "String",
13183             "optional": true,
13184             "field": "integration",
13185             "description": ""
13186           },
13187           {
13188             "group": "Body",
13189             "type": "String",
13190             "optional": true,
13191             "field": "eventChannel",
13192             "description": ""
13193           },
13194           {
13195             "group": "Body",
13196             "type": "String",
13197             "optional": true,
13198             "field": "exitStatus",
13199             "description": ""
13200           },
13201           {
13202             "group": "Body",
13203             "type": "String",
13204             "optional": true,
13205             "field": "ticketId",
13206             "description": ""
13207           },
13208           {
13209             "group": "Body",
13210             "type": "Integer",
13211             "optional": true,
13212             "field": "integrationId",
13213             "description": ""
13214           },
13215           {
13216             "group": "Body",
13217             "type": "String",
13218             "optional": true,
13219             "field": "contacts",
13220             "description": ""
13221           },
13222           {
13223             "group": "Body",
13224             "type": "String",
13225             "optional": true,
13226             "field": "uniqueid",
13227             "description": ""
13228           },
13229           {
13230             "group": "Body",
13231             "type": "String",
13232             "optional": true,
13233             "field": "calleridnum",
13234             "description": ""
13235           },
13236           {
13237             "group": "Body",
13238             "type": "String",
13239             "optional": true,
13240             "field": "calleridname",
13241             "description": ""
13242           },
13243           {
13244             "group": "Body",
13245             "type": "String",
13246             "optional": true,
13247             "field": "queue",
13248             "description": ""
13249           },
13250           {
13251             "group": "Body",
13252             "type": "String",
13253             "optional": true,
13254             "field": "interface",
13255             "description": ""
13256           },
13257           {
13258             "group": "Body",
13259             "type": "String",
13260             "optional": true,
13261             "field": "membername",
13262             "description": ""
13263           },
13264           {
13265             "group": "Body",
13266             "type": "String",
13267             "optional": true,
13268             "field": "agentcalledAt",
13269             "description": ""
13270           },
13271           {
13272             "group": "Body",
13273             "type": "String",
13274             "optional": true,
13275             "field": "agentconnectAt",
13276             "description": ""
13277           },
13278           {
13279             "group": "Body",
13280             "type": "Integer",
13281             "optional": true,
13282             "field": "holdtime",
13283             "description": ""
13284           },
13285           {
13286             "group": "Body",
13287             "type": "Boolean",
13288             "optional": true,
13289             "field": "agentcomplete",
13290             "description": ""
13291           },
13292           {
13293             "group": "Body",
13294             "type": "String",
13295             "optional": true,
13296             "field": "agentcompleteAt",
13297             "description": ""
13298           },
13299           {
13300             "group": "Body",
13301             "type": "Integer",
13302             "optional": true,
13303             "field": "talktime",
13304             "description": ""
13305           },
13306           {
13307             "group": "Body",
13308             "type": "Boolean",
13309             "optional": true,
13310             "field": "agentacw",
13311             "description": ""
13312           },
13313           {
13314             "group": "Body",
13315             "type": "Integer",
13316             "optional": true,
13317             "field": "acwtime",
13318             "description": ""
13319           },
13320           {
13321             "group": "Body",
13322             "type": "String",
13323             "optional": true,
13324             "field": "reason",
13325             "description": ""
13326           },
13327           {
13328             "group": "Body",
13329             "type": "Boolean",
13330             "optional": true,
13331             "field": "agentringnoanswer",
13332             "description": ""
13333           },
13334           {
13335             "group": "Body",
13336             "type": "String",
13337             "optional": true,
13338             "field": "agentringnoanswerAt",
13339             "description": ""
13340           },
13341           {
13342             "group": "Body",
13343             "type": "Boolean",
13344             "optional": true,
13345             "field": "agentdump",
13346             "description": ""
13347           },
13348           {
13349             "group": "Body",
13350             "type": "String",
13351             "optional": true,
13352             "field": "agentdumpAt",
13353             "description": ""
13354           },
13355           {
13356             "group": "Body",
13357             "type": "String",
13358             "optional": true,
13359             "field": "lastevent",
13360             "description": ""
13361           },
13362           {
13363             "group": "Body",
13364             "type": "String",
13365             "optional": true,
13366             "field": "channel",
13367             "description": ""
13368           },
13369           {
13370             "group": "Body",
13371             "type": "Integer",
13372             "optional": true,
13373             "field": "channelstate",
13374             "description": ""
13375           },
13376           {
13377             "group": "Body",
13378             "type": "String",
13379             "optional": true,
13380             "field": "channelstatedesc",
13381             "description": ""
13382           },
13383           {
13384             "group": "Body",
13385             "type": "String",
13386             "optional": true,
13387             "field": "connectedlinenum",
13388             "description": ""
13389           },
13390           {
13391             "group": "Body",
13392             "type": "String",
13393             "optional": true,
13394             "field": "connectedlinename",
13395             "description": ""
13396           },
13397           {
13398             "group": "Body",
13399             "type": "String",
13400             "optional": true,
13401             "field": "language",
13402             "description": ""
13403           },
13404           {
13405             "group": "Body",
13406             "type": "String",
13407             "optional": true,
13408             "field": "accountcode",
13409             "description": ""
13410           },
13411           {
13412             "group": "Body",
13413             "type": "String",
13414             "optional": true,
13415             "field": "context",
13416             "description": ""
13417           },
13418           {
13419             "group": "Body",
13420             "type": "String",
13421             "optional": true,
13422             "field": "exten",
13423             "description": ""
13424           },
13425           {
13426             "group": "Body",
13427             "type": "String",
13428             "optional": true,
13429             "field": "priority",
13430             "description": ""
13431           },
13432           {
13433             "group": "Body",
13434             "type": "String",
13435             "optional": true,
13436             "field": "destchannel",
13437             "description": ""
13438           },
13439           {
13440             "group": "Body",
13441             "type": "Integer",
13442             "optional": true,
13443             "field": "destchannelstate",
13444             "description": ""
13445           },
13446           {
13447             "group": "Body",
13448             "type": "String",
13449             "optional": true,
13450             "field": "destchannelstatedesc",
13451             "description": ""
13452           },
13453           {
13454             "group": "Body",
13455             "type": "String",
13456             "optional": true,
13457             "field": "destcalleridnum",
13458             "description": ""
13459           },
13460           {
13461             "group": "Body",
13462             "type": "String",
13463             "optional": true,
13464             "field": "destcalleridname",
13465             "description": ""
13466           },
13467           {
13468             "group": "Body",
13469             "type": "String",
13470             "optional": true,
13471             "field": "destconnectedlinenum",
13472             "description": ""
13473           },
13474           {
13475             "group": "Body",
13476             "type": "String",
13477             "optional": true,
13478             "field": "destconnectedlinename",
13479             "description": ""
13480           },
13481           {
13482             "group": "Body",
13483             "type": "String",
13484             "optional": true,
13485             "field": "destlanguage",
13486             "description": ""
13487           },
13488           {
13489             "group": "Body",
13490             "type": "String",
13491             "optional": true,
13492             "field": "destaccountcode",
13493             "description": ""
13494           },
13495           {
13496             "group": "Body",
13497             "type": "String",
13498             "optional": true,
13499             "field": "destcontext",
13500             "description": ""
13501           },
13502           {
13503             "group": "Body",
13504             "type": "String",
13505             "optional": true,
13506             "field": "destexten",
13507             "description": ""
13508           },
13509           {
13510             "group": "Body",
13511             "type": "String",
13512             "optional": true,
13513             "field": "destpriority",
13514             "description": ""
13515           },
13516           {
13517             "group": "Body",
13518             "type": "String",
13519             "optional": true,
13520             "field": "destuniqueid",
13521             "description": ""
13522           },
13523           {
13524             "group": "Body",
13525             "type": "String",
13526             "optional": true,
13527             "field": "messageId",
13528             "description": ""
13529           },
13530           {
13531             "group": "Body",
13532             "type": "String",
13533             "optional": true,
13534             "field": "inReplyTo",
13535             "description": ""
13536           },
13537           {
13538             "group": "Body",
13539             "type": "String",
13540             "optional": true,
13541             "field": "subject",
13542             "description": ""
13543           },
13544           {
13545             "group": "Body",
13546             "type": "String",
13547             "optional": true,
13548             "field": "from",
13549             "description": ""
13550           },
13551           {
13552             "group": "Body",
13553             "type": "String",
13554             "optional": true,
13555             "field": "to",
13556             "description": ""
13557           },
13558           {
13559             "group": "Body",
13560             "type": "String",
13561             "optional": true,
13562             "field": "cc",
13563             "description": ""
13564           },
13565           {
13566             "group": "Body",
13567             "type": "Text",
13568             "optional": true,
13569             "field": "attachment",
13570             "description": ""
13571           },
13572           {
13573             "group": "Body",
13574             "type": "Text",
13575             "optional": true,
13576             "field": "html",
13577             "description": ""
13578           },
13579           {
13580             "group": "Body",
13581             "type": "Text",
13582             "optional": true,
13583             "field": "text",
13584             "description": ""
13585           },
13586           {
13587             "group": "Body",
13588             "type": "String",
13589             "allowedValues": [
13590               "\"SENT\"",
13591               "\"SENDING\"",
13592               "\"RECEIVED\"",
13593               "\"FAILED\""
13594             ],
13595             "optional": true,
13596             "field": "status",
13597             "description": ""
13598           },
13599           {
13600             "group": "Body",
13601             "type": "String",
13602             "optional": true,
13603             "field": "url",
13604             "description": ""
13605           },
13606           {
13607             "group": "Body",
13608             "type": "String",
13609             "optional": true,
13610             "field": "app",
13611             "description": ""
13612           },
13613           {
13614             "group": "Body",
13615             "type": "String",
13616             "optional": true,
13617             "field": "appdata",
13618             "description": ""
13619           },
13620           {
13621             "group": "Body",
13622             "type": "Integer",
13623             "optional": true,
13624             "field": "projectId",
13625             "description": ""
13626           }
13627         ]
13628       }
13629     },
13630     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13631     "version": "0.0.0",
13632     "filename": "server/api/integrationReport/index.js",
13633     "groupTitle": "Integration_Reports"
13634   },
13635   {
13636     "type": "delete",
13637     "url": "/api/integrations/reports/{id}",
13638     "title": "Deletes a Integration Report",
13639     "examples": [
13640       {
13641         "title": "Example usage:",
13642         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13643         "type": "json"
13644       }
13645     ],
13646     "name": "DeleteIntegration_Reports",
13647     "group": "Integration_Reports",
13648     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13649     "version": "0.0.0",
13650     "filename": "server/api/integrationReport/index.js",
13651     "groupTitle": "Integration_Reports"
13652   },
13653   {
13654     "type": "get",
13655     "url": "/api/integrations/reports/describe",
13656     "title": "Gets table info about Integration Reports",
13657     "examples": [
13658       {
13659         "title": "Example usage:",
13660         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13661         "type": "json"
13662       }
13663     ],
13664     "name": "DescribeIntegration_Reports",
13665     "group": "Integration_Reports",
13666     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13667     "version": "0.0.0",
13668     "filename": "server/api/integrationReport/index.js",
13669     "groupTitle": "Integration_Reports"
13670   },
13671   {
13672     "type": "get",
13673     "url": "/api/integrations/reports",
13674     "title": "Gets a list of Integration Reports",
13675     "examples": [
13676       {
13677         "title": "Example usage:",
13678         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13679         "type": "json"
13680       }
13681     ],
13682     "name": "GetIntegration_Reports",
13683     "group": "Integration_Reports",
13684     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13685     "version": "0.0.0",
13686     "filename": "server/api/integrationReport/index.js",
13687     "groupTitle": "Integration_Reports"
13688   },
13689   {
13690     "type": "get",
13691     "url": "/api/integrations/reports/{id}",
13692     "title": "Gets a single Integration Report",
13693     "examples": [
13694       {
13695         "title": "Example usage:",
13696         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13697         "type": "json"
13698       }
13699     ],
13700     "name": "ShowIntegration_Reports",
13701     "group": "Integration_Reports",
13702     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13703     "version": "0.0.0",
13704     "filename": "server/api/integrationReport/index.js",
13705     "groupTitle": "Integration_Reports"
13706   },
13707   {
13708     "type": "put",
13709     "url": "/api/integrations/reports/{id}",
13710     "title": "Update an existing Integration Report",
13711     "examples": [
13712       {
13713         "title": "Example usage:",
13714         "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",
13715         "type": "json"
13716       }
13717     ],
13718     "name": "updateIntegration_Reports",
13719     "group": "Integration_Reports",
13720     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13721     "version": "0.0.0",
13722     "filename": "server/api/integrationReport/index.js",
13723     "groupTitle": "Integration_Reports"
13724   },
13725   {
13726     "type": "post",
13727     "url": "/api/intervals",
13728     "title": "Creates a new Interval",
13729     "examples": [
13730       {
13731         "title": "Example usage:",
13732         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13733         "type": "json"
13734       }
13735     ],
13736     "name": "CreateIntervals",
13737     "group": "Intervals",
13738     "parameter": {
13739       "fields": {
13740         "Body": [
13741           {
13742             "group": "Body",
13743             "type": "String",
13744             "optional": true,
13745             "field": "name",
13746             "description": ""
13747           },
13748           {
13749             "group": "Body",
13750             "type": "String",
13751             "optional": true,
13752             "field": "description",
13753             "description": ""
13754           },
13755           {
13756             "group": "Body",
13757             "type": "String",
13758             "optional": true,
13759             "field": "interval",
13760             "description": ""
13761           }
13762         ]
13763       }
13764     },
13765     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13766     "version": "0.0.0",
13767     "filename": "server/api/interval/index.js",
13768     "groupTitle": "Intervals"
13769   },
13770   {
13771     "type": "delete",
13772     "url": "/api/intervals/{id}",
13773     "title": "Deletes a Interval",
13774     "examples": [
13775       {
13776         "title": "Example usage:",
13777         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13778         "type": "json"
13779       }
13780     ],
13781     "name": "DeleteIntervals",
13782     "group": "Intervals",
13783     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13784     "version": "0.0.0",
13785     "filename": "server/api/interval/index.js",
13786     "groupTitle": "Intervals"
13787   },
13788   {
13789     "type": "get",
13790     "url": "/api/intervals",
13791     "title": "Gets a list of Intervals",
13792     "examples": [
13793       {
13794         "title": "Example usage:",
13795         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13796         "type": "json"
13797       }
13798     ],
13799     "name": "GetIntervals",
13800     "group": "Intervals",
13801     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13802     "version": "0.0.0",
13803     "filename": "server/api/interval/index.js",
13804     "groupTitle": "Intervals"
13805   },
13806   {
13807     "type": "get",
13808     "url": "/api/intervals/{id}",
13809     "title": "Gets a single Interval",
13810     "examples": [
13811       {
13812         "title": "Example usage:",
13813         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13814         "type": "json"
13815       }
13816     ],
13817     "name": "ShowIntervals",
13818     "group": "Intervals",
13819     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13820     "version": "0.0.0",
13821     "filename": "server/api/interval/index.js",
13822     "groupTitle": "Intervals"
13823   },
13824   {
13825     "type": "post",
13826     "url": "/api/intervals/{id}/sub_intervals",
13827     "title": "Creates a new sub interval",
13828     "examples": [
13829       {
13830         "title": "Example usage:",
13831         "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",
13832         "type": "json"
13833       }
13834     ],
13835     "name": "addInterval",
13836     "group": "Intervals",
13837     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13838     "version": "0.0.0",
13839     "filename": "server/api/interval/index.js",
13840     "groupTitle": "Intervals"
13841   },
13842   {
13843     "type": "post",
13844     "url": "/api/intervals/{id}/sub_intervals/create_many",
13845     "title": "Create new sub intervals set",
13846     "examples": [
13847       {
13848         "title": "Example usage:",
13849         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13850         "type": "json"
13851       }
13852     ],
13853     "name": "addIntervals",
13854     "group": "Intervals",
13855     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13856     "version": "0.0.0",
13857     "filename": "server/api/interval/index.js",
13858     "groupTitle": "Intervals"
13859   },
13860   {
13861     "type": "get",
13862     "url": "/api/intervals/{id}/sub_intervals",
13863     "title": "Get sub intervals set",
13864     "examples": [
13865       {
13866         "title": "Example usage:",
13867         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13868         "type": "json"
13869       }
13870     ],
13871     "name": "getIntervals",
13872     "group": "Intervals",
13873     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13874     "version": "0.0.0",
13875     "filename": "server/api/interval/index.js",
13876     "groupTitle": "Intervals"
13877   },
13878   {
13879     "type": "put",
13880     "url": "/api/intervals/{id}",
13881     "title": "Update an existing Interval",
13882     "examples": [
13883       {
13884         "title": "Example usage:",
13885         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13886         "type": "json"
13887       }
13888     ],
13889     "name": "updateIntervals",
13890     "group": "Intervals",
13891     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13892     "version": "0.0.0",
13893     "filename": "server/api/interval/index.js",
13894     "groupTitle": "Intervals"
13895   },
13896   {
13897     "type": "post",
13898     "url": "/api/jira",
13899     "title": "Creates a new issue",
13900     "examples": [
13901       {
13902         "title": "Example usage:",
13903         "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}",
13904         "type": "json"
13905       }
13906     ],
13907     "name": "Creates_Issue",
13908     "group": "Issue",
13909     "parameter": {
13910       "fields": {
13911         "Body": [
13912           {
13913             "group": "Body",
13914             "type": "String",
13915             "allowedValues": [
13916               "\"Bug\""
13917             ],
13918             "optional": true,
13919             "field": "issuetype",
13920             "description": ""
13921           },
13922           {
13923             "group": "Body",
13924             "type": "String",
13925             "optional": false,
13926             "field": "summary",
13927             "description": ""
13928           },
13929           {
13930             "group": "Body",
13931             "type": "String",
13932             "optional": false,
13933             "field": "description",
13934             "description": ""
13935           }
13936         ]
13937       }
13938     },
13939     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13940     "version": "0.0.0",
13941     "filename": "server/api/jira/index.js",
13942     "groupTitle": "Issue"
13943   },
13944   {
13945     "type": "post",
13946     "url": "/api/jscripty/answers/reports",
13947     "title": "Creates a new Report",
13948     "examples": [
13949       {
13950         "title": "Example usage:",
13951         "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",
13952         "type": "json"
13953       }
13954     ],
13955     "name": "CreateReports",
13956     "group": "JscriptyAnswerReport",
13957     "parameter": {
13958       "fields": {
13959         "Body": [
13960           {
13961             "group": "Body",
13962             "type": "Text",
13963             "optional": true,
13964             "field": "question",
13965             "description": ""
13966           },
13967           {
13968             "group": "Body",
13969             "type": "Text",
13970             "optional": true,
13971             "field": "answer",
13972             "description": ""
13973           },
13974           {
13975             "group": "Body",
13976             "type": "String",
13977             "optional": true,
13978             "field": "membername",
13979             "description": ""
13980           },
13981           {
13982             "group": "Body",
13983             "type": "String",
13984             "optional": true,
13985             "field": "projectname",
13986             "description": ""
13987           },
13988           {
13989             "group": "Body",
13990             "type": "String",
13991             "optional": true,
13992             "field": "queue",
13993             "description": ""
13994           },
13995           {
13996             "group": "Body",
13997             "type": "String",
13998             "optional": true,
13999             "field": "uniqueid",
14000             "description": ""
14001           },
14002           {
14003             "group": "Body",
14004             "type": "String",
14005             "optional": true,
14006             "field": "calleridname",
14007             "description": ""
14008           },
14009           {
14010             "group": "Body",
14011             "type": "String",
14012             "optional": true,
14013             "field": "calleridnum",
14014             "description": ""
14015           },
14016           {
14017             "group": "Body",
14018             "type": "String",
14019             "optional": true,
14020             "field": "questionId",
14021             "description": ""
14022           }
14023         ]
14024       }
14025     },
14026     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14027     "version": "0.0.0",
14028     "filename": "server/api/jscriptyAnswerReport/index.js",
14029     "groupTitle": "JscriptyAnswerReport"
14030   },
14031   {
14032     "type": "delete",
14033     "url": "/api/jscripty/answers/reports/{id}",
14034     "title": "Deletes a Report",
14035     "examples": [
14036       {
14037         "title": "Example usage:",
14038         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14039         "type": "json"
14040       }
14041     ],
14042     "name": "DeleteReports",
14043     "group": "JscriptyAnswerReport",
14044     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14045     "version": "0.0.0",
14046     "filename": "server/api/jscriptyAnswerReport/index.js",
14047     "groupTitle": "JscriptyAnswerReport"
14048   },
14049   {
14050     "type": "get",
14051     "url": "/api/jscripty/answers/reports/describe",
14052     "title": "Gets table info about Reports",
14053     "examples": [
14054       {
14055         "title": "Example usage:",
14056         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14057         "type": "json"
14058       }
14059     ],
14060     "name": "DescribeReports",
14061     "group": "JscriptyAnswerReport",
14062     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14063     "version": "0.0.0",
14064     "filename": "server/api/jscriptyAnswerReport/index.js",
14065     "groupTitle": "JscriptyAnswerReport"
14066   },
14067   {
14068     "type": "get",
14069     "url": "/api/jscripty/answers/reports",
14070     "title": "Gets a list of Reports",
14071     "examples": [
14072       {
14073         "title": "Example usage:",
14074         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14075         "type": "json"
14076       }
14077     ],
14078     "name": "GetReports",
14079     "group": "JscriptyAnswerReport",
14080     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14081     "version": "0.0.0",
14082     "filename": "server/api/jscriptyAnswerReport/index.js",
14083     "groupTitle": "JscriptyAnswerReport"
14084   },
14085   {
14086     "type": "get",
14087     "url": "/api/jscripty/answers/reports/{id}",
14088     "title": "Gets a single Report",
14089     "examples": [
14090       {
14091         "title": "Example usage:",
14092         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14093         "type": "json"
14094       }
14095     ],
14096     "name": "ShowReports",
14097     "group": "JscriptyAnswerReport",
14098     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14099     "version": "0.0.0",
14100     "filename": "server/api/jscriptyAnswerReport/index.js",
14101     "groupTitle": "JscriptyAnswerReport"
14102   },
14103   {
14104     "type": "put",
14105     "url": "/api/jscripty/answers/reports/{id}",
14106     "title": "Update an existing Report",
14107     "examples": [
14108       {
14109         "title": "Example usage:",
14110         "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",
14111         "type": "json"
14112       }
14113     ],
14114     "name": "updateReports",
14115     "group": "JscriptyAnswerReport",
14116     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14117     "version": "0.0.0",
14118     "filename": "server/api/jscriptyAnswerReport/index.js",
14119     "groupTitle": "JscriptyAnswerReport"
14120   },
14121   {
14122     "type": "post",
14123     "url": "/api/jscripty/questions/reports",
14124     "title": "Creates a new Report",
14125     "examples": [
14126       {
14127         "title": "Example usage:",
14128         "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",
14129         "type": "json"
14130       }
14131     ],
14132     "name": "CreateReports",
14133     "group": "JscriptyQuestionReport",
14134     "parameter": {
14135       "fields": {
14136         "Body": [
14137           {
14138             "group": "Body",
14139             "type": "Text",
14140             "optional": true,
14141             "field": "question",
14142             "description": ""
14143           },
14144           {
14145             "group": "Body",
14146             "type": "Text",
14147             "optional": true,
14148             "field": "answer",
14149             "description": ""
14150           },
14151           {
14152             "group": "Body",
14153             "type": "String",
14154             "optional": true,
14155             "field": "membername",
14156             "description": ""
14157           },
14158           {
14159             "group": "Body",
14160             "type": "String",
14161             "optional": true,
14162             "field": "projectname",
14163             "description": ""
14164           },
14165           {
14166             "group": "Body",
14167             "type": "String",
14168             "optional": true,
14169             "field": "queue",
14170             "description": ""
14171           },
14172           {
14173             "group": "Body",
14174             "type": "String",
14175             "optional": true,
14176             "field": "uniqueid",
14177             "description": ""
14178           },
14179           {
14180             "group": "Body",
14181             "type": "String",
14182             "optional": true,
14183             "field": "calleridname",
14184             "description": ""
14185           },
14186           {
14187             "group": "Body",
14188             "type": "String",
14189             "optional": true,
14190             "field": "calleridnum",
14191             "description": ""
14192           },
14193           {
14194             "group": "Body",
14195             "type": "String",
14196             "optional": true,
14197             "field": "questionId",
14198             "description": ""
14199           }
14200         ]
14201       }
14202     },
14203     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14204     "version": "0.0.0",
14205     "filename": "server/api/jscriptyQuestionReport/index.js",
14206     "groupTitle": "JscriptyQuestionReport"
14207   },
14208   {
14209     "type": "delete",
14210     "url": "/api/jscripty/questions/reports/{id}",
14211     "title": "Deletes a Report",
14212     "examples": [
14213       {
14214         "title": "Example usage:",
14215         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14216         "type": "json"
14217       }
14218     ],
14219     "name": "DeleteReports",
14220     "group": "JscriptyQuestionReport",
14221     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14222     "version": "0.0.0",
14223     "filename": "server/api/jscriptyQuestionReport/index.js",
14224     "groupTitle": "JscriptyQuestionReport"
14225   },
14226   {
14227     "type": "get",
14228     "url": "/api/jscripty/questions/reports/describe",
14229     "title": "Gets table info about Reports",
14230     "examples": [
14231       {
14232         "title": "Example usage:",
14233         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14234         "type": "json"
14235       }
14236     ],
14237     "name": "DescribeReports",
14238     "group": "JscriptyQuestionReport",
14239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14240     "version": "0.0.0",
14241     "filename": "server/api/jscriptyQuestionReport/index.js",
14242     "groupTitle": "JscriptyQuestionReport"
14243   },
14244   {
14245     "type": "get",
14246     "url": "/api/jscripty/questions/reports",
14247     "title": "Gets a list of Reports",
14248     "examples": [
14249       {
14250         "title": "Example usage:",
14251         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14252         "type": "json"
14253       }
14254     ],
14255     "name": "GetReports",
14256     "group": "JscriptyQuestionReport",
14257     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14258     "version": "0.0.0",
14259     "filename": "server/api/jscriptyQuestionReport/index.js",
14260     "groupTitle": "JscriptyQuestionReport"
14261   },
14262   {
14263     "type": "get",
14264     "url": "/api/jscripty/questions/reports/{id}",
14265     "title": "Gets a single Report",
14266     "examples": [
14267       {
14268         "title": "Example usage:",
14269         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14270         "type": "json"
14271       }
14272     ],
14273     "name": "ShowReports",
14274     "group": "JscriptyQuestionReport",
14275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14276     "version": "0.0.0",
14277     "filename": "server/api/jscriptyQuestionReport/index.js",
14278     "groupTitle": "JscriptyQuestionReport"
14279   },
14280   {
14281     "type": "put",
14282     "url": "/api/jscripty/questions/reports/{id}",
14283     "title": "Update an existing Report",
14284     "examples": [
14285       {
14286         "title": "Example usage:",
14287         "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",
14288         "type": "json"
14289       }
14290     ],
14291     "name": "updateReports",
14292     "group": "JscriptyQuestionReport",
14293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14294     "version": "0.0.0",
14295     "filename": "server/api/jscriptyQuestionReport/index.js",
14296     "groupTitle": "JscriptyQuestionReport"
14297   },
14298   {
14299     "type": "post",
14300     "url": "/api/jscripty/sessions/reports",
14301     "title": "Creates a new Report",
14302     "examples": [
14303       {
14304         "title": "Example usage:",
14305         "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",
14306         "type": "json"
14307       }
14308     ],
14309     "name": "CreateReports",
14310     "group": "JscriptySessionReport",
14311     "parameter": {
14312       "fields": {
14313         "Body": [
14314           {
14315             "group": "Body",
14316             "type": "String",
14317             "optional": true,
14318             "field": "starttime",
14319             "description": ""
14320           },
14321           {
14322             "group": "Body",
14323             "type": "String",
14324             "optional": true,
14325             "field": "endtime",
14326             "description": ""
14327           },
14328           {
14329             "group": "Body",
14330             "type": "String",
14331             "optional": true,
14332             "field": "membername",
14333             "description": ""
14334           },
14335           {
14336             "group": "Body",
14337             "type": "String",
14338             "optional": true,
14339             "field": "projectname",
14340             "description": ""
14341           },
14342           {
14343             "group": "Body",
14344             "type": "String",
14345             "optional": true,
14346             "field": "queue",
14347             "description": ""
14348           },
14349           {
14350             "group": "Body",
14351             "type": "String",
14352             "optional": true,
14353             "field": "uniqueid",
14354             "description": ""
14355           },
14356           {
14357             "group": "Body",
14358             "type": "String",
14359             "optional": true,
14360             "field": "calleridname",
14361             "description": ""
14362           },
14363           {
14364             "group": "Body",
14365             "type": "String",
14366             "optional": true,
14367             "field": "calleridnum",
14368             "description": ""
14369           },
14370           {
14371             "group": "Body",
14372             "type": "Boolean",
14373             "optional": true,
14374             "field": "completed",
14375             "description": ""
14376           }
14377         ]
14378       }
14379     },
14380     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14381     "version": "0.0.0",
14382     "filename": "server/api/jscriptySessionReport/index.js",
14383     "groupTitle": "JscriptySessionReport"
14384   },
14385   {
14386     "type": "delete",
14387     "url": "/api/jscripty/sessions/reports/{id}",
14388     "title": "Deletes a Report",
14389     "examples": [
14390       {
14391         "title": "Example usage:",
14392         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14393         "type": "json"
14394       }
14395     ],
14396     "name": "DeleteReports",
14397     "group": "JscriptySessionReport",
14398     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14399     "version": "0.0.0",
14400     "filename": "server/api/jscriptySessionReport/index.js",
14401     "groupTitle": "JscriptySessionReport"
14402   },
14403   {
14404     "type": "get",
14405     "url": "/api/jscripty/sessions/reports/describe",
14406     "title": "Gets table info about Reports",
14407     "examples": [
14408       {
14409         "title": "Example usage:",
14410         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14411         "type": "json"
14412       }
14413     ],
14414     "name": "DescribeReports",
14415     "group": "JscriptySessionReport",
14416     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14417     "version": "0.0.0",
14418     "filename": "server/api/jscriptySessionReport/index.js",
14419     "groupTitle": "JscriptySessionReport"
14420   },
14421   {
14422     "type": "get",
14423     "url": "/api/jscripty/sessions/reports",
14424     "title": "Gets a list of Reports",
14425     "examples": [
14426       {
14427         "title": "Example usage:",
14428         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14429         "type": "json"
14430       }
14431     ],
14432     "name": "GetReports",
14433     "group": "JscriptySessionReport",
14434     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14435     "version": "0.0.0",
14436     "filename": "server/api/jscriptySessionReport/index.js",
14437     "groupTitle": "JscriptySessionReport"
14438   },
14439   {
14440     "type": "get",
14441     "url": "/api/jscripty/sessions/reports/{id}",
14442     "title": "Gets a single Report",
14443     "examples": [
14444       {
14445         "title": "Example usage:",
14446         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14447         "type": "json"
14448       }
14449     ],
14450     "name": "ShowReports",
14451     "group": "JscriptySessionReport",
14452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14453     "version": "0.0.0",
14454     "filename": "server/api/jscriptySessionReport/index.js",
14455     "groupTitle": "JscriptySessionReport"
14456   },
14457   {
14458     "type": "get",
14459     "url": "/api/jscripty/sessions/reports/{id}/questions",
14460     "title": "Gets Jscripty Session questions",
14461     "examples": [
14462       {
14463         "title": "Example usage:",
14464         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
14465         "type": "json"
14466       }
14467     ],
14468     "name": "getQuestions",
14469     "group": "JscriptySessionReport",
14470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14471     "version": "0.0.0",
14472     "filename": "server/api/jscriptySessionReport/index.js",
14473     "groupTitle": "JscriptySessionReport"
14474   },
14475   {
14476     "type": "put",
14477     "url": "/api/jscripty/sessions/reports/{id}",
14478     "title": "Update an existing Report",
14479     "examples": [
14480       {
14481         "title": "Example usage:",
14482         "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",
14483         "type": "json"
14484       }
14485     ],
14486     "name": "updateReports",
14487     "group": "JscriptySessionReport",
14488     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14489     "version": "0.0.0",
14490     "filename": "server/api/jscriptySessionReport/index.js",
14491     "groupTitle": "JscriptySessionReport"
14492   },
14493   {
14494     "type": "post",
14495     "url": "/api/jscripty/projects/clone",
14496     "title": "Clone an existing Project",
14497     "examples": [
14498       {
14499         "title": "Example usage:",
14500         "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",
14501         "type": "json"
14502       }
14503     ],
14504     "name": "CloneProjects",
14505     "group": "Jscripty_Projects",
14506     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14507     "version": "0.0.0",
14508     "filename": "server/api/jscriptyProject/index.js",
14509     "groupTitle": "Jscripty_Projects"
14510   },
14511   {
14512     "type": "post",
14513     "url": "/api/jscripty/projects",
14514     "title": "Creates a new Project",
14515     "examples": [
14516       {
14517         "title": "Example usage:",
14518         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14519         "type": "json"
14520       }
14521     ],
14522     "name": "CreateProjects",
14523     "group": "Jscripty_Projects",
14524     "parameter": {
14525       "fields": {
14526         "Body": [
14527           {
14528             "group": "Body",
14529             "type": "String",
14530             "optional": true,
14531             "field": "name",
14532             "description": ""
14533           },
14534           {
14535             "group": "Body",
14536             "type": "String",
14537             "optional": true,
14538             "field": "description",
14539             "description": ""
14540           },
14541           {
14542             "group": "Body",
14543             "type": "Text",
14544             "optional": true,
14545             "field": "formData",
14546             "description": ""
14547           },
14548           {
14549             "group": "Body",
14550             "type": "Boolean",
14551             "optional": true,
14552             "field": "enableUncompleteSave",
14553             "description": ""
14554           },
14555           {
14556             "group": "Body",
14557             "type": "Boolean",
14558             "optional": true,
14559             "field": "sendUnpauseOnSubmit",
14560             "description": ""
14561           }
14562         ]
14563       }
14564     },
14565     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14566     "version": "0.0.0",
14567     "filename": "server/api/jscriptyProject/index.js",
14568     "groupTitle": "Jscripty_Projects"
14569   },
14570   {
14571     "type": "delete",
14572     "url": "/api/jscripty/projects/{id}",
14573     "title": "Deletes a Project",
14574     "examples": [
14575       {
14576         "title": "Example usage:",
14577         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14578         "type": "json"
14579       }
14580     ],
14581     "name": "DeleteProjects",
14582     "group": "Jscripty_Projects",
14583     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14584     "version": "0.0.0",
14585     "filename": "server/api/jscriptyProject/index.js",
14586     "groupTitle": "Jscripty_Projects"
14587   },
14588   {
14589     "type": "get",
14590     "url": "/api/jscripty/projects",
14591     "title": "Gets a list of Projects",
14592     "examples": [
14593       {
14594         "title": "Example usage:",
14595         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14596         "type": "json"
14597       }
14598     ],
14599     "name": "GetProjects",
14600     "group": "Jscripty_Projects",
14601     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14602     "version": "0.0.0",
14603     "filename": "server/api/jscriptyProject/index.js",
14604     "groupTitle": "Jscripty_Projects"
14605   },
14606   {
14607     "type": "get",
14608     "url": "/api/jscripty/projects/{id}",
14609     "title": "Gets a single Project",
14610     "examples": [
14611       {
14612         "title": "Example usage:",
14613         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14614         "type": "json"
14615       }
14616     ],
14617     "name": "ShowProjects",
14618     "group": "Jscripty_Projects",
14619     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14620     "version": "0.0.0",
14621     "filename": "server/api/jscriptyProject/index.js",
14622     "groupTitle": "Jscripty_Projects"
14623   },
14624   {
14625     "type": "get",
14626     "url": "/api/jscripty/projects/{id}/answers",
14627     "title": "Gets jscripty project answers",
14628     "examples": [
14629       {
14630         "title": "Example usage:",
14631         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
14632         "type": "json"
14633       }
14634     ],
14635     "name": "getAnswers",
14636     "group": "Jscripty_Projects",
14637     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14638     "version": "0.0.0",
14639     "filename": "server/api/jscriptyProject/index.js",
14640     "groupTitle": "Jscripty_Projects"
14641   },
14642   {
14643     "type": "get",
14644     "url": "/api/jscripty/projects/{id}/sessions",
14645     "title": "Gets jscripty project sessions",
14646     "examples": [
14647       {
14648         "title": "Example usage:",
14649         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
14650         "type": "json"
14651       }
14652     ],
14653     "name": "getSessions",
14654     "group": "Jscripty_Projects",
14655     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14656     "version": "0.0.0",
14657     "filename": "server/api/jscriptyProject/index.js",
14658     "groupTitle": "Jscripty_Projects"
14659   },
14660   {
14661     "type": "get",
14662     "url": "/api/jscripty/projects/{id}/summary",
14663     "title": "Gets jscripty project summary",
14664     "examples": [
14665       {
14666         "title": "Example usage:",
14667         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
14668         "type": "json"
14669       }
14670     ],
14671     "name": "getSummary",
14672     "group": "Jscripty_Projects",
14673     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14674     "version": "0.0.0",
14675     "filename": "server/api/jscriptyProject/index.js",
14676     "groupTitle": "Jscripty_Projects"
14677   },
14678   {
14679     "type": "put",
14680     "url": "/api/jscripty/projects/{id}",
14681     "title": "Update an existing Project",
14682     "examples": [
14683       {
14684         "title": "Example usage:",
14685         "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",
14686         "type": "json"
14687       }
14688     ],
14689     "name": "updateProjects",
14690     "group": "Jscripty_Projects",
14691     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14692     "version": "0.0.0",
14693     "filename": "server/api/jscriptyProject/index.js",
14694     "groupTitle": "Jscripty_Projects"
14695   },
14696   {
14697     "type": "get",
14698     "url": "/api/license",
14699     "title": "Gets License Info",
14700     "examples": [
14701       {
14702         "title": "Example usage:",
14703         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14704         "type": "json"
14705       }
14706     ],
14707     "name": "index",
14708     "group": "License",
14709     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14710     "version": "0.0.0",
14711     "filename": "server/api/license/index.js",
14712     "groupTitle": "License"
14713   },
14714   {
14715     "type": "put",
14716     "url": "/api/license/{id}",
14717     "title": "Update License Info",
14718     "examples": [
14719       {
14720         "title": "Example usage:",
14721         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14722         "type": "json"
14723       }
14724     ],
14725     "name": "update",
14726     "group": "License",
14727     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14728     "version": "0.0.0",
14729     "filename": "server/api/license/index.js",
14730     "groupTitle": "License"
14731   },
14732   {
14733     "type": "post",
14734     "url": "/api/mail/accounts/{id}/users",
14735     "title": "Add agents to a mail account",
14736     "examples": [
14737       {
14738         "title": "Example usage:",
14739         "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",
14740         "type": "json"
14741       }
14742     ],
14743     "name": "AddAgents",
14744     "group": "Mail_Accounts",
14745     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14746     "version": "0.0.0",
14747     "filename": "server/api/mailAccount/index.js",
14748     "groupTitle": "Mail_Accounts"
14749   },
14750   {
14751     "type": "post",
14752     "url": "/api/mail/accounts/{id}/in_servers",
14753     "title": "Creates a new IMAP server",
14754     "examples": [
14755       {
14756         "title": "Example usage:",
14757         "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",
14758         "type": "json"
14759       }
14760     ],
14761     "name": "AddImap",
14762     "group": "Mail_Accounts",
14763     "parameter": {
14764       "fields": {
14765         "Body": [
14766           {
14767             "group": "Body",
14768             "type": "String",
14769             "optional": true,
14770             "field": "description",
14771             "description": ""
14772           },
14773           {
14774             "group": "Body",
14775             "type": "String",
14776             "optional": true,
14777             "field": "host",
14778             "description": ""
14779           },
14780           {
14781             "group": "Body",
14782             "type": "Boolean",
14783             "optional": true,
14784             "field": "authentication",
14785             "description": ""
14786           },
14787           {
14788             "group": "Body",
14789             "type": "String",
14790             "optional": true,
14791             "field": "user",
14792             "description": ""
14793           },
14794           {
14795             "group": "Body",
14796             "type": "String",
14797             "optional": true,
14798             "field": "password",
14799             "description": ""
14800           },
14801           {
14802             "group": "Body",
14803             "type": "Integer",
14804             "optional": true,
14805             "field": "port",
14806             "description": ""
14807           },
14808           {
14809             "group": "Body",
14810             "type": "Boolean",
14811             "optional": true,
14812             "field": "tls",
14813             "description": ""
14814           },
14815           {
14816             "group": "Body",
14817             "type": "String",
14818             "optional": true,
14819             "field": "mailbox",
14820             "description": ""
14821           },
14822           {
14823             "group": "Body",
14824             "type": "Integer",
14825             "optional": true,
14826             "field": "connTimeout",
14827             "description": ""
14828           },
14829           {
14830             "group": "Body",
14831             "type": "Integer",
14832             "optional": true,
14833             "field": "authTimeout",
14834             "description": ""
14835           },
14836           {
14837             "group": "Body",
14838             "type": "String",
14839             "optional": true,
14840             "field": "service",
14841             "description": ""
14842           }
14843         ]
14844       }
14845     },
14846     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14847     "version": "0.0.0",
14848     "filename": "server/api/mailAccount/index.js",
14849     "groupTitle": "Mail_Accounts"
14850   },
14851   {
14852     "type": "post",
14853     "url": "/api/mail/accounts/{id}/out_servers",
14854     "title": "Creates a new SMTP server",
14855     "examples": [
14856       {
14857         "title": "Example usage:",
14858         "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",
14859         "type": "json"
14860       }
14861     ],
14862     "name": "AddSmtp",
14863     "group": "Mail_Accounts",
14864     "parameter": {
14865       "fields": {
14866         "Body": [
14867           {
14868             "group": "Body",
14869             "type": "String",
14870             "optional": true,
14871             "field": "description",
14872             "description": ""
14873           },
14874           {
14875             "group": "Body",
14876             "type": "String",
14877             "optional": true,
14878             "field": "host",
14879             "description": ""
14880           },
14881           {
14882             "group": "Body",
14883             "type": "String",
14884             "optional": true,
14885             "field": "user",
14886             "description": ""
14887           },
14888           {
14889             "group": "Body",
14890             "type": "String",
14891             "optional": true,
14892             "field": "pass",
14893             "description": ""
14894           },
14895           {
14896             "group": "Body",
14897             "type": "Integer",
14898             "optional": true,
14899             "field": "port",
14900             "description": ""
14901           },
14902           {
14903             "group": "Body",
14904             "type": "Boolean",
14905             "optional": true,
14906             "field": "secure",
14907             "description": ""
14908           },
14909           {
14910             "group": "Body",
14911             "type": "String",
14912             "optional": true,
14913             "field": "service",
14914             "description": ""
14915           },
14916           {
14917             "group": "Body",
14918             "type": "Boolean",
14919             "optional": true,
14920             "field": "authentication",
14921             "description": ""
14922           }
14923         ]
14924       }
14925     },
14926     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14927     "version": "0.0.0",
14928     "filename": "server/api/mailAccount/index.js",
14929     "groupTitle": "Mail_Accounts"
14930   },
14931   {
14932     "type": "delete",
14933     "url": "/api/mail/accounts/{id}",
14934     "title": "Deletes a mail account",
14935     "examples": [
14936       {
14937         "title": "Example usage:",
14938         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14939         "type": "json"
14940       }
14941     ],
14942     "name": "DeleteMailAccounts",
14943     "group": "Mail_Accounts",
14944     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14945     "version": "0.0.0",
14946     "filename": "server/api/mailAccount/index.js",
14947     "groupTitle": "Mail_Accounts"
14948   },
14949   {
14950     "type": "get",
14951     "url": "/api/mail/accounts/describe",
14952     "title": "Gets table info about Accounts",
14953     "examples": [
14954       {
14955         "title": "Example usage:",
14956         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14957         "type": "json"
14958       }
14959     ],
14960     "name": "DescribeAccounts",
14961     "group": "Mail_Accounts",
14962     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14963     "version": "0.0.0",
14964     "filename": "server/api/mailAccount/index.js",
14965     "groupTitle": "Mail_Accounts"
14966   },
14967   {
14968     "type": "get",
14969     "url": "/api/mail/accounts",
14970     "title": "Gets a list of Accounts",
14971     "examples": [
14972       {
14973         "title": "Example usage:",
14974         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14975         "type": "json"
14976       }
14977     ],
14978     "name": "GetAccounts",
14979     "group": "Mail_Accounts",
14980     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14981     "version": "0.0.0",
14982     "filename": "server/api/mailAccount/index.js",
14983     "groupTitle": "Mail_Accounts"
14984   },
14985   {
14986     "type": "get",
14987     "url": "/api/mail/accounts/{id}/users",
14988     "title": "Gets agents from mail account",
14989     "examples": [
14990       {
14991         "title": "Example usage:",
14992         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
14993         "type": "json"
14994       }
14995     ],
14996     "name": "GetAgents",
14997     "group": "Mail_Accounts",
14998     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14999     "version": "0.0.0",
15000     "filename": "server/api/mailAccount/index.js",
15001     "groupTitle": "Mail_Accounts"
15002   },
15003   {
15004     "type": "get",
15005     "url": "/api/mail/accounts/{id}/in_servers",
15006     "title": "Gets account IMAP server",
15007     "examples": [
15008       {
15009         "title": "Example usage:",
15010         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15011         "type": "json"
15012       }
15013     ],
15014     "name": "GetImap",
15015     "group": "Mail_Accounts",
15016     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15017     "version": "0.0.0",
15018     "filename": "server/api/mailAccount/index.js",
15019     "groupTitle": "Mail_Accounts"
15020   },
15021   {
15022     "type": "get",
15023     "url": "/api/mail/accounts/{id}/out_servers",
15024     "title": "Gets account SMTP server",
15025     "examples": [
15026       {
15027         "title": "Example usage:",
15028         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15029         "type": "json"
15030       }
15031     ],
15032     "name": "GetSmtp",
15033     "group": "Mail_Accounts",
15034     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15035     "version": "0.0.0",
15036     "filename": "server/api/mailAccount/index.js",
15037     "groupTitle": "Mail_Accounts"
15038   },
15039   {
15040     "type": "delete",
15041     "url": "/api/mail/accounts/{id}/users",
15042     "title": "Removes agents from a mail account",
15043     "examples": [
15044       {
15045         "title": "Example usage:",
15046         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15047         "type": "json"
15048       }
15049     ],
15050     "name": "RemoveAgents",
15051     "group": "Mail_Accounts",
15052     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15053     "version": "0.0.0",
15054     "filename": "server/api/mailAccount/index.js",
15055     "groupTitle": "Mail_Accounts"
15056   },
15057   {
15058     "type": "delete",
15059     "url": "/api/mail/accounts/{id}/canned_answers",
15060     "title": "Removes canned answers from account",
15061     "examples": [
15062       {
15063         "title": "Example usage:",
15064         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15065         "type": "json"
15066       }
15067     ],
15068     "name": "RemoveAnswers",
15069     "group": "Mail_Accounts",
15070     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15071     "version": "0.0.0",
15072     "filename": "server/api/mailAccount/index.js",
15073     "groupTitle": "Mail_Accounts"
15074   },
15075   {
15076     "type": "delete",
15077     "url": "/api/mail/accounts/{id}/dispositions",
15078     "title": "Removes dispositions from account",
15079     "examples": [
15080       {
15081         "title": "Example usage:",
15082         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15083         "type": "json"
15084       }
15085     ],
15086     "name": "RemoveDispositions",
15087     "group": "Mail_Accounts",
15088     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15089     "version": "0.0.0",
15090     "filename": "server/api/mailAccount/index.js",
15091     "groupTitle": "Mail_Accounts"
15092   },
15093   {
15094     "type": "delete",
15095     "url": "/api/mail/accounts/{id}/in_servers",
15096     "title": "Removes IMAP server from an account",
15097     "examples": [
15098       {
15099         "title": "Example usage:",
15100         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15101         "type": "json"
15102       }
15103     ],
15104     "name": "RemoveImmap",
15105     "group": "Mail_Accounts",
15106     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15107     "version": "0.0.0",
15108     "filename": "server/api/mailAccount/index.js",
15109     "groupTitle": "Mail_Accounts"
15110   },
15111   {
15112     "type": "delete",
15113     "url": "/api/mail/accounts/{id}/out_servers",
15114     "title": "Removes SMTP server from an account",
15115     "examples": [
15116       {
15117         "title": "Example usage:",
15118         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15119         "type": "json"
15120       }
15121     ],
15122     "name": "RemoveSmtp",
15123     "group": "Mail_Accounts",
15124     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15125     "version": "0.0.0",
15126     "filename": "server/api/mailAccount/index.js",
15127     "groupTitle": "Mail_Accounts"
15128   },
15129   {
15130     "type": "get",
15131     "url": "/api/mail/accounts/{id}",
15132     "title": "Gets a single Account",
15133     "examples": [
15134       {
15135         "title": "Example usage:",
15136         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15137         "type": "json"
15138       }
15139     ],
15140     "name": "ShowAccounts",
15141     "group": "Mail_Accounts",
15142     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15143     "version": "0.0.0",
15144     "filename": "server/api/mailAccount/index.js",
15145     "groupTitle": "Mail_Accounts"
15146   },
15147   {
15148     "type": "post",
15149     "url": "/api/mail/accounts/{id}/canned_answers",
15150     "title": "Creates new canned answer",
15151     "examples": [
15152       {
15153         "title": "Example usage:",
15154         "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",
15155         "type": "json"
15156       }
15157     ],
15158     "name": "addAnswer",
15159     "group": "Mail_Accounts",
15160     "parameter": {
15161       "fields": {
15162         "Body": [
15163           {
15164             "group": "Body",
15165             "type": "String",
15166             "optional": false,
15167             "field": "key",
15168             "description": ""
15169           },
15170           {
15171             "group": "Body",
15172             "type": "Text",
15173             "optional": false,
15174             "field": "value",
15175             "description": ""
15176           },
15177           {
15178             "group": "Body",
15179             "type": "String",
15180             "optional": true,
15181             "field": "description",
15182             "description": ""
15183           },
15184           {
15185             "group": "Body",
15186             "type": "Virtual",
15187             "optional": true,
15188             "field": "name",
15189             "description": ""
15190           }
15191         ]
15192       }
15193     },
15194     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15195     "version": "0.0.0",
15196     "filename": "server/api/mailAccount/index.js",
15197     "groupTitle": "Mail_Accounts"
15198   },
15199   {
15200     "type": "post",
15201     "url": "/api/mail/accounts/{id}/applications",
15202     "title": "Creates new applications",
15203     "examples": [
15204       {
15205         "title": "Example usage:",
15206         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15207         "type": "json"
15208       }
15209     ],
15210     "name": "addApplications",
15211     "group": "Mail_Accounts",
15212     "parameter": {
15213       "fields": {
15214         "Body": [
15215           {
15216             "group": "Body",
15217             "type": "Integer",
15218             "optional": false,
15219             "field": "priority",
15220             "description": ""
15221           },
15222           {
15223             "group": "Body",
15224             "type": "String",
15225             "optional": false,
15226             "field": "app",
15227             "description": ""
15228           },
15229           {
15230             "group": "Body",
15231             "type": "Text",
15232             "optional": true,
15233             "field": "appdata",
15234             "description": ""
15235           },
15236           {
15237             "group": "Body",
15238             "type": "String",
15239             "optional": true,
15240             "field": "description",
15241             "description": ""
15242           },
15243           {
15244             "group": "Body",
15245             "type": "String",
15246             "optional": true,
15247             "field": "interval",
15248             "description": ""
15249           }
15250         ]
15251       }
15252     },
15253     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15254     "version": "0.0.0",
15255     "filename": "server/api/mailAccount/index.js",
15256     "groupTitle": "Mail_Accounts"
15257   },
15258   {
15259     "type": "post",
15260     "url": "/api/mail/accounts/{id}/dispositions",
15261     "title": "Creates new disposition",
15262     "examples": [
15263       {
15264         "title": "Example usage:",
15265         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15266         "type": "json"
15267       }
15268     ],
15269     "name": "addDisposition",
15270     "group": "Mail_Accounts",
15271     "parameter": {
15272       "fields": {
15273         "Body": [
15274           {
15275             "group": "Body",
15276             "type": "String",
15277             "optional": false,
15278             "field": "name",
15279             "description": ""
15280           },
15281           {
15282             "group": "Body",
15283             "type": "String",
15284             "allowedValues": [
15285               "\"first\"",
15286               "\"second\"",
15287               "\"third\""
15288             ],
15289             "optional": false,
15290             "field": "level",
15291             "description": ""
15292           },
15293           {
15294             "group": "Body",
15295             "type": "String",
15296             "optional": true,
15297             "field": "description",
15298             "description": ""
15299           }
15300         ]
15301       }
15302     },
15303     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15304     "version": "0.0.0",
15305     "filename": "server/api/mailAccount/index.js",
15306     "groupTitle": "Mail_Accounts"
15307   },
15308   {
15309     "type": "post",
15310     "url": "/api/mail/accounts/{id}/interactions",
15311     "title": "Creates new interactions",
15312     "examples": [
15313       {
15314         "title": "Example usage:",
15315         "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",
15316         "type": "json"
15317       }
15318     ],
15319     "name": "addInteraction",
15320     "group": "Mail_Accounts",
15321     "parameter": {
15322       "fields": {
15323         "Body": [
15324           {
15325             "group": "Body",
15326             "type": "Boolean",
15327             "optional": true,
15328             "field": "closed",
15329             "description": ""
15330           },
15331           {
15332             "group": "Body",
15333             "type": "String",
15334             "optional": true,
15335             "field": "closedAt",
15336             "description": ""
15337           },
15338           {
15339             "group": "Body",
15340             "type": "String",
15341             "optional": true,
15342             "field": "disposition",
15343             "description": ""
15344           },
15345           {
15346             "group": "Body",
15347             "type": "String",
15348             "optional": true,
15349             "field": "secondDisposition",
15350             "description": ""
15351           },
15352           {
15353             "group": "Body",
15354             "type": "String",
15355             "optional": true,
15356             "field": "thirdDisposition",
15357             "description": ""
15358           },
15359           {
15360             "group": "Body",
15361             "type": "String",
15362             "optional": true,
15363             "field": "note",
15364             "description": ""
15365           },
15366           {
15367             "group": "Body",
15368             "type": "String",
15369             "optional": true,
15370             "field": "inReplyTo",
15371             "description": ""
15372           },
15373           {
15374             "group": "Body",
15375             "type": "String",
15376             "optional": true,
15377             "field": "to",
15378             "description": ""
15379           },
15380           {
15381             "group": "Body",
15382             "type": "Text",
15383             "optional": true,
15384             "field": "cc",
15385             "description": ""
15386           },
15387           {
15388             "group": "Body",
15389             "type": "Text",
15390             "optional": true,
15391             "field": "subject",
15392             "description": ""
15393           },
15394           {
15395             "group": "Body",
15396             "type": "Boolean",
15397             "optional": true,
15398             "field": "attach",
15399             "description": ""
15400           },
15401           {
15402             "group": "Body",
15403             "type": "String",
15404             "optional": true,
15405             "field": "read1stAt",
15406             "description": ""
15407           },
15408           {
15409             "group": "Body",
15410             "type": "String",
15411             "optional": true,
15412             "field": "substatus",
15413             "description": ""
15414           },
15415           {
15416             "group": "Body",
15417             "type": "String",
15418             "optional": true,
15419             "field": "substatusAt",
15420             "description": ""
15421           },
15422           {
15423             "group": "Body",
15424             "type": "String",
15425             "allowedValues": [
15426               "\"in\"",
15427               "\"out\""
15428             ],
15429             "optional": false,
15430             "field": "firstMsgDirection",
15431             "description": ""
15432           },
15433           {
15434             "group": "Body",
15435             "type": "String",
15436             "optional": true,
15437             "field": "lastMsgAt",
15438             "description": ""
15439           },
15440           {
15441             "group": "Body",
15442             "type": "String",
15443             "allowedValues": [
15444               "\"in\"",
15445               "\"out\""
15446             ],
15447             "optional": false,
15448             "field": "lastMsgDirection",
15449             "description": ""
15450           }
15451         ]
15452       }
15453     },
15454     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15455     "version": "0.0.0",
15456     "filename": "server/api/mailAccount/index.js",
15457     "groupTitle": "Mail_Accounts"
15458   },
15459   {
15460     "type": "post",
15461     "url": "/api/mail/accounts",
15462     "title": "Create a mail account",
15463     "examples": [
15464       {
15465         "title": "Example usage:",
15466         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15467         "type": "json"
15468       }
15469     ],
15470     "name": "create",
15471     "group": "Mail_Accounts",
15472     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15473     "version": "0.0.0",
15474     "filename": "server/api/mailAccount/index.js",
15475     "groupTitle": "Mail_Accounts"
15476   },
15477   {
15478     "type": "get",
15479     "url": "/api/mail/accounts/{id}/canned_answers",
15480     "title": "Gets account canned answers",
15481     "examples": [
15482       {
15483         "title": "Example usage:",
15484         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15485         "type": "json"
15486       }
15487     ],
15488     "name": "getAnswers",
15489     "group": "Mail_Accounts",
15490     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15491     "version": "0.0.0",
15492     "filename": "server/api/mailAccount/index.js",
15493     "groupTitle": "Mail_Accounts"
15494   },
15495   {
15496     "type": "get",
15497     "url": "/api/mail/accounts/{id}/applications",
15498     "title": "Gets account applications",
15499     "examples": [
15500       {
15501         "title": "Example usage:",
15502         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15503         "type": "json"
15504       }
15505     ],
15506     "name": "getApplications",
15507     "group": "Mail_Accounts",
15508     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15509     "version": "0.0.0",
15510     "filename": "server/api/mailAccount/index.js",
15511     "groupTitle": "Mail_Accounts"
15512   },
15513   {
15514     "type": "get",
15515     "url": "/api/mail/accounts/{id}/dispositions",
15516     "title": "Gets account dispositions",
15517     "examples": [
15518       {
15519         "title": "Example usage:",
15520         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15521         "type": "json"
15522       }
15523     ],
15524     "name": "getDispositions",
15525     "group": "Mail_Accounts",
15526     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15527     "version": "0.0.0",
15528     "filename": "server/api/mailAccount/index.js",
15529     "groupTitle": "Mail_Accounts"
15530   },
15531   {
15532     "type": "get",
15533     "url": "/api/mail/accounts/{id}/interactions",
15534     "title": "Gets account interactions",
15535     "examples": [
15536       {
15537         "title": "Example usage:",
15538         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15539         "type": "json"
15540       }
15541     ],
15542     "name": "getInteraction",
15543     "group": "Mail_Accounts",
15544     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15545     "version": "0.0.0",
15546     "filename": "server/api/mailAccount/index.js",
15547     "groupTitle": "Mail_Accounts"
15548   },
15549   {
15550     "type": "get",
15551     "url": "/api/mail/accounts/{id}/messages",
15552     "title": "Gets account messages",
15553     "examples": [
15554       {
15555         "title": "Example usage:",
15556         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15557         "type": "json"
15558       }
15559     ],
15560     "name": "getMessages",
15561     "group": "Mail_Accounts",
15562     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15563     "version": "0.0.0",
15564     "filename": "server/api/mailAccount/index.js",
15565     "groupTitle": "Mail_Accounts"
15566   },
15567   {
15568     "type": "post",
15569     "url": "/api/mail/accounts/{id}/send",
15570     "title": "Send new mail",
15571     "examples": [
15572       {
15573         "title": "Example usage:",
15574         "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",
15575         "type": "json"
15576       }
15577     ],
15578     "name": "sendMail",
15579     "group": "Mail_Accounts",
15580     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15581     "version": "0.0.0",
15582     "filename": "server/api/mailAccount/index.js",
15583     "groupTitle": "Mail_Accounts"
15584   },
15585   {
15586     "type": "put",
15587     "url": "/api/mail/accounts/{id}",
15588     "title": "Update an existing Account",
15589     "examples": [
15590       {
15591         "title": "Example usage:",
15592         "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",
15593         "type": "json"
15594       }
15595     ],
15596     "name": "updateAccounts",
15597     "group": "Mail_Accounts",
15598     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15599     "version": "0.0.0",
15600     "filename": "server/api/mailAccount/index.js",
15601     "groupTitle": "Mail_Accounts"
15602   },
15603   {
15604     "type": "get",
15605     "url": "/api/mail/accounts/{id}/verify",
15606     "title": "Verify mail account",
15607     "examples": [
15608       {
15609         "title": "Example usage:",
15610         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15611         "type": "json"
15612       }
15613     ],
15614     "name": "verifySmtp",
15615     "group": "Mail_Accounts",
15616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15617     "version": "0.0.0",
15618     "filename": "server/api/mailAccount/index.js",
15619     "groupTitle": "Mail_Accounts"
15620   },
15621   {
15622     "type": "delete",
15623     "url": "/api/mail/applications/{id}",
15624     "title": "Deletes a Application",
15625     "examples": [
15626       {
15627         "title": "Example usage:",
15628         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15629         "type": "json"
15630       }
15631     ],
15632     "name": "DeleteApplications",
15633     "group": "Mail_Applications",
15634     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15635     "version": "0.0.0",
15636     "filename": "server/api/mailApplication/index.js",
15637     "groupTitle": "Mail_Applications"
15638   },
15639   {
15640     "type": "get",
15641     "url": "/api/mail/applications/{id}",
15642     "title": "Gets a single Application",
15643     "examples": [
15644       {
15645         "title": "Example usage:",
15646         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15647         "type": "json"
15648       }
15649     ],
15650     "name": "ShowApplications",
15651     "group": "Mail_Applications",
15652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15653     "version": "0.0.0",
15654     "filename": "server/api/mailApplication/index.js",
15655     "groupTitle": "Mail_Applications"
15656   },
15657   {
15658     "type": "put",
15659     "url": "/api/mail/applications/{id}",
15660     "title": "Update an existing Application",
15661     "examples": [
15662       {
15663         "title": "Example usage:",
15664         "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",
15665         "type": "json"
15666       }
15667     ],
15668     "name": "updateApplications",
15669     "group": "Mail_Applications",
15670     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15671     "version": "0.0.0",
15672     "filename": "server/api/mailApplication/index.js",
15673     "groupTitle": "Mail_Applications"
15674   },
15675   {
15676     "type": "post",
15677     "url": "/api/mail/interactions/{id}/tags",
15678     "title": "Add tags to the interaction",
15679     "examples": [
15680       {
15681         "title": "Example usage:",
15682         "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",
15683         "type": "json"
15684       }
15685     ],
15686     "name": "AddTags",
15687     "group": "Mail_Interactions",
15688     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15689     "version": "0.0.0",
15690     "filename": "server/api/mailInteraction/index.js",
15691     "groupTitle": "Mail_Interactions"
15692   },
15693   {
15694     "type": "post",
15695     "url": "/api/mail/interactions",
15696     "title": "Creates a new Interaction",
15697     "examples": [
15698       {
15699         "title": "Example usage:",
15700         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15701         "type": "json"
15702       }
15703     ],
15704     "name": "CreateInteractions",
15705     "group": "Mail_Interactions",
15706     "parameter": {
15707       "fields": {
15708         "Body": [
15709           {
15710             "group": "Body",
15711             "type": "Boolean",
15712             "optional": true,
15713             "field": "closed",
15714             "description": ""
15715           },
15716           {
15717             "group": "Body",
15718             "type": "String",
15719             "optional": true,
15720             "field": "closedAt",
15721             "description": ""
15722           },
15723           {
15724             "group": "Body",
15725             "type": "String",
15726             "optional": true,
15727             "field": "disposition",
15728             "description": ""
15729           },
15730           {
15731             "group": "Body",
15732             "type": "String",
15733             "optional": true,
15734             "field": "secondDisposition",
15735             "description": ""
15736           },
15737           {
15738             "group": "Body",
15739             "type": "String",
15740             "optional": true,
15741             "field": "thirdDisposition",
15742             "description": ""
15743           },
15744           {
15745             "group": "Body",
15746             "type": "String",
15747             "optional": true,
15748             "field": "note",
15749             "description": ""
15750           },
15751           {
15752             "group": "Body",
15753             "type": "String",
15754             "optional": true,
15755             "field": "inReplyTo",
15756             "description": ""
15757           },
15758           {
15759             "group": "Body",
15760             "type": "String",
15761             "optional": true,
15762             "field": "to",
15763             "description": ""
15764           },
15765           {
15766             "group": "Body",
15767             "type": "Text",
15768             "optional": true,
15769             "field": "cc",
15770             "description": ""
15771           },
15772           {
15773             "group": "Body",
15774             "type": "Text",
15775             "optional": true,
15776             "field": "subject",
15777             "description": ""
15778           },
15779           {
15780             "group": "Body",
15781             "type": "Boolean",
15782             "optional": true,
15783             "field": "attach",
15784             "description": ""
15785           },
15786           {
15787             "group": "Body",
15788             "type": "String",
15789             "optional": true,
15790             "field": "read1stAt",
15791             "description": ""
15792           },
15793           {
15794             "group": "Body",
15795             "type": "String",
15796             "optional": true,
15797             "field": "substatus",
15798             "description": ""
15799           },
15800           {
15801             "group": "Body",
15802             "type": "String",
15803             "optional": true,
15804             "field": "substatusAt",
15805             "description": ""
15806           },
15807           {
15808             "group": "Body",
15809             "type": "String",
15810             "allowedValues": [
15811               "\"in\"",
15812               "\"out\""
15813             ],
15814             "optional": false,
15815             "field": "firstMsgDirection",
15816             "description": ""
15817           },
15818           {
15819             "group": "Body",
15820             "type": "String",
15821             "optional": true,
15822             "field": "lastMsgAt",
15823             "description": ""
15824           },
15825           {
15826             "group": "Body",
15827             "type": "String",
15828             "allowedValues": [
15829               "\"in\"",
15830               "\"out\""
15831             ],
15832             "optional": false,
15833             "field": "lastMsgDirection",
15834             "description": ""
15835           }
15836         ]
15837       }
15838     },
15839     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15840     "version": "0.0.0",
15841     "filename": "server/api/mailInteraction/index.js",
15842     "groupTitle": "Mail_Interactions"
15843   },
15844   {
15845     "type": "delete",
15846     "url": "/api/mail/interactions/{id}",
15847     "title": "Deletes a Interaction",
15848     "examples": [
15849       {
15850         "title": "Example usage:",
15851         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15852         "type": "json"
15853       }
15854     ],
15855     "name": "DeleteInteractions",
15856     "group": "Mail_Interactions",
15857     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15858     "version": "0.0.0",
15859     "filename": "server/api/mailInteraction/index.js",
15860     "groupTitle": "Mail_Interactions"
15861   },
15862   {
15863     "type": "get",
15864     "url": "/api/mail/interactions/describe",
15865     "title": "Gets table info about Interactions",
15866     "examples": [
15867       {
15868         "title": "Example usage:",
15869         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15870         "type": "json"
15871       }
15872     ],
15873     "name": "DescribeInteractions",
15874     "group": "Mail_Interactions",
15875     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15876     "version": "0.0.0",
15877     "filename": "server/api/mailInteraction/index.js",
15878     "groupTitle": "Mail_Interactions"
15879   },
15880   {
15881     "type": "get",
15882     "url": "/api/mail/interactions",
15883     "title": "Gets a list of Interactions",
15884     "examples": [
15885       {
15886         "title": "Example usage:",
15887         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15888         "type": "json"
15889       }
15890     ],
15891     "name": "GetInteractions",
15892     "group": "Mail_Interactions",
15893     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15894     "version": "0.0.0",
15895     "filename": "server/api/mailInteraction/index.js",
15896     "groupTitle": "Mail_Interactions"
15897   },
15898   {
15899     "type": "delete",
15900     "url": "/api/mail/interactions/{id}/tags",
15901     "title": "Removes tags from interaction",
15902     "examples": [
15903       {
15904         "title": "Example usage:",
15905         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15906         "type": "json"
15907       }
15908     ],
15909     "name": "RemoveTags",
15910     "group": "Mail_Interactions",
15911     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15912     "version": "0.0.0",
15913     "filename": "server/api/mailInteraction/index.js",
15914     "groupTitle": "Mail_Interactions"
15915   },
15916   {
15917     "type": "get",
15918     "url": "/api/mail/interactions/{id}",
15919     "title": "Gets a single Interaction",
15920     "examples": [
15921       {
15922         "title": "Example usage:",
15923         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15924         "type": "json"
15925       }
15926     ],
15927     "name": "ShowInteractions",
15928     "group": "Mail_Interactions",
15929     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15930     "version": "0.0.0",
15931     "filename": "server/api/mailInteraction/index.js",
15932     "groupTitle": "Mail_Interactions"
15933   },
15934   {
15935     "type": "post",
15936     "url": "/api/mail/interactions/{id}/messages",
15937     "title": "Creates new message",
15938     "examples": [
15939       {
15940         "title": "Example usage:",
15941         "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",
15942         "type": "json"
15943       }
15944     ],
15945     "name": "addMessage",
15946     "group": "Mail_Interactions",
15947     "parameter": {
15948       "fields": {
15949         "Body": [
15950           {
15951             "group": "Body",
15952             "type": "Text",
15953             "optional": false,
15954             "field": "body",
15955             "description": ""
15956           },
15957           {
15958             "group": "Body",
15959             "type": "Text",
15960             "optional": true,
15961             "field": "plainBody",
15962             "description": ""
15963           },
15964           {
15965             "group": "Body",
15966             "type": "Boolean",
15967             "optional": true,
15968             "field": "read",
15969             "description": ""
15970           },
15971           {
15972             "group": "Body",
15973             "type": "String",
15974             "allowedValues": [
15975               "\"in\"",
15976               "\"out\""
15977             ],
15978             "optional": false,
15979             "field": "direction",
15980             "description": ""
15981           },
15982           {
15983             "group": "Body",
15984             "type": "String",
15985             "optional": true,
15986             "field": "messageId",
15987             "description": ""
15988           },
15989           {
15990             "group": "Body",
15991             "type": "String",
15992             "optional": true,
15993             "field": "from",
15994             "description": ""
15995           },
15996           {
15997             "group": "Body",
15998             "type": "Text",
15999             "optional": true,
16000             "field": "to",
16001             "description": ""
16002           },
16003           {
16004             "group": "Body",
16005             "type": "Text",
16006             "optional": true,
16007             "field": "cc",
16008             "description": ""
16009           },
16010           {
16011             "group": "Body",
16012             "type": "Text",
16013             "optional": true,
16014             "field": "bcc",
16015             "description": ""
16016           },
16017           {
16018             "group": "Body",
16019             "type": "Text",
16020             "optional": true,
16021             "field": "subject",
16022             "description": ""
16023           },
16024           {
16025             "group": "Body",
16026             "type": "String",
16027             "optional": true,
16028             "field": "sentAt",
16029             "description": ""
16030           },
16031           {
16032             "group": "Body",
16033             "type": "Integer",
16034             "optional": true,
16035             "field": "attach",
16036             "description": ""
16037           },
16038           {
16039             "group": "Body",
16040             "type": "Boolean",
16041             "optional": true,
16042             "field": "secret",
16043             "description": ""
16044           },
16045           {
16046             "group": "Body",
16047             "type": "String",
16048             "optional": true,
16049             "field": "readAt",
16050             "description": ""
16051           },
16052           {
16053             "group": "Body",
16054             "type": "Text",
16055             "optional": true,
16056             "field": "originTo",
16057             "description": ""
16058           },
16059           {
16060             "group": "Body",
16061             "type": "Text",
16062             "optional": true,
16063             "field": "originCc",
16064             "description": ""
16065           },
16066           {
16067             "group": "Body",
16068             "type": "String",
16069             "allowedValues": [
16070               "\"Email\"",
16071               "\"Chat\""
16072             ],
16073             "optional": false,
16074             "field": "originChannel",
16075             "description": ""
16076           }
16077         ]
16078       }
16079     },
16080     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16081     "version": "0.0.0",
16082     "filename": "server/api/mailInteraction/index.js",
16083     "groupTitle": "Mail_Interactions"
16084   },
16085   {
16086     "type": "get",
16087     "url": "/api/mail/interactions/{id}/download",
16088     "title": "Gets interaction",
16089     "examples": [
16090       {
16091         "title": "Example usage:",
16092         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16093         "type": "json"
16094       }
16095     ],
16096     "name": "download",
16097     "group": "Mail_Interactions",
16098     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16099     "version": "0.0.0",
16100     "filename": "server/api/mailInteraction/index.js",
16101     "groupTitle": "Mail_Interactions"
16102   },
16103   {
16104     "type": "get",
16105     "url": "/api/mail/interactions/{id}/messages",
16106     "title": "Gets interaction messages",
16107     "examples": [
16108       {
16109         "title": "Example usage:",
16110         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16111         "type": "json"
16112       }
16113     ],
16114     "name": "getMessages",
16115     "group": "Mail_Interactions",
16116     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16117     "version": "0.0.0",
16118     "filename": "server/api/mailInteraction/index.js",
16119     "groupTitle": "Mail_Interactions"
16120   },
16121   {
16122     "type": "put",
16123     "url": "/api/mail/interactions/{id}",
16124     "title": "Update an existing Interaction",
16125     "examples": [
16126       {
16127         "title": "Example usage:",
16128         "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",
16129         "type": "json"
16130       }
16131     ],
16132     "name": "updateInteractions",
16133     "group": "Mail_Interactions",
16134     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16135     "version": "0.0.0",
16136     "filename": "server/api/mailInteraction/index.js",
16137     "groupTitle": "Mail_Interactions"
16138   },
16139   {
16140     "type": "delete",
16141     "url": "/api/mail/messages/{id}",
16142     "title": "Deletes a Message",
16143     "examples": [
16144       {
16145         "title": "Example usage:",
16146         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16147         "type": "json"
16148       }
16149     ],
16150     "name": "DeleteMessages",
16151     "group": "Mail_Messages",
16152     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16153     "version": "0.0.0",
16154     "filename": "server/api/mailMessage/index.js",
16155     "groupTitle": "Mail_Messages"
16156   },
16157   {
16158     "type": "get",
16159     "url": "/api/mail/messages/describe",
16160     "title": "Gets table info about Messages",
16161     "examples": [
16162       {
16163         "title": "Example usage:",
16164         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16165         "type": "json"
16166       }
16167     ],
16168     "name": "DescribeMessages",
16169     "group": "Mail_Messages",
16170     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16171     "version": "0.0.0",
16172     "filename": "server/api/mailMessage/index.js",
16173     "groupTitle": "Mail_Messages"
16174   },
16175   {
16176     "type": "get",
16177     "url": "/api/mail/messages",
16178     "title": "Gets a list of Messages",
16179     "examples": [
16180       {
16181         "title": "Example usage:",
16182         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16183         "type": "json"
16184       }
16185     ],
16186     "name": "GetMessages",
16187     "group": "Mail_Messages",
16188     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16189     "version": "0.0.0",
16190     "filename": "server/api/mailMessage/index.js",
16191     "groupTitle": "Mail_Messages"
16192   },
16193   {
16194     "type": "get",
16195     "url": "/api/mail/messages/{id}",
16196     "title": "Gets a single Message",
16197     "examples": [
16198       {
16199         "title": "Example usage:",
16200         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16201         "type": "json"
16202       }
16203     ],
16204     "name": "ShowMessages",
16205     "group": "Mail_Messages",
16206     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16207     "version": "0.0.0",
16208     "filename": "server/api/mailMessage/index.js",
16209     "groupTitle": "Mail_Messages"
16210   },
16211   {
16212     "type": "put",
16213     "url": "/api/mail/messages/{id}/accept",
16214     "title": "Accepts message",
16215     "examples": [
16216       {
16217         "title": "Example usage:",
16218         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16219         "type": "json"
16220       }
16221     ],
16222     "name": "acceptMessage",
16223     "group": "Mail_Messages",
16224     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16225     "version": "0.0.0",
16226     "filename": "server/api/mailMessage/index.js",
16227     "groupTitle": "Mail_Messages"
16228   },
16229   {
16230     "type": "post",
16231     "url": "/api/mail/messages",
16232     "title": "Create a message",
16233     "examples": [
16234       {
16235         "title": "Example usage:",
16236         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16237         "type": "json"
16238       }
16239     ],
16240     "name": "createMessage",
16241     "group": "Mail_Messages",
16242     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16243     "version": "0.0.0",
16244     "filename": "server/api/mailMessage/index.js",
16245     "groupTitle": "Mail_Messages"
16246   },
16247   {
16248     "type": "get",
16249     "url": "/api/mail/messages/{id}/download",
16250     "title": "Gets message",
16251     "examples": [
16252       {
16253         "title": "Example usage:",
16254         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16255         "type": "json"
16256       }
16257     ],
16258     "name": "download",
16259     "group": "Mail_Messages",
16260     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16261     "version": "0.0.0",
16262     "filename": "server/api/mailMessage/index.js",
16263     "groupTitle": "Mail_Messages"
16264   },
16265   {
16266     "type": "put",
16267     "url": "/api/mail/messages/{id}/reject",
16268     "title": "Rejects message",
16269     "examples": [
16270       {
16271         "title": "Example usage:",
16272         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16273         "type": "json"
16274       }
16275     ],
16276     "name": "rejectMessage",
16277     "group": "Mail_Messages",
16278     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16279     "version": "0.0.0",
16280     "filename": "server/api/mailMessage/index.js",
16281     "groupTitle": "Mail_Messages"
16282   },
16283   {
16284     "type": "put",
16285     "url": "/api/mail/messages/{id}",
16286     "title": "Update an existing Message",
16287     "examples": [
16288       {
16289         "title": "Example usage:",
16290         "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",
16291         "type": "json"
16292       }
16293     ],
16294     "name": "updateMessages",
16295     "group": "Mail_Messages",
16296     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16297     "version": "0.0.0",
16298     "filename": "server/api/mailMessage/index.js",
16299     "groupTitle": "Mail_Messages"
16300   },
16301   {
16302     "type": "post",
16303     "url": "/api/mail/reports/queue",
16304     "title": "Creates a new Mail Queue Report",
16305     "examples": [
16306       {
16307         "title": "Example usage:",
16308         "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",
16309         "type": "json"
16310       }
16311     ],
16312     "name": "CreateMail_Queue_Reports",
16313     "group": "Mail_Queue_Reports",
16314     "parameter": {
16315       "fields": {
16316         "Body": [
16317           {
16318             "group": "Body",
16319             "type": "String",
16320             "optional": false,
16321             "field": "uniqueid",
16322             "description": ""
16323           },
16324           {
16325             "group": "Body",
16326             "type": "String",
16327             "optional": true,
16328             "field": "from",
16329             "description": ""
16330           },
16331           {
16332             "group": "Body",
16333             "type": "String",
16334             "optional": true,
16335             "field": "joinAt",
16336             "description": ""
16337           },
16338           {
16339             "group": "Body",
16340             "type": "String",
16341             "optional": true,
16342             "field": "leaveAt",
16343             "description": ""
16344           },
16345           {
16346             "group": "Body",
16347             "type": "String",
16348             "optional": true,
16349             "field": "acceptAt",
16350             "description": ""
16351           },
16352           {
16353             "group": "Body",
16354             "type": "String",
16355             "optional": true,
16356             "field": "exitAt",
16357             "description": ""
16358           },
16359           {
16360             "group": "Body",
16361             "type": "String",
16362             "optional": true,
16363             "field": "reason",
16364             "description": ""
16365           }
16366         ]
16367       }
16368     },
16369     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16370     "version": "0.0.0",
16371     "filename": "server/api/mailQueueReport/index.js",
16372     "groupTitle": "Mail_Queue_Reports"
16373   },
16374   {
16375     "type": "delete",
16376     "url": "/api/mail/reports/queue/{id}",
16377     "title": "Deletes a Mail Queue Report",
16378     "examples": [
16379       {
16380         "title": "Example usage:",
16381         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16382         "type": "json"
16383       }
16384     ],
16385     "name": "DeleteMail_Queue_Reports",
16386     "group": "Mail_Queue_Reports",
16387     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16388     "version": "0.0.0",
16389     "filename": "server/api/mailQueueReport/index.js",
16390     "groupTitle": "Mail_Queue_Reports"
16391   },
16392   {
16393     "type": "get",
16394     "url": "/api/mail/reports/queue/describe",
16395     "title": "Gets table info about Mail Queue Reports",
16396     "examples": [
16397       {
16398         "title": "Example usage:",
16399         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16400         "type": "json"
16401       }
16402     ],
16403     "name": "DescribeMail_Queue_Reports",
16404     "group": "Mail_Queue_Reports",
16405     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16406     "version": "0.0.0",
16407     "filename": "server/api/mailQueueReport/index.js",
16408     "groupTitle": "Mail_Queue_Reports"
16409   },
16410   {
16411     "type": "get",
16412     "url": "/api/mail/reports/queue",
16413     "title": "Gets a list of Mail Queue Reports",
16414     "examples": [
16415       {
16416         "title": "Example usage:",
16417         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16418         "type": "json"
16419       }
16420     ],
16421     "name": "GetMail_Queue_Reports",
16422     "group": "Mail_Queue_Reports",
16423     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16424     "version": "0.0.0",
16425     "filename": "server/api/mailQueueReport/index.js",
16426     "groupTitle": "Mail_Queue_Reports"
16427   },
16428   {
16429     "type": "get",
16430     "url": "/api/mail/reports/queue/{id}",
16431     "title": "Gets a single Mail Queue Report",
16432     "examples": [
16433       {
16434         "title": "Example usage:",
16435         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16436         "type": "json"
16437       }
16438     ],
16439     "name": "ShowMail_Queue_Reports",
16440     "group": "Mail_Queue_Reports",
16441     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16442     "version": "0.0.0",
16443     "filename": "server/api/mailQueueReport/index.js",
16444     "groupTitle": "Mail_Queue_Reports"
16445   },
16446   {
16447     "type": "put",
16448     "url": "/api/mail/reports/queue/{id}",
16449     "title": "Update an existing Mail Queue Report",
16450     "examples": [
16451       {
16452         "title": "Example usage:",
16453         "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",
16454         "type": "json"
16455       }
16456     ],
16457     "name": "updateMail_Queue_Reports",
16458     "group": "Mail_Queue_Reports",
16459     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16460     "version": "0.0.0",
16461     "filename": "server/api/mailQueueReport/index.js",
16462     "groupTitle": "Mail_Queue_Reports"
16463   },
16464   {
16465     "type": "post",
16466     "url": "/api/mail/queues/{id}/users",
16467     "title": "Add agents to a queue",
16468     "examples": [
16469       {
16470         "title": "Example usage:",
16471         "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",
16472         "type": "json"
16473       }
16474     ],
16475     "name": "AddAgents",
16476     "group": "Mail_Queues",
16477     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16478     "version": "0.0.0",
16479     "filename": "server/api/mailQueue/index.js",
16480     "groupTitle": "Mail_Queues"
16481   },
16482   {
16483     "type": "post",
16484     "url": "/api/mail/queues/{id}/teams",
16485     "title": "Add teams to a queue",
16486     "examples": [
16487       {
16488         "title": "Example usage:",
16489         "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",
16490         "type": "json"
16491       }
16492     ],
16493     "name": "AddTeams",
16494     "group": "Mail_Queues",
16495     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16496     "version": "0.0.0",
16497     "filename": "server/api/mailQueue/index.js",
16498     "groupTitle": "Mail_Queues"
16499   },
16500   {
16501     "type": "post",
16502     "url": "/api/mail/queues",
16503     "title": "Creates a new Queue",
16504     "examples": [
16505       {
16506         "title": "Example usage:",
16507         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16508         "type": "json"
16509       }
16510     ],
16511     "name": "CreateQueues",
16512     "group": "Mail_Queues",
16513     "parameter": {
16514       "fields": {
16515         "Body": [
16516           {
16517             "group": "Body",
16518             "type": "String",
16519             "optional": true,
16520             "field": "name",
16521             "description": ""
16522           },
16523           {
16524             "group": "Body",
16525             "type": "String",
16526             "optional": true,
16527             "field": "description",
16528             "description": ""
16529           },
16530           {
16531             "group": "Body",
16532             "type": "Integer",
16533             "optional": true,
16534             "field": "timeout",
16535             "description": ""
16536           },
16537           {
16538             "group": "Body",
16539             "type": "String",
16540             "allowedValues": [
16541               "\"rrmemory\"",
16542               "\"beepall\"",
16543               "\"roundrobin\""
16544             ],
16545             "optional": true,
16546             "field": "strategy",
16547             "description": ""
16548           }
16549         ]
16550       }
16551     },
16552     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16553     "version": "0.0.0",
16554     "filename": "server/api/mailQueue/index.js",
16555     "groupTitle": "Mail_Queues"
16556   },
16557   {
16558     "type": "delete",
16559     "url": "/api/mail/queues/{id}",
16560     "title": "Deletes a Queue",
16561     "examples": [
16562       {
16563         "title": "Example usage:",
16564         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16565         "type": "json"
16566       }
16567     ],
16568     "name": "DeleteQueues",
16569     "group": "Mail_Queues",
16570     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16571     "version": "0.0.0",
16572     "filename": "server/api/mailQueue/index.js",
16573     "groupTitle": "Mail_Queues"
16574   },
16575   {
16576     "type": "get",
16577     "url": "/api/mail/queues/describe",
16578     "title": "Gets table info about Queues",
16579     "examples": [
16580       {
16581         "title": "Example usage:",
16582         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16583         "type": "json"
16584       }
16585     ],
16586     "name": "DescribeQueues",
16587     "group": "Mail_Queues",
16588     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16589     "version": "0.0.0",
16590     "filename": "server/api/mailQueue/index.js",
16591     "groupTitle": "Mail_Queues"
16592   },
16593   {
16594     "type": "get",
16595     "url": "/api/mail/queues/{id}/users",
16596     "title": "Gets queue agents",
16597     "examples": [
16598       {
16599         "title": "Example usage:",
16600         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16601         "type": "json"
16602       }
16603     ],
16604     "name": "GetAgents",
16605     "group": "Mail_Queues",
16606     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16607     "version": "0.0.0",
16608     "filename": "server/api/mailQueue/index.js",
16609     "groupTitle": "Mail_Queues"
16610   },
16611   {
16612     "type": "get",
16613     "url": "/api/mail/queues/{id}/members",
16614     "title": "GetMembers",
16615     "examples": [
16616       {
16617         "title": "Example usage:",
16618         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
16619         "type": "json"
16620       }
16621     ],
16622     "name": "GetMembers",
16623     "group": "Mail_Queues",
16624     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16625     "version": "0.0.0",
16626     "filename": "server/api/mailQueue/index.js",
16627     "groupTitle": "Mail_Queues"
16628   },
16629   {
16630     "type": "get",
16631     "url": "/api/mail/queues",
16632     "title": "Gets a list of Queues",
16633     "examples": [
16634       {
16635         "title": "Example usage:",
16636         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16637         "type": "json"
16638       }
16639     ],
16640     "name": "GetQueues",
16641     "group": "Mail_Queues",
16642     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16643     "version": "0.0.0",
16644     "filename": "server/api/mailQueue/index.js",
16645     "groupTitle": "Mail_Queues"
16646   },
16647   {
16648     "type": "get",
16649     "url": "/api/mail/queues/{id}/teams",
16650     "title": "Gets queues list",
16651     "examples": [
16652       {
16653         "title": "Example usage:",
16654         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16655         "type": "json"
16656       }
16657     ],
16658     "name": "GetTeams",
16659     "group": "Mail_Queues",
16660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16661     "version": "0.0.0",
16662     "filename": "server/api/mailQueue/index.js",
16663     "groupTitle": "Mail_Queues"
16664   },
16665   {
16666     "type": "delete",
16667     "url": "/api/mail/queues/{id}/users",
16668     "title": "Removes agents from a queue",
16669     "examples": [
16670       {
16671         "title": "Example usage:",
16672         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16673         "type": "json"
16674       }
16675     ],
16676     "name": "RemoveAgents",
16677     "group": "Mail_Queues",
16678     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16679     "version": "0.0.0",
16680     "filename": "server/api/mailQueue/index.js",
16681     "groupTitle": "Mail_Queues"
16682   },
16683   {
16684     "type": "get",
16685     "url": "/api/mail/queues/{id}",
16686     "title": "Gets a single Queue",
16687     "examples": [
16688       {
16689         "title": "Example usage:",
16690         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16691         "type": "json"
16692       }
16693     ],
16694     "name": "ShowQueues",
16695     "group": "Mail_Queues",
16696     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16697     "version": "0.0.0",
16698     "filename": "server/api/mailQueue/index.js",
16699     "groupTitle": "Mail_Queues"
16700   },
16701   {
16702     "type": "put",
16703     "url": "/api/mail/queues/{id}",
16704     "title": "Update an existing Queue",
16705     "examples": [
16706       {
16707         "title": "Example usage:",
16708         "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",
16709         "type": "json"
16710       }
16711     ],
16712     "name": "updateQueues",
16713     "group": "Mail_Queues",
16714     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16715     "version": "0.0.0",
16716     "filename": "server/api/mailQueue/index.js",
16717     "groupTitle": "Mail_Queues"
16718   },
16719   {
16720     "type": "post",
16721     "url": "/api/mail/out_servers",
16722     "title": "Creates a new SMTP",
16723     "examples": [
16724       {
16725         "title": "Example usage:",
16726         "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",
16727         "type": "json"
16728       }
16729     ],
16730     "name": "CreateSMTPs",
16731     "group": "Mail_SMTP",
16732     "parameter": {
16733       "fields": {
16734         "Body": [
16735           {
16736             "group": "Body",
16737             "type": "String",
16738             "optional": true,
16739             "field": "description",
16740             "description": ""
16741           },
16742           {
16743             "group": "Body",
16744             "type": "String",
16745             "optional": true,
16746             "field": "host",
16747             "description": ""
16748           },
16749           {
16750             "group": "Body",
16751             "type": "String",
16752             "optional": true,
16753             "field": "user",
16754             "description": ""
16755           },
16756           {
16757             "group": "Body",
16758             "type": "String",
16759             "optional": true,
16760             "field": "pass",
16761             "description": ""
16762           },
16763           {
16764             "group": "Body",
16765             "type": "Integer",
16766             "optional": true,
16767             "field": "port",
16768             "description": ""
16769           },
16770           {
16771             "group": "Body",
16772             "type": "Boolean",
16773             "optional": true,
16774             "field": "secure",
16775             "description": ""
16776           },
16777           {
16778             "group": "Body",
16779             "type": "String",
16780             "optional": true,
16781             "field": "service",
16782             "description": ""
16783           },
16784           {
16785             "group": "Body",
16786             "type": "Boolean",
16787             "optional": true,
16788             "field": "authentication",
16789             "description": ""
16790           }
16791         ]
16792       }
16793     },
16794     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16795     "version": "0.0.0",
16796     "filename": "server/api/mailServerOut/index.js",
16797     "groupTitle": "Mail_SMTP"
16798   },
16799   {
16800     "type": "delete",
16801     "url": "/api/mail/out_servers/{id}",
16802     "title": "Deletes a SMTP",
16803     "examples": [
16804       {
16805         "title": "Example usage:",
16806         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16807         "type": "json"
16808       }
16809     ],
16810     "name": "DeleteSMTPs",
16811     "group": "Mail_SMTP",
16812     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16813     "version": "0.0.0",
16814     "filename": "server/api/mailServerOut/index.js",
16815     "groupTitle": "Mail_SMTP"
16816   },
16817   {
16818     "type": "get",
16819     "url": "/api/mail/out_servers",
16820     "title": "Gets a list of SMTPs",
16821     "examples": [
16822       {
16823         "title": "Example usage:",
16824         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16825         "type": "json"
16826       }
16827     ],
16828     "name": "GetSMTPs",
16829     "group": "Mail_SMTP",
16830     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16831     "version": "0.0.0",
16832     "filename": "server/api/mailServerOut/index.js",
16833     "groupTitle": "Mail_SMTP"
16834   },
16835   {
16836     "type": "get",
16837     "url": "/api/mail/out_servers/{id}",
16838     "title": "Gets a single SMTP",
16839     "examples": [
16840       {
16841         "title": "Example usage:",
16842         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16843         "type": "json"
16844       }
16845     ],
16846     "name": "ShowSMTPs",
16847     "group": "Mail_SMTP",
16848     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16849     "version": "0.0.0",
16850     "filename": "server/api/mailServerOut/index.js",
16851     "groupTitle": "Mail_SMTP"
16852   },
16853   {
16854     "type": "put",
16855     "url": "/api/mail/out_servers/{id}",
16856     "title": "Update an existing SMTP",
16857     "examples": [
16858       {
16859         "title": "Example usage:",
16860         "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",
16861         "type": "json"
16862       }
16863     ],
16864     "name": "updateSMTPs",
16865     "group": "Mail_SMTP",
16866     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16867     "version": "0.0.0",
16868     "filename": "server/api/mailServerOut/index.js",
16869     "groupTitle": "Mail_SMTP"
16870   },
16871   {
16872     "type": "post",
16873     "url": "/api/mail/substatuses",
16874     "title": "Creates a new Queue",
16875     "examples": [
16876       {
16877         "title": "Example usage:",
16878         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16879         "type": "json"
16880       }
16881     ],
16882     "name": "CreateSubstatuses",
16883     "group": "Mail_Substatuses",
16884     "parameter": {
16885       "fields": {
16886         "Body": [
16887           {
16888             "group": "Body",
16889             "type": "String",
16890             "optional": false,
16891             "field": "name",
16892             "description": ""
16893           },
16894           {
16895             "group": "Body",
16896             "type": "String",
16897             "optional": true,
16898             "field": "description",
16899             "description": ""
16900           }
16901         ]
16902       }
16903     },
16904     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16905     "version": "0.0.0",
16906     "filename": "server/api/mailSubstatus/index.js",
16907     "groupTitle": "Mail_Substatuses"
16908   },
16909   {
16910     "type": "delete",
16911     "url": "/api/mail/substatuses/{id}",
16912     "title": "Deletes a Queue",
16913     "examples": [
16914       {
16915         "title": "Example usage:",
16916         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16917         "type": "json"
16918       }
16919     ],
16920     "name": "DeleteSubstatuses",
16921     "group": "Mail_Substatuses",
16922     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16923     "version": "0.0.0",
16924     "filename": "server/api/mailSubstatus/index.js",
16925     "groupTitle": "Mail_Substatuses"
16926   },
16927   {
16928     "type": "get",
16929     "url": "/api/mail/substatuses/describe",
16930     "title": "Gets table info about Substatuses",
16931     "examples": [
16932       {
16933         "title": "Example usage:",
16934         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16935         "type": "json"
16936       }
16937     ],
16938     "name": "DescribeSubstatuses",
16939     "group": "Mail_Substatuses",
16940     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16941     "version": "0.0.0",
16942     "filename": "server/api/mailSubstatus/index.js",
16943     "groupTitle": "Mail_Substatuses"
16944   },
16945   {
16946     "type": "get",
16947     "url": "/api/mail/substatuses",
16948     "title": "Gets a list of Substatuses",
16949     "examples": [
16950       {
16951         "title": "Example usage:",
16952         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16953         "type": "json"
16954       }
16955     ],
16956     "name": "GetSubstatuses",
16957     "group": "Mail_Substatuses",
16958     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16959     "version": "0.0.0",
16960     "filename": "server/api/mailSubstatus/index.js",
16961     "groupTitle": "Mail_Substatuses"
16962   },
16963   {
16964     "type": "get",
16965     "url": "/api/mail/substatuses/{id}",
16966     "title": "Gets a single Queue",
16967     "examples": [
16968       {
16969         "title": "Example usage:",
16970         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16971         "type": "json"
16972       }
16973     ],
16974     "name": "ShowSubstatuses",
16975     "group": "Mail_Substatuses",
16976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16977     "version": "0.0.0",
16978     "filename": "server/api/mailSubstatus/index.js",
16979     "groupTitle": "Mail_Substatuses"
16980   },
16981   {
16982     "type": "put",
16983     "url": "/api/mail/substatuses/{id}",
16984     "title": "Update an existing Queue",
16985     "examples": [
16986       {
16987         "title": "Example usage:",
16988         "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",
16989         "type": "json"
16990       }
16991     ],
16992     "name": "updateSubstatuses",
16993     "group": "Mail_Substatuses",
16994     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16995     "version": "0.0.0",
16996     "filename": "server/api/mailSubstatus/index.js",
16997     "groupTitle": "Mail_Substatuses"
16998   },
16999   {
17000     "type": "post",
17001     "url": "/api/mail/reports/transfer",
17002     "title": "Creates a new Mail Transfer Report",
17003     "examples": [
17004       {
17005         "title": "Example usage:",
17006         "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",
17007         "type": "json"
17008       }
17009     ],
17010     "name": "CreateMail_Transfer_Reports",
17011     "group": "Mail_Transfer_Reports",
17012     "parameter": {
17013       "fields": {
17014         "Body": [
17015           {
17016             "group": "Body",
17017             "type": "String",
17018             "optional": false,
17019             "field": "uniqueid",
17020             "description": ""
17021           },
17022           {
17023             "group": "Body",
17024             "type": "String",
17025             "allowedValues": [
17026               "\"account\"",
17027               "\"agent\"",
17028               "\"queue\""
17029             ],
17030             "optional": false,
17031             "field": "type",
17032             "description": ""
17033           },
17034           {
17035             "group": "Body",
17036             "type": "String",
17037             "optional": false,
17038             "field": "transferredAt",
17039             "description": ""
17040           }
17041         ]
17042       }
17043     },
17044     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17045     "version": "0.0.0",
17046     "filename": "server/api/mailTransferReport/index.js",
17047     "groupTitle": "Mail_Transfer_Reports"
17048   },
17049   {
17050     "type": "delete",
17051     "url": "/api/mail/reports/transfer/{id}",
17052     "title": "Deletes a Mail Transfer Report",
17053     "examples": [
17054       {
17055         "title": "Example usage:",
17056         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17057         "type": "json"
17058       }
17059     ],
17060     "name": "DeleteMail_Transfer_Reports",
17061     "group": "Mail_Transfer_Reports",
17062     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17063     "version": "0.0.0",
17064     "filename": "server/api/mailTransferReport/index.js",
17065     "groupTitle": "Mail_Transfer_Reports"
17066   },
17067   {
17068     "type": "get",
17069     "url": "/api/mail/reports/transfer/describe",
17070     "title": "Gets table info about Mail Transfer Reports",
17071     "examples": [
17072       {
17073         "title": "Example usage:",
17074         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17075         "type": "json"
17076       }
17077     ],
17078     "name": "DescribeMail_Transfer_Reports",
17079     "group": "Mail_Transfer_Reports",
17080     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17081     "version": "0.0.0",
17082     "filename": "server/api/mailTransferReport/index.js",
17083     "groupTitle": "Mail_Transfer_Reports"
17084   },
17085   {
17086     "type": "get",
17087     "url": "/api/mail/reports/transfer",
17088     "title": "Gets a list of Mail Transfer Reports",
17089     "examples": [
17090       {
17091         "title": "Example usage:",
17092         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17093         "type": "json"
17094       }
17095     ],
17096     "name": "GetMail_Transfer_Reports",
17097     "group": "Mail_Transfer_Reports",
17098     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17099     "version": "0.0.0",
17100     "filename": "server/api/mailTransferReport/index.js",
17101     "groupTitle": "Mail_Transfer_Reports"
17102   },
17103   {
17104     "type": "get",
17105     "url": "/api/mail/reports/transfer/{id}",
17106     "title": "Gets a single Mail Transfer Report",
17107     "examples": [
17108       {
17109         "title": "Example usage:",
17110         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17111         "type": "json"
17112       }
17113     ],
17114     "name": "ShowMail_Transfer_Reports",
17115     "group": "Mail_Transfer_Reports",
17116     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17117     "version": "0.0.0",
17118     "filename": "server/api/mailTransferReport/index.js",
17119     "groupTitle": "Mail_Transfer_Reports"
17120   },
17121   {
17122     "type": "put",
17123     "url": "/api/mail/reports/transfer/{id}",
17124     "title": "Update an existing Mail Transfer Report",
17125     "examples": [
17126       {
17127         "title": "Example usage:",
17128         "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",
17129         "type": "json"
17130       }
17131     ],
17132     "name": "updateMail_Transfer_Reports",
17133     "group": "Mail_Transfer_Reports",
17134     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17135     "version": "0.0.0",
17136     "filename": "server/api/mailTransferReport/index.js",
17137     "groupTitle": "Mail_Transfer_Reports"
17138   },
17139   {
17140     "type": "get",
17141     "url": "/api/members/reports/describe",
17142     "title": "Gets table info about Member Reports",
17143     "examples": [
17144       {
17145         "title": "Example usage:",
17146         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17147         "type": "json"
17148       }
17149     ],
17150     "name": "DescribeMember_Reports",
17151     "group": "Member_Reports",
17152     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17153     "version": "0.0.0",
17154     "filename": "server/api/memberReport/index.js",
17155     "groupTitle": "Member_Reports"
17156   },
17157   {
17158     "type": "get",
17159     "url": "/api/members/reports",
17160     "title": "Gets a list of Member Reports",
17161     "examples": [
17162       {
17163         "title": "Example usage:",
17164         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17165         "type": "json"
17166       }
17167     ],
17168     "name": "GetMember_Reports",
17169     "group": "Member_Reports",
17170     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17171     "version": "0.0.0",
17172     "filename": "server/api/memberReport/index.js",
17173     "groupTitle": "Member_Reports"
17174   },
17175   {
17176     "type": "get",
17177     "url": "/api/members/reports/{id}",
17178     "title": "Gets a single Member Report",
17179     "examples": [
17180       {
17181         "title": "Example usage:",
17182         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17183         "type": "json"
17184       }
17185     ],
17186     "name": "ShowMember_Reports",
17187     "group": "Member_Reports",
17188     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17189     "version": "0.0.0",
17190     "filename": "server/api/memberReport/index.js",
17191     "groupTitle": "Member_Reports"
17192   },
17193   {
17194     "type": "get",
17195     "url": "/api/migrations",
17196     "title": "Gets a list of Migrations",
17197     "examples": [
17198       {
17199         "title": "Example usage:",
17200         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17201         "type": "json"
17202       }
17203     ],
17204     "name": "GetMigrations",
17205     "group": "Migrations",
17206     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17207     "version": "0.0.0",
17208     "filename": "server/api/migration/index.js",
17209     "groupTitle": "Migrations"
17210   },
17211   {
17212     "type": "post",
17213     "url": "/api/voice/networks",
17214     "title": "Create a new network",
17215     "examples": [
17216       {
17217         "title": "Example usage:",
17218         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17219         "type": "json"
17220       }
17221     ],
17222     "name": "Create",
17223     "group": "Networks",
17224     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17225     "version": "0.0.0",
17226     "filename": "server/api/network/index.js",
17227     "groupTitle": "Networks"
17228   },
17229   {
17230     "type": "delete",
17231     "url": "/api/voice/networks/{id}",
17232     "title": "Deletes a network",
17233     "examples": [
17234       {
17235         "title": "Example usage:",
17236         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17237         "type": "json"
17238       }
17239     ],
17240     "name": "Delete",
17241     "group": "Networks",
17242     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17243     "version": "0.0.0",
17244     "filename": "server/api/network/index.js",
17245     "groupTitle": "Networks"
17246   },
17247   {
17248     "type": "get",
17249     "url": "/api/networks",
17250     "title": "Gets a list of Networks",
17251     "examples": [
17252       {
17253         "title": "Example usage:",
17254         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17255         "type": "json"
17256       }
17257     ],
17258     "name": "GetNetworks",
17259     "group": "Networks",
17260     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17261     "version": "0.0.0",
17262     "filename": "server/api/network/index.js",
17263     "groupTitle": "Networks"
17264   },
17265   {
17266     "type": "get",
17267     "url": "/api/networks/{id}",
17268     "title": "Gets a single Network",
17269     "examples": [
17270       {
17271         "title": "Example usage:",
17272         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17273         "type": "json"
17274       }
17275     ],
17276     "name": "ShowNetworks",
17277     "group": "Networks",
17278     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17279     "version": "0.0.0",
17280     "filename": "server/api/network/index.js",
17281     "groupTitle": "Networks"
17282   },
17283   {
17284     "type": "put",
17285     "url": "/api/voice/networks/{id}",
17286     "title": "Update an existing network",
17287     "examples": [
17288       {
17289         "title": "Example usage:",
17290         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17291         "type": "json"
17292       }
17293     ],
17294     "name": "Update",
17295     "group": "Networks",
17296     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17297     "version": "0.0.0",
17298     "filename": "server/api/network/index.js",
17299     "groupTitle": "Networks"
17300   },
17301   {
17302     "type": "post",
17303     "url": "/api/openchannel/accounts/{id}/users",
17304     "title": "Add agents to a openchannel account",
17305     "examples": [
17306       {
17307         "title": "Example usage:",
17308         "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",
17309         "type": "json"
17310       }
17311     ],
17312     "name": "AddAgents",
17313     "group": "Openchannel_Accounts",
17314     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17315     "version": "0.0.0",
17316     "filename": "server/api/openchannelAccount/index.js",
17317     "groupTitle": "Openchannel_Accounts"
17318   },
17319   {
17320     "type": "post",
17321     "url": "/api/openchannel/accounts",
17322     "title": "Creates a new Account",
17323     "examples": [
17324       {
17325         "title": "Example usage:",
17326         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17327         "type": "json"
17328       }
17329     ],
17330     "name": "CreateAccounts",
17331     "group": "Openchannel_Accounts",
17332     "parameter": {
17333       "fields": {
17334         "Body": [
17335           {
17336             "group": "Body",
17337             "type": "String",
17338             "optional": false,
17339             "field": "name",
17340             "description": ""
17341           },
17342           {
17343             "group": "Body",
17344             "type": "String",
17345             "optional": true,
17346             "field": "description",
17347             "description": ""
17348           },
17349           {
17350             "group": "Body",
17351             "type": "String",
17352             "optional": true,
17353             "field": "token",
17354             "description": ""
17355           },
17356           {
17357             "group": "Body",
17358             "type": "String",
17359             "optional": true,
17360             "field": "replyUri",
17361             "description": ""
17362           },
17363           {
17364             "group": "Body",
17365             "type": "String",
17366             "optional": false,
17367             "field": "key",
17368             "description": ""
17369           },
17370           {
17371             "group": "Body",
17372             "type": "Text",
17373             "optional": true,
17374             "field": "notificationTemplate",
17375             "description": ""
17376           },
17377           {
17378             "group": "Body",
17379             "type": "Boolean",
17380             "optional": true,
17381             "field": "notificationSound",
17382             "description": ""
17383           },
17384           {
17385             "group": "Body",
17386             "type": "Boolean",
17387             "optional": true,
17388             "field": "notificationShake",
17389             "description": ""
17390           },
17391           {
17392             "group": "Body",
17393             "type": "Integer",
17394             "optional": true,
17395             "field": "waitForTheAssignedAgent",
17396             "description": ""
17397           },
17398           {
17399             "group": "Body",
17400             "type": "String",
17401             "optional": true,
17402             "field": "mapKey",
17403             "description": ""
17404           },
17405           {
17406             "group": "Body",
17407             "type": "Boolean",
17408             "optional": true,
17409             "field": "queueTransfer",
17410             "description": ""
17411           },
17412           {
17413             "group": "Body",
17414             "type": "Integer",
17415             "optional": true,
17416             "field": "queueTransferTimeout",
17417             "description": ""
17418           },
17419           {
17420             "group": "Body",
17421             "type": "Boolean",
17422             "optional": true,
17423             "field": "agentTransfer",
17424             "description": ""
17425           },
17426           {
17427             "group": "Body",
17428             "type": "Integer",
17429             "optional": true,
17430             "field": "agentTransferTimeout",
17431             "description": ""
17432           },
17433           {
17434             "group": "Body",
17435             "type": "Integer",
17436             "optional": true,
17437             "field": "mandatoryDispositionPauseId",
17438             "description": "<p>Status to put when mandatory disposition is enabled</p>"
17439           },
17440           {
17441             "group": "Body",
17442             "type": "Boolean",
17443             "optional": true,
17444             "field": "mandatoryDisposition",
17445             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17446           }
17447         ]
17448       }
17449     },
17450     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17451     "version": "0.0.0",
17452     "filename": "server/api/openchannelAccount/index.js",
17453     "groupTitle": "Openchannel_Accounts"
17454   },
17455   {
17456     "type": "delete",
17457     "url": "/api/openchannel/accounts/{id}",
17458     "title": "Deletes a Account",
17459     "examples": [
17460       {
17461         "title": "Example usage:",
17462         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17463         "type": "json"
17464       }
17465     ],
17466     "name": "DeleteAccounts",
17467     "group": "Openchannel_Accounts",
17468     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17469     "version": "0.0.0",
17470     "filename": "server/api/openchannelAccount/index.js",
17471     "groupTitle": "Openchannel_Accounts"
17472   },
17473   {
17474     "type": "get",
17475     "url": "/api/openchannel/accounts/describe",
17476     "title": "Gets table info about Accounts",
17477     "examples": [
17478       {
17479         "title": "Example usage:",
17480         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17481         "type": "json"
17482       }
17483     ],
17484     "name": "DescribeAccounts",
17485     "group": "Openchannel_Accounts",
17486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17487     "version": "0.0.0",
17488     "filename": "server/api/openchannelAccount/index.js",
17489     "groupTitle": "Openchannel_Accounts"
17490   },
17491   {
17492     "type": "get",
17493     "url": "/api/openchannel/accounts",
17494     "title": "Gets a list of Accounts",
17495     "examples": [
17496       {
17497         "title": "Example usage:",
17498         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17499         "type": "json"
17500       }
17501     ],
17502     "name": "GetAccounts",
17503     "group": "Openchannel_Accounts",
17504     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17505     "version": "0.0.0",
17506     "filename": "server/api/openchannelAccount/index.js",
17507     "groupTitle": "Openchannel_Accounts"
17508   },
17509   {
17510     "type": "get",
17511     "url": "/api/openchannel/accounts/{id}/users",
17512     "title": "Gets agents from openchannel account",
17513     "examples": [
17514       {
17515         "title": "Example usage:",
17516         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17517         "type": "json"
17518       }
17519     ],
17520     "name": "GetAgents",
17521     "group": "Openchannel_Accounts",
17522     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17523     "version": "0.0.0",
17524     "filename": "server/api/openchannelAccount/index.js",
17525     "groupTitle": "Openchannel_Accounts"
17526   },
17527   {
17528     "type": "delete",
17529     "url": "/api/openchannel/accounts/{id}/users",
17530     "title": "Removes agents from a openchannel account",
17531     "examples": [
17532       {
17533         "title": "Example usage:",
17534         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17535         "type": "json"
17536       }
17537     ],
17538     "name": "RemoveAgents",
17539     "group": "Openchannel_Accounts",
17540     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17541     "version": "0.0.0",
17542     "filename": "server/api/openchannelAccount/index.js",
17543     "groupTitle": "Openchannel_Accounts"
17544   },
17545   {
17546     "type": "delete",
17547     "url": "/api/openchannel/accounts/{id}/canned_answers",
17548     "title": "Removes canned answers from account",
17549     "examples": [
17550       {
17551         "title": "Example usage:",
17552         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17553         "type": "json"
17554       }
17555     ],
17556     "name": "RemoveAnswers",
17557     "group": "Openchannel_Accounts",
17558     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17559     "version": "0.0.0",
17560     "filename": "server/api/openchannelAccount/index.js",
17561     "groupTitle": "Openchannel_Accounts"
17562   },
17563   {
17564     "type": "delete",
17565     "url": "/api/openchannel/accounts/{id}/dispositions",
17566     "title": "Removes dispositions from account",
17567     "examples": [
17568       {
17569         "title": "Example usage:",
17570         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17571         "type": "json"
17572       }
17573     ],
17574     "name": "RemoveDispositions",
17575     "group": "Openchannel_Accounts",
17576     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17577     "version": "0.0.0",
17578     "filename": "server/api/openchannelAccount/index.js",
17579     "groupTitle": "Openchannel_Accounts"
17580   },
17581   {
17582     "type": "get",
17583     "url": "/api/openchannel/accounts/{id}",
17584     "title": "Gets a single Account",
17585     "examples": [
17586       {
17587         "title": "Example usage:",
17588         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17589         "type": "json"
17590       }
17591     ],
17592     "name": "ShowAccounts",
17593     "group": "Openchannel_Accounts",
17594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17595     "version": "0.0.0",
17596     "filename": "server/api/openchannelAccount/index.js",
17597     "groupTitle": "Openchannel_Accounts"
17598   },
17599   {
17600     "type": "post",
17601     "url": "/api/openchannel/accounts/{id}/canned_answers",
17602     "title": "Creates new canned answer",
17603     "examples": [
17604       {
17605         "title": "Example usage:",
17606         "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",
17607         "type": "json"
17608       }
17609     ],
17610     "name": "addAnswer",
17611     "group": "Openchannel_Accounts",
17612     "parameter": {
17613       "fields": {
17614         "Body": [
17615           {
17616             "group": "Body",
17617             "type": "String",
17618             "optional": false,
17619             "field": "key",
17620             "description": ""
17621           },
17622           {
17623             "group": "Body",
17624             "type": "Text",
17625             "optional": false,
17626             "field": "value",
17627             "description": ""
17628           },
17629           {
17630             "group": "Body",
17631             "type": "String",
17632             "optional": true,
17633             "field": "description",
17634             "description": ""
17635           },
17636           {
17637             "group": "Body",
17638             "type": "Virtual",
17639             "optional": true,
17640             "field": "name",
17641             "description": ""
17642           }
17643         ]
17644       }
17645     },
17646     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17647     "version": "0.0.0",
17648     "filename": "server/api/openchannelAccount/index.js",
17649     "groupTitle": "Openchannel_Accounts"
17650   },
17651   {
17652     "type": "post",
17653     "url": "/api/openchannel/accounts/{id}/applications",
17654     "title": "Creates new applications",
17655     "examples": [
17656       {
17657         "title": "Example usage:",
17658         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17659         "type": "json"
17660       }
17661     ],
17662     "name": "addApplications",
17663     "group": "Openchannel_Accounts",
17664     "parameter": {
17665       "fields": {
17666         "Body": [
17667           {
17668             "group": "Body",
17669             "type": "Integer",
17670             "optional": false,
17671             "field": "priority",
17672             "description": ""
17673           },
17674           {
17675             "group": "Body",
17676             "type": "String",
17677             "optional": false,
17678             "field": "app",
17679             "description": ""
17680           },
17681           {
17682             "group": "Body",
17683             "type": "Text",
17684             "optional": true,
17685             "field": "appdata",
17686             "description": ""
17687           },
17688           {
17689             "group": "Body",
17690             "type": "String",
17691             "optional": true,
17692             "field": "description",
17693             "description": ""
17694           },
17695           {
17696             "group": "Body",
17697             "type": "String",
17698             "optional": true,
17699             "field": "interval",
17700             "description": ""
17701           }
17702         ]
17703       }
17704     },
17705     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17706     "version": "0.0.0",
17707     "filename": "server/api/openchannelAccount/index.js",
17708     "groupTitle": "Openchannel_Accounts"
17709   },
17710   {
17711     "type": "post",
17712     "url": "/api/openchannel/accounts/{id}/dispositions",
17713     "title": "Creates new disposition",
17714     "examples": [
17715       {
17716         "title": "Example usage:",
17717         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17718         "type": "json"
17719       }
17720     ],
17721     "name": "addDisposition",
17722     "group": "Openchannel_Accounts",
17723     "parameter": {
17724       "fields": {
17725         "Body": [
17726           {
17727             "group": "Body",
17728             "type": "String",
17729             "optional": false,
17730             "field": "name",
17731             "description": ""
17732           },
17733           {
17734             "group": "Body",
17735             "type": "String",
17736             "allowedValues": [
17737               "\"first\"",
17738               "\"second\"",
17739               "\"third\""
17740             ],
17741             "optional": false,
17742             "field": "level",
17743             "description": ""
17744           },
17745           {
17746             "group": "Body",
17747             "type": "String",
17748             "optional": true,
17749             "field": "description",
17750             "description": ""
17751           }
17752         ]
17753       }
17754     },
17755     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17756     "version": "0.0.0",
17757     "filename": "server/api/openchannelAccount/index.js",
17758     "groupTitle": "Openchannel_Accounts"
17759   },
17760   {
17761     "type": "get",
17762     "url": "/api/openchannel/accounts/{id}/canned_answers",
17763     "title": "Gets account canned answers",
17764     "examples": [
17765       {
17766         "title": "Example usage:",
17767         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17768         "type": "json"
17769       }
17770     ],
17771     "name": "getAnswers",
17772     "group": "Openchannel_Accounts",
17773     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17774     "version": "0.0.0",
17775     "filename": "server/api/openchannelAccount/index.js",
17776     "groupTitle": "Openchannel_Accounts"
17777   },
17778   {
17779     "type": "get",
17780     "url": "/api/openchannel/accounts/{id}/applications",
17781     "title": "Gets account applications",
17782     "examples": [
17783       {
17784         "title": "Example usage:",
17785         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17786         "type": "json"
17787       }
17788     ],
17789     "name": "getApplications",
17790     "group": "Openchannel_Accounts",
17791     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17792     "version": "0.0.0",
17793     "filename": "server/api/openchannelAccount/index.js",
17794     "groupTitle": "Openchannel_Accounts"
17795   },
17796   {
17797     "type": "get",
17798     "url": "/api/openchannel/accounts/{id}/dispositions",
17799     "title": "Gets account dispositions",
17800     "examples": [
17801       {
17802         "title": "Example usage:",
17803         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17804         "type": "json"
17805       }
17806     ],
17807     "name": "getDispositions",
17808     "group": "Openchannel_Accounts",
17809     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17810     "version": "0.0.0",
17811     "filename": "server/api/openchannelAccount/index.js",
17812     "groupTitle": "Openchannel_Accounts"
17813   },
17814   {
17815     "type": "get",
17816     "url": "/api/openchannel/accounts/{id}/interactions",
17817     "title": "Gets Openchannel Account Interactions",
17818     "examples": [
17819       {
17820         "title": "Example usage:",
17821         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17822         "type": "json"
17823       }
17824     ],
17825     "name": "getInteractions",
17826     "group": "Openchannel_Accounts",
17827     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17828     "version": "0.0.0",
17829     "filename": "server/api/openchannelAccount/index.js",
17830     "groupTitle": "Openchannel_Accounts"
17831   },
17832   {
17833     "type": "post",
17834     "url": "/api/openchannel/accounts/{id}/notify",
17835     "title": "Notify new message",
17836     "examples": [
17837       {
17838         "title": "Example usage:",
17839         "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",
17840         "type": "json"
17841       }
17842     ],
17843     "name": "notify",
17844     "group": "Openchannel_Accounts",
17845     "description": "<p>Motion 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>",
17846     "version": "0.0.0",
17847     "filename": "server/api/openchannelAccount/index.js",
17848     "groupTitle": "Openchannel_Accounts"
17849   },
17850   {
17851     "type": "post",
17852     "url": "/api/openchannel/accounts/{id}/send",
17853     "title": "Send new openchannel message",
17854     "examples": [
17855       {
17856         "title": "Example usage:",
17857         "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",
17858         "type": "json"
17859       }
17860     ],
17861     "name": "sendOpenchannel",
17862     "group": "Openchannel_Accounts",
17863     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17864     "version": "0.0.0",
17865     "filename": "server/api/openchannelAccount/index.js",
17866     "groupTitle": "Openchannel_Accounts"
17867   },
17868   {
17869     "type": "put",
17870     "url": "/api/openchannel/accounts/{id}",
17871     "title": "Update an existing Account",
17872     "examples": [
17873       {
17874         "title": "Example usage:",
17875         "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",
17876         "type": "json"
17877       }
17878     ],
17879     "name": "updateAccounts",
17880     "group": "Openchannel_Accounts",
17881     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17882     "version": "0.0.0",
17883     "filename": "server/api/openchannelAccount/index.js",
17884     "groupTitle": "Openchannel_Accounts"
17885   },
17886   {
17887     "type": "post",
17888     "url": "/api/openchannel/applications",
17889     "title": "Creates a new Application",
17890     "examples": [
17891       {
17892         "title": "Example usage:",
17893         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17894         "type": "json"
17895       }
17896     ],
17897     "name": "CreateApplications",
17898     "group": "Openchannel_Applications",
17899     "parameter": {
17900       "fields": {
17901         "Body": [
17902           {
17903             "group": "Body",
17904             "type": "Integer",
17905             "optional": false,
17906             "field": "priority",
17907             "description": ""
17908           },
17909           {
17910             "group": "Body",
17911             "type": "String",
17912             "optional": false,
17913             "field": "app",
17914             "description": ""
17915           },
17916           {
17917             "group": "Body",
17918             "type": "Text",
17919             "optional": true,
17920             "field": "appdata",
17921             "description": ""
17922           },
17923           {
17924             "group": "Body",
17925             "type": "String",
17926             "optional": true,
17927             "field": "description",
17928             "description": ""
17929           },
17930           {
17931             "group": "Body",
17932             "type": "String",
17933             "optional": true,
17934             "field": "interval",
17935             "description": ""
17936           }
17937         ]
17938       }
17939     },
17940     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17941     "version": "0.0.0",
17942     "filename": "server/api/openchannelApplication/index.js",
17943     "groupTitle": "Openchannel_Applications"
17944   },
17945   {
17946     "type": "delete",
17947     "url": "/api/openchannel/applications/{id}",
17948     "title": "Deletes a Application",
17949     "examples": [
17950       {
17951         "title": "Example usage:",
17952         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17953         "type": "json"
17954       }
17955     ],
17956     "name": "DeleteApplications",
17957     "group": "Openchannel_Applications",
17958     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17959     "version": "0.0.0",
17960     "filename": "server/api/openchannelApplication/index.js",
17961     "groupTitle": "Openchannel_Applications"
17962   },
17963   {
17964     "type": "get",
17965     "url": "/api/openchannel/applications",
17966     "title": "Gets a list of Applications",
17967     "examples": [
17968       {
17969         "title": "Example usage:",
17970         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17971         "type": "json"
17972       }
17973     ],
17974     "name": "GetApplications",
17975     "group": "Openchannel_Applications",
17976     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17977     "version": "0.0.0",
17978     "filename": "server/api/openchannelApplication/index.js",
17979     "groupTitle": "Openchannel_Applications"
17980   },
17981   {
17982     "type": "get",
17983     "url": "/api/openchannel/applications/{id}",
17984     "title": "Gets a single Application",
17985     "examples": [
17986       {
17987         "title": "Example usage:",
17988         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
17989         "type": "json"
17990       }
17991     ],
17992     "name": "ShowApplications",
17993     "group": "Openchannel_Applications",
17994     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17995     "version": "0.0.0",
17996     "filename": "server/api/openchannelApplication/index.js",
17997     "groupTitle": "Openchannel_Applications"
17998   },
17999   {
18000     "type": "put",
18001     "url": "/api/openchannel/applications/{id}",
18002     "title": "Update an existing Application",
18003     "examples": [
18004       {
18005         "title": "Example usage:",
18006         "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",
18007         "type": "json"
18008       }
18009     ],
18010     "name": "updateApplications",
18011     "group": "Openchannel_Applications",
18012     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18013     "version": "0.0.0",
18014     "filename": "server/api/openchannelApplication/index.js",
18015     "groupTitle": "Openchannel_Applications"
18016   },
18017   {
18018     "type": "post",
18019     "url": "/api/openchannel/interactions/{id}/tags",
18020     "title": "Add tags to the interaction",
18021     "examples": [
18022       {
18023         "title": "Example usage:",
18024         "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",
18025         "type": "json"
18026       }
18027     ],
18028     "name": "AddTags",
18029     "group": "Openchannel_Interactions",
18030     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18031     "version": "0.0.0",
18032     "filename": "server/api/openchannelInteraction/index.js",
18033     "groupTitle": "Openchannel_Interactions"
18034   },
18035   {
18036     "type": "post",
18037     "url": "/api/openchannel/interactions",
18038     "title": "Creates a new Interaction",
18039     "examples": [
18040       {
18041         "title": "Example usage:",
18042         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18043         "type": "json"
18044       }
18045     ],
18046     "name": "CreateInteractions",
18047     "group": "Openchannel_Interactions",
18048     "parameter": {
18049       "fields": {
18050         "Body": [
18051           {
18052             "group": "Body",
18053             "type": "Boolean",
18054             "optional": true,
18055             "field": "closed",
18056             "description": ""
18057           },
18058           {
18059             "group": "Body",
18060             "type": "String",
18061             "optional": true,
18062             "field": "closedAt",
18063             "description": ""
18064           },
18065           {
18066             "group": "Body",
18067             "type": "String",
18068             "optional": true,
18069             "field": "disposition",
18070             "description": ""
18071           },
18072           {
18073             "group": "Body",
18074             "type": "String",
18075             "optional": true,
18076             "field": "secondDisposition",
18077             "description": ""
18078           },
18079           {
18080             "group": "Body",
18081             "type": "String",
18082             "optional": true,
18083             "field": "thirdDisposition",
18084             "description": ""
18085           },
18086           {
18087             "group": "Body",
18088             "type": "String",
18089             "optional": true,
18090             "field": "note",
18091             "description": ""
18092           },
18093           {
18094             "group": "Body",
18095             "type": "String",
18096             "optional": true,
18097             "field": "read1stAt",
18098             "description": ""
18099           },
18100           {
18101             "group": "Body",
18102             "type": "String",
18103             "optional": true,
18104             "field": "threadId",
18105             "description": ""
18106           },
18107           {
18108             "group": "Body",
18109             "type": "String",
18110             "optional": true,
18111             "field": "externalUrl",
18112             "description": ""
18113           },
18114           {
18115             "group": "Body",
18116             "type": "String",
18117             "optional": true,
18118             "field": "lastMsgAt",
18119             "description": ""
18120           },
18121           {
18122             "group": "Body",
18123             "type": "String",
18124             "allowedValues": [
18125               "\"in\"",
18126               "\"out\""
18127             ],
18128             "optional": false,
18129             "field": "lastMsgDirection",
18130             "description": ""
18131           },
18132           {
18133             "group": "Body",
18134             "type": "String",
18135             "optional": true,
18136             "field": "from",
18137             "description": ""
18138           }
18139         ]
18140       }
18141     },
18142     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18143     "version": "0.0.0",
18144     "filename": "server/api/openchannelInteraction/index.js",
18145     "groupTitle": "Openchannel_Interactions"
18146   },
18147   {
18148     "type": "delete",
18149     "url": "/api/openchannel/interactions/{id}",
18150     "title": "Deletes a Interaction",
18151     "examples": [
18152       {
18153         "title": "Example usage:",
18154         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18155         "type": "json"
18156       }
18157     ],
18158     "name": "DeleteInteractions",
18159     "group": "Openchannel_Interactions",
18160     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18161     "version": "0.0.0",
18162     "filename": "server/api/openchannelInteraction/index.js",
18163     "groupTitle": "Openchannel_Interactions"
18164   },
18165   {
18166     "type": "get",
18167     "url": "/api/openchannel/interactions/describe",
18168     "title": "Gets table info about Interactions",
18169     "examples": [
18170       {
18171         "title": "Example usage:",
18172         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18173         "type": "json"
18174       }
18175     ],
18176     "name": "DescribeInteractions",
18177     "group": "Openchannel_Interactions",
18178     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18179     "version": "0.0.0",
18180     "filename": "server/api/openchannelInteraction/index.js",
18181     "groupTitle": "Openchannel_Interactions"
18182   },
18183   {
18184     "type": "get",
18185     "url": "/api/openchannel/interactions",
18186     "title": "Gets a list of Interactions",
18187     "examples": [
18188       {
18189         "title": "Example usage:",
18190         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18191         "type": "json"
18192       }
18193     ],
18194     "name": "GetInteractions",
18195     "group": "Openchannel_Interactions",
18196     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18197     "version": "0.0.0",
18198     "filename": "server/api/openchannelInteraction/index.js",
18199     "groupTitle": "Openchannel_Interactions"
18200   },
18201   {
18202     "type": "delete",
18203     "url": "/api/openchannel/interactions/{id}/tags",
18204     "title": "Removes tags from interaction",
18205     "examples": [
18206       {
18207         "title": "Example usage:",
18208         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18209         "type": "json"
18210       }
18211     ],
18212     "name": "RemoveTags",
18213     "group": "Openchannel_Interactions",
18214     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18215     "version": "0.0.0",
18216     "filename": "server/api/openchannelInteraction/index.js",
18217     "groupTitle": "Openchannel_Interactions"
18218   },
18219   {
18220     "type": "get",
18221     "url": "/api/openchannel/interactions/{id}",
18222     "title": "Gets a single Interaction",
18223     "examples": [
18224       {
18225         "title": "Example usage:",
18226         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18227         "type": "json"
18228       }
18229     ],
18230     "name": "ShowInteractions",
18231     "group": "Openchannel_Interactions",
18232     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18233     "version": "0.0.0",
18234     "filename": "server/api/openchannelInteraction/index.js",
18235     "groupTitle": "Openchannel_Interactions"
18236   },
18237   {
18238     "type": "post",
18239     "url": "/api/openchannel/interactions/{id}/messages",
18240     "title": "Creates new messages",
18241     "examples": [
18242       {
18243         "title": "Example usage:",
18244         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18245         "type": "json"
18246       }
18247     ],
18248     "name": "addMessage",
18249     "group": "Openchannel_Interactions",
18250     "parameter": {
18251       "fields": {
18252         "Body": [
18253           {
18254             "group": "Body",
18255             "type": "Text",
18256             "optional": false,
18257             "field": "body",
18258             "description": ""
18259           },
18260           {
18261             "group": "Body",
18262             "type": "Boolean",
18263             "optional": true,
18264             "field": "read",
18265             "description": ""
18266           },
18267           {
18268             "group": "Body",
18269             "type": "Boolean",
18270             "optional": true,
18271             "field": "secret",
18272             "description": ""
18273           },
18274           {
18275             "group": "Body",
18276             "type": "String",
18277             "allowedValues": [
18278               "\"in\"",
18279               "\"out\""
18280             ],
18281             "optional": false,
18282             "field": "direction",
18283             "description": ""
18284           },
18285           {
18286             "group": "Body",
18287             "type": "String",
18288             "optional": true,
18289             "field": "readAt",
18290             "description": ""
18291           },
18292           {
18293             "group": "Body",
18294             "type": "String",
18295             "optional": true,
18296             "field": "providerName",
18297             "description": ""
18298           },
18299           {
18300             "group": "Body",
18301             "type": "Text",
18302             "optional": true,
18303             "field": "providerResponse",
18304             "description": ""
18305           }
18306         ]
18307       }
18308     },
18309     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18310     "version": "0.0.0",
18311     "filename": "server/api/openchannelInteraction/index.js",
18312     "groupTitle": "Openchannel_Interactions"
18313   },
18314   {
18315     "type": "get",
18316     "url": "/api/openchannel/interactions/{id}/download",
18317     "title": "Gets interaction",
18318     "examples": [
18319       {
18320         "title": "Example usage:",
18321         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18322         "type": "json"
18323       }
18324     ],
18325     "name": "download",
18326     "group": "Openchannel_Interactions",
18327     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18328     "version": "0.0.0",
18329     "filename": "server/api/openchannelInteraction/index.js",
18330     "groupTitle": "Openchannel_Interactions"
18331   },
18332   {
18333     "type": "get",
18334     "url": "/api/openchannel/interactions/{id}/messages",
18335     "title": "Gets interaction messages",
18336     "examples": [
18337       {
18338         "title": "Example usage:",
18339         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18340         "type": "json"
18341       }
18342     ],
18343     "name": "getMessages",
18344     "group": "Openchannel_Interactions",
18345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18346     "version": "0.0.0",
18347     "filename": "server/api/openchannelInteraction/index.js",
18348     "groupTitle": "Openchannel_Interactions"
18349   },
18350   {
18351     "type": "put",
18352     "url": "/api/openchannel/interactions/{id}",
18353     "title": "Update an existing Interaction",
18354     "examples": [
18355       {
18356         "title": "Example usage:",
18357         "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",
18358         "type": "json"
18359       }
18360     ],
18361     "name": "updateInteractions",
18362     "group": "Openchannel_Interactions",
18363     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18364     "version": "0.0.0",
18365     "filename": "server/api/openchannelInteraction/index.js",
18366     "groupTitle": "Openchannel_Interactions"
18367   },
18368   {
18369     "type": "post",
18370     "url": "/api/openchannel/messages",
18371     "title": "Creates a new Message",
18372     "examples": [
18373       {
18374         "title": "Example usage:",
18375         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18376         "type": "json"
18377       }
18378     ],
18379     "name": "CreateMessages",
18380     "group": "Openchannel_Messages",
18381     "parameter": {
18382       "fields": {
18383         "Body": [
18384           {
18385             "group": "Body",
18386             "type": "Text",
18387             "optional": false,
18388             "field": "body",
18389             "description": ""
18390           },
18391           {
18392             "group": "Body",
18393             "type": "Boolean",
18394             "optional": true,
18395             "field": "read",
18396             "description": ""
18397           },
18398           {
18399             "group": "Body",
18400             "type": "Boolean",
18401             "optional": true,
18402             "field": "secret",
18403             "description": ""
18404           },
18405           {
18406             "group": "Body",
18407             "type": "String",
18408             "allowedValues": [
18409               "\"in\"",
18410               "\"out\""
18411             ],
18412             "optional": false,
18413             "field": "direction",
18414             "description": ""
18415           },
18416           {
18417             "group": "Body",
18418             "type": "String",
18419             "optional": true,
18420             "field": "readAt",
18421             "description": ""
18422           },
18423           {
18424             "group": "Body",
18425             "type": "String",
18426             "optional": true,
18427             "field": "providerName",
18428             "description": ""
18429           },
18430           {
18431             "group": "Body",
18432             "type": "Text",
18433             "optional": true,
18434             "field": "providerResponse",
18435             "description": ""
18436           }
18437         ]
18438       }
18439     },
18440     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18441     "version": "0.0.0",
18442     "filename": "server/api/openchannelMessage/index.js",
18443     "groupTitle": "Openchannel_Messages"
18444   },
18445   {
18446     "type": "delete",
18447     "url": "/api/openchannel/messages/{id}",
18448     "title": "Deletes a Message",
18449     "examples": [
18450       {
18451         "title": "Example usage:",
18452         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18453         "type": "json"
18454       }
18455     ],
18456     "name": "DeleteMessages",
18457     "group": "Openchannel_Messages",
18458     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18459     "version": "0.0.0",
18460     "filename": "server/api/openchannelMessage/index.js",
18461     "groupTitle": "Openchannel_Messages"
18462   },
18463   {
18464     "type": "get",
18465     "url": "/api/openchannel/messages/describe",
18466     "title": "Gets table info about Messages",
18467     "examples": [
18468       {
18469         "title": "Example usage:",
18470         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18471         "type": "json"
18472       }
18473     ],
18474     "name": "DescribeMessages",
18475     "group": "Openchannel_Messages",
18476     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18477     "version": "0.0.0",
18478     "filename": "server/api/openchannelMessage/index.js",
18479     "groupTitle": "Openchannel_Messages"
18480   },
18481   {
18482     "type": "get",
18483     "url": "/api/openchannel/messages",
18484     "title": "Gets a list of Messages",
18485     "examples": [
18486       {
18487         "title": "Example usage:",
18488         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18489         "type": "json"
18490       }
18491     ],
18492     "name": "GetMessages",
18493     "group": "Openchannel_Messages",
18494     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18495     "version": "0.0.0",
18496     "filename": "server/api/openchannelMessage/index.js",
18497     "groupTitle": "Openchannel_Messages"
18498   },
18499   {
18500     "type": "get",
18501     "url": "/api/openchannel/messages/{id}",
18502     "title": "Gets a single Message",
18503     "examples": [
18504       {
18505         "title": "Example usage:",
18506         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18507         "type": "json"
18508       }
18509     ],
18510     "name": "ShowMessages",
18511     "group": "Openchannel_Messages",
18512     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18513     "version": "0.0.0",
18514     "filename": "server/api/openchannelMessage/index.js",
18515     "groupTitle": "Openchannel_Messages"
18516   },
18517   {
18518     "type": "put",
18519     "url": "/api/openchannel/messages/{id}/accept",
18520     "title": "Accepts message",
18521     "examples": [
18522       {
18523         "title": "Example usage:",
18524         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18525         "type": "json"
18526       }
18527     ],
18528     "name": "acceptMessage",
18529     "group": "Openchannel_Messages",
18530     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18531     "version": "0.0.0",
18532     "filename": "server/api/openchannelMessage/index.js",
18533     "groupTitle": "Openchannel_Messages"
18534   },
18535   {
18536     "type": "put",
18537     "url": "/api/openchannel/messages/{id}/reject",
18538     "title": "Rejects message",
18539     "examples": [
18540       {
18541         "title": "Example usage:",
18542         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18543         "type": "json"
18544       }
18545     ],
18546     "name": "rejectMessage",
18547     "group": "Openchannel_Messages",
18548     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18549     "version": "0.0.0",
18550     "filename": "server/api/openchannelMessage/index.js",
18551     "groupTitle": "Openchannel_Messages"
18552   },
18553   {
18554     "type": "put",
18555     "url": "/api/openchannel/messages/{id}",
18556     "title": "Update an existing Message",
18557     "examples": [
18558       {
18559         "title": "Example usage:",
18560         "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",
18561         "type": "json"
18562       }
18563     ],
18564     "name": "updateMessages",
18565     "group": "Openchannel_Messages",
18566     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18567     "version": "0.0.0",
18568     "filename": "server/api/openchannelMessage/index.js",
18569     "groupTitle": "Openchannel_Messages"
18570   },
18571   {
18572     "type": "post",
18573     "url": "/api/openchannel/reports/queue",
18574     "title": "Creates a new Openchannel Queue Report",
18575     "examples": [
18576       {
18577         "title": "Example usage:",
18578         "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",
18579         "type": "json"
18580       }
18581     ],
18582     "name": "CreateOpenchannel_Queue_Reports",
18583     "group": "Openchannel_Queue_Reports",
18584     "parameter": {
18585       "fields": {
18586         "Body": [
18587           {
18588             "group": "Body",
18589             "type": "String",
18590             "optional": false,
18591             "field": "uniqueid",
18592             "description": ""
18593           },
18594           {
18595             "group": "Body",
18596             "type": "String",
18597             "optional": true,
18598             "field": "from",
18599             "description": ""
18600           },
18601           {
18602             "group": "Body",
18603             "type": "String",
18604             "optional": true,
18605             "field": "joinAt",
18606             "description": ""
18607           },
18608           {
18609             "group": "Body",
18610             "type": "String",
18611             "optional": true,
18612             "field": "leaveAt",
18613             "description": ""
18614           },
18615           {
18616             "group": "Body",
18617             "type": "String",
18618             "optional": true,
18619             "field": "acceptAt",
18620             "description": ""
18621           },
18622           {
18623             "group": "Body",
18624             "type": "String",
18625             "optional": true,
18626             "field": "exitAt",
18627             "description": ""
18628           },
18629           {
18630             "group": "Body",
18631             "type": "String",
18632             "optional": true,
18633             "field": "reason",
18634             "description": ""
18635           }
18636         ]
18637       }
18638     },
18639     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18640     "version": "0.0.0",
18641     "filename": "server/api/openchannelQueueReport/index.js",
18642     "groupTitle": "Openchannel_Queue_Reports"
18643   },
18644   {
18645     "type": "delete",
18646     "url": "/api/openchannel/reports/queue/{id}",
18647     "title": "Deletes a Openchannel Queue Report",
18648     "examples": [
18649       {
18650         "title": "Example usage:",
18651         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18652         "type": "json"
18653       }
18654     ],
18655     "name": "DeleteOpenchannel_Queue_Reports",
18656     "group": "Openchannel_Queue_Reports",
18657     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18658     "version": "0.0.0",
18659     "filename": "server/api/openchannelQueueReport/index.js",
18660     "groupTitle": "Openchannel_Queue_Reports"
18661   },
18662   {
18663     "type": "get",
18664     "url": "/api/openchannel/reports/queue/describe",
18665     "title": "Gets table info about Openchannel Queue Reports",
18666     "examples": [
18667       {
18668         "title": "Example usage:",
18669         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18670         "type": "json"
18671       }
18672     ],
18673     "name": "DescribeOpenchannel_Queue_Reports",
18674     "group": "Openchannel_Queue_Reports",
18675     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18676     "version": "0.0.0",
18677     "filename": "server/api/openchannelQueueReport/index.js",
18678     "groupTitle": "Openchannel_Queue_Reports"
18679   },
18680   {
18681     "type": "get",
18682     "url": "/api/openchannel/reports/queue",
18683     "title": "Gets a list of Openchannel Queue Reports",
18684     "examples": [
18685       {
18686         "title": "Example usage:",
18687         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18688         "type": "json"
18689       }
18690     ],
18691     "name": "GetOpenchannel_Queue_Reports",
18692     "group": "Openchannel_Queue_Reports",
18693     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18694     "version": "0.0.0",
18695     "filename": "server/api/openchannelQueueReport/index.js",
18696     "groupTitle": "Openchannel_Queue_Reports"
18697   },
18698   {
18699     "type": "get",
18700     "url": "/api/openchannel/reports/queue/{id}",
18701     "title": "Gets a single Openchannel Queue Report",
18702     "examples": [
18703       {
18704         "title": "Example usage:",
18705         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18706         "type": "json"
18707       }
18708     ],
18709     "name": "ShowOpenchannel_Queue_Reports",
18710     "group": "Openchannel_Queue_Reports",
18711     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18712     "version": "0.0.0",
18713     "filename": "server/api/openchannelQueueReport/index.js",
18714     "groupTitle": "Openchannel_Queue_Reports"
18715   },
18716   {
18717     "type": "put",
18718     "url": "/api/openchannel/reports/queue/{id}",
18719     "title": "Update an existing Openchannel Queue Report",
18720     "examples": [
18721       {
18722         "title": "Example usage:",
18723         "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",
18724         "type": "json"
18725       }
18726     ],
18727     "name": "updateOpenchannel_Queue_Reports",
18728     "group": "Openchannel_Queue_Reports",
18729     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18730     "version": "0.0.0",
18731     "filename": "server/api/openchannelQueueReport/index.js",
18732     "groupTitle": "Openchannel_Queue_Reports"
18733   },
18734   {
18735     "type": "post",
18736     "url": "/api/openchannel/queues/{id}/users",
18737     "title": "Add agents to a queue",
18738     "examples": [
18739       {
18740         "title": "Example usage:",
18741         "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",
18742         "type": "json"
18743       }
18744     ],
18745     "name": "AddAgents",
18746     "group": "Openchannel_Queues",
18747     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18748     "version": "0.0.0",
18749     "filename": "server/api/openchannelQueue/index.js",
18750     "groupTitle": "Openchannel_Queues"
18751   },
18752   {
18753     "type": "post",
18754     "url": "/api/openchannel/queues/{id}/teams",
18755     "title": "Add teams to a queue",
18756     "examples": [
18757       {
18758         "title": "Example usage:",
18759         "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",
18760         "type": "json"
18761       }
18762     ],
18763     "name": "AddTeams",
18764     "group": "Openchannel_Queues",
18765     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18766     "version": "0.0.0",
18767     "filename": "server/api/openchannelQueue/index.js",
18768     "groupTitle": "Openchannel_Queues"
18769   },
18770   {
18771     "type": "post",
18772     "url": "/api/openchannel/queues",
18773     "title": "Creates a new Queue",
18774     "examples": [
18775       {
18776         "title": "Example usage:",
18777         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18778         "type": "json"
18779       }
18780     ],
18781     "name": "CreateQueues",
18782     "group": "Openchannel_Queues",
18783     "parameter": {
18784       "fields": {
18785         "Body": [
18786           {
18787             "group": "Body",
18788             "type": "String",
18789             "optional": true,
18790             "field": "name",
18791             "description": ""
18792           },
18793           {
18794             "group": "Body",
18795             "type": "String",
18796             "optional": true,
18797             "field": "description",
18798             "description": ""
18799           },
18800           {
18801             "group": "Body",
18802             "type": "Integer",
18803             "optional": true,
18804             "field": "timeout",
18805             "description": ""
18806           },
18807           {
18808             "group": "Body",
18809             "type": "String",
18810             "allowedValues": [
18811               "\"rrmemory\"",
18812               "\"beepall\"",
18813               "\"roundrobin\""
18814             ],
18815             "optional": true,
18816             "field": "strategy",
18817             "description": ""
18818           }
18819         ]
18820       }
18821     },
18822     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18823     "version": "0.0.0",
18824     "filename": "server/api/openchannelQueue/index.js",
18825     "groupTitle": "Openchannel_Queues"
18826   },
18827   {
18828     "type": "delete",
18829     "url": "/api/openchannel/queues/{id}",
18830     "title": "Deletes a Queue",
18831     "examples": [
18832       {
18833         "title": "Example usage:",
18834         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18835         "type": "json"
18836       }
18837     ],
18838     "name": "DeleteQueues",
18839     "group": "Openchannel_Queues",
18840     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18841     "version": "0.0.0",
18842     "filename": "server/api/openchannelQueue/index.js",
18843     "groupTitle": "Openchannel_Queues"
18844   },
18845   {
18846     "type": "get",
18847     "url": "/api/openchannel/queues/describe",
18848     "title": "Gets table info about Queues",
18849     "examples": [
18850       {
18851         "title": "Example usage:",
18852         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18853         "type": "json"
18854       }
18855     ],
18856     "name": "DescribeQueues",
18857     "group": "Openchannel_Queues",
18858     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18859     "version": "0.0.0",
18860     "filename": "server/api/openchannelQueue/index.js",
18861     "groupTitle": "Openchannel_Queues"
18862   },
18863   {
18864     "type": "get",
18865     "url": "/api/openchannel/queues/{id}/users",
18866     "title": "Gets queue agents",
18867     "examples": [
18868       {
18869         "title": "Example usage:",
18870         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18871         "type": "json"
18872       }
18873     ],
18874     "name": "GetAgents",
18875     "group": "Openchannel_Queues",
18876     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18877     "version": "0.0.0",
18878     "filename": "server/api/openchannelQueue/index.js",
18879     "groupTitle": "Openchannel_Queues"
18880   },
18881   {
18882     "type": "get",
18883     "url": "/api/openchannel/queues/{id}/members",
18884     "title": "GetMembers",
18885     "examples": [
18886       {
18887         "title": "Example usage:",
18888         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
18889         "type": "json"
18890       }
18891     ],
18892     "name": "GetMembers",
18893     "group": "Openchannel_Queues",
18894     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18895     "version": "0.0.0",
18896     "filename": "server/api/openchannelQueue/index.js",
18897     "groupTitle": "Openchannel_Queues"
18898   },
18899   {
18900     "type": "get",
18901     "url": "/api/openchannel/queues",
18902     "title": "Gets a list of Queues",
18903     "examples": [
18904       {
18905         "title": "Example usage:",
18906         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18907         "type": "json"
18908       }
18909     ],
18910     "name": "GetQueues",
18911     "group": "Openchannel_Queues",
18912     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18913     "version": "0.0.0",
18914     "filename": "server/api/openchannelQueue/index.js",
18915     "groupTitle": "Openchannel_Queues"
18916   },
18917   {
18918     "type": "get",
18919     "url": "/api/openchannel/queues/{id}/teams",
18920     "title": "Gets queues list",
18921     "examples": [
18922       {
18923         "title": "Example usage:",
18924         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18925         "type": "json"
18926       }
18927     ],
18928     "name": "GetTeams",
18929     "group": "Openchannel_Queues",
18930     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18931     "version": "0.0.0",
18932     "filename": "server/api/openchannelQueue/index.js",
18933     "groupTitle": "Openchannel_Queues"
18934   },
18935   {
18936     "type": "delete",
18937     "url": "/api/openchannel/queues/{id}/users",
18938     "title": "Removes agents from a queue",
18939     "examples": [
18940       {
18941         "title": "Example usage:",
18942         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18943         "type": "json"
18944       }
18945     ],
18946     "name": "RemoveAgents",
18947     "group": "Openchannel_Queues",
18948     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18949     "version": "0.0.0",
18950     "filename": "server/api/openchannelQueue/index.js",
18951     "groupTitle": "Openchannel_Queues"
18952   },
18953   {
18954     "type": "get",
18955     "url": "/api/openchannel/queues/{id}",
18956     "title": "Gets a single Queue",
18957     "examples": [
18958       {
18959         "title": "Example usage:",
18960         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18961         "type": "json"
18962       }
18963     ],
18964     "name": "ShowQueues",
18965     "group": "Openchannel_Queues",
18966     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18967     "version": "0.0.0",
18968     "filename": "server/api/openchannelQueue/index.js",
18969     "groupTitle": "Openchannel_Queues"
18970   },
18971   {
18972     "type": "put",
18973     "url": "/api/openchannel/queues/{id}",
18974     "title": "Update an existing Queue",
18975     "examples": [
18976       {
18977         "title": "Example usage:",
18978         "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",
18979         "type": "json"
18980       }
18981     ],
18982     "name": "updateQueues",
18983     "group": "Openchannel_Queues",
18984     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18985     "version": "0.0.0",
18986     "filename": "server/api/openchannelQueue/index.js",
18987     "groupTitle": "Openchannel_Queues"
18988   },
18989   {
18990     "type": "post",
18991     "url": "/api/openchannel/reports/transfer",
18992     "title": "Creates a new Openchannel Transfer Report",
18993     "examples": [
18994       {
18995         "title": "Example usage:",
18996         "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",
18997         "type": "json"
18998       }
18999     ],
19000     "name": "CreateOpenchannel_Transfer_Reports",
19001     "group": "Openchannel_Transfer_Reports",
19002     "parameter": {
19003       "fields": {
19004         "Body": [
19005           {
19006             "group": "Body",
19007             "type": "String",
19008             "optional": false,
19009             "field": "uniqueid",
19010             "description": ""
19011           },
19012           {
19013             "group": "Body",
19014             "type": "String",
19015             "allowedValues": [
19016               "\"account\"",
19017               "\"agent\"",
19018               "\"queue\""
19019             ],
19020             "optional": false,
19021             "field": "type",
19022             "description": ""
19023           },
19024           {
19025             "group": "Body",
19026             "type": "String",
19027             "optional": false,
19028             "field": "transferredAt",
19029             "description": ""
19030           }
19031         ]
19032       }
19033     },
19034     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19035     "version": "0.0.0",
19036     "filename": "server/api/openchannelTransferReport/index.js",
19037     "groupTitle": "Openchannel_Transfer_Reports"
19038   },
19039   {
19040     "type": "delete",
19041     "url": "/api/openchannel/reports/transfer/{id}",
19042     "title": "Deletes a Openchannel Transfer Report",
19043     "examples": [
19044       {
19045         "title": "Example usage:",
19046         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19047         "type": "json"
19048       }
19049     ],
19050     "name": "DeleteOpenchannel_Transfer_Reports",
19051     "group": "Openchannel_Transfer_Reports",
19052     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19053     "version": "0.0.0",
19054     "filename": "server/api/openchannelTransferReport/index.js",
19055     "groupTitle": "Openchannel_Transfer_Reports"
19056   },
19057   {
19058     "type": "get",
19059     "url": "/api/openchannel/reports/transfer/describe",
19060     "title": "Gets table info about Openchannel Transfer Reports",
19061     "examples": [
19062       {
19063         "title": "Example usage:",
19064         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19065         "type": "json"
19066       }
19067     ],
19068     "name": "DescribeOpenchannel_Transfer_Reports",
19069     "group": "Openchannel_Transfer_Reports",
19070     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19071     "version": "0.0.0",
19072     "filename": "server/api/openchannelTransferReport/index.js",
19073     "groupTitle": "Openchannel_Transfer_Reports"
19074   },
19075   {
19076     "type": "get",
19077     "url": "/api/openchannel/reports/transfer",
19078     "title": "Gets a list of Openchannel Transfer Reports",
19079     "examples": [
19080       {
19081         "title": "Example usage:",
19082         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19083         "type": "json"
19084       }
19085     ],
19086     "name": "GetOpenchannel_Transfer_Reports",
19087     "group": "Openchannel_Transfer_Reports",
19088     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19089     "version": "0.0.0",
19090     "filename": "server/api/openchannelTransferReport/index.js",
19091     "groupTitle": "Openchannel_Transfer_Reports"
19092   },
19093   {
19094     "type": "get",
19095     "url": "/api/openchannel/reports/transfer/{id}",
19096     "title": "Gets a single Openchannel Transfer Report",
19097     "examples": [
19098       {
19099         "title": "Example usage:",
19100         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19101         "type": "json"
19102       }
19103     ],
19104     "name": "ShowOpenchannel_Transfer_Reports",
19105     "group": "Openchannel_Transfer_Reports",
19106     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19107     "version": "0.0.0",
19108     "filename": "server/api/openchannelTransferReport/index.js",
19109     "groupTitle": "Openchannel_Transfer_Reports"
19110   },
19111   {
19112     "type": "put",
19113     "url": "/api/openchannel/reports/transfer/{id}",
19114     "title": "Update an existing Openchannel Transfer Report",
19115     "examples": [
19116       {
19117         "title": "Example usage:",
19118         "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",
19119         "type": "json"
19120       }
19121     ],
19122     "name": "updateOpenchannel_Transfer_Reports",
19123     "group": "Openchannel_Transfer_Reports",
19124     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19125     "version": "0.0.0",
19126     "filename": "server/api/openchannelTransferReport/index.js",
19127     "groupTitle": "Openchannel_Transfer_Reports"
19128   },
19129   {
19130     "type": "post",
19131     "url": "/api/pauses",
19132     "title": "Creates a new Pause",
19133     "examples": [
19134       {
19135         "title": "Example usage:",
19136         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19137         "type": "json"
19138       }
19139     ],
19140     "name": "CreatePauses",
19141     "group": "Pauses",
19142     "parameter": {
19143       "fields": {
19144         "Body": [
19145           {
19146             "group": "Body",
19147             "type": "String",
19148             "optional": false,
19149             "field": "name",
19150             "description": ""
19151           },
19152           {
19153             "group": "Body",
19154             "type": "String",
19155             "optional": true,
19156             "field": "description",
19157             "description": ""
19158           }
19159         ]
19160       }
19161     },
19162     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19163     "version": "0.0.0",
19164     "filename": "server/api/pause/index.js",
19165     "groupTitle": "Pauses"
19166   },
19167   {
19168     "type": "delete",
19169     "url": "/api/pauses/{id}",
19170     "title": "Deletes a Pause",
19171     "examples": [
19172       {
19173         "title": "Example usage:",
19174         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19175         "type": "json"
19176       }
19177     ],
19178     "name": "DeletePauses",
19179     "group": "Pauses",
19180     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/pause/index.js",
19183     "groupTitle": "Pauses"
19184   },
19185   {
19186     "type": "get",
19187     "url": "/api/pauses",
19188     "title": "Gets a list of Pauses",
19189     "examples": [
19190       {
19191         "title": "Example usage:",
19192         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19193         "type": "json"
19194       }
19195     ],
19196     "name": "GetPauses",
19197     "group": "Pauses",
19198     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19199     "version": "0.0.0",
19200     "filename": "server/api/pause/index.js",
19201     "groupTitle": "Pauses"
19202   },
19203   {
19204     "type": "get",
19205     "url": "/api/pauses/{id}",
19206     "title": "Gets a single Pause",
19207     "examples": [
19208       {
19209         "title": "Example usage:",
19210         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19211         "type": "json"
19212       }
19213     ],
19214     "name": "ShowPauses",
19215     "group": "Pauses",
19216     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19217     "version": "0.0.0",
19218     "filename": "server/api/pause/index.js",
19219     "groupTitle": "Pauses"
19220   },
19221   {
19222     "type": "put",
19223     "url": "/api/pauses/{id}",
19224     "title": "Update an existing Pause",
19225     "examples": [
19226       {
19227         "title": "Example usage:",
19228         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19229         "type": "json"
19230       }
19231     ],
19232     "name": "updatePauses",
19233     "group": "Pauses",
19234     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19235     "version": "0.0.0",
19236     "filename": "server/api/pause/index.js",
19237     "groupTitle": "Pauses"
19238   },
19239   {
19240     "type": "get",
19241     "url": "/api/plugins",
19242     "title": "Gets a list of Plugins",
19243     "examples": [
19244       {
19245         "title": "Example usage:",
19246         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19247         "type": "json"
19248       }
19249     ],
19250     "name": "GetPlugins",
19251     "group": "Plugins",
19252     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19253     "version": "0.0.0",
19254     "filename": "server/api/plugin/index.js",
19255     "groupTitle": "Plugins"
19256   },
19257   {
19258     "type": "get",
19259     "url": "/api/plugins/{id}",
19260     "title": "Gets a single Plugin",
19261     "examples": [
19262       {
19263         "title": "Example usage:",
19264         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19265         "type": "json"
19266       }
19267     ],
19268     "name": "ShowPlugins",
19269     "group": "Plugins",
19270     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19271     "version": "0.0.0",
19272     "filename": "server/api/plugin/index.js",
19273     "groupTitle": "Plugins"
19274   },
19275   {
19276     "type": "delete",
19277     "url": "/api/plugins/{id}",
19278     "title": "Delete a plugin",
19279     "examples": [
19280       {
19281         "title": "Example usage:",
19282         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19283         "type": "json"
19284       }
19285     ],
19286     "name": "destroyPlugin",
19287     "group": "Plugins",
19288     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19289     "version": "0.0.0",
19290     "filename": "server/api/plugin/index.js",
19291     "groupTitle": "Plugins"
19292   },
19293   {
19294     "type": "get",
19295     "url": "/api/plugins/{id}/download",
19296     "title": "Download plugin source code",
19297     "examples": [
19298       {
19299         "title": "Example usage:",
19300         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19301         "type": "json"
19302       }
19303     ],
19304     "name": "download",
19305     "group": "Plugins",
19306     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19307     "version": "0.0.0",
19308     "filename": "server/api/plugin/index.js",
19309     "groupTitle": "Plugins"
19310   },
19311   {
19312     "type": "put",
19313     "url": "/api/plugins/{id}",
19314     "title": "Update an existing plugin",
19315     "examples": [
19316       {
19317         "title": "Example usage:",
19318         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19319         "type": "json"
19320       }
19321     ],
19322     "name": "updatePlugin",
19323     "group": "Plugins",
19324     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19325     "version": "0.0.0",
19326     "filename": "server/api/plugin/index.js",
19327     "groupTitle": "Plugins"
19328   },
19329   {
19330     "type": "post",
19331     "url": "/api/plugins",
19332     "title": "Upload new plugin",
19333     "examples": [
19334       {
19335         "title": "Example usage:",
19336         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19337         "type": "json"
19338       }
19339     ],
19340     "name": "uploadPlugin",
19341     "group": "Plugins",
19342     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19343     "version": "0.0.0",
19344     "filename": "server/api/plugin/index.js",
19345     "groupTitle": "Plugins"
19346   },
19347   {
19348     "type": "get",
19349     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19350     "title": "Redirect a plugin request to the specified path",
19351     "examples": [
19352       {
19353         "title": "Example usage:",
19354         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19355         "type": "json"
19356       }
19357     ],
19358     "name": "webhookPlugin",
19359     "group": "Plugins",
19360     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19361     "version": "0.0.0",
19362     "filename": "server/api/plugin/index.js",
19363     "groupTitle": "Plugins"
19364   },
19365   {
19366     "type": "post",
19367     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19368     "title": "Redirect a plugin request to the specified path",
19369     "examples": [
19370       {
19371         "title": "Example usage:",
19372         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19373         "type": "json"
19374       }
19375     ],
19376     "name": "webhookPlugin",
19377     "group": "Plugins",
19378     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19379     "version": "0.0.0",
19380     "filename": "server/api/plugin/index.js",
19381     "groupTitle": "Plugins"
19382   },
19383   {
19384     "type": "delete",
19385     "url": "/api/pm2/{id}",
19386     "title": "Deletes an existing process",
19387     "examples": [
19388       {
19389         "title": "Example usage:",
19390         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19391         "type": "json"
19392       }
19393     ],
19394     "name": "DeletePm2Process",
19395     "group": "Pm2",
19396     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19397     "version": "0.0.0",
19398     "filename": "server/api/pm2/index.js",
19399     "groupTitle": "Pm2"
19400   },
19401   {
19402     "type": "get",
19403     "url": "/api/pm2/{id}",
19404     "title": "Gets a single pm2 process",
19405     "examples": [
19406       {
19407         "title": "Example usage:",
19408         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19409         "type": "json"
19410       }
19411     ],
19412     "name": "GetPm2Process",
19413     "group": "Pm2",
19414     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19415     "version": "0.0.0",
19416     "filename": "server/api/pm2/index.js",
19417     "groupTitle": "Pm2"
19418   },
19419   {
19420     "type": "get",
19421     "url": "/api/pm2",
19422     "title": "Gets pm2 processes",
19423     "examples": [
19424       {
19425         "title": "Example usage:",
19426         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19427         "type": "json"
19428       }
19429     ],
19430     "name": "GetPm2Processes",
19431     "group": "Pm2",
19432     "description": "<p>Motion returns the pm2 processes list.</p>",
19433     "version": "0.0.0",
19434     "filename": "server/api/pm2/index.js",
19435     "groupTitle": "Pm2"
19436   },
19437   {
19438     "type": "post",
19439     "url": "/api/pm2",
19440     "title": "Start a single pm2 process",
19441     "examples": [
19442       {
19443         "title": "Example usage:",
19444         "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",
19445         "type": "json"
19446       }
19447     ],
19448     "name": "StartPm2Process",
19449     "group": "Pm2",
19450     "parameter": {
19451       "fields": {
19452         "Body": [
19453           {
19454             "group": "Body",
19455             "type": "String",
19456             "optional": false,
19457             "field": "name",
19458             "description": ""
19459           },
19460           {
19461             "group": "Body",
19462             "type": "String",
19463             "optional": false,
19464             "field": "script",
19465             "description": ""
19466           }
19467         ]
19468       }
19469     },
19470     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "put",
19477     "url": "/api/pm2/{id}",
19478     "title": "Update an existing process",
19479     "examples": [
19480       {
19481         "title": "Example usage:",
19482         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19483         "type": "json"
19484       }
19485     ],
19486     "name": "UpdatePm2Process",
19487     "group": "Pm2",
19488     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19489     "version": "0.0.0",
19490     "filename": "server/api/pm2/index.js",
19491     "groupTitle": "Pm2"
19492   },
19493   {
19494     "type": "get",
19495     "url": "/api/rpc/campaigns/",
19496     "title": "Gets a list of campaigns",
19497     "examples": [
19498       {
19499         "title": "Example usage:",
19500         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19501         "type": "json"
19502       }
19503     ],
19504     "name": "Campaigns",
19505     "group": "RPC_Realtime",
19506     "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>",
19507     "version": "0.0.0",
19508     "filename": "server/api/rpc/index.js",
19509     "groupTitle": "RPC_Realtime"
19510   },
19511   {
19512     "type": "get",
19513     "url": "/api/rpc/fax/accounts",
19514     "title": "Gets a list of FaxAccounts",
19515     "examples": [
19516       {
19517         "title": "Example usage:",
19518         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19519         "type": "json"
19520       }
19521     ],
19522     "name": "FaxAccounts",
19523     "group": "RPC_Realtime",
19524     "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>",
19525     "version": "0.0.0",
19526     "filename": "server/api/rpc/index.js",
19527     "groupTitle": "RPC_Realtime"
19528   },
19529   {
19530     "type": "put",
19531     "url": "/api/rpc/agents/:id/capacity",
19532     "title": "Sets agent capacity",
19533     "examples": [
19534       {
19535         "title": "Example usage:",
19536         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19537         "type": "json"
19538       }
19539     ],
19540     "name": "RTAgentCapacity",
19541     "group": "RPC_Realtime",
19542     "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>",
19543     "version": "0.0.0",
19544     "filename": "server/api/rpc/index.js",
19545     "groupTitle": "RPC_Realtime"
19546   },
19547   {
19548     "type": "get",
19549     "url": "/api/rpc/agents",
19550     "title": "Gets a list of RTAgents",
19551     "examples": [
19552       {
19553         "title": "Example usage:",
19554         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19555         "type": "json"
19556       }
19557     ],
19558     "name": "RTAgents",
19559     "group": "RPC_Realtime",
19560     "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>",
19561     "version": "0.0.0",
19562     "filename": "server/api/rpc/index.js",
19563     "groupTitle": "RPC_Realtime"
19564   },
19565   {
19566     "type": "get",
19567     "url": "/api/rpc/chat/queues",
19568     "title": "Gets a list of RTChatQueues",
19569     "examples": [
19570       {
19571         "title": "Example usage:",
19572         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19573         "type": "json"
19574       }
19575     ],
19576     "name": "RTChatQueues",
19577     "group": "RPC_Realtime",
19578     "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>",
19579     "version": "0.0.0",
19580     "filename": "server/api/rpc/index.js",
19581     "groupTitle": "RPC_Realtime"
19582   },
19583   {
19584     "type": "get",
19585     "url": "/api/rpc/fax/queues",
19586     "title": "Gets a list of RTFaxQueues",
19587     "examples": [
19588       {
19589         "title": "Example usage:",
19590         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19591         "type": "json"
19592       }
19593     ],
19594     "name": "RTFaxQueues",
19595     "group": "RPC_Realtime",
19596     "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>",
19597     "version": "0.0.0",
19598     "filename": "server/api/rpc/index.js",
19599     "groupTitle": "RPC_Realtime"
19600   },
19601   {
19602     "type": "get",
19603     "url": "/api/rpc/mail/accounts",
19604     "title": "Gets a list of RTMailAccounts",
19605     "examples": [
19606       {
19607         "title": "Example usage:",
19608         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19609         "type": "json"
19610       }
19611     ],
19612     "name": "RTMailAccounts",
19613     "group": "RPC_Realtime",
19614     "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>",
19615     "version": "0.0.0",
19616     "filename": "server/api/rpc/index.js",
19617     "groupTitle": "RPC_Realtime"
19618   },
19619   {
19620     "type": "get",
19621     "url": "/api/rpc/mail/queues",
19622     "title": "Gets a list of RTMailQueues",
19623     "examples": [
19624       {
19625         "title": "Example usage:",
19626         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19627         "type": "json"
19628       }
19629     ],
19630     "name": "RTMailQueues",
19631     "group": "RPC_Realtime",
19632     "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>",
19633     "version": "0.0.0",
19634     "filename": "server/api/rpc/index.js",
19635     "groupTitle": "RPC_Realtime"
19636   },
19637   {
19638     "type": "get",
19639     "url": "/api/rpc/openchannel/queues",
19640     "title": "Gets a list of RTOpenchannelQueues",
19641     "examples": [
19642       {
19643         "title": "Example usage:",
19644         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19645         "type": "json"
19646       }
19647     ],
19648     "name": "RTOpenchannelQueues",
19649     "group": "RPC_Realtime",
19650     "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>",
19651     "version": "0.0.0",
19652     "filename": "server/api/rpc/index.js",
19653     "groupTitle": "RPC_Realtime"
19654   },
19655   {
19656     "type": "get",
19657     "url": "/api/rpc/outbound/channels",
19658     "title": "Gets a list of RTOutboundChannels",
19659     "examples": [
19660       {
19661         "title": "Example usage:",
19662         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19663         "type": "json"
19664       }
19665     ],
19666     "name": "RTOutboundChannels",
19667     "group": "RPC_Realtime",
19668     "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>",
19669     "version": "0.0.0",
19670     "filename": "server/api/rpc/index.js",
19671     "groupTitle": "RPC_Realtime"
19672   },
19673   {
19674     "type": "get",
19675     "url": "/api/rpc/sms/queues",
19676     "title": "Gets a list of RTSmsQueues",
19677     "examples": [
19678       {
19679         "title": "Example usage:",
19680         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19681         "type": "json"
19682       }
19683     ],
19684     "name": "RTSmsQueues",
19685     "group": "RPC_Realtime",
19686     "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>",
19687     "version": "0.0.0",
19688     "filename": "server/api/rpc/index.js",
19689     "groupTitle": "RPC_Realtime"
19690   },
19691   {
19692     "type": "get",
19693     "url": "/api/rpc/telephones",
19694     "title": "Gets a list of RTTelephones",
19695     "examples": [
19696       {
19697         "title": "Example usage:",
19698         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19699         "type": "json"
19700       }
19701     ],
19702     "name": "RTTelephones",
19703     "group": "RPC_Realtime",
19704     "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>",
19705     "version": "0.0.0",
19706     "filename": "server/api/rpc/index.js",
19707     "groupTitle": "RPC_Realtime"
19708   },
19709   {
19710     "type": "get",
19711     "url": "/api/rpc/trunks",
19712     "title": "Gets a list of RTTrunks",
19713     "examples": [
19714       {
19715         "title": "Example usage:",
19716         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19717         "type": "json"
19718       }
19719     ],
19720     "name": "RTTrunks",
19721     "group": "RPC_Realtime",
19722     "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>",
19723     "version": "0.0.0",
19724     "filename": "server/api/rpc/index.js",
19725     "groupTitle": "RPC_Realtime"
19726   },
19727   {
19728     "type": "get",
19729     "url": "/api/rpc/voice/channels",
19730     "title": "Gets a list of RTVoiceChannelMixMonitor",
19731     "examples": [
19732       {
19733         "title": "Example usage:",
19734         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19735         "type": "json"
19736       }
19737     ],
19738     "name": "RTVoiceChannelMixMonitor",
19739     "group": "RPC_Realtime",
19740     "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>",
19741     "version": "0.0.0",
19742     "filename": "server/api/rpc/index.js",
19743     "groupTitle": "RPC_Realtime"
19744   },
19745   {
19746     "type": "get",
19747     "url": "/api/rpc/voice/channels",
19748     "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19749     "examples": [
19750       {
19751         "title": "Example usage:",
19752         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19753         "type": "json"
19754       }
19755     ],
19756     "name": "RTVoiceChannelStopMixMonitor",
19757     "group": "RPC_Realtime",
19758     "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>",
19759     "version": "0.0.0",
19760     "filename": "server/api/rpc/index.js",
19761     "groupTitle": "RPC_Realtime"
19762   },
19763   {
19764     "type": "get",
19765     "url": "/api/rpc/voice/channels",
19766     "title": "Gets a list of RTVoiceChannels",
19767     "examples": [
19768       {
19769         "title": "Example usage:",
19770         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19771         "type": "json"
19772       }
19773     ],
19774     "name": "RTVoiceChannels",
19775     "group": "RPC_Realtime",
19776     "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>",
19777     "version": "0.0.0",
19778     "filename": "server/api/rpc/index.js",
19779     "groupTitle": "RPC_Realtime"
19780   },
19781   {
19782     "type": "get",
19783     "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19784     "title": "Gets a single RTVoiceQueueChannel",
19785     "examples": [
19786       {
19787         "title": "Example usage:",
19788         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19789         "type": "json"
19790       }
19791     ],
19792     "name": "RTVoiceQueueChannel",
19793     "group": "RPC_Realtime",
19794     "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19795     "version": "0.0.0",
19796     "filename": "server/api/rpc/index.js",
19797     "groupTitle": "RPC_Realtime"
19798   },
19799   {
19800     "type": "get",
19801     "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19802     "title": "Hangup a single RTVoiceQueueChannel",
19803     "examples": [
19804       {
19805         "title": "Example usage:",
19806         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19807         "type": "json"
19808       }
19809     ],
19810     "name": "RTVoiceQueueChannelHangup",
19811     "group": "RPC_Realtime",
19812     "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19813     "version": "0.0.0",
19814     "filename": "server/api/rpc/index.js",
19815     "groupTitle": "RPC_Realtime"
19816   },
19817   {
19818     "type": "get",
19819     "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19820     "title": "Hangup a single RTVoiceQueueChannel",
19821     "examples": [
19822       {
19823         "title": "Example usage:",
19824         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19825         "type": "json"
19826       }
19827     ],
19828     "name": "RTVoiceQueueChannelRedirect",
19829     "group": "RPC_Realtime",
19830     "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>",
19831     "version": "0.0.0",
19832     "filename": "server/api/rpc/index.js",
19833     "groupTitle": "RPC_Realtime"
19834   },
19835   {
19836     "type": "get",
19837     "url": "/api/rpc/voice/queues/preview/{id}",
19838     "title": "Gets a single preview contact",
19839     "examples": [
19840       {
19841         "title": "Example usage:",
19842         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19843         "type": "json"
19844       }
19845     ],
19846     "name": "RTVoiceQueuePreview",
19847     "group": "RPC_Realtime",
19848     "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19849     "version": "0.0.0",
19850     "filename": "server/api/rpc/index.js",
19851     "groupTitle": "RPC_Realtime"
19852   },
19853   {
19854     "type": "get",
19855     "url": "/api/rpc/outbound",
19856     "title": "Gets a list of RTOutbound",
19857     "examples": [
19858       {
19859         "title": "Example usage:",
19860         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19861         "type": "json"
19862       }
19863     ],
19864     "name": "RTVoiceQueues",
19865     "group": "RPC_Realtime",
19866     "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>",
19867     "version": "0.0.0",
19868     "filename": "server/api/rpc/index.js",
19869     "groupTitle": "RPC_Realtime"
19870   },
19871   {
19872     "type": "get",
19873     "url": "/api/rpc/voice/queues",
19874     "title": "Gets a list of RTVoiceQueues",
19875     "examples": [
19876       {
19877         "title": "Example usage:",
19878         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19879         "type": "json"
19880       }
19881     ],
19882     "name": "RTVoiceQueues",
19883     "group": "RPC_Realtime",
19884     "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>",
19885     "version": "0.0.0",
19886     "filename": "server/api/rpc/index.js",
19887     "groupTitle": "RPC_Realtime"
19888   },
19889   {
19890     "type": "get",
19891     "url": "/api/rpc/voice/queues/channels",
19892     "title": "Gets a list of RTVoiceQueuesChannels",
19893     "examples": [
19894       {
19895         "title": "Example usage:",
19896         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19897         "type": "json"
19898       }
19899     ],
19900     "name": "RTVoiceQueuesChannels",
19901     "group": "RPC_Realtime",
19902     "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>",
19903     "version": "0.0.0",
19904     "filename": "server/api/rpc/index.js",
19905     "groupTitle": "RPC_Realtime"
19906   },
19907   {
19908     "type": "get",
19909     "url": "/api/rpc/chat/queues/{id}",
19910     "title": "Gets a single RTChatQueue",
19911     "examples": [
19912       {
19913         "title": "Example usage:",
19914         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19915         "type": "json"
19916       }
19917     ],
19918     "name": "ShowRTChatQueues",
19919     "group": "RPC_Realtime",
19920     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19921     "version": "0.0.0",
19922     "filename": "server/api/rpc/index.js",
19923     "groupTitle": "RPC_Realtime"
19924   },
19925   {
19926     "type": "get",
19927     "url": "/api/rpc/fax/queues/{id}",
19928     "title": "Gets a single RTFaxQueue",
19929     "examples": [
19930       {
19931         "title": "Example usage:",
19932         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19933         "type": "json"
19934       }
19935     ],
19936     "name": "ShowRTFaxQueues",
19937     "group": "RPC_Realtime",
19938     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19939     "version": "0.0.0",
19940     "filename": "server/api/rpc/index.js",
19941     "groupTitle": "RPC_Realtime"
19942   },
19943   {
19944     "type": "get",
19945     "url": "/api/rpc/mail/queues/{id}",
19946     "title": "Gets a single RTMailQueue",
19947     "examples": [
19948       {
19949         "title": "Example usage:",
19950         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19951         "type": "json"
19952       }
19953     ],
19954     "name": "ShowRTMailQueues",
19955     "group": "RPC_Realtime",
19956     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19957     "version": "0.0.0",
19958     "filename": "server/api/rpc/index.js",
19959     "groupTitle": "RPC_Realtime"
19960   },
19961   {
19962     "type": "get",
19963     "url": "/api/rpc/openchannel/queues/{id}",
19964     "title": "Gets a single RTOpenchannelQueue",
19965     "examples": [
19966       {
19967         "title": "Example usage:",
19968         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19969         "type": "json"
19970       }
19971     ],
19972     "name": "ShowRTOpenchannelQueues",
19973     "group": "RPC_Realtime",
19974     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19975     "version": "0.0.0",
19976     "filename": "server/api/rpc/index.js",
19977     "groupTitle": "RPC_Realtime"
19978   },
19979   {
19980     "type": "get",
19981     "url": "/api/rpc/sms/queues/{id}",
19982     "title": "Gets a single RTSmsQueue",
19983     "examples": [
19984       {
19985         "title": "Example usage:",
19986         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
19987         "type": "json"
19988       }
19989     ],
19990     "name": "ShowRTSmsQueues",
19991     "group": "RPC_Realtime",
19992     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19993     "version": "0.0.0",
19994     "filename": "server/api/rpc/index.js",
19995     "groupTitle": "RPC_Realtime"
19996   },
19997   {
19998     "type": "get",
19999     "url": "/api/rpc/voice/queues/{id}",
20000     "title": "Gets a single RTVoiceQueue",
20001     "examples": [
20002       {
20003         "title": "Example usage:",
20004         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20005         "type": "json"
20006       }
20007     ],
20008     "name": "ShowRTVoiceQueues",
20009     "group": "RPC_Realtime",
20010     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20011     "version": "0.0.0",
20012     "filename": "server/api/rpc/index.js",
20013     "groupTitle": "RPC_Realtime"
20014   },
20015   {
20016     "type": "put",
20017     "url": "/api/rpc/voice/{id}/queues",
20018     "title": "Updates a single VoiceQueue",
20019     "examples": [
20020       {
20021         "title": "Example usage:",
20022         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20023         "type": "json"
20024       }
20025     ],
20026     "name": "UpdateVoiceQueues",
20027     "group": "RPC_Realtime",
20028     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20029     "version": "0.0.0",
20030     "filename": "server/api/rpc/index.js",
20031     "groupTitle": "RPC_Realtime"
20032   },
20033   {
20034     "type": "post",
20035     "url": "/api/rpc/agents/:id/notify",
20036     "title": "Notify message to a specific agent",
20037     "examples": [
20038       {
20039         "title": "Example usage:",
20040         "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",
20041         "type": "json"
20042       }
20043     ],
20044     "name": "agentNotify",
20045     "group": "RPC_Realtime",
20046     "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>",
20047     "version": "0.0.0",
20048     "filename": "server/api/rpc/index.js",
20049     "groupTitle": "RPC_Realtime"
20050   },
20051   {
20052     "type": "post",
20053     "url": "/api/rpc/chat/queues/:id/notify",
20054     "title": "Notify message to a specific queue",
20055     "examples": [
20056       {
20057         "title": "Example usage:",
20058         "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",
20059         "type": "json"
20060       }
20061     ],
20062     "name": "chatQueueNotify",
20063     "group": "RPC_Realtime",
20064     "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>",
20065     "version": "0.0.0",
20066     "filename": "server/api/rpc/index.js",
20067     "groupTitle": "RPC_Realtime"
20068   },
20069   {
20070     "type": "get",
20071     "url": "/api/rpc/chat/queues/waitinginteractions",
20072     "title": "Gets a list of chatQueuesWaitingInteractions",
20073     "examples": [
20074       {
20075         "title": "Example usage:",
20076         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20077         "type": "json"
20078       }
20079     ],
20080     "name": "chatQueuesWaitingInteractions",
20081     "group": "RPC_Realtime",
20082     "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>",
20083     "version": "0.0.0",
20084     "filename": "server/api/rpc/index.js",
20085     "groupTitle": "RPC_Realtime"
20086   },
20087   {
20088     "type": "post",
20089     "url": "/api/rpc/fax/queues/:id/notify",
20090     "title": "Notify message to a specific queue",
20091     "examples": [
20092       {
20093         "title": "Example usage:",
20094         "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",
20095         "type": "json"
20096       }
20097     ],
20098     "name": "faxQueueNotify",
20099     "group": "RPC_Realtime",
20100     "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>",
20101     "version": "0.0.0",
20102     "filename": "server/api/rpc/index.js",
20103     "groupTitle": "RPC_Realtime"
20104   },
20105   {
20106     "type": "get",
20107     "url": "/api/rpc/fax/queues/waitinginteractions",
20108     "title": "Gets a list of faxQueuesWaitingInteractions",
20109     "examples": [
20110       {
20111         "title": "Example usage:",
20112         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20113         "type": "json"
20114       }
20115     ],
20116     "name": "faxQueuesWaitingInteractions",
20117     "group": "RPC_Realtime",
20118     "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>",
20119     "version": "0.0.0",
20120     "filename": "server/api/rpc/index.js",
20121     "groupTitle": "RPC_Realtime"
20122   },
20123   {
20124     "type": "post",
20125     "url": "/api/rpc/mail/queues/:id/notify",
20126     "title": "Notify message to a specific queue",
20127     "examples": [
20128       {
20129         "title": "Example usage:",
20130         "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",
20131         "type": "json"
20132       }
20133     ],
20134     "name": "mailQueueNotify",
20135     "group": "RPC_Realtime",
20136     "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>",
20137     "version": "0.0.0",
20138     "filename": "server/api/rpc/index.js",
20139     "groupTitle": "RPC_Realtime"
20140   },
20141   {
20142     "type": "get",
20143     "url": "/api/rpc/mail/queues/waitinginteractions",
20144     "title": "Gets a list of mailQueuesWaitingInteractions",
20145     "examples": [
20146       {
20147         "title": "Example usage:",
20148         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20149         "type": "json"
20150       }
20151     ],
20152     "name": "mailQueuesWaitingInteractions",
20153     "group": "RPC_Realtime",
20154     "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>",
20155     "version": "0.0.0",
20156     "filename": "server/api/rpc/index.js",
20157     "groupTitle": "RPC_Realtime"
20158   },
20159   {
20160     "type": "post",
20161     "url": "/api/rpc/openchannel/queues/:id/notify",
20162     "title": "Notify message to a specific queue",
20163     "examples": [
20164       {
20165         "title": "Example usage:",
20166         "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",
20167         "type": "json"
20168       }
20169     ],
20170     "name": "openchannelQueueNotify",
20171     "group": "RPC_Realtime",
20172     "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>",
20173     "version": "0.0.0",
20174     "filename": "server/api/rpc/index.js",
20175     "groupTitle": "RPC_Realtime"
20176   },
20177   {
20178     "type": "get",
20179     "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20180     "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20181     "examples": [
20182       {
20183         "title": "Example usage:",
20184         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20185         "type": "json"
20186       }
20187     ],
20188     "name": "openchannelQueuesIdWaitingInteractions",
20189     "group": "RPC_Realtime",
20190     "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>",
20191     "version": "0.0.0",
20192     "filename": "server/api/rpc/index.js",
20193     "groupTitle": "RPC_Realtime"
20194   },
20195   {
20196     "type": "get",
20197     "url": "/api/rpc/openchannel/queues/waitinginteractions",
20198     "title": "Gets a list of openchannelQueuesWaitingInteractions",
20199     "examples": [
20200       {
20201         "title": "Example usage:",
20202         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20203         "type": "json"
20204       }
20205     ],
20206     "name": "openchannelQueuesWaitingInteractions",
20207     "group": "RPC_Realtime",
20208     "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>",
20209     "version": "0.0.0",
20210     "filename": "server/api/rpc/index.js",
20211     "groupTitle": "RPC_Realtime"
20212   },
20213   {
20214     "type": "post",
20215     "url": "/api/rpc/sms/queues/:id/notify",
20216     "title": "Notify message to a specific queue",
20217     "examples": [
20218       {
20219         "title": "Example usage:",
20220         "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",
20221         "type": "json"
20222       }
20223     ],
20224     "name": "smsQueueNotify",
20225     "group": "RPC_Realtime",
20226     "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>",
20227     "version": "0.0.0",
20228     "filename": "server/api/rpc/index.js",
20229     "groupTitle": "RPC_Realtime"
20230   },
20231   {
20232     "type": "get",
20233     "url": "/api/rpc/sms/queues/waitinginteractions",
20234     "title": "Gets a list of smsQueuesWaitingInteractions",
20235     "examples": [
20236       {
20237         "title": "Example usage:",
20238         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20239         "type": "json"
20240       }
20241     ],
20242     "name": "smsQueuesWaitingInteractions",
20243     "group": "RPC_Realtime",
20244     "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>",
20245     "version": "0.0.0",
20246     "filename": "server/api/rpc/index.js",
20247     "groupTitle": "RPC_Realtime"
20248   },
20249   {
20250     "type": "post",
20251     "url": "/api/integrations/salesforce/accounts",
20252     "title": "Creates a new Salesforce Account",
20253     "examples": [
20254       {
20255         "title": "Example usage:",
20256         "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",
20257         "type": "json"
20258       }
20259     ],
20260     "name": "CreateSalesforce_Accounts",
20261     "group": "Salesforce_Accounts",
20262     "parameter": {
20263       "fields": {
20264         "Body": [
20265           {
20266             "group": "Body",
20267             "type": "String",
20268             "optional": true,
20269             "field": "name",
20270             "description": ""
20271           },
20272           {
20273             "group": "Body",
20274             "type": "String",
20275             "optional": true,
20276             "field": "description",
20277             "description": ""
20278           },
20279           {
20280             "group": "Body",
20281             "type": "String",
20282             "optional": true,
20283             "field": "username",
20284             "description": ""
20285           },
20286           {
20287             "group": "Body",
20288             "type": "String",
20289             "optional": true,
20290             "field": "remoteUri",
20291             "description": ""
20292           },
20293           {
20294             "group": "Body",
20295             "type": "String",
20296             "optional": true,
20297             "field": "password",
20298             "description": ""
20299           },
20300           {
20301             "group": "Body",
20302             "type": "String",
20303             "optional": true,
20304             "field": "clientId",
20305             "description": ""
20306           },
20307           {
20308             "group": "Body",
20309             "type": "String",
20310             "optional": true,
20311             "field": "clientSecret",
20312             "description": ""
20313           },
20314           {
20315             "group": "Body",
20316             "type": "String",
20317             "optional": true,
20318             "field": "securityToken",
20319             "description": ""
20320           },
20321           {
20322             "group": "Body",
20323             "type": "String",
20324             "optional": false,
20325             "field": "serverUrl",
20326             "description": ""
20327           },
20328           {
20329             "group": "Body",
20330             "type": "String",
20331             "allowedValues": [
20332               "\"integrationTab\"",
20333               "\"newTab\""
20334             ],
20335             "optional": true,
20336             "field": "type",
20337             "description": ""
20338           }
20339         ]
20340       }
20341     },
20342     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20343     "version": "0.0.0",
20344     "filename": "server/api/intSalesforceAccount/index.js",
20345     "groupTitle": "Salesforce_Accounts"
20346   },
20347   {
20348     "type": "delete",
20349     "url": "/api/integrations/salesforce/accounts/{id}",
20350     "title": "Deletes a Salesforce Account",
20351     "examples": [
20352       {
20353         "title": "Example usage:",
20354         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20355         "type": "json"
20356       }
20357     ],
20358     "name": "DeleteSalesforce_Accounts",
20359     "group": "Salesforce_Accounts",
20360     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20361     "version": "0.0.0",
20362     "filename": "server/api/intSalesforceAccount/index.js",
20363     "groupTitle": "Salesforce_Accounts"
20364   },
20365   {
20366     "type": "get",
20367     "url": "/api/integrations/salesforce/accounts",
20368     "title": "Gets a list of Salesforce Accounts",
20369     "examples": [
20370       {
20371         "title": "Example usage:",
20372         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20373         "type": "json"
20374       }
20375     ],
20376     "name": "GetSalesforce_Accounts",
20377     "group": "Salesforce_Accounts",
20378     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20379     "version": "0.0.0",
20380     "filename": "server/api/intSalesforceAccount/index.js",
20381     "groupTitle": "Salesforce_Accounts"
20382   },
20383   {
20384     "type": "get",
20385     "url": "/api/integrations/salesforce/accounts/{id}",
20386     "title": "Gets a single Salesforce Account",
20387     "examples": [
20388       {
20389         "title": "Example usage:",
20390         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20391         "type": "json"
20392       }
20393     ],
20394     "name": "ShowSalesforce_Accounts",
20395     "group": "Salesforce_Accounts",
20396     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20397     "version": "0.0.0",
20398     "filename": "server/api/intSalesforceAccount/index.js",
20399     "groupTitle": "Salesforce_Accounts"
20400   },
20401   {
20402     "type": "post",
20403     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20404     "title": "Creates new configuration",
20405     "examples": [
20406       {
20407         "title": "Example usage:",
20408         "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",
20409         "type": "json"
20410       }
20411     ],
20412     "name": "addConfiguration",
20413     "group": "Salesforce_Accounts",
20414     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20415     "version": "0.0.0",
20416     "filename": "server/api/intSalesforceAccount/index.js",
20417     "groupTitle": "Salesforce_Accounts"
20418   },
20419   {
20420     "type": "get",
20421     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20422     "title": "Gets account configurations",
20423     "examples": [
20424       {
20425         "title": "Example usage:",
20426         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20427         "type": "json"
20428       }
20429     ],
20430     "name": "getConfigurations",
20431     "group": "Salesforce_Accounts",
20432     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20433     "version": "0.0.0",
20434     "filename": "server/api/intSalesforceAccount/index.js",
20435     "groupTitle": "Salesforce_Accounts"
20436   },
20437   {
20438     "type": "get",
20439     "url": "/api/integrations/salesforce/accounts/{id}/fields",
20440     "title": "Gets account fields",
20441     "examples": [
20442       {
20443         "title": "Example usage:",
20444         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20445         "type": "json"
20446       }
20447     ],
20448     "name": "getFields",
20449     "group": "Salesforce_Accounts",
20450     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20451     "version": "0.0.0",
20452     "filename": "server/api/intSalesforceAccount/index.js",
20453     "groupTitle": "Salesforce_Accounts"
20454   },
20455   {
20456     "type": "put",
20457     "url": "/api/integrations/salesforce/accounts/{id}",
20458     "title": "Update an existing Salesforce Account",
20459     "examples": [
20460       {
20461         "title": "Example usage:",
20462         "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",
20463         "type": "json"
20464       }
20465     ],
20466     "name": "updateSalesforce_Accounts",
20467     "group": "Salesforce_Accounts",
20468     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20469     "version": "0.0.0",
20470     "filename": "server/api/intSalesforceAccount/index.js",
20471     "groupTitle": "Salesforce_Accounts"
20472   },
20473   {
20474     "type": "post",
20475     "url": "/api/integrations/salesforce/configurations",
20476     "title": "Creates a new Salesforce Configuration",
20477     "examples": [
20478       {
20479         "title": "Example usage:",
20480         "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",
20481         "type": "json"
20482       }
20483     ],
20484     "name": "CreateSalesforce_Configurations",
20485     "group": "Salesforce_Configurations",
20486     "parameter": {
20487       "fields": {
20488         "Body": [
20489           {
20490             "group": "Body",
20491             "type": "String",
20492             "optional": true,
20493             "field": "name",
20494             "description": ""
20495           },
20496           {
20497             "group": "Body",
20498             "type": "String",
20499             "optional": true,
20500             "field": "description",
20501             "description": ""
20502           },
20503           {
20504             "group": "Body",
20505             "type": "String",
20506             "allowedValues": [
20507               "\"Task\"",
20508               "\"Case\""
20509             ],
20510             "optional": true,
20511             "field": "ticketType",
20512             "description": ""
20513           },
20514           {
20515             "group": "Body",
20516             "type": "String",
20517             "allowedValues": [
20518               "\"contact_lead\"",
20519               "\"contact\"",
20520               "\"lead\"",
20521               "\"account_contact_lead\"",
20522               "\"account\""
20523             ],
20524             "optional": true,
20525             "field": "moduleSearch",
20526             "description": ""
20527           },
20528           {
20529             "group": "Body",
20530             "type": "String",
20531             "allowedValues": [
20532               "\"nothing\"",
20533               "\"contact\"",
20534               "\"lead\"",
20535               "\"account\""
20536             ],
20537             "optional": true,
20538             "field": "moduleCreate",
20539             "description": ""
20540           },
20541           {
20542             "group": "Body",
20543             "type": "String",
20544             "optional": true,
20545             "field": "leadId",
20546             "description": ""
20547           },
20548           {
20549             "group": "Body",
20550             "type": "String",
20551             "optional": true,
20552             "field": "additionalSearchAccount",
20553             "description": ""
20554           },
20555           {
20556             "group": "Body",
20557             "type": "String",
20558             "optional": true,
20559             "field": "additionalSearchContact",
20560             "description": ""
20561           },
20562           {
20563             "group": "Body",
20564             "type": "String",
20565             "optional": true,
20566             "field": "additionalSearchLead",
20567             "description": ""
20568           }
20569         ]
20570       }
20571     },
20572     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20573     "version": "0.0.0",
20574     "filename": "server/api/intSalesforceConfiguration/index.js",
20575     "groupTitle": "Salesforce_Configurations"
20576   },
20577   {
20578     "type": "delete",
20579     "url": "/api/integrations/salesforce/configurations/{id}",
20580     "title": "Deletes a Salesforce Configuration",
20581     "examples": [
20582       {
20583         "title": "Example usage:",
20584         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20585         "type": "json"
20586       }
20587     ],
20588     "name": "DeleteSalesforce_Configurations",
20589     "group": "Salesforce_Configurations",
20590     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20591     "version": "0.0.0",
20592     "filename": "server/api/intSalesforceConfiguration/index.js",
20593     "groupTitle": "Salesforce_Configurations"
20594   },
20595   {
20596     "type": "get",
20597     "url": "/api/integrations/salesforce/configurations",
20598     "title": "Gets a list of Salesforce Configurations",
20599     "examples": [
20600       {
20601         "title": "Example usage:",
20602         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20603         "type": "json"
20604       }
20605     ],
20606     "name": "GetSalesforce_Configurations",
20607     "group": "Salesforce_Configurations",
20608     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20609     "version": "0.0.0",
20610     "filename": "server/api/intSalesforceConfiguration/index.js",
20611     "groupTitle": "Salesforce_Configurations"
20612   },
20613   {
20614     "type": "get",
20615     "url": "/api/integrations/salesforce/configurations/{id}",
20616     "title": "Gets a single Salesforce Configuration",
20617     "examples": [
20618       {
20619         "title": "Example usage:",
20620         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20621         "type": "json"
20622       }
20623     ],
20624     "name": "ShowSalesforce_Configurations",
20625     "group": "Salesforce_Configurations",
20626     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20627     "version": "0.0.0",
20628     "filename": "server/api/intSalesforceConfiguration/index.js",
20629     "groupTitle": "Salesforce_Configurations"
20630   },
20631   {
20632     "type": "get",
20633     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20634     "title": "Gets configurations descriptions",
20635     "examples": [
20636       {
20637         "title": "Example usage:",
20638         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20639         "type": "json"
20640       }
20641     ],
20642     "name": "getDescriptions",
20643     "group": "Salesforce_Configurations",
20644     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20645     "version": "0.0.0",
20646     "filename": "server/api/intSalesforceConfiguration/index.js",
20647     "groupTitle": "Salesforce_Configurations"
20648   },
20649   {
20650     "type": "get",
20651     "url": "/api/integrations/salesforce/configurations/{id}/fields",
20652     "title": "Gets configurations fields",
20653     "examples": [
20654       {
20655         "title": "Example usage:",
20656         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20657         "type": "json"
20658       }
20659     ],
20660     "name": "getFields",
20661     "group": "Salesforce_Configurations",
20662     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20663     "version": "0.0.0",
20664     "filename": "server/api/intSalesforceConfiguration/index.js",
20665     "groupTitle": "Salesforce_Configurations"
20666   },
20667   {
20668     "type": "get",
20669     "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20670     "title": "Gets configurations subjects",
20671     "examples": [
20672       {
20673         "title": "Example usage:",
20674         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20675         "type": "json"
20676       }
20677     ],
20678     "name": "getSubjects",
20679     "group": "Salesforce_Configurations",
20680     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20681     "version": "0.0.0",
20682     "filename": "server/api/intSalesforceConfiguration/index.js",
20683     "groupTitle": "Salesforce_Configurations"
20684   },
20685   {
20686     "type": "put",
20687     "url": "/api/integrations/salesforce/configurations/{id}",
20688     "title": "Update an existing Salesforce Configuration",
20689     "examples": [
20690       {
20691         "title": "Example usage:",
20692         "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",
20693         "type": "json"
20694       }
20695     ],
20696     "name": "updateSalesforce_Configurations",
20697     "group": "Salesforce_Configurations",
20698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20699     "version": "0.0.0",
20700     "filename": "server/api/intSalesforceConfiguration/index.js",
20701     "groupTitle": "Salesforce_Configurations"
20702   },
20703   {
20704     "type": "post",
20705     "url": "/api/integrations/salesforce/fields",
20706     "title": "Creates a new Salesforce Field",
20707     "examples": [
20708       {
20709         "title": "Example usage:",
20710         "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",
20711         "type": "json"
20712       }
20713     ],
20714     "name": "CreateSalesforce_Fields",
20715     "group": "Salesforce_Fields",
20716     "parameter": {
20717       "fields": {
20718         "Body": [
20719           {
20720             "group": "Body",
20721             "type": "String",
20722             "allowedValues": [
20723               "\"string\"",
20724               "\"variable\"",
20725               "\"customVariable\"",
20726               "\"keyValue\"",
20727               "\"picklist\""
20728             ],
20729             "optional": true,
20730             "field": "type",
20731             "description": ""
20732           },
20733           {
20734             "group": "Body",
20735             "type": "String",
20736             "optional": true,
20737             "field": "content",
20738             "description": ""
20739           },
20740           {
20741             "group": "Body",
20742             "type": "String",
20743             "optional": true,
20744             "field": "key",
20745             "description": ""
20746           },
20747           {
20748             "group": "Body",
20749             "type": "String",
20750             "allowedValues": [
20751               "\"string\"",
20752               "\"variable\"",
20753               "\"customVariable\""
20754             ],
20755             "optional": true,
20756             "field": "keyType",
20757             "description": ""
20758           },
20759           {
20760             "group": "Body",
20761             "type": "String",
20762             "optional": true,
20763             "field": "keyContent",
20764             "description": ""
20765           },
20766           {
20767             "group": "Body",
20768             "type": "String",
20769             "optional": true,
20770             "field": "idField",
20771             "description": ""
20772           },
20773           {
20774             "group": "Body",
20775             "type": "String",
20776             "optional": true,
20777             "field": "variableName",
20778             "description": ""
20779           }
20780         ]
20781       }
20782     },
20783     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20784     "version": "0.0.0",
20785     "filename": "server/api/intSalesforceField/index.js",
20786     "groupTitle": "Salesforce_Fields"
20787   },
20788   {
20789     "type": "delete",
20790     "url": "/api/integrations/salesforce/fields/{id}",
20791     "title": "Deletes a Salesforce Field",
20792     "examples": [
20793       {
20794         "title": "Example usage:",
20795         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20796         "type": "json"
20797       }
20798     ],
20799     "name": "DeleteSalesforce_Fields",
20800     "group": "Salesforce_Fields",
20801     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20802     "version": "0.0.0",
20803     "filename": "server/api/intSalesforceField/index.js",
20804     "groupTitle": "Salesforce_Fields"
20805   },
20806   {
20807     "type": "get",
20808     "url": "/api/integrations/salesforce/fields",
20809     "title": "Gets a list of Salesforce Fields",
20810     "examples": [
20811       {
20812         "title": "Example usage:",
20813         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20814         "type": "json"
20815       }
20816     ],
20817     "name": "GetSalesforce_Fields",
20818     "group": "Salesforce_Fields",
20819     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20820     "version": "0.0.0",
20821     "filename": "server/api/intSalesforceField/index.js",
20822     "groupTitle": "Salesforce_Fields"
20823   },
20824   {
20825     "type": "get",
20826     "url": "/api/integrations/salesforce/fields/{id}",
20827     "title": "Gets a single Salesforce Field",
20828     "examples": [
20829       {
20830         "title": "Example usage:",
20831         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20832         "type": "json"
20833       }
20834     ],
20835     "name": "ShowSalesforce_Fields",
20836     "group": "Salesforce_Fields",
20837     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20838     "version": "0.0.0",
20839     "filename": "server/api/intSalesforceField/index.js",
20840     "groupTitle": "Salesforce_Fields"
20841   },
20842   {
20843     "type": "put",
20844     "url": "/api/integrations/salesforce/fields/{id}",
20845     "title": "Update an existing Salesforce Field",
20846     "examples": [
20847       {
20848         "title": "Example usage:",
20849         "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",
20850         "type": "json"
20851       }
20852     ],
20853     "name": "updateSalesforce_Fields",
20854     "group": "Salesforce_Fields",
20855     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20856     "version": "0.0.0",
20857     "filename": "server/api/intSalesforceField/index.js",
20858     "groupTitle": "Salesforce_Fields"
20859   },
20860   {
20861     "type": "post",
20862     "url": "/api/schedules",
20863     "title": "Creates a new Schedule",
20864     "examples": [
20865       {
20866         "title": "Example usage:",
20867         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20868         "type": "json"
20869       }
20870     ],
20871     "name": "CreateSchedules",
20872     "group": "Schedules",
20873     "parameter": {
20874       "fields": {
20875         "Body": [
20876           {
20877             "group": "Body",
20878             "type": "String",
20879             "optional": false,
20880             "field": "name",
20881             "description": ""
20882           },
20883           {
20884             "group": "Body",
20885             "type": "String",
20886             "optional": true,
20887             "field": "description",
20888             "description": ""
20889           },
20890           {
20891             "group": "Body",
20892             "type": "Boolean",
20893             "optional": false,
20894             "field": "active",
20895             "description": ""
20896           },
20897           {
20898             "group": "Body",
20899             "type": "String",
20900             "optional": false,
20901             "field": "cron",
20902             "description": ""
20903           },
20904           {
20905             "group": "Body",
20906             "type": "String",
20907             "optional": false,
20908             "field": "startAt",
20909             "description": ""
20910           },
20911           {
20912             "group": "Body",
20913             "type": "String",
20914             "optional": false,
20915             "field": "endAt",
20916             "description": ""
20917           },
20918           {
20919             "group": "Body",
20920             "type": "Integer",
20921             "optional": false,
20922             "field": "subtractNumber",
20923             "description": ""
20924           },
20925           {
20926             "group": "Body",
20927             "type": "String",
20928             "allowedValues": [
20929               "\"years\"",
20930               "\"quarters\"",
20931               "\"months\"",
20932               "\"weeks\"",
20933               "\"days\"",
20934               "\"hours\"",
20935               "\"minutes\""
20936             ],
20937             "optional": false,
20938             "field": "subtractUnit",
20939             "description": ""
20940           },
20941           {
20942             "group": "Body",
20943             "type": "String",
20944             "allowedValues": [
20945               "\"csv\"",
20946               "\"pdf\"",
20947               "\"xlsx\""
20948             ],
20949             "optional": false,
20950             "field": "output",
20951             "description": ""
20952           },
20953           {
20954             "group": "Body",
20955             "type": "String",
20956             "allowedValues": [
20957               "\"custom\"",
20958               "\"default\""
20959             ],
20960             "optional": false,
20961             "field": "type",
20962             "description": ""
20963           },
20964           {
20965             "group": "Body",
20966             "type": "Boolean",
20967             "optional": true,
20968             "field": "sendMail",
20969             "description": ""
20970           },
20971           {
20972             "group": "Body",
20973             "type": "String",
20974             "optional": true,
20975             "field": "email",
20976             "description": ""
20977           },
20978           {
20979             "group": "Body",
20980             "type": "Text",
20981             "optional": true,
20982             "field": "cc",
20983             "description": ""
20984           },
20985           {
20986             "group": "Body",
20987             "type": "Text",
20988             "optional": true,
20989             "field": "bcc",
20990             "description": ""
20991           },
20992           {
20993             "group": "Body",
20994             "type": "Boolean",
20995             "optional": true,
20996             "field": "sendIfEmpty",
20997             "description": ""
20998           }
20999         ]
21000       }
21001     },
21002     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21003     "version": "0.0.0",
21004     "filename": "server/api/schedule/index.js",
21005     "groupTitle": "Schedules"
21006   },
21007   {
21008     "type": "delete",
21009     "url": "/api/schedules/{id}",
21010     "title": "Deletes a Schedule",
21011     "examples": [
21012       {
21013         "title": "Example usage:",
21014         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21015         "type": "json"
21016       }
21017     ],
21018     "name": "DeleteSchedules",
21019     "group": "Schedules",
21020     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21021     "version": "0.0.0",
21022     "filename": "server/api/schedule/index.js",
21023     "groupTitle": "Schedules"
21024   },
21025   {
21026     "type": "get",
21027     "url": "/api/schedules",
21028     "title": "Gets a list of Schedules",
21029     "examples": [
21030       {
21031         "title": "Example usage:",
21032         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21033         "type": "json"
21034       }
21035     ],
21036     "name": "GetSchedules",
21037     "group": "Schedules",
21038     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21039     "version": "0.0.0",
21040     "filename": "server/api/schedule/index.js",
21041     "groupTitle": "Schedules"
21042   },
21043   {
21044     "type": "get",
21045     "url": "/api/schedules/{id}",
21046     "title": "Gets a single Schedule",
21047     "examples": [
21048       {
21049         "title": "Example usage:",
21050         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21051         "type": "json"
21052       }
21053     ],
21054     "name": "ShowSchedules",
21055     "group": "Schedules",
21056     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21057     "version": "0.0.0",
21058     "filename": "server/api/schedule/index.js",
21059     "groupTitle": "Schedules"
21060   },
21061   {
21062     "type": "get",
21063     "url": "/api/schedules/{id}/run",
21064     "title": "Run Scheduler",
21065     "examples": [
21066       {
21067         "title": "Example usage:",
21068         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21069         "type": "json"
21070       }
21071     ],
21072     "name": "run",
21073     "group": "Schedules",
21074     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21075     "version": "0.0.0",
21076     "filename": "server/api/schedule/index.js",
21077     "groupTitle": "Schedules"
21078   },
21079   {
21080     "type": "put",
21081     "url": "/api/schedules/{id}",
21082     "title": "Update an existing Schedule",
21083     "examples": [
21084       {
21085         "title": "Example usage:",
21086         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21087         "type": "json"
21088       }
21089     ],
21090     "name": "updateSchedules",
21091     "group": "Schedules",
21092     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21093     "version": "0.0.0",
21094     "filename": "server/api/schedule/index.js",
21095     "groupTitle": "Schedules"
21096   },
21097   {
21098     "type": "post",
21099     "url": "/api/screen/recordings",
21100     "title": "Creates a new Recording",
21101     "examples": [
21102       {
21103         "title": "Example usage:",
21104         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21105         "type": "json"
21106       }
21107     ],
21108     "name": "CreateRecordings",
21109     "group": "Screen_Recordings",
21110     "parameter": {
21111       "fields": {
21112         "Body": [
21113           {
21114             "group": "Body",
21115             "type": "Virtual",
21116             "optional": true,
21117             "field": "format",
21118             "description": ""
21119           },
21120           {
21121             "group": "Body",
21122             "type": "String",
21123             "optional": true,
21124             "field": "interactionid",
21125             "description": ""
21126           },
21127           {
21128             "group": "Body",
21129             "type": "String",
21130             "optional": true,
21131             "field": "channel",
21132             "description": ""
21133           },
21134           {
21135             "group": "Body",
21136             "type": "String",
21137             "optional": true,
21138             "field": "value",
21139             "description": ""
21140           },
21141           {
21142             "group": "Body",
21143             "type": "Integer",
21144             "optional": true,
21145             "field": "rating",
21146             "description": ""
21147           },
21148           {
21149             "group": "Body",
21150             "type": "Integer",
21151             "optional": true,
21152             "field": "duration",
21153             "description": ""
21154           },
21155           {
21156             "group": "Body",
21157             "type": "String",
21158             "optional": true,
21159             "field": "startedAt",
21160             "description": ""
21161           },
21162           {
21163             "group": "Body",
21164             "type": "String",
21165             "optional": true,
21166             "field": "closedAt",
21167             "description": ""
21168           },
21169           {
21170             "group": "Body",
21171             "type": "String",
21172             "optional": true,
21173             "field": "createdAt",
21174             "description": ""
21175           },
21176           {
21177             "group": "Body",
21178             "type": "String",
21179             "optional": true,
21180             "field": "updatedAt",
21181             "description": ""
21182           }
21183         ]
21184       }
21185     },
21186     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21187     "version": "0.0.0",
21188     "filename": "server/api/screenRecording/index.js",
21189     "groupTitle": "Screen_Recordings"
21190   },
21191   {
21192     "type": "get",
21193     "url": "/api/screen/recordings/describe",
21194     "title": "Gets table info about Recordings",
21195     "examples": [
21196       {
21197         "title": "Example usage:",
21198         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21199         "type": "json"
21200       }
21201     ],
21202     "name": "DescribeRecordings",
21203     "group": "Screen_Recordings",
21204     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21205     "version": "0.0.0",
21206     "filename": "server/api/screenRecording/index.js",
21207     "groupTitle": "Screen_Recordings"
21208   },
21209   {
21210     "type": "get",
21211     "url": "/api/screen/recordings",
21212     "title": "Gets a list of Recordings",
21213     "examples": [
21214       {
21215         "title": "Example usage:",
21216         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21217         "type": "json"
21218       }
21219     ],
21220     "name": "GetRecordings",
21221     "group": "Screen_Recordings",
21222     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21223     "version": "0.0.0",
21224     "filename": "server/api/screenRecording/index.js",
21225     "groupTitle": "Screen_Recordings"
21226   },
21227   {
21228     "type": "get",
21229     "url": "/api/screen/recordings/{id}",
21230     "title": "Gets a single Recording",
21231     "examples": [
21232       {
21233         "title": "Example usage:",
21234         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21235         "type": "json"
21236       }
21237     ],
21238     "name": "ShowRecordings",
21239     "group": "Screen_Recordings",
21240     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21241     "version": "0.0.0",
21242     "filename": "server/api/screenRecording/index.js",
21243     "groupTitle": "Screen_Recordings"
21244   },
21245   {
21246     "type": "delete",
21247     "url": "/api/screen/recordings/{id}",
21248     "title": "Delete screen recording",
21249     "examples": [
21250       {
21251         "title": "Example usage:",
21252         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21253         "type": "json"
21254       }
21255     ],
21256     "name": "destroy",
21257     "group": "Screen_Recordings",
21258     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21259     "version": "0.0.0",
21260     "filename": "server/api/screenRecording/index.js",
21261     "groupTitle": "Screen_Recordings"
21262   },
21263   {
21264     "type": "get",
21265     "url": "/api/screen/recordings/{id}/download",
21266     "title": "Download Recording",
21267     "examples": [
21268       {
21269         "title": "Example usage:",
21270         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21271         "type": "json"
21272       }
21273     ],
21274     "name": "download",
21275     "group": "Screen_Recordings",
21276     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21277     "version": "0.0.0",
21278     "filename": "server/api/screenRecording/index.js",
21279     "groupTitle": "Screen_Recordings"
21280   },
21281   {
21282     "type": "put",
21283     "url": "/api/screen/recordings/{id}",
21284     "title": "Update an existing Recording",
21285     "examples": [
21286       {
21287         "title": "Example usage:",
21288         "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",
21289         "type": "json"
21290       }
21291     ],
21292     "name": "updateRecordings",
21293     "group": "Screen_Recordings",
21294     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21295     "version": "0.0.0",
21296     "filename": "server/api/screenRecording/index.js",
21297     "groupTitle": "Screen_Recordings"
21298   },
21299   {
21300     "type": "post",
21301     "url": "/api/integrations/servicenow/accounts",
21302     "title": "Creates a new Servicenow Account",
21303     "examples": [
21304       {
21305         "title": "Example usage:",
21306         "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",
21307         "type": "json"
21308       }
21309     ],
21310     "name": "CreateServicenow_Accounts",
21311     "group": "Servicenow_Accounts",
21312     "parameter": {
21313       "fields": {
21314         "Body": [
21315           {
21316             "group": "Body",
21317             "type": "String",
21318             "optional": true,
21319             "field": "name",
21320             "description": ""
21321           },
21322           {
21323             "group": "Body",
21324             "type": "String",
21325             "optional": true,
21326             "field": "description",
21327             "description": ""
21328           },
21329           {
21330             "group": "Body",
21331             "type": "String",
21332             "optional": true,
21333             "field": "username",
21334             "description": ""
21335           },
21336           {
21337             "group": "Body",
21338             "type": "String",
21339             "optional": true,
21340             "field": "password",
21341             "description": ""
21342           },
21343           {
21344             "group": "Body",
21345             "type": "String",
21346             "optional": true,
21347             "field": "email",
21348             "description": ""
21349           },
21350           {
21351             "group": "Body",
21352             "type": "String",
21353             "optional": true,
21354             "field": "remoteUri",
21355             "description": ""
21356           },
21357           {
21358             "group": "Body",
21359             "type": "String",
21360             "optional": false,
21361             "field": "serverUrl",
21362             "description": ""
21363           }
21364         ]
21365       }
21366     },
21367     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21368     "version": "0.0.0",
21369     "filename": "server/api/intServicenowAccount/index.js",
21370     "groupTitle": "Servicenow_Accounts"
21371   },
21372   {
21373     "type": "delete",
21374     "url": "/api/integrations/servicenow/accounts/{id}",
21375     "title": "Deletes a Servicenow Account",
21376     "examples": [
21377       {
21378         "title": "Example usage:",
21379         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21380         "type": "json"
21381       }
21382     ],
21383     "name": "DeleteServicenow_Accounts",
21384     "group": "Servicenow_Accounts",
21385     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21386     "version": "0.0.0",
21387     "filename": "server/api/intServicenowAccount/index.js",
21388     "groupTitle": "Servicenow_Accounts"
21389   },
21390   {
21391     "type": "get",
21392     "url": "/api/integrations/servicenow/accounts",
21393     "title": "Gets a list of Servicenow Accounts",
21394     "examples": [
21395       {
21396         "title": "Example usage:",
21397         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21398         "type": "json"
21399       }
21400     ],
21401     "name": "GetServicenow_Accounts",
21402     "group": "Servicenow_Accounts",
21403     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21404     "version": "0.0.0",
21405     "filename": "server/api/intServicenowAccount/index.js",
21406     "groupTitle": "Servicenow_Accounts"
21407   },
21408   {
21409     "type": "get",
21410     "url": "/api/integrations/servicenow/accounts/{id}",
21411     "title": "Gets a single Servicenow Account",
21412     "examples": [
21413       {
21414         "title": "Example usage:",
21415         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21416         "type": "json"
21417       }
21418     ],
21419     "name": "ShowServicenow_Accounts",
21420     "group": "Servicenow_Accounts",
21421     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21422     "version": "0.0.0",
21423     "filename": "server/api/intServicenowAccount/index.js",
21424     "groupTitle": "Servicenow_Accounts"
21425   },
21426   {
21427     "type": "post",
21428     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21429     "title": "Creates new configuration",
21430     "examples": [
21431       {
21432         "title": "Example usage:",
21433         "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",
21434         "type": "json"
21435       }
21436     ],
21437     "name": "addConfiguration",
21438     "group": "Servicenow_Accounts",
21439     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21440     "version": "0.0.0",
21441     "filename": "server/api/intServicenowAccount/index.js",
21442     "groupTitle": "Servicenow_Accounts"
21443   },
21444   {
21445     "type": "get",
21446     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21447     "title": "Gets account configurations",
21448     "examples": [
21449       {
21450         "title": "Example usage:",
21451         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21452         "type": "json"
21453       }
21454     ],
21455     "name": "getConfigurations",
21456     "group": "Servicenow_Accounts",
21457     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21458     "version": "0.0.0",
21459     "filename": "server/api/intServicenowAccount/index.js",
21460     "groupTitle": "Servicenow_Accounts"
21461   },
21462   {
21463     "type": "get",
21464     "url": "/api/integrations/servicenow/accounts/{id}/fields",
21465     "title": "Gets account fields",
21466     "examples": [
21467       {
21468         "title": "Example usage:",
21469         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21470         "type": "json"
21471       }
21472     ],
21473     "name": "getFields",
21474     "group": "Servicenow_Accounts",
21475     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21476     "version": "0.0.0",
21477     "filename": "server/api/intServicenowAccount/index.js",
21478     "groupTitle": "Servicenow_Accounts"
21479   },
21480   {
21481     "type": "put",
21482     "url": "/api/integrations/servicenow/accounts/{id}",
21483     "title": "Update an existing Servicenow Account",
21484     "examples": [
21485       {
21486         "title": "Example usage:",
21487         "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",
21488         "type": "json"
21489       }
21490     ],
21491     "name": "updateServicenow_Accounts",
21492     "group": "Servicenow_Accounts",
21493     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21494     "version": "0.0.0",
21495     "filename": "server/api/intServicenowAccount/index.js",
21496     "groupTitle": "Servicenow_Accounts"
21497   },
21498   {
21499     "type": "post",
21500     "url": "/api/integrations/servicenow/configurations",
21501     "title": "Creates a new Servicenow Configuration",
21502     "examples": [
21503       {
21504         "title": "Example usage:",
21505         "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",
21506         "type": "json"
21507       }
21508     ],
21509     "name": "CreateServicenow_Configurations",
21510     "group": "Servicenow_Configurations",
21511     "parameter": {
21512       "fields": {
21513         "Body": [
21514           {
21515             "group": "Body",
21516             "type": "String",
21517             "optional": true,
21518             "field": "name",
21519             "description": ""
21520           },
21521           {
21522             "group": "Body",
21523             "type": "String",
21524             "optional": true,
21525             "field": "description",
21526             "description": ""
21527           }
21528         ]
21529       }
21530     },
21531     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21532     "version": "0.0.0",
21533     "filename": "server/api/intServicenowConfiguration/index.js",
21534     "groupTitle": "Servicenow_Configurations"
21535   },
21536   {
21537     "type": "delete",
21538     "url": "/api/integrations/servicenow/configurations/{id}",
21539     "title": "Deletes a Servicenow Configuration",
21540     "examples": [
21541       {
21542         "title": "Example usage:",
21543         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21544         "type": "json"
21545       }
21546     ],
21547     "name": "DeleteServicenow_Configurations",
21548     "group": "Servicenow_Configurations",
21549     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/intServicenowConfiguration/index.js",
21552     "groupTitle": "Servicenow_Configurations"
21553   },
21554   {
21555     "type": "get",
21556     "url": "/api/integrations/servicenow/configurations",
21557     "title": "Gets a list of Servicenow Configurations",
21558     "examples": [
21559       {
21560         "title": "Example usage:",
21561         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21562         "type": "json"
21563       }
21564     ],
21565     "name": "GetServicenow_Configurations",
21566     "group": "Servicenow_Configurations",
21567     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21568     "version": "0.0.0",
21569     "filename": "server/api/intServicenowConfiguration/index.js",
21570     "groupTitle": "Servicenow_Configurations"
21571   },
21572   {
21573     "type": "get",
21574     "url": "/api/integrations/servicenow/configurations/{id}",
21575     "title": "Gets a single Servicenow Configuration",
21576     "examples": [
21577       {
21578         "title": "Example usage:",
21579         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21580         "type": "json"
21581       }
21582     ],
21583     "name": "ShowServicenow_Configurations",
21584     "group": "Servicenow_Configurations",
21585     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21586     "version": "0.0.0",
21587     "filename": "server/api/intServicenowConfiguration/index.js",
21588     "groupTitle": "Servicenow_Configurations"
21589   },
21590   {
21591     "type": "get",
21592     "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21593     "title": "Gets configurations descriptions",
21594     "examples": [
21595       {
21596         "title": "Example usage:",
21597         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21598         "type": "json"
21599       }
21600     ],
21601     "name": "getDescriptions",
21602     "group": "Servicenow_Configurations",
21603     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21604     "version": "0.0.0",
21605     "filename": "server/api/intServicenowConfiguration/index.js",
21606     "groupTitle": "Servicenow_Configurations"
21607   },
21608   {
21609     "type": "get",
21610     "url": "/api/integrations/servicenow/configurations/{id}/fields",
21611     "title": "Gets configurations fields",
21612     "examples": [
21613       {
21614         "title": "Example usage:",
21615         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21616         "type": "json"
21617       }
21618     ],
21619     "name": "getFields",
21620     "group": "Servicenow_Configurations",
21621     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21622     "version": "0.0.0",
21623     "filename": "server/api/intServicenowConfiguration/index.js",
21624     "groupTitle": "Servicenow_Configurations"
21625   },
21626   {
21627     "type": "get",
21628     "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21629     "title": "Gets configurations subjects",
21630     "examples": [
21631       {
21632         "title": "Example usage:",
21633         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21634         "type": "json"
21635       }
21636     ],
21637     "name": "getSubjects",
21638     "group": "Servicenow_Configurations",
21639     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21640     "version": "0.0.0",
21641     "filename": "server/api/intServicenowConfiguration/index.js",
21642     "groupTitle": "Servicenow_Configurations"
21643   },
21644   {
21645     "type": "put",
21646     "url": "/api/integrations/servicenow/configurations/{id}",
21647     "title": "Update an existing Servicenow Configuration",
21648     "examples": [
21649       {
21650         "title": "Example usage:",
21651         "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",
21652         "type": "json"
21653       }
21654     ],
21655     "name": "updateServicenow_Configurations",
21656     "group": "Servicenow_Configurations",
21657     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21658     "version": "0.0.0",
21659     "filename": "server/api/intServicenowConfiguration/index.js",
21660     "groupTitle": "Servicenow_Configurations"
21661   },
21662   {
21663     "type": "post",
21664     "url": "/api/integrations/servicenow/fields",
21665     "title": "Creates a new Servicenow Field",
21666     "examples": [
21667       {
21668         "title": "Example usage:",
21669         "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",
21670         "type": "json"
21671       }
21672     ],
21673     "name": "CreateServicenow_Fields",
21674     "group": "Servicenow_Fields",
21675     "parameter": {
21676       "fields": {
21677         "Body": [
21678           {
21679             "group": "Body",
21680             "type": "String",
21681             "allowedValues": [
21682               "\"string\"",
21683               "\"variable\"",
21684               "\"customVariable\"",
21685               "\"keyValue\"",
21686               "\"picklist\""
21687             ],
21688             "optional": true,
21689             "field": "type",
21690             "description": ""
21691           },
21692           {
21693             "group": "Body",
21694             "type": "String",
21695             "optional": true,
21696             "field": "content",
21697             "description": ""
21698           },
21699           {
21700             "group": "Body",
21701             "type": "String",
21702             "optional": true,
21703             "field": "key",
21704             "description": ""
21705           },
21706           {
21707             "group": "Body",
21708             "type": "String",
21709             "allowedValues": [
21710               "\"string\"",
21711               "\"variable\"",
21712               "\"customVariable\""
21713             ],
21714             "optional": true,
21715             "field": "keyType",
21716             "description": ""
21717           },
21718           {
21719             "group": "Body",
21720             "type": "String",
21721             "optional": true,
21722             "field": "keyContent",
21723             "description": ""
21724           },
21725           {
21726             "group": "Body",
21727             "type": "String",
21728             "optional": true,
21729             "field": "idField",
21730             "description": ""
21731           },
21732           {
21733             "group": "Body",
21734             "type": "String",
21735             "optional": true,
21736             "field": "nameField",
21737             "description": ""
21738           },
21739           {
21740             "group": "Body",
21741             "type": "Boolean",
21742             "optional": true,
21743             "field": "customField",
21744             "description": ""
21745           },
21746           {
21747             "group": "Body",
21748             "type": "String",
21749             "optional": true,
21750             "field": "variableName",
21751             "description": ""
21752           }
21753         ]
21754       }
21755     },
21756     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21757     "version": "0.0.0",
21758     "filename": "server/api/intServicenowField/index.js",
21759     "groupTitle": "Servicenow_Fields"
21760   },
21761   {
21762     "type": "delete",
21763     "url": "/api/integrations/servicenow/fields/{id}",
21764     "title": "Deletes a Servicenow Field",
21765     "examples": [
21766       {
21767         "title": "Example usage:",
21768         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21769         "type": "json"
21770       }
21771     ],
21772     "name": "DeleteServicenow_Fields",
21773     "group": "Servicenow_Fields",
21774     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21775     "version": "0.0.0",
21776     "filename": "server/api/intServicenowField/index.js",
21777     "groupTitle": "Servicenow_Fields"
21778   },
21779   {
21780     "type": "get",
21781     "url": "/api/integrations/servicenow/fields",
21782     "title": "Gets a list of Servicenow Fields",
21783     "examples": [
21784       {
21785         "title": "Example usage:",
21786         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21787         "type": "json"
21788       }
21789     ],
21790     "name": "GetServicenow_Fields",
21791     "group": "Servicenow_Fields",
21792     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21793     "version": "0.0.0",
21794     "filename": "server/api/intServicenowField/index.js",
21795     "groupTitle": "Servicenow_Fields"
21796   },
21797   {
21798     "type": "get",
21799     "url": "/api/integrations/servicenow/fields/{id}",
21800     "title": "Gets a single Servicenow Field",
21801     "examples": [
21802       {
21803         "title": "Example usage:",
21804         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21805         "type": "json"
21806       }
21807     ],
21808     "name": "ShowServicenow_Fields",
21809     "group": "Servicenow_Fields",
21810     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21811     "version": "0.0.0",
21812     "filename": "server/api/intServicenowField/index.js",
21813     "groupTitle": "Servicenow_Fields"
21814   },
21815   {
21816     "type": "put",
21817     "url": "/api/integrations/servicenow/fields/{id}",
21818     "title": "Update an existing Servicenow Field",
21819     "examples": [
21820       {
21821         "title": "Example usage:",
21822         "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",
21823         "type": "json"
21824       }
21825     ],
21826     "name": "updateServicenow_Fields",
21827     "group": "Servicenow_Fields",
21828     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21829     "version": "0.0.0",
21830     "filename": "server/api/intServicenowField/index.js",
21831     "groupTitle": "Servicenow_Fields"
21832   },
21833   {
21834     "type": "get",
21835     "url": "/api/settings",
21836     "title": "Gets a list of Settings",
21837     "examples": [
21838       {
21839         "title": "Example usage:",
21840         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21841         "type": "json"
21842       }
21843     ],
21844     "name": "GetSettings",
21845     "group": "Settings",
21846     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21847     "version": "0.0.0",
21848     "filename": "server/api/setting/index.js",
21849     "groupTitle": "Settings"
21850   },
21851   {
21852     "type": "get",
21853     "url": "/api/settings/{id}",
21854     "title": "Gets a single Setting",
21855     "examples": [
21856       {
21857         "title": "Example usage:",
21858         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21859         "type": "json"
21860       }
21861     ],
21862     "name": "ShowSettings",
21863     "group": "Settings",
21864     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21865     "version": "0.0.0",
21866     "filename": "server/api/setting/index.js",
21867     "groupTitle": "Settings"
21868   },
21869   {
21870     "type": "post",
21871     "url": "/api/settings/{id}/favicon",
21872     "title": "Add Favicon",
21873     "examples": [
21874       {
21875         "title": "Example usage:",
21876         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21877         "type": "json"
21878       }
21879     ],
21880     "name": "addFavicon",
21881     "group": "Settings",
21882     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21883     "version": "0.0.0",
21884     "filename": "server/api/setting/index.js",
21885     "groupTitle": "Settings"
21886   },
21887   {
21888     "type": "post",
21889     "url": "/api/settings/{id}/logo",
21890     "title": "Add logo",
21891     "examples": [
21892       {
21893         "title": "Example usage:",
21894         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21895         "type": "json"
21896       }
21897     ],
21898     "name": "addLogo",
21899     "group": "Settings",
21900     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21901     "version": "0.0.0",
21902     "filename": "server/api/setting/index.js",
21903     "groupTitle": "Settings"
21904   },
21905   {
21906     "type": "post",
21907     "url": "/api/settings/{id}/logo_login",
21908     "title": "Add logo login",
21909     "examples": [
21910       {
21911         "title": "Example usage:",
21912         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21913         "type": "json"
21914       }
21915     ],
21916     "name": "addLogoLogin",
21917     "group": "Settings",
21918     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21919     "version": "0.0.0",
21920     "filename": "server/api/setting/index.js",
21921     "groupTitle": "Settings"
21922   },
21923   {
21924     "type": "post",
21925     "url": "/api/settings/{id}/preferred",
21926     "title": "Add Preferred",
21927     "examples": [
21928       {
21929         "title": "Example usage:",
21930         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21931         "type": "json"
21932       }
21933     ],
21934     "name": "addPreferred",
21935     "group": "Settings",
21936     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21937     "version": "0.0.0",
21938     "filename": "server/api/setting/index.js",
21939     "groupTitle": "Settings"
21940   },
21941   {
21942     "type": "get",
21943     "url": "/api/settings/now",
21944     "title": "Get Server Current Date",
21945     "examples": [
21946       {
21947         "title": "Example usage:",
21948         "content": "curl https://{domain}/api/settings/now -v -X GET",
21949         "type": "json"
21950       }
21951     ],
21952     "name": "getDate",
21953     "group": "Settings",
21954     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21955     "version": "0.0.0",
21956     "filename": "server/api/setting/index.js",
21957     "groupTitle": "Settings"
21958   },
21959   {
21960     "type": "get",
21961     "url": "/api/settings/{id}/favicon",
21962     "title": "Get Favicon",
21963     "examples": [
21964       {
21965         "title": "Example usage:",
21966         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21967         "type": "json"
21968       }
21969     ],
21970     "name": "getFavicon",
21971     "group": "Settings",
21972     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21973     "version": "0.0.0",
21974     "filename": "server/api/setting/index.js",
21975     "groupTitle": "Settings"
21976   },
21977   {
21978     "type": "get",
21979     "url": "/api/settings/{id}/gdpr",
21980     "title": "Get gdpr settings",
21981     "examples": [
21982       {
21983         "title": "Example usage:",
21984         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
21985         "type": "json"
21986       }
21987     ],
21988     "name": "getGdpr",
21989     "group": "Settings",
21990     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21991     "version": "0.0.0",
21992     "filename": "server/api/setting/index.js",
21993     "groupTitle": "Settings"
21994   },
21995   {
21996     "type": "get",
21997     "url": "/api/settings/{id}/logo",
21998     "title": "Get logo",
21999     "examples": [
22000       {
22001         "title": "Example usage:",
22002         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22003         "type": "json"
22004       }
22005     ],
22006     "name": "getLogo",
22007     "group": "Settings",
22008     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22009     "version": "0.0.0",
22010     "filename": "server/api/setting/index.js",
22011     "groupTitle": "Settings"
22012   },
22013   {
22014     "type": "get",
22015     "url": "/api/settings/{id}/logo_login",
22016     "title": "Get logo login",
22017     "examples": [
22018       {
22019         "title": "Example usage:",
22020         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22021         "type": "json"
22022       }
22023     ],
22024     "name": "getLogoLogin",
22025     "group": "Settings",
22026     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22027     "version": "0.0.0",
22028     "filename": "server/api/setting/index.js",
22029     "groupTitle": "Settings"
22030   },
22031   {
22032     "type": "get",
22033     "url": "/api/settings/{id}/preferred",
22034     "title": "Get Preferred",
22035     "examples": [
22036       {
22037         "title": "Example usage:",
22038         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22039         "type": "json"
22040       }
22041     ],
22042     "name": "getPreferred",
22043     "group": "Settings",
22044     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22045     "version": "0.0.0",
22046     "filename": "server/api/setting/index.js",
22047     "groupTitle": "Settings"
22048   },
22049   {
22050     "type": "put",
22051     "url": "/api/settings/{id}",
22052     "title": "Update an existing Setting",
22053     "examples": [
22054       {
22055         "title": "Example usage:",
22056         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22057         "type": "json"
22058       }
22059     ],
22060     "name": "updateSettings",
22061     "group": "Settings",
22062     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22063     "version": "0.0.0",
22064     "filename": "server/api/setting/index.js",
22065     "groupTitle": "Settings"
22066   },
22067   {
22068     "type": "post",
22069     "url": "/api/sms/accounts/{id}/users",
22070     "title": "Add agents to a sms account",
22071     "examples": [
22072       {
22073         "title": "Example usage:",
22074         "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",
22075         "type": "json"
22076       }
22077     ],
22078     "name": "AddAgents",
22079     "group": "Sms_Accounts",
22080     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22081     "version": "0.0.0",
22082     "filename": "server/api/smsAccount/index.js",
22083     "groupTitle": "Sms_Accounts"
22084   },
22085   {
22086     "type": "post",
22087     "url": "/api/sms/accounts",
22088     "title": "Creates a new Account",
22089     "examples": [
22090       {
22091         "title": "Example usage:",
22092         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22093         "type": "json"
22094       }
22095     ],
22096     "name": "CreateAccounts",
22097     "group": "Sms_Accounts",
22098     "parameter": {
22099       "fields": {
22100         "Body": [
22101           {
22102             "group": "Body",
22103             "type": "String",
22104             "optional": false,
22105             "field": "name",
22106             "description": ""
22107           },
22108           {
22109             "group": "Body",
22110             "type": "String",
22111             "optional": false,
22112             "field": "key",
22113             "description": ""
22114           },
22115           {
22116             "group": "Body",
22117             "type": "String",
22118             "optional": false,
22119             "field": "remote",
22120             "description": ""
22121           },
22122           {
22123             "group": "Body",
22124             "type": "String",
22125             "optional": true,
22126             "field": "token",
22127             "description": ""
22128           },
22129           {
22130             "group": "Body",
22131             "type": "String",
22132             "optional": true,
22133             "field": "phone",
22134             "description": ""
22135           },
22136           {
22137             "group": "Body",
22138             "type": "String",
22139             "allowedValues": [
22140               "\"twilio\"",
22141               "\"skebby\"",
22142               "\"connectel\"",
22143               "\"clicksend\"",
22144               "\"plivo\"",
22145               "\"clickatell\"",
22146               "\"bandwidth\"",
22147               "\"csc\"",
22148               "\"infobip\"",
22149               "\"intelepeer\""
22150             ],
22151             "optional": true,
22152             "field": "type",
22153             "description": ""
22154           },
22155           {
22156             "group": "Body",
22157             "type": "String",
22158             "optional": true,
22159             "field": "accountSid",
22160             "description": ""
22161           },
22162           {
22163             "group": "Body",
22164             "type": "String",
22165             "optional": true,
22166             "field": "authId",
22167             "description": ""
22168           },
22169           {
22170             "group": "Body",
22171             "type": "String",
22172             "optional": true,
22173             "field": "authToken",
22174             "description": ""
22175           },
22176           {
22177             "group": "Body",
22178             "type": "String",
22179             "allowedValues": [
22180               "\"SI\"",
22181               "\"TI\"",
22182               "\"GP\""
22183             ],
22184             "optional": true,
22185             "field": "smsMethod",
22186             "description": ""
22187           },
22188           {
22189             "group": "Body",
22190             "type": "String",
22191             "optional": true,
22192             "field": "username",
22193             "description": ""
22194           },
22195           {
22196             "group": "Body",
22197             "type": "String",
22198             "optional": true,
22199             "field": "password",
22200             "description": ""
22201           },
22202           {
22203             "group": "Body",
22204             "type": "String",
22205             "optional": true,
22206             "field": "apiKey",
22207             "description": ""
22208           },
22209           {
22210             "group": "Body",
22211             "type": "String",
22212             "optional": true,
22213             "field": "applicationId",
22214             "description": ""
22215           },
22216           {
22217             "group": "Body",
22218             "type": "String",
22219             "optional": true,
22220             "field": "accountId",
22221             "description": ""
22222           },
22223           {
22224             "group": "Body",
22225             "type": "String",
22226             "optional": true,
22227             "field": "senderString",
22228             "description": ""
22229           },
22230           {
22231             "group": "Body",
22232             "type": "Boolean",
22233             "optional": true,
22234             "field": "deliveryReport",
22235             "description": ""
22236           },
22237           {
22238             "group": "Body",
22239             "type": "String",
22240             "optional": true,
22241             "field": "description",
22242             "description": ""
22243           },
22244           {
22245             "group": "Body",
22246             "type": "Text",
22247             "optional": true,
22248             "field": "notificationTemplate",
22249             "description": ""
22250           },
22251           {
22252             "group": "Body",
22253             "type": "Boolean",
22254             "optional": true,
22255             "field": "notificationSound",
22256             "description": ""
22257           },
22258           {
22259             "group": "Body",
22260             "type": "Boolean",
22261             "optional": true,
22262             "field": "notificationShake",
22263             "description": ""
22264           },
22265           {
22266             "group": "Body",
22267             "type": "Integer",
22268             "optional": true,
22269             "field": "waitForTheAssignedAgent",
22270             "description": ""
22271           },
22272           {
22273             "group": "Body",
22274             "type": "Boolean",
22275             "optional": true,
22276             "field": "queueTransfer",
22277             "description": ""
22278           },
22279           {
22280             "group": "Body",
22281             "type": "Integer",
22282             "optional": true,
22283             "field": "queueTransferTimeout",
22284             "description": ""
22285           },
22286           {
22287             "group": "Body",
22288             "type": "Boolean",
22289             "optional": true,
22290             "field": "agentTransfer",
22291             "description": ""
22292           },
22293           {
22294             "group": "Body",
22295             "type": "Integer",
22296             "optional": true,
22297             "field": "agentTransferTimeout",
22298             "description": ""
22299           },
22300           {
22301             "group": "Body",
22302             "type": "String",
22303             "optional": true,
22304             "field": "baseUrl",
22305             "description": ""
22306           },
22307           {
22308             "group": "Body",
22309             "type": "Integer",
22310             "optional": true,
22311             "field": "mandatoryDispositionPauseId",
22312             "description": "<p>Status to put when mandatory disposition is enabled</p>"
22313           },
22314           {
22315             "group": "Body",
22316             "type": "Boolean",
22317             "optional": true,
22318             "field": "mandatoryDisposition",
22319             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22320           }
22321         ]
22322       }
22323     },
22324     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22325     "version": "0.0.0",
22326     "filename": "server/api/smsAccount/index.js",
22327     "groupTitle": "Sms_Accounts"
22328   },
22329   {
22330     "type": "delete",
22331     "url": "/api/sms/accounts/{id}",
22332     "title": "Deletes a Account",
22333     "examples": [
22334       {
22335         "title": "Example usage:",
22336         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22337         "type": "json"
22338       }
22339     ],
22340     "name": "DeleteAccounts",
22341     "group": "Sms_Accounts",
22342     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22343     "version": "0.0.0",
22344     "filename": "server/api/smsAccount/index.js",
22345     "groupTitle": "Sms_Accounts"
22346   },
22347   {
22348     "type": "get",
22349     "url": "/api/sms/accounts/describe",
22350     "title": "Gets table info about Accounts",
22351     "examples": [
22352       {
22353         "title": "Example usage:",
22354         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22355         "type": "json"
22356       }
22357     ],
22358     "name": "DescribeAccounts",
22359     "group": "Sms_Accounts",
22360     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22361     "version": "0.0.0",
22362     "filename": "server/api/smsAccount/index.js",
22363     "groupTitle": "Sms_Accounts"
22364   },
22365   {
22366     "type": "get",
22367     "url": "/api/sms/accounts",
22368     "title": "Gets a list of Accounts",
22369     "examples": [
22370       {
22371         "title": "Example usage:",
22372         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22373         "type": "json"
22374       }
22375     ],
22376     "name": "GetAccounts",
22377     "group": "Sms_Accounts",
22378     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22379     "version": "0.0.0",
22380     "filename": "server/api/smsAccount/index.js",
22381     "groupTitle": "Sms_Accounts"
22382   },
22383   {
22384     "type": "get",
22385     "url": "/api/sms/accounts/{id}/users",
22386     "title": "Gets agents from sms account",
22387     "examples": [
22388       {
22389         "title": "Example usage:",
22390         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22391         "type": "json"
22392       }
22393     ],
22394     "name": "GetAgents",
22395     "group": "Sms_Accounts",
22396     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22397     "version": "0.0.0",
22398     "filename": "server/api/smsAccount/index.js",
22399     "groupTitle": "Sms_Accounts"
22400   },
22401   {
22402     "type": "delete",
22403     "url": "/api/sms/accounts/{id}/users",
22404     "title": "Removes agents from a sms account",
22405     "examples": [
22406       {
22407         "title": "Example usage:",
22408         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22409         "type": "json"
22410       }
22411     ],
22412     "name": "RemoveAgents",
22413     "group": "Sms_Accounts",
22414     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22415     "version": "0.0.0",
22416     "filename": "server/api/smsAccount/index.js",
22417     "groupTitle": "Sms_Accounts"
22418   },
22419   {
22420     "type": "delete",
22421     "url": "/api/sms/accounts/{id}/canned_answers",
22422     "title": "Removes canned answers from account",
22423     "examples": [
22424       {
22425         "title": "Example usage:",
22426         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22427         "type": "json"
22428       }
22429     ],
22430     "name": "RemoveAnswers",
22431     "group": "Sms_Accounts",
22432     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22433     "version": "0.0.0",
22434     "filename": "server/api/smsAccount/index.js",
22435     "groupTitle": "Sms_Accounts"
22436   },
22437   {
22438     "type": "delete",
22439     "url": "/api/sms/accounts/{id}/dispositions",
22440     "title": "Removes dispositions from account",
22441     "examples": [
22442       {
22443         "title": "Example usage:",
22444         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22445         "type": "json"
22446       }
22447     ],
22448     "name": "RemoveDispositions",
22449     "group": "Sms_Accounts",
22450     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22451     "version": "0.0.0",
22452     "filename": "server/api/smsAccount/index.js",
22453     "groupTitle": "Sms_Accounts"
22454   },
22455   {
22456     "type": "get",
22457     "url": "/api/sms/accounts/{id}",
22458     "title": "Gets a single Account",
22459     "examples": [
22460       {
22461         "title": "Example usage:",
22462         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22463         "type": "json"
22464       }
22465     ],
22466     "name": "ShowAccounts",
22467     "group": "Sms_Accounts",
22468     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22469     "version": "0.0.0",
22470     "filename": "server/api/smsAccount/index.js",
22471     "groupTitle": "Sms_Accounts"
22472   },
22473   {
22474     "type": "put",
22475     "url": "/api/sms/messages/{id}/accept",
22476     "title": "Accepts message",
22477     "examples": [
22478       {
22479         "title": "Example usage:",
22480         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22481         "type": "json"
22482       }
22483     ],
22484     "name": "acceptMessage",
22485     "group": "Sms_Accounts",
22486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22487     "version": "0.0.0",
22488     "filename": "server/api/smsMessage/index.js",
22489     "groupTitle": "Sms_Accounts"
22490   },
22491   {
22492     "type": "post",
22493     "url": "/api/sms/accounts/{id}/canned_answers",
22494     "title": "Creates new canned answer",
22495     "examples": [
22496       {
22497         "title": "Example usage:",
22498         "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",
22499         "type": "json"
22500       }
22501     ],
22502     "name": "addAnswer",
22503     "group": "Sms_Accounts",
22504     "parameter": {
22505       "fields": {
22506         "Body": [
22507           {
22508             "group": "Body",
22509             "type": "String",
22510             "optional": false,
22511             "field": "key",
22512             "description": ""
22513           },
22514           {
22515             "group": "Body",
22516             "type": "Text",
22517             "optional": false,
22518             "field": "value",
22519             "description": ""
22520           },
22521           {
22522             "group": "Body",
22523             "type": "String",
22524             "optional": true,
22525             "field": "description",
22526             "description": ""
22527           },
22528           {
22529             "group": "Body",
22530             "type": "Virtual",
22531             "optional": true,
22532             "field": "name",
22533             "description": ""
22534           }
22535         ]
22536       }
22537     },
22538     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22539     "version": "0.0.0",
22540     "filename": "server/api/smsAccount/index.js",
22541     "groupTitle": "Sms_Accounts"
22542   },
22543   {
22544     "type": "post",
22545     "url": "/api/sms/accounts/{id}/applications",
22546     "title": "Creates new applications",
22547     "examples": [
22548       {
22549         "title": "Example usage:",
22550         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22551         "type": "json"
22552       }
22553     ],
22554     "name": "addApplications",
22555     "group": "Sms_Accounts",
22556     "parameter": {
22557       "fields": {
22558         "Body": [
22559           {
22560             "group": "Body",
22561             "type": "Integer",
22562             "optional": false,
22563             "field": "priority",
22564             "description": ""
22565           },
22566           {
22567             "group": "Body",
22568             "type": "String",
22569             "optional": false,
22570             "field": "app",
22571             "description": ""
22572           },
22573           {
22574             "group": "Body",
22575             "type": "Text",
22576             "optional": true,
22577             "field": "appdata",
22578             "description": ""
22579           },
22580           {
22581             "group": "Body",
22582             "type": "String",
22583             "optional": true,
22584             "field": "description",
22585             "description": ""
22586           },
22587           {
22588             "group": "Body",
22589             "type": "String",
22590             "optional": true,
22591             "field": "interval",
22592             "description": ""
22593           }
22594         ]
22595       }
22596     },
22597     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22598     "version": "0.0.0",
22599     "filename": "server/api/smsAccount/index.js",
22600     "groupTitle": "Sms_Accounts"
22601   },
22602   {
22603     "type": "post",
22604     "url": "/api/sms/accounts/{id}/dispositions",
22605     "title": "Creates new disposition",
22606     "examples": [
22607       {
22608         "title": "Example usage:",
22609         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22610         "type": "json"
22611       }
22612     ],
22613     "name": "addDisposition",
22614     "group": "Sms_Accounts",
22615     "parameter": {
22616       "fields": {
22617         "Body": [
22618           {
22619             "group": "Body",
22620             "type": "String",
22621             "optional": false,
22622             "field": "name",
22623             "description": ""
22624           },
22625           {
22626             "group": "Body",
22627             "type": "String",
22628             "allowedValues": [
22629               "\"first\"",
22630               "\"second\"",
22631               "\"third\""
22632             ],
22633             "optional": false,
22634             "field": "level",
22635             "description": ""
22636           },
22637           {
22638             "group": "Body",
22639             "type": "String",
22640             "optional": true,
22641             "field": "description",
22642             "description": ""
22643           }
22644         ]
22645       }
22646     },
22647     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22648     "version": "0.0.0",
22649     "filename": "server/api/smsAccount/index.js",
22650     "groupTitle": "Sms_Accounts"
22651   },
22652   {
22653     "type": "get",
22654     "url": "/api/sms/accounts/{id}/canned_answers",
22655     "title": "Gets account canned answers",
22656     "examples": [
22657       {
22658         "title": "Example usage:",
22659         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22660         "type": "json"
22661       }
22662     ],
22663     "name": "getAnswers",
22664     "group": "Sms_Accounts",
22665     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22666     "version": "0.0.0",
22667     "filename": "server/api/smsAccount/index.js",
22668     "groupTitle": "Sms_Accounts"
22669   },
22670   {
22671     "type": "get",
22672     "url": "/api/sms/accounts/{id}/applications",
22673     "title": "Gets account applications",
22674     "examples": [
22675       {
22676         "title": "Example usage:",
22677         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22678         "type": "json"
22679       }
22680     ],
22681     "name": "getApplications",
22682     "group": "Sms_Accounts",
22683     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22684     "version": "0.0.0",
22685     "filename": "server/api/smsAccount/index.js",
22686     "groupTitle": "Sms_Accounts"
22687   },
22688   {
22689     "type": "get",
22690     "url": "/api/sms/accounts/{id}/dispositions",
22691     "title": "Gets account dispositions",
22692     "examples": [
22693       {
22694         "title": "Example usage:",
22695         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22696         "type": "json"
22697       }
22698     ],
22699     "name": "getDispositions",
22700     "group": "Sms_Accounts",
22701     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22702     "version": "0.0.0",
22703     "filename": "server/api/smsAccount/index.js",
22704     "groupTitle": "Sms_Accounts"
22705   },
22706   {
22707     "type": "get",
22708     "url": "/api/sms/accounts/{id}/interactions",
22709     "title": "Gets Sms Account interactions",
22710     "examples": [
22711       {
22712         "title": "Example usage:",
22713         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22714         "type": "json"
22715       }
22716     ],
22717     "name": "getInteractions",
22718     "group": "Sms_Accounts",
22719     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22720     "version": "0.0.0",
22721     "filename": "server/api/smsAccount/index.js",
22722     "groupTitle": "Sms_Accounts"
22723   },
22724   {
22725     "type": "post",
22726     "url": "/api/sms/accounts/{id}/notify",
22727     "title": "Notify new message",
22728     "examples": [
22729       {
22730         "title": "Example usage:",
22731         "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",
22732         "type": "json"
22733       }
22734     ],
22735     "name": "notify",
22736     "group": "Sms_Accounts",
22737     "description": "<p>Motion 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>",
22738     "version": "0.0.0",
22739     "filename": "server/api/smsAccount/index.js",
22740     "groupTitle": "Sms_Accounts"
22741   },
22742   {
22743     "type": "put",
22744     "url": "/api/sms/messages/{id}/reject",
22745     "title": "Rejects message",
22746     "examples": [
22747       {
22748         "title": "Example usage:",
22749         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22750         "type": "json"
22751       }
22752     ],
22753     "name": "rejectMessage",
22754     "group": "Sms_Accounts",
22755     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22756     "version": "0.0.0",
22757     "filename": "server/api/smsMessage/index.js",
22758     "groupTitle": "Sms_Accounts"
22759   },
22760   {
22761     "type": "post",
22762     "url": "/api/sms/accounts/{id}/send",
22763     "title": "Send new sms message",
22764     "examples": [
22765       {
22766         "title": "Example usage:",
22767         "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",
22768         "type": "json"
22769       }
22770     ],
22771     "name": "sendSms",
22772     "group": "Sms_Accounts",
22773     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22774     "version": "0.0.0",
22775     "filename": "server/api/smsAccount/index.js",
22776     "groupTitle": "Sms_Accounts"
22777   },
22778   {
22779     "type": "get",
22780     "url": "/api/sms/accounts/{id}/status",
22781     "title": "Receive message status as get request",
22782     "examples": [
22783       {
22784         "title": "Example usage:",
22785         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22786         "type": "json"
22787       }
22788     ],
22789     "name": "statusMessage",
22790     "group": "Sms_Accounts",
22791     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22792     "version": "0.0.0",
22793     "filename": "server/api/smsAccount/index.js",
22794     "groupTitle": "Sms_Accounts"
22795   },
22796   {
22797     "type": "post",
22798     "url": "/api/sms/messages/{id}/status",
22799     "title": "Receive message status",
22800     "examples": [
22801       {
22802         "title": "Example usage:",
22803         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22804         "type": "json"
22805       }
22806     ],
22807     "name": "statusMessage",
22808     "group": "Sms_Accounts",
22809     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22810     "version": "0.0.0",
22811     "filename": "server/api/smsMessage/index.js",
22812     "groupTitle": "Sms_Accounts"
22813   },
22814   {
22815     "type": "post",
22816     "url": "/api/sms/accounts/{id}/status",
22817     "title": "Receive message status",
22818     "examples": [
22819       {
22820         "title": "Example usage:",
22821         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22822         "type": "json"
22823       }
22824     ],
22825     "name": "statusMessage",
22826     "group": "Sms_Accounts",
22827     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22828     "version": "0.0.0",
22829     "filename": "server/api/smsAccount/index.js",
22830     "groupTitle": "Sms_Accounts"
22831   },
22832   {
22833     "type": "put",
22834     "url": "/api/sms/accounts/{id}",
22835     "title": "Update an existing Account",
22836     "examples": [
22837       {
22838         "title": "Example usage:",
22839         "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",
22840         "type": "json"
22841       }
22842     ],
22843     "name": "updateAccounts",
22844     "group": "Sms_Accounts",
22845     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22846     "version": "0.0.0",
22847     "filename": "server/api/smsAccount/index.js",
22848     "groupTitle": "Sms_Accounts"
22849   },
22850   {
22851     "type": "post",
22852     "url": "/api/sms/applications",
22853     "title": "Creates a new Application",
22854     "examples": [
22855       {
22856         "title": "Example usage:",
22857         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22858         "type": "json"
22859       }
22860     ],
22861     "name": "CreateApplications",
22862     "group": "Sms_Applications",
22863     "parameter": {
22864       "fields": {
22865         "Body": [
22866           {
22867             "group": "Body",
22868             "type": "Integer",
22869             "optional": false,
22870             "field": "priority",
22871             "description": ""
22872           },
22873           {
22874             "group": "Body",
22875             "type": "String",
22876             "optional": false,
22877             "field": "app",
22878             "description": ""
22879           },
22880           {
22881             "group": "Body",
22882             "type": "Text",
22883             "optional": true,
22884             "field": "appdata",
22885             "description": ""
22886           },
22887           {
22888             "group": "Body",
22889             "type": "String",
22890             "optional": true,
22891             "field": "description",
22892             "description": ""
22893           },
22894           {
22895             "group": "Body",
22896             "type": "String",
22897             "optional": true,
22898             "field": "interval",
22899             "description": ""
22900           }
22901         ]
22902       }
22903     },
22904     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22905     "version": "0.0.0",
22906     "filename": "server/api/smsApplication/index.js",
22907     "groupTitle": "Sms_Applications"
22908   },
22909   {
22910     "type": "delete",
22911     "url": "/api/sms/applications/{id}",
22912     "title": "Deletes a Application",
22913     "examples": [
22914       {
22915         "title": "Example usage:",
22916         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22917         "type": "json"
22918       }
22919     ],
22920     "name": "DeleteApplications",
22921     "group": "Sms_Applications",
22922     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22923     "version": "0.0.0",
22924     "filename": "server/api/smsApplication/index.js",
22925     "groupTitle": "Sms_Applications"
22926   },
22927   {
22928     "type": "get",
22929     "url": "/api/sms/applications",
22930     "title": "Gets a list of Applications",
22931     "examples": [
22932       {
22933         "title": "Example usage:",
22934         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22935         "type": "json"
22936       }
22937     ],
22938     "name": "GetApplications",
22939     "group": "Sms_Applications",
22940     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22941     "version": "0.0.0",
22942     "filename": "server/api/smsApplication/index.js",
22943     "groupTitle": "Sms_Applications"
22944   },
22945   {
22946     "type": "get",
22947     "url": "/api/sms/applications/{id}",
22948     "title": "Gets a single Application",
22949     "examples": [
22950       {
22951         "title": "Example usage:",
22952         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22953         "type": "json"
22954       }
22955     ],
22956     "name": "ShowApplications",
22957     "group": "Sms_Applications",
22958     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22959     "version": "0.0.0",
22960     "filename": "server/api/smsApplication/index.js",
22961     "groupTitle": "Sms_Applications"
22962   },
22963   {
22964     "type": "put",
22965     "url": "/api/sms/applications/{id}",
22966     "title": "Update an existing Application",
22967     "examples": [
22968       {
22969         "title": "Example usage:",
22970         "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",
22971         "type": "json"
22972       }
22973     ],
22974     "name": "updateApplications",
22975     "group": "Sms_Applications",
22976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22977     "version": "0.0.0",
22978     "filename": "server/api/smsApplication/index.js",
22979     "groupTitle": "Sms_Applications"
22980   },
22981   {
22982     "type": "post",
22983     "url": "/api/sms/interactions/{id}/tags",
22984     "title": "Add tags to the interaction",
22985     "examples": [
22986       {
22987         "title": "Example usage:",
22988         "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",
22989         "type": "json"
22990       }
22991     ],
22992     "name": "AddTags",
22993     "group": "Sms_Interactions",
22994     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22995     "version": "0.0.0",
22996     "filename": "server/api/smsInteraction/index.js",
22997     "groupTitle": "Sms_Interactions"
22998   },
22999   {
23000     "type": "post",
23001     "url": "/api/sms/interactions",
23002     "title": "Creates a new Interaction",
23003     "examples": [
23004       {
23005         "title": "Example usage:",
23006         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23007         "type": "json"
23008       }
23009     ],
23010     "name": "CreateInteractions",
23011     "group": "Sms_Interactions",
23012     "parameter": {
23013       "fields": {
23014         "Body": [
23015           {
23016             "group": "Body",
23017             "type": "Boolean",
23018             "optional": true,
23019             "field": "closed",
23020             "description": ""
23021           },
23022           {
23023             "group": "Body",
23024             "type": "String",
23025             "optional": true,
23026             "field": "closedAt",
23027             "description": ""
23028           },
23029           {
23030             "group": "Body",
23031             "type": "String",
23032             "optional": true,
23033             "field": "disposition",
23034             "description": ""
23035           },
23036           {
23037             "group": "Body",
23038             "type": "String",
23039             "optional": true,
23040             "field": "secondDisposition",
23041             "description": ""
23042           },
23043           {
23044             "group": "Body",
23045             "type": "String",
23046             "optional": true,
23047             "field": "thirdDisposition",
23048             "description": ""
23049           },
23050           {
23051             "group": "Body",
23052             "type": "String",
23053             "optional": true,
23054             "field": "note",
23055             "description": ""
23056           },
23057           {
23058             "group": "Body",
23059             "type": "String",
23060             "optional": true,
23061             "field": "phone",
23062             "description": ""
23063           },
23064           {
23065             "group": "Body",
23066             "type": "String",
23067             "optional": true,
23068             "field": "read1stAt",
23069             "description": ""
23070           },
23071           {
23072             "group": "Body",
23073             "type": "String",
23074             "allowedValues": [
23075               "\"in\"",
23076               "\"out\""
23077             ],
23078             "optional": false,
23079             "field": "firstMsgDirection",
23080             "description": ""
23081           },
23082           {
23083             "group": "Body",
23084             "type": "String",
23085             "optional": true,
23086             "field": "lastMsgAt",
23087             "description": ""
23088           },
23089           {
23090             "group": "Body",
23091             "type": "String",
23092             "allowedValues": [
23093               "\"in\"",
23094               "\"out\""
23095             ],
23096             "optional": false,
23097             "field": "lastMsgDirection",
23098             "description": ""
23099           }
23100         ]
23101       }
23102     },
23103     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23104     "version": "0.0.0",
23105     "filename": "server/api/smsInteraction/index.js",
23106     "groupTitle": "Sms_Interactions"
23107   },
23108   {
23109     "type": "delete",
23110     "url": "/api/sms/interactions/{id}",
23111     "title": "Deletes a Interaction",
23112     "examples": [
23113       {
23114         "title": "Example usage:",
23115         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23116         "type": "json"
23117       }
23118     ],
23119     "name": "DeleteInteractions",
23120     "group": "Sms_Interactions",
23121     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23122     "version": "0.0.0",
23123     "filename": "server/api/smsInteraction/index.js",
23124     "groupTitle": "Sms_Interactions"
23125   },
23126   {
23127     "type": "get",
23128     "url": "/api/sms/interactions/describe",
23129     "title": "Gets table info about Interactions",
23130     "examples": [
23131       {
23132         "title": "Example usage:",
23133         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23134         "type": "json"
23135       }
23136     ],
23137     "name": "DescribeInteractions",
23138     "group": "Sms_Interactions",
23139     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23140     "version": "0.0.0",
23141     "filename": "server/api/smsInteraction/index.js",
23142     "groupTitle": "Sms_Interactions"
23143   },
23144   {
23145     "type": "get",
23146     "url": "/api/sms/interactions",
23147     "title": "Gets a list of Interactions",
23148     "examples": [
23149       {
23150         "title": "Example usage:",
23151         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23152         "type": "json"
23153       }
23154     ],
23155     "name": "GetInteractions",
23156     "group": "Sms_Interactions",
23157     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23158     "version": "0.0.0",
23159     "filename": "server/api/smsInteraction/index.js",
23160     "groupTitle": "Sms_Interactions"
23161   },
23162   {
23163     "type": "delete",
23164     "url": "/api/sms/interactions/{id}/tags",
23165     "title": "Removes tags from interaction",
23166     "examples": [
23167       {
23168         "title": "Example usage:",
23169         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23170         "type": "json"
23171       }
23172     ],
23173     "name": "RemoveTags",
23174     "group": "Sms_Interactions",
23175     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23176     "version": "0.0.0",
23177     "filename": "server/api/smsInteraction/index.js",
23178     "groupTitle": "Sms_Interactions"
23179   },
23180   {
23181     "type": "get",
23182     "url": "/api/sms/interactions/{id}",
23183     "title": "Gets a single Interaction",
23184     "examples": [
23185       {
23186         "title": "Example usage:",
23187         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23188         "type": "json"
23189       }
23190     ],
23191     "name": "ShowInteractions",
23192     "group": "Sms_Interactions",
23193     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23194     "version": "0.0.0",
23195     "filename": "server/api/smsInteraction/index.js",
23196     "groupTitle": "Sms_Interactions"
23197   },
23198   {
23199     "type": "post",
23200     "url": "/api/sms/interactions/{id}/messages",
23201     "title": "Creates new messages",
23202     "examples": [
23203       {
23204         "title": "Example usage:",
23205         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23206         "type": "json"
23207       }
23208     ],
23209     "name": "addMessage",
23210     "group": "Sms_Interactions",
23211     "parameter": {
23212       "fields": {
23213         "Body": [
23214           {
23215             "group": "Body",
23216             "type": "Text",
23217             "optional": false,
23218             "field": "body",
23219             "description": ""
23220           },
23221           {
23222             "group": "Body",
23223             "type": "Boolean",
23224             "optional": true,
23225             "field": "read",
23226             "description": ""
23227           },
23228           {
23229             "group": "Body",
23230             "type": "String",
23231             "allowedValues": [
23232               "\"in\"",
23233               "\"out\""
23234             ],
23235             "optional": false,
23236             "field": "direction",
23237             "description": ""
23238           },
23239           {
23240             "group": "Body",
23241             "type": "String",
23242             "optional": true,
23243             "field": "messageId",
23244             "description": ""
23245           },
23246           {
23247             "group": "Body",
23248             "type": "String",
23249             "optional": true,
23250             "field": "phone",
23251             "description": ""
23252           },
23253           {
23254             "group": "Body",
23255             "type": "String",
23256             "optional": true,
23257             "field": "readAt",
23258             "description": ""
23259           },
23260           {
23261             "group": "Body",
23262             "type": "Boolean",
23263             "optional": true,
23264             "field": "secret",
23265             "description": ""
23266           },
23267           {
23268             "group": "Body",
23269             "type": "String",
23270             "optional": true,
23271             "field": "providerName",
23272             "description": ""
23273           },
23274           {
23275             "group": "Body",
23276             "type": "Text",
23277             "optional": true,
23278             "field": "providerResponse",
23279             "description": ""
23280           }
23281         ]
23282       }
23283     },
23284     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23285     "version": "0.0.0",
23286     "filename": "server/api/smsInteraction/index.js",
23287     "groupTitle": "Sms_Interactions"
23288   },
23289   {
23290     "type": "get",
23291     "url": "/api/sms/interactions/{id}/download",
23292     "title": "Gets interaction",
23293     "examples": [
23294       {
23295         "title": "Example usage:",
23296         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23297         "type": "json"
23298       }
23299     ],
23300     "name": "download",
23301     "group": "Sms_Interactions",
23302     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23303     "version": "0.0.0",
23304     "filename": "server/api/smsInteraction/index.js",
23305     "groupTitle": "Sms_Interactions"
23306   },
23307   {
23308     "type": "get",
23309     "url": "/api/sms/interactions/{id}/messages",
23310     "title": "Gets interaction messages",
23311     "examples": [
23312       {
23313         "title": "Example usage:",
23314         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23315         "type": "json"
23316       }
23317     ],
23318     "name": "getMessages",
23319     "group": "Sms_Interactions",
23320     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23321     "version": "0.0.0",
23322     "filename": "server/api/smsInteraction/index.js",
23323     "groupTitle": "Sms_Interactions"
23324   },
23325   {
23326     "type": "put",
23327     "url": "/api/sms/interactions/{id}",
23328     "title": "Update an existing Interaction",
23329     "examples": [
23330       {
23331         "title": "Example usage:",
23332         "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",
23333         "type": "json"
23334       }
23335     ],
23336     "name": "updateInteractions",
23337     "group": "Sms_Interactions",
23338     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23339     "version": "0.0.0",
23340     "filename": "server/api/smsInteraction/index.js",
23341     "groupTitle": "Sms_Interactions"
23342   },
23343   {
23344     "type": "post",
23345     "url": "/api/sms/messages",
23346     "title": "Creates a new Message",
23347     "examples": [
23348       {
23349         "title": "Example usage:",
23350         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23351         "type": "json"
23352       }
23353     ],
23354     "name": "CreateMessages",
23355     "group": "Sms_Messages",
23356     "parameter": {
23357       "fields": {
23358         "Body": [
23359           {
23360             "group": "Body",
23361             "type": "Text",
23362             "optional": false,
23363             "field": "body",
23364             "description": ""
23365           },
23366           {
23367             "group": "Body",
23368             "type": "Boolean",
23369             "optional": true,
23370             "field": "read",
23371             "description": ""
23372           },
23373           {
23374             "group": "Body",
23375             "type": "String",
23376             "allowedValues": [
23377               "\"in\"",
23378               "\"out\""
23379             ],
23380             "optional": false,
23381             "field": "direction",
23382             "description": ""
23383           },
23384           {
23385             "group": "Body",
23386             "type": "String",
23387             "optional": true,
23388             "field": "messageId",
23389             "description": ""
23390           },
23391           {
23392             "group": "Body",
23393             "type": "String",
23394             "optional": true,
23395             "field": "phone",
23396             "description": ""
23397           },
23398           {
23399             "group": "Body",
23400             "type": "String",
23401             "optional": true,
23402             "field": "readAt",
23403             "description": ""
23404           },
23405           {
23406             "group": "Body",
23407             "type": "Boolean",
23408             "optional": true,
23409             "field": "secret",
23410             "description": ""
23411           },
23412           {
23413             "group": "Body",
23414             "type": "String",
23415             "optional": true,
23416             "field": "providerName",
23417             "description": ""
23418           },
23419           {
23420             "group": "Body",
23421             "type": "Text",
23422             "optional": true,
23423             "field": "providerResponse",
23424             "description": ""
23425           }
23426         ]
23427       }
23428     },
23429     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23430     "version": "0.0.0",
23431     "filename": "server/api/smsMessage/index.js",
23432     "groupTitle": "Sms_Messages"
23433   },
23434   {
23435     "type": "delete",
23436     "url": "/api/sms/messages/{id}",
23437     "title": "Deletes a Message",
23438     "examples": [
23439       {
23440         "title": "Example usage:",
23441         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23442         "type": "json"
23443       }
23444     ],
23445     "name": "DeleteMessages",
23446     "group": "Sms_Messages",
23447     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23448     "version": "0.0.0",
23449     "filename": "server/api/smsMessage/index.js",
23450     "groupTitle": "Sms_Messages"
23451   },
23452   {
23453     "type": "get",
23454     "url": "/api/sms/messages/describe",
23455     "title": "Gets table info about Messages",
23456     "examples": [
23457       {
23458         "title": "Example usage:",
23459         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23460         "type": "json"
23461       }
23462     ],
23463     "name": "DescribeMessages",
23464     "group": "Sms_Messages",
23465     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23466     "version": "0.0.0",
23467     "filename": "server/api/smsMessage/index.js",
23468     "groupTitle": "Sms_Messages"
23469   },
23470   {
23471     "type": "get",
23472     "url": "/api/sms/messages",
23473     "title": "Gets a list of Messages",
23474     "examples": [
23475       {
23476         "title": "Example usage:",
23477         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23478         "type": "json"
23479       }
23480     ],
23481     "name": "GetMessages",
23482     "group": "Sms_Messages",
23483     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23484     "version": "0.0.0",
23485     "filename": "server/api/smsMessage/index.js",
23486     "groupTitle": "Sms_Messages"
23487   },
23488   {
23489     "type": "get",
23490     "url": "/api/sms/messages/{id}",
23491     "title": "Gets a single Message",
23492     "examples": [
23493       {
23494         "title": "Example usage:",
23495         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23496         "type": "json"
23497       }
23498     ],
23499     "name": "ShowMessages",
23500     "group": "Sms_Messages",
23501     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23502     "version": "0.0.0",
23503     "filename": "server/api/smsMessage/index.js",
23504     "groupTitle": "Sms_Messages"
23505   },
23506   {
23507     "type": "put",
23508     "url": "/api/sms/messages/{id}",
23509     "title": "Update an existing Message",
23510     "examples": [
23511       {
23512         "title": "Example usage:",
23513         "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",
23514         "type": "json"
23515       }
23516     ],
23517     "name": "updateMessages",
23518     "group": "Sms_Messages",
23519     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23520     "version": "0.0.0",
23521     "filename": "server/api/smsMessage/index.js",
23522     "groupTitle": "Sms_Messages"
23523   },
23524   {
23525     "type": "post",
23526     "url": "/api/sms/reports/queue",
23527     "title": "Creates a new Sms Queue Report",
23528     "examples": [
23529       {
23530         "title": "Example usage:",
23531         "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",
23532         "type": "json"
23533       }
23534     ],
23535     "name": "CreateSms_Queue_Reports",
23536     "group": "Sms_Queue_Reports",
23537     "parameter": {
23538       "fields": {
23539         "Body": [
23540           {
23541             "group": "Body",
23542             "type": "String",
23543             "optional": false,
23544             "field": "uniqueid",
23545             "description": ""
23546           },
23547           {
23548             "group": "Body",
23549             "type": "String",
23550             "optional": true,
23551             "field": "from",
23552             "description": ""
23553           },
23554           {
23555             "group": "Body",
23556             "type": "String",
23557             "optional": true,
23558             "field": "joinAt",
23559             "description": ""
23560           },
23561           {
23562             "group": "Body",
23563             "type": "String",
23564             "optional": true,
23565             "field": "leaveAt",
23566             "description": ""
23567           },
23568           {
23569             "group": "Body",
23570             "type": "String",
23571             "optional": true,
23572             "field": "acceptAt",
23573             "description": ""
23574           },
23575           {
23576             "group": "Body",
23577             "type": "String",
23578             "optional": true,
23579             "field": "exitAt",
23580             "description": ""
23581           },
23582           {
23583             "group": "Body",
23584             "type": "String",
23585             "optional": true,
23586             "field": "reason",
23587             "description": ""
23588           }
23589         ]
23590       }
23591     },
23592     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23593     "version": "0.0.0",
23594     "filename": "server/api/smsQueueReport/index.js",
23595     "groupTitle": "Sms_Queue_Reports"
23596   },
23597   {
23598     "type": "delete",
23599     "url": "/api/sms/reports/queue/{id}",
23600     "title": "Deletes a Sms Queue Report",
23601     "examples": [
23602       {
23603         "title": "Example usage:",
23604         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23605         "type": "json"
23606       }
23607     ],
23608     "name": "DeleteSms_Queue_Reports",
23609     "group": "Sms_Queue_Reports",
23610     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23611     "version": "0.0.0",
23612     "filename": "server/api/smsQueueReport/index.js",
23613     "groupTitle": "Sms_Queue_Reports"
23614   },
23615   {
23616     "type": "get",
23617     "url": "/api/sms/reports/queue/describe",
23618     "title": "Gets table info about Sms Queue Reports",
23619     "examples": [
23620       {
23621         "title": "Example usage:",
23622         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23623         "type": "json"
23624       }
23625     ],
23626     "name": "DescribeSms_Queue_Reports",
23627     "group": "Sms_Queue_Reports",
23628     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23629     "version": "0.0.0",
23630     "filename": "server/api/smsQueueReport/index.js",
23631     "groupTitle": "Sms_Queue_Reports"
23632   },
23633   {
23634     "type": "get",
23635     "url": "/api/sms/reports/queue",
23636     "title": "Gets a list of Sms Queue Reports",
23637     "examples": [
23638       {
23639         "title": "Example usage:",
23640         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23641         "type": "json"
23642       }
23643     ],
23644     "name": "GetSms_Queue_Reports",
23645     "group": "Sms_Queue_Reports",
23646     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23647     "version": "0.0.0",
23648     "filename": "server/api/smsQueueReport/index.js",
23649     "groupTitle": "Sms_Queue_Reports"
23650   },
23651   {
23652     "type": "get",
23653     "url": "/api/sms/reports/queue/{id}",
23654     "title": "Gets a single Sms Queue Report",
23655     "examples": [
23656       {
23657         "title": "Example usage:",
23658         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23659         "type": "json"
23660       }
23661     ],
23662     "name": "ShowSms_Queue_Reports",
23663     "group": "Sms_Queue_Reports",
23664     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23665     "version": "0.0.0",
23666     "filename": "server/api/smsQueueReport/index.js",
23667     "groupTitle": "Sms_Queue_Reports"
23668   },
23669   {
23670     "type": "put",
23671     "url": "/api/sms/reports/queue/{id}",
23672     "title": "Update an existing Sms Queue Report",
23673     "examples": [
23674       {
23675         "title": "Example usage:",
23676         "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",
23677         "type": "json"
23678       }
23679     ],
23680     "name": "updateSms_Queue_Reports",
23681     "group": "Sms_Queue_Reports",
23682     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23683     "version": "0.0.0",
23684     "filename": "server/api/smsQueueReport/index.js",
23685     "groupTitle": "Sms_Queue_Reports"
23686   },
23687   {
23688     "type": "post",
23689     "url": "/api/sms/queues/{id}/users",
23690     "title": "Add agents to a queue",
23691     "examples": [
23692       {
23693         "title": "Example usage:",
23694         "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",
23695         "type": "json"
23696       }
23697     ],
23698     "name": "AddAgents",
23699     "group": "Sms_Queues",
23700     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23701     "version": "0.0.0",
23702     "filename": "server/api/smsQueue/index.js",
23703     "groupTitle": "Sms_Queues"
23704   },
23705   {
23706     "type": "post",
23707     "url": "/api/sms/queues/{id}/teams",
23708     "title": "Add teams to a queue",
23709     "examples": [
23710       {
23711         "title": "Example usage:",
23712         "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",
23713         "type": "json"
23714       }
23715     ],
23716     "name": "AddTeams",
23717     "group": "Sms_Queues",
23718     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23719     "version": "0.0.0",
23720     "filename": "server/api/smsQueue/index.js",
23721     "groupTitle": "Sms_Queues"
23722   },
23723   {
23724     "type": "post",
23725     "url": "/api/sms/queues",
23726     "title": "Creates a new Queue",
23727     "examples": [
23728       {
23729         "title": "Example usage:",
23730         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23731         "type": "json"
23732       }
23733     ],
23734     "name": "CreateQueues",
23735     "group": "Sms_Queues",
23736     "parameter": {
23737       "fields": {
23738         "Body": [
23739           {
23740             "group": "Body",
23741             "type": "String",
23742             "optional": true,
23743             "field": "name",
23744             "description": ""
23745           },
23746           {
23747             "group": "Body",
23748             "type": "String",
23749             "optional": true,
23750             "field": "description",
23751             "description": ""
23752           },
23753           {
23754             "group": "Body",
23755             "type": "Integer",
23756             "optional": true,
23757             "field": "timeout",
23758             "description": ""
23759           },
23760           {
23761             "group": "Body",
23762             "type": "String",
23763             "allowedValues": [
23764               "\"rrmemory\"",
23765               "\"beepall\"",
23766               "\"roundrobin\""
23767             ],
23768             "optional": true,
23769             "field": "strategy",
23770             "description": ""
23771           }
23772         ]
23773       }
23774     },
23775     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23776     "version": "0.0.0",
23777     "filename": "server/api/smsQueue/index.js",
23778     "groupTitle": "Sms_Queues"
23779   },
23780   {
23781     "type": "delete",
23782     "url": "/api/sms/queues/{id}",
23783     "title": "Deletes a Queue",
23784     "examples": [
23785       {
23786         "title": "Example usage:",
23787         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23788         "type": "json"
23789       }
23790     ],
23791     "name": "DeleteQueues",
23792     "group": "Sms_Queues",
23793     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23794     "version": "0.0.0",
23795     "filename": "server/api/smsQueue/index.js",
23796     "groupTitle": "Sms_Queues"
23797   },
23798   {
23799     "type": "get",
23800     "url": "/api/sms/queues/describe",
23801     "title": "Gets table info about Queues",
23802     "examples": [
23803       {
23804         "title": "Example usage:",
23805         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23806         "type": "json"
23807       }
23808     ],
23809     "name": "DescribeQueues",
23810     "group": "Sms_Queues",
23811     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23812     "version": "0.0.0",
23813     "filename": "server/api/smsQueue/index.js",
23814     "groupTitle": "Sms_Queues"
23815   },
23816   {
23817     "type": "get",
23818     "url": "/api/sms/queues/{id}/users",
23819     "title": "Gets queue agents",
23820     "examples": [
23821       {
23822         "title": "Example usage:",
23823         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23824         "type": "json"
23825       }
23826     ],
23827     "name": "GetAgents",
23828     "group": "Sms_Queues",
23829     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23830     "version": "0.0.0",
23831     "filename": "server/api/smsQueue/index.js",
23832     "groupTitle": "Sms_Queues"
23833   },
23834   {
23835     "type": "get",
23836     "url": "/api/sms/queues/{id}/members",
23837     "title": "GetMembers",
23838     "examples": [
23839       {
23840         "title": "Example usage:",
23841         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
23842         "type": "json"
23843       }
23844     ],
23845     "name": "GetMembers",
23846     "group": "Sms_Queues",
23847     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23848     "version": "0.0.0",
23849     "filename": "server/api/smsQueue/index.js",
23850     "groupTitle": "Sms_Queues"
23851   },
23852   {
23853     "type": "get",
23854     "url": "/api/sms/queues",
23855     "title": "Gets a list of Queues",
23856     "examples": [
23857       {
23858         "title": "Example usage:",
23859         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23860         "type": "json"
23861       }
23862     ],
23863     "name": "GetQueues",
23864     "group": "Sms_Queues",
23865     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23866     "version": "0.0.0",
23867     "filename": "server/api/smsQueue/index.js",
23868     "groupTitle": "Sms_Queues"
23869   },
23870   {
23871     "type": "get",
23872     "url": "/api/sms/queues/{id}/teams",
23873     "title": "Gets queues list",
23874     "examples": [
23875       {
23876         "title": "Example usage:",
23877         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23878         "type": "json"
23879       }
23880     ],
23881     "name": "GetTeams",
23882     "group": "Sms_Queues",
23883     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23884     "version": "0.0.0",
23885     "filename": "server/api/smsQueue/index.js",
23886     "groupTitle": "Sms_Queues"
23887   },
23888   {
23889     "type": "delete",
23890     "url": "/api/sms/queues/{id}/users",
23891     "title": "Removes agents from a queue",
23892     "examples": [
23893       {
23894         "title": "Example usage:",
23895         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23896         "type": "json"
23897       }
23898     ],
23899     "name": "RemoveAgents",
23900     "group": "Sms_Queues",
23901     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23902     "version": "0.0.0",
23903     "filename": "server/api/smsQueue/index.js",
23904     "groupTitle": "Sms_Queues"
23905   },
23906   {
23907     "type": "get",
23908     "url": "/api/sms/queues/{id}",
23909     "title": "Gets a single Queue",
23910     "examples": [
23911       {
23912         "title": "Example usage:",
23913         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23914         "type": "json"
23915       }
23916     ],
23917     "name": "ShowQueues",
23918     "group": "Sms_Queues",
23919     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23920     "version": "0.0.0",
23921     "filename": "server/api/smsQueue/index.js",
23922     "groupTitle": "Sms_Queues"
23923   },
23924   {
23925     "type": "put",
23926     "url": "/api/sms/queues/{id}",
23927     "title": "Update an existing Queue",
23928     "examples": [
23929       {
23930         "title": "Example usage:",
23931         "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",
23932         "type": "json"
23933       }
23934     ],
23935     "name": "updateQueues",
23936     "group": "Sms_Queues",
23937     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23938     "version": "0.0.0",
23939     "filename": "server/api/smsQueue/index.js",
23940     "groupTitle": "Sms_Queues"
23941   },
23942   {
23943     "type": "post",
23944     "url": "/api/sms/reports/transfer",
23945     "title": "Creates a new Sms Transfer Report",
23946     "examples": [
23947       {
23948         "title": "Example usage:",
23949         "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",
23950         "type": "json"
23951       }
23952     ],
23953     "name": "CreateSms_Transfer_Reports",
23954     "group": "Sms_Transfer_Reports",
23955     "parameter": {
23956       "fields": {
23957         "Body": [
23958           {
23959             "group": "Body",
23960             "type": "String",
23961             "optional": false,
23962             "field": "uniqueid",
23963             "description": ""
23964           },
23965           {
23966             "group": "Body",
23967             "type": "String",
23968             "allowedValues": [
23969               "\"account\"",
23970               "\"agent\"",
23971               "\"queue\""
23972             ],
23973             "optional": false,
23974             "field": "type",
23975             "description": ""
23976           },
23977           {
23978             "group": "Body",
23979             "type": "String",
23980             "optional": false,
23981             "field": "transferredAt",
23982             "description": ""
23983           }
23984         ]
23985       }
23986     },
23987     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23988     "version": "0.0.0",
23989     "filename": "server/api/smsTransferReport/index.js",
23990     "groupTitle": "Sms_Transfer_Reports"
23991   },
23992   {
23993     "type": "delete",
23994     "url": "/api/sms/reports/transfer/{id}",
23995     "title": "Deletes a Sms Transfer Report",
23996     "examples": [
23997       {
23998         "title": "Example usage:",
23999         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24000         "type": "json"
24001       }
24002     ],
24003     "name": "DeleteSms_Transfer_Reports",
24004     "group": "Sms_Transfer_Reports",
24005     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24006     "version": "0.0.0",
24007     "filename": "server/api/smsTransferReport/index.js",
24008     "groupTitle": "Sms_Transfer_Reports"
24009   },
24010   {
24011     "type": "get",
24012     "url": "/api/sms/reports/transfer/describe",
24013     "title": "Gets table info about Sms Transfer Reports",
24014     "examples": [
24015       {
24016         "title": "Example usage:",
24017         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24018         "type": "json"
24019       }
24020     ],
24021     "name": "DescribeSms_Transfer_Reports",
24022     "group": "Sms_Transfer_Reports",
24023     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24024     "version": "0.0.0",
24025     "filename": "server/api/smsTransferReport/index.js",
24026     "groupTitle": "Sms_Transfer_Reports"
24027   },
24028   {
24029     "type": "get",
24030     "url": "/api/sms/reports/transfer",
24031     "title": "Gets a list of Sms Transfer Reports",
24032     "examples": [
24033       {
24034         "title": "Example usage:",
24035         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24036         "type": "json"
24037       }
24038     ],
24039     "name": "GetSms_Transfer_Reports",
24040     "group": "Sms_Transfer_Reports",
24041     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24042     "version": "0.0.0",
24043     "filename": "server/api/smsTransferReport/index.js",
24044     "groupTitle": "Sms_Transfer_Reports"
24045   },
24046   {
24047     "type": "get",
24048     "url": "/api/sms/reports/transfer/{id}",
24049     "title": "Gets a single Sms Transfer Report",
24050     "examples": [
24051       {
24052         "title": "Example usage:",
24053         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24054         "type": "json"
24055       }
24056     ],
24057     "name": "ShowSms_Transfer_Reports",
24058     "group": "Sms_Transfer_Reports",
24059     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24060     "version": "0.0.0",
24061     "filename": "server/api/smsTransferReport/index.js",
24062     "groupTitle": "Sms_Transfer_Reports"
24063   },
24064   {
24065     "type": "put",
24066     "url": "/api/sms/reports/transfer/{id}",
24067     "title": "Update an existing Sms Transfer Report",
24068     "examples": [
24069       {
24070         "title": "Example usage:",
24071         "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",
24072         "type": "json"
24073       }
24074     ],
24075     "name": "updateSms_Transfer_Reports",
24076     "group": "Sms_Transfer_Reports",
24077     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24078     "version": "0.0.0",
24079     "filename": "server/api/smsTransferReport/index.js",
24080     "groupTitle": "Sms_Transfer_Reports"
24081   },
24082   {
24083     "type": "get",
24084     "url": "/api/sounds",
24085     "title": "Gets a list of Sounds",
24086     "examples": [
24087       {
24088         "title": "Example usage:",
24089         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24090         "type": "json"
24091       }
24092     ],
24093     "name": "GetSounds",
24094     "group": "Sounds",
24095     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24096     "version": "0.0.0",
24097     "filename": "server/api/sound/index.js",
24098     "groupTitle": "Sounds"
24099   },
24100   {
24101     "type": "get",
24102     "url": "/api/sounds/{id}",
24103     "title": "Gets a single Sound",
24104     "examples": [
24105       {
24106         "title": "Example usage:",
24107         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24108         "type": "json"
24109       }
24110     ],
24111     "name": "ShowSounds",
24112     "group": "Sounds",
24113     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24114     "version": "0.0.0",
24115     "filename": "server/api/sound/index.js",
24116     "groupTitle": "Sounds"
24117   },
24118   {
24119     "type": "post",
24120     "url": "/api/sounds",
24121     "title": "Create a new sound",
24122     "examples": [
24123       {
24124         "title": "Example usage:",
24125         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24126         "type": "json"
24127       }
24128     ],
24129     "name": "addSound",
24130     "group": "Sounds",
24131     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24132     "version": "0.0.0",
24133     "filename": "server/api/sound/index.js",
24134     "groupTitle": "Sounds"
24135   },
24136   {
24137     "type": "delete",
24138     "url": "/api/sounds/{id}",
24139     "title": "Deletes a sound",
24140     "examples": [
24141       {
24142         "title": "Example usage:",
24143         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24144         "type": "json"
24145       }
24146     ],
24147     "name": "destroySound",
24148     "group": "Sounds",
24149     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24150     "version": "0.0.0",
24151     "filename": "server/api/sound/index.js",
24152     "groupTitle": "Sounds"
24153   },
24154   {
24155     "type": "get",
24156     "url": "/api/sounds/{id}/download",
24157     "title": "Download Sound",
24158     "examples": [
24159       {
24160         "title": "Example usage:",
24161         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24162         "type": "json"
24163       }
24164     ],
24165     "name": "download",
24166     "group": "Sounds",
24167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24168     "version": "0.0.0",
24169     "filename": "server/api/sound/index.js",
24170     "groupTitle": "Sounds"
24171   },
24172   {
24173     "type": "put",
24174     "url": "/api/sounds",
24175     "title": "Update an existing new sound",
24176     "examples": [
24177       {
24178         "title": "Example usage:",
24179         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24180         "type": "json"
24181       }
24182     ],
24183     "name": "updateSound",
24184     "group": "Sounds",
24185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24186     "version": "0.0.0",
24187     "filename": "server/api/sound/index.js",
24188     "groupTitle": "Sounds"
24189   },
24190   {
24191     "type": "post",
24192     "url": "/api/square/details/reports",
24193     "title": "Creates a new Square Detail Report",
24194     "examples": [
24195       {
24196         "title": "Example usage:",
24197         "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",
24198         "type": "json"
24199       }
24200     ],
24201     "name": "CreateSquare_Detail_Reports",
24202     "group": "Square_Details_Reports",
24203     "parameter": {
24204       "fields": {
24205         "Body": [
24206           {
24207             "group": "Body",
24208             "type": "String",
24209             "optional": true,
24210             "field": "uniqueid",
24211             "description": ""
24212           },
24213           {
24214             "group": "Body",
24215             "type": "String",
24216             "optional": true,
24217             "field": "node",
24218             "description": ""
24219           },
24220           {
24221             "group": "Body",
24222             "type": "String",
24223             "optional": true,
24224             "field": "application",
24225             "description": ""
24226           },
24227           {
24228             "group": "Body",
24229             "type": "Text",
24230             "optional": true,
24231             "field": "data",
24232             "description": ""
24233           },
24234           {
24235             "group": "Body",
24236             "type": "String",
24237             "optional": true,
24238             "field": "project_name",
24239             "description": ""
24240           },
24241           {
24242             "group": "Body",
24243             "type": "String",
24244             "optional": true,
24245             "field": "callerid",
24246             "description": ""
24247           }
24248         ]
24249       }
24250     },
24251     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24252     "version": "0.0.0",
24253     "filename": "server/api/squareReportDetail/index.js",
24254     "groupTitle": "Square_Details_Reports"
24255   },
24256   {
24257     "type": "delete",
24258     "url": "/api/square/details/reports/{id}",
24259     "title": "Deletes a Square Detail Report",
24260     "examples": [
24261       {
24262         "title": "Example usage:",
24263         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24264         "type": "json"
24265       }
24266     ],
24267     "name": "DeleteSquare_Detail_Reports",
24268     "group": "Square_Details_Reports",
24269     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24270     "version": "0.0.0",
24271     "filename": "server/api/squareReportDetail/index.js",
24272     "groupTitle": "Square_Details_Reports"
24273   },
24274   {
24275     "type": "get",
24276     "url": "/api/square/details/reports/describe",
24277     "title": "Gets table info about Square Detail Reports",
24278     "examples": [
24279       {
24280         "title": "Example usage:",
24281         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24282         "type": "json"
24283       }
24284     ],
24285     "name": "DescribeSquare_Detail_Reports",
24286     "group": "Square_Details_Reports",
24287     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24288     "version": "0.0.0",
24289     "filename": "server/api/squareReportDetail/index.js",
24290     "groupTitle": "Square_Details_Reports"
24291   },
24292   {
24293     "type": "get",
24294     "url": "/api/square/details/reports",
24295     "title": "Gets a list of Square Detail Reports",
24296     "examples": [
24297       {
24298         "title": "Example usage:",
24299         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24300         "type": "json"
24301       }
24302     ],
24303     "name": "GetSquare_Detail_Reports",
24304     "group": "Square_Details_Reports",
24305     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24306     "version": "0.0.0",
24307     "filename": "server/api/squareReportDetail/index.js",
24308     "groupTitle": "Square_Details_Reports"
24309   },
24310   {
24311     "type": "get",
24312     "url": "/api/square/details/reports/{id}",
24313     "title": "Gets a single Square Detail Report",
24314     "examples": [
24315       {
24316         "title": "Example usage:",
24317         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24318         "type": "json"
24319       }
24320     ],
24321     "name": "ShowSquare_Detail_Reports",
24322     "group": "Square_Details_Reports",
24323     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24324     "version": "0.0.0",
24325     "filename": "server/api/squareReportDetail/index.js",
24326     "groupTitle": "Square_Details_Reports"
24327   },
24328   {
24329     "type": "put",
24330     "url": "/api/square/details/reports/{id}",
24331     "title": "Update an existing Square Detail Report",
24332     "examples": [
24333       {
24334         "title": "Example usage:",
24335         "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",
24336         "type": "json"
24337       }
24338     ],
24339     "name": "updateSquare_Detail_Reports",
24340     "group": "Square_Details_Reports",
24341     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24342     "version": "0.0.0",
24343     "filename": "server/api/squareReportDetail/index.js",
24344     "groupTitle": "Square_Details_Reports"
24345   },
24346   {
24347     "type": "post",
24348     "url": "/api/square/messages",
24349     "title": "Creates a new Message",
24350     "examples": [
24351       {
24352         "title": "Example usage:",
24353         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24354         "type": "json"
24355       }
24356     ],
24357     "name": "CreateMessages",
24358     "group": "Square_Messages",
24359     "parameter": {
24360       "fields": {
24361         "Body": [
24362           {
24363             "group": "Body",
24364             "type": "String",
24365             "optional": true,
24366             "field": "uniqueid",
24367             "description": ""
24368           },
24369           {
24370             "group": "Body",
24371             "type": "Text",
24372             "optional": false,
24373             "field": "body",
24374             "description": ""
24375           },
24376           {
24377             "group": "Body",
24378             "type": "String",
24379             "allowedValues": [
24380               "\"in\"",
24381               "\"out\""
24382             ],
24383             "optional": false,
24384             "field": "direction",
24385             "description": ""
24386           },
24387           {
24388             "group": "Body",
24389             "type": "String",
24390             "optional": true,
24391             "field": "providerName",
24392             "description": ""
24393           },
24394           {
24395             "group": "Body",
24396             "type": "Text",
24397             "optional": true,
24398             "field": "providerResponse",
24399             "description": ""
24400           }
24401         ]
24402       }
24403     },
24404     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24405     "version": "0.0.0",
24406     "filename": "server/api/squareMessage/index.js",
24407     "groupTitle": "Square_Messages"
24408   },
24409   {
24410     "type": "delete",
24411     "url": "/api/square/messages/{id}",
24412     "title": "Deletes a Message",
24413     "examples": [
24414       {
24415         "title": "Example usage:",
24416         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24417         "type": "json"
24418       }
24419     ],
24420     "name": "DeleteMessages",
24421     "group": "Square_Messages",
24422     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/squareMessage/index.js",
24425     "groupTitle": "Square_Messages"
24426   },
24427   {
24428     "type": "get",
24429     "url": "/api/square/messages",
24430     "title": "Gets a list of Messages",
24431     "examples": [
24432       {
24433         "title": "Example usage:",
24434         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24435         "type": "json"
24436       }
24437     ],
24438     "name": "GetMessages",
24439     "group": "Square_Messages",
24440     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24441     "version": "0.0.0",
24442     "filename": "server/api/squareMessage/index.js",
24443     "groupTitle": "Square_Messages"
24444   },
24445   {
24446     "type": "get",
24447     "url": "/api/square/messages/{id}",
24448     "title": "Gets a single Message",
24449     "examples": [
24450       {
24451         "title": "Example usage:",
24452         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24453         "type": "json"
24454       }
24455     ],
24456     "name": "ShowMessages",
24457     "group": "Square_Messages",
24458     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24459     "version": "0.0.0",
24460     "filename": "server/api/squareMessage/index.js",
24461     "groupTitle": "Square_Messages"
24462   },
24463   {
24464     "type": "put",
24465     "url": "/api/square/messages/{id}",
24466     "title": "Update an existing Message",
24467     "examples": [
24468       {
24469         "title": "Example usage:",
24470         "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",
24471         "type": "json"
24472       }
24473     ],
24474     "name": "updateMessages",
24475     "group": "Square_Messages",
24476     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24477     "version": "0.0.0",
24478     "filename": "server/api/squareMessage/index.js",
24479     "groupTitle": "Square_Messages"
24480   },
24481   {
24482     "type": "post",
24483     "url": "/api/square/odbc",
24484     "title": "Creates a new ODBC",
24485     "examples": [
24486       {
24487         "title": "Example usage:",
24488         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24489         "type": "json"
24490       }
24491     ],
24492     "name": "CreateODBCs",
24493     "group": "Square_ODBC",
24494     "parameter": {
24495       "fields": {
24496         "Body": [
24497           {
24498             "group": "Body",
24499             "type": "String",
24500             "optional": false,
24501             "field": "name",
24502             "description": ""
24503           },
24504           {
24505             "group": "Body",
24506             "type": "String",
24507             "optional": true,
24508             "field": "dsn",
24509             "description": ""
24510           },
24511           {
24512             "group": "Body",
24513             "type": "String",
24514             "optional": true,
24515             "field": "description",
24516             "description": ""
24517           }
24518         ]
24519       }
24520     },
24521     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24522     "version": "0.0.0",
24523     "filename": "server/api/squareOdbc/index.js",
24524     "groupTitle": "Square_ODBC"
24525   },
24526   {
24527     "type": "delete",
24528     "url": "/api/square/odbc/{id}",
24529     "title": "Deletes a ODBC",
24530     "examples": [
24531       {
24532         "title": "Example usage:",
24533         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24534         "type": "json"
24535       }
24536     ],
24537     "name": "DeleteODBCs",
24538     "group": "Square_ODBC",
24539     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/squareOdbc/index.js",
24542     "groupTitle": "Square_ODBC"
24543   },
24544   {
24545     "type": "get",
24546     "url": "/api/square/odbc",
24547     "title": "Gets a list of ODBCs",
24548     "examples": [
24549       {
24550         "title": "Example usage:",
24551         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24552         "type": "json"
24553       }
24554     ],
24555     "name": "GetODBCs",
24556     "group": "Square_ODBC",
24557     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24558     "version": "0.0.0",
24559     "filename": "server/api/squareOdbc/index.js",
24560     "groupTitle": "Square_ODBC"
24561   },
24562   {
24563     "type": "get",
24564     "url": "/api/square/odbc/{id}",
24565     "title": "Gets a single ODBC",
24566     "examples": [
24567       {
24568         "title": "Example usage:",
24569         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24570         "type": "json"
24571       }
24572     ],
24573     "name": "ShowODBCs",
24574     "group": "Square_ODBC",
24575     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24576     "version": "0.0.0",
24577     "filename": "server/api/squareOdbc/index.js",
24578     "groupTitle": "Square_ODBC"
24579   },
24580   {
24581     "type": "get",
24582     "url": "/api/square/odbc/{id}/test",
24583     "title": "Test Odbc",
24584     "examples": [
24585       {
24586         "title": "Example usage:",
24587         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24588         "type": "json"
24589       }
24590     ],
24591     "name": "test",
24592     "group": "Square_ODBC",
24593     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24594     "version": "0.0.0",
24595     "filename": "server/api/squareOdbc/index.js",
24596     "groupTitle": "Square_ODBC"
24597   },
24598   {
24599     "type": "put",
24600     "url": "/api/square/odbc/{id}",
24601     "title": "Update an existing ODBC",
24602     "examples": [
24603       {
24604         "title": "Example usage:",
24605         "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",
24606         "type": "json"
24607       }
24608     ],
24609     "name": "updateODBCs",
24610     "group": "Square_ODBC",
24611     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24612     "version": "0.0.0",
24613     "filename": "server/api/squareOdbc/index.js",
24614     "groupTitle": "Square_ODBC"
24615   },
24616   {
24617     "type": "post",
24618     "url": "/api/square/projects",
24619     "title": "Creates a new Project",
24620     "examples": [
24621       {
24622         "title": "Example usage:",
24623         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24624         "type": "json"
24625       }
24626     ],
24627     "name": "CreateProjects",
24628     "group": "Square_Projects",
24629     "parameter": {
24630       "fields": {
24631         "Body": [
24632           {
24633             "group": "Body",
24634             "type": "String",
24635             "optional": false,
24636             "field": "name",
24637             "description": ""
24638           },
24639           {
24640             "group": "Body",
24641             "type": "String",
24642             "optional": true,
24643             "field": "description",
24644             "description": ""
24645           },
24646           {
24647             "group": "Body",
24648             "type": "Text",
24649             "optional": true,
24650             "field": "notes",
24651             "description": ""
24652           },
24653           {
24654             "group": "Body",
24655             "type": "Blob",
24656             "optional": true,
24657             "field": "preproduction",
24658             "description": ""
24659           },
24660           {
24661             "group": "Body",
24662             "type": "Blob",
24663             "optional": true,
24664             "field": "production",
24665             "description": ""
24666           },
24667           {
24668             "group": "Body",
24669             "type": "String",
24670             "optional": true,
24671             "field": "savedAt",
24672             "description": ""
24673           },
24674           {
24675             "group": "Body",
24676             "type": "String",
24677             "optional": true,
24678             "field": "publishedAt",
24679             "description": ""
24680           }
24681         ]
24682       }
24683     },
24684     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24685     "version": "0.0.0",
24686     "filename": "server/api/squareProject/index.js",
24687     "groupTitle": "Square_Projects"
24688   },
24689   {
24690     "type": "delete",
24691     "url": "/api/square/projects/{id}",
24692     "title": "Deletes a Project",
24693     "examples": [
24694       {
24695         "title": "Example usage:",
24696         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24697         "type": "json"
24698       }
24699     ],
24700     "name": "DeleteProjects",
24701     "group": "Square_Projects",
24702     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24703     "version": "0.0.0",
24704     "filename": "server/api/squareProject/index.js",
24705     "groupTitle": "Square_Projects"
24706   },
24707   {
24708     "type": "get",
24709     "url": "/api/square/projects",
24710     "title": "Gets a list of Projects",
24711     "examples": [
24712       {
24713         "title": "Example usage:",
24714         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24715         "type": "json"
24716       }
24717     ],
24718     "name": "GetProjects",
24719     "group": "Square_Projects",
24720     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24721     "version": "0.0.0",
24722     "filename": "server/api/squareProject/index.js",
24723     "groupTitle": "Square_Projects"
24724   },
24725   {
24726     "type": "get",
24727     "url": "/api/square/projects/{id}",
24728     "title": "Gets a single Project",
24729     "examples": [
24730       {
24731         "title": "Example usage:",
24732         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24733         "type": "json"
24734       }
24735     ],
24736     "name": "ShowProjects",
24737     "group": "Square_Projects",
24738     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24739     "version": "0.0.0",
24740     "filename": "server/api/squareProject/index.js",
24741     "groupTitle": "Square_Projects"
24742   },
24743   {
24744     "type": "post",
24745     "url": "/api/square/projects/{id}/users",
24746     "title": "Adds user permissions to a Project",
24747     "examples": [
24748       {
24749         "title": "Example usage:",
24750         "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",
24751         "type": "json"
24752       }
24753     ],
24754     "name": "addUsers",
24755     "group": "Square_Projects",
24756     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24757     "version": "0.0.0",
24758     "filename": "server/api/squareProject/index.js",
24759     "groupTitle": "Square_Projects"
24760   },
24761   {
24762     "type": "get",
24763     "url": "/api/square/projects/{id}/users",
24764     "title": "Gets users permissions from Project",
24765     "examples": [
24766       {
24767         "title": "Example usage:",
24768         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24769         "type": "json"
24770       }
24771     ],
24772     "name": "getUsers",
24773     "group": "Square_Projects",
24774     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24775     "version": "0.0.0",
24776     "filename": "server/api/squareProject/index.js",
24777     "groupTitle": "Square_Projects"
24778   },
24779   {
24780     "type": "delete",
24781     "url": "/api/square/projects/{id}/users",
24782     "title": "Removes user permissions from a Project",
24783     "examples": [
24784       {
24785         "title": "Example usage:",
24786         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24787         "type": "json"
24788       }
24789     ],
24790     "name": "removeUsers",
24791     "group": "Square_Projects",
24792     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24793     "version": "0.0.0",
24794     "filename": "server/api/squareProject/index.js",
24795     "groupTitle": "Square_Projects"
24796   },
24797   {
24798     "type": "put",
24799     "url": "/api/square/projects/{id}",
24800     "title": "Update an existing Project",
24801     "examples": [
24802       {
24803         "title": "Example usage:",
24804         "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",
24805         "type": "json"
24806       }
24807     ],
24808     "name": "updateProjects",
24809     "group": "Square_Projects",
24810     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24811     "version": "0.0.0",
24812     "filename": "server/api/squareProject/index.js",
24813     "groupTitle": "Square_Projects"
24814   },
24815   {
24816     "type": "post",
24817     "url": "/api/square/recordings",
24818     "title": "Creates a new Recording",
24819     "examples": [
24820       {
24821         "title": "Example usage:",
24822         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24823         "type": "json"
24824       }
24825     ],
24826     "name": "CreateRecordings",
24827     "group": "Square_Recordings",
24828     "parameter": {
24829       "fields": {
24830         "Body": [
24831           {
24832             "group": "Body",
24833             "type": "String",
24834             "optional": true,
24835             "field": "uniqueid",
24836             "description": ""
24837           },
24838           {
24839             "group": "Body",
24840             "type": "String",
24841             "optional": true,
24842             "field": "callerid",
24843             "description": ""
24844           },
24845           {
24846             "group": "Body",
24847             "type": "String",
24848             "optional": true,
24849             "field": "calleridname",
24850             "description": ""
24851           },
24852           {
24853             "group": "Body",
24854             "type": "String",
24855             "optional": true,
24856             "field": "context",
24857             "description": ""
24858           },
24859           {
24860             "group": "Body",
24861             "type": "String",
24862             "optional": true,
24863             "field": "extension",
24864             "description": ""
24865           },
24866           {
24867             "group": "Body",
24868             "type": "String",
24869             "optional": true,
24870             "field": "priority",
24871             "description": ""
24872           },
24873           {
24874             "group": "Body",
24875             "type": "String",
24876             "optional": true,
24877             "field": "accountcode",
24878             "description": ""
24879           },
24880           {
24881             "group": "Body",
24882             "type": "String",
24883             "optional": true,
24884             "field": "dnid",
24885             "description": ""
24886           },
24887           {
24888             "group": "Body",
24889             "type": "String",
24890             "optional": true,
24891             "field": "projectName",
24892             "description": ""
24893           },
24894           {
24895             "group": "Body",
24896             "type": "String",
24897             "optional": true,
24898             "field": "saveName",
24899             "description": ""
24900           },
24901           {
24902             "group": "Body",
24903             "type": "String",
24904             "optional": true,
24905             "field": "filename",
24906             "description": ""
24907           },
24908           {
24909             "group": "Body",
24910             "type": "String",
24911             "optional": true,
24912             "field": "savePath",
24913             "description": ""
24914           },
24915           {
24916             "group": "Body",
24917             "type": "Virtual",
24918             "optional": true,
24919             "field": "format",
24920             "description": ""
24921           }
24922         ]
24923       }
24924     },
24925     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24926     "version": "0.0.0",
24927     "filename": "server/api/squareRecording/index.js",
24928     "groupTitle": "Square_Recordings"
24929   },
24930   {
24931     "type": "get",
24932     "url": "/api/square/recordings",
24933     "title": "Gets a list of Recordings",
24934     "examples": [
24935       {
24936         "title": "Example usage:",
24937         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24938         "type": "json"
24939       }
24940     ],
24941     "name": "GetRecordings",
24942     "group": "Square_Recordings",
24943     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24944     "version": "0.0.0",
24945     "filename": "server/api/squareRecording/index.js",
24946     "groupTitle": "Square_Recordings"
24947   },
24948   {
24949     "type": "get",
24950     "url": "/api/square/recordings/{id}",
24951     "title": "Gets a single Recording",
24952     "examples": [
24953       {
24954         "title": "Example usage:",
24955         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24956         "type": "json"
24957       }
24958     ],
24959     "name": "ShowRecordings",
24960     "group": "Square_Recordings",
24961     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24962     "version": "0.0.0",
24963     "filename": "server/api/squareRecording/index.js",
24964     "groupTitle": "Square_Recordings"
24965   },
24966   {
24967     "type": "delete",
24968     "url": "/api/square/recordings/{id}/delete",
24969     "title": "Delete recording",
24970     "examples": [
24971       {
24972         "title": "Example usage:",
24973         "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
24974         "type": "json"
24975       }
24976     ],
24977     "name": "destroy",
24978     "group": "Square_Recordings",
24979     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24980     "version": "0.0.0",
24981     "filename": "server/api/squareRecording/index.js",
24982     "groupTitle": "Square_Recordings"
24983   },
24984   {
24985     "type": "get",
24986     "url": "/api/square/recordings/{id}/download",
24987     "title": "Download Recording",
24988     "examples": [
24989       {
24990         "title": "Example usage:",
24991         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
24992         "type": "json"
24993       }
24994     ],
24995     "name": "download",
24996     "group": "Square_Recordings",
24997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24998     "version": "0.0.0",
24999     "filename": "server/api/squareRecording/index.js",
25000     "groupTitle": "Square_Recordings"
25001   },
25002   {
25003     "type": "put",
25004     "url": "/api/square/recordings/{id}",
25005     "title": "Update an existing Recording",
25006     "examples": [
25007       {
25008         "title": "Example usage:",
25009         "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",
25010         "type": "json"
25011       }
25012     ],
25013     "name": "updateRecordings",
25014     "group": "Square_Recordings",
25015     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25016     "version": "0.0.0",
25017     "filename": "server/api/squareRecording/index.js",
25018     "groupTitle": "Square_Recordings"
25019   },
25020   {
25021     "type": "post",
25022     "url": "/api/square/reports",
25023     "title": "Creates a new Square Report",
25024     "examples": [
25025       {
25026         "title": "Example usage:",
25027         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25028         "type": "json"
25029       }
25030     ],
25031     "name": "CreateSquare_Reports",
25032     "group": "Square_Reports",
25033     "parameter": {
25034       "fields": {
25035         "Body": [
25036           {
25037             "group": "Body",
25038             "type": "String",
25039             "optional": true,
25040             "field": "network",
25041             "description": ""
25042           },
25043           {
25044             "group": "Body",
25045             "type": "String",
25046             "optional": true,
25047             "field": "network_script",
25048             "description": ""
25049           },
25050           {
25051             "group": "Body",
25052             "type": "String",
25053             "optional": true,
25054             "field": "request",
25055             "description": ""
25056           },
25057           {
25058             "group": "Body",
25059             "type": "String",
25060             "optional": true,
25061             "field": "channel",
25062             "description": ""
25063           },
25064           {
25065             "group": "Body",
25066             "type": "String",
25067             "optional": true,
25068             "field": "language",
25069             "description": ""
25070           },
25071           {
25072             "group": "Body",
25073             "type": "String",
25074             "optional": true,
25075             "field": "type",
25076             "description": ""
25077           },
25078           {
25079             "group": "Body",
25080             "type": "String",
25081             "optional": true,
25082             "field": "uniqueid",
25083             "description": ""
25084           },
25085           {
25086             "group": "Body",
25087             "type": "String",
25088             "optional": true,
25089             "field": "version",
25090             "description": ""
25091           },
25092           {
25093             "group": "Body",
25094             "type": "String",
25095             "optional": true,
25096             "field": "callerid",
25097             "description": ""
25098           },
25099           {
25100             "group": "Body",
25101             "type": "String",
25102             "optional": true,
25103             "field": "calleridname",
25104             "description": ""
25105           },
25106           {
25107             "group": "Body",
25108             "type": "String",
25109             "optional": true,
25110             "field": "callingpres",
25111             "description": ""
25112           },
25113           {
25114             "group": "Body",
25115             "type": "String",
25116             "optional": true,
25117             "field": "callingani2",
25118             "description": ""
25119           },
25120           {
25121             "group": "Body",
25122             "type": "String",
25123             "optional": true,
25124             "field": "callington",
25125             "description": ""
25126           },
25127           {
25128             "group": "Body",
25129             "type": "String",
25130             "optional": true,
25131             "field": "callingtns",
25132             "description": ""
25133           },
25134           {
25135             "group": "Body",
25136             "type": "String",
25137             "optional": true,
25138             "field": "dnid",
25139             "description": ""
25140           },
25141           {
25142             "group": "Body",
25143             "type": "String",
25144             "optional": true,
25145             "field": "rdnis",
25146             "description": ""
25147           },
25148           {
25149             "group": "Body",
25150             "type": "String",
25151             "optional": true,
25152             "field": "context",
25153             "description": ""
25154           },
25155           {
25156             "group": "Body",
25157             "type": "String",
25158             "optional": true,
25159             "field": "extension",
25160             "description": ""
25161           },
25162           {
25163             "group": "Body",
25164             "type": "String",
25165             "optional": true,
25166             "field": "priority",
25167             "description": ""
25168           },
25169           {
25170             "group": "Body",
25171             "type": "String",
25172             "optional": true,
25173             "field": "enhanced",
25174             "description": ""
25175           },
25176           {
25177             "group": "Body",
25178             "type": "String",
25179             "optional": true,
25180             "field": "accountcode",
25181             "description": ""
25182           },
25183           {
25184             "group": "Body",
25185             "type": "String",
25186             "optional": true,
25187             "field": "threadid",
25188             "description": ""
25189           },
25190           {
25191             "group": "Body",
25192             "type": "String",
25193             "optional": true,
25194             "field": "project_name",
25195             "description": ""
25196           },
25197           {
25198             "group": "Body",
25199             "type": "String",
25200             "optional": true,
25201             "field": "joinAt",
25202             "description": ""
25203           },
25204           {
25205             "group": "Body",
25206             "type": "String",
25207             "optional": true,
25208             "field": "leaveAt",
25209             "description": ""
25210           },
25211           {
25212             "group": "Body",
25213             "type": "Boolean",
25214             "optional": true,
25215             "field": "bot",
25216             "description": ""
25217           }
25218         ]
25219       }
25220     },
25221     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25222     "version": "0.0.0",
25223     "filename": "server/api/squareReport/index.js",
25224     "groupTitle": "Square_Reports"
25225   },
25226   {
25227     "type": "delete",
25228     "url": "/api/square/reports/{id}",
25229     "title": "Deletes a Square Report",
25230     "examples": [
25231       {
25232         "title": "Example usage:",
25233         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25234         "type": "json"
25235       }
25236     ],
25237     "name": "DeleteSquare_Reports",
25238     "group": "Square_Reports",
25239     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25240     "version": "0.0.0",
25241     "filename": "server/api/squareReport/index.js",
25242     "groupTitle": "Square_Reports"
25243   },
25244   {
25245     "type": "get",
25246     "url": "/api/square/reports/describe",
25247     "title": "Gets table info about Square Reports",
25248     "examples": [
25249       {
25250         "title": "Example usage:",
25251         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25252         "type": "json"
25253       }
25254     ],
25255     "name": "DescribeSquare_Reports",
25256     "group": "Square_Reports",
25257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25258     "version": "0.0.0",
25259     "filename": "server/api/squareReport/index.js",
25260     "groupTitle": "Square_Reports"
25261   },
25262   {
25263     "type": "get",
25264     "url": "/api/square/reports",
25265     "title": "Gets a list of Square Reports",
25266     "examples": [
25267       {
25268         "title": "Example usage:",
25269         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25270         "type": "json"
25271       }
25272     ],
25273     "name": "GetSquare_Reports",
25274     "group": "Square_Reports",
25275     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25276     "version": "0.0.0",
25277     "filename": "server/api/squareReport/index.js",
25278     "groupTitle": "Square_Reports"
25279   },
25280   {
25281     "type": "get",
25282     "url": "/api/square/reports/{id}",
25283     "title": "Gets a single Square Report",
25284     "examples": [
25285       {
25286         "title": "Example usage:",
25287         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25288         "type": "json"
25289       }
25290     ],
25291     "name": "ShowSquare_Reports",
25292     "group": "Square_Reports",
25293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25294     "version": "0.0.0",
25295     "filename": "server/api/squareReport/index.js",
25296     "groupTitle": "Square_Reports"
25297   },
25298   {
25299     "type": "put",
25300     "url": "/api/square/reports/{id}",
25301     "title": "Update an existing Square Report",
25302     "examples": [
25303       {
25304         "title": "Example usage:",
25305         "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",
25306         "type": "json"
25307       }
25308     ],
25309     "name": "updateSquare_Reports",
25310     "group": "Square_Reports",
25311     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25312     "version": "0.0.0",
25313     "filename": "server/api/squareReport/index.js",
25314     "groupTitle": "Square_Reports"
25315   },
25316   {
25317     "type": "post",
25318     "url": "/api/integrations/sugarcrm/configurations",
25319     "title": "Creates a new SugarCRM Configuration",
25320     "examples": [
25321       {
25322         "title": "Example usage:",
25323         "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",
25324         "type": "json"
25325       }
25326     ],
25327     "name": "CreateSugarCRM_Configurations",
25328     "group": "SugarCRM_Configurations",
25329     "parameter": {
25330       "fields": {
25331         "Body": [
25332           {
25333             "group": "Body",
25334             "type": "String",
25335             "optional": true,
25336             "field": "name",
25337             "description": ""
25338           },
25339           {
25340             "group": "Body",
25341             "type": "String",
25342             "optional": true,
25343             "field": "description",
25344             "description": ""
25345           }
25346         ]
25347       }
25348     },
25349     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25350     "version": "0.0.0",
25351     "filename": "server/api/intSugarcrmConfiguration/index.js",
25352     "groupTitle": "SugarCRM_Configurations"
25353   },
25354   {
25355     "type": "delete",
25356     "url": "/api/integrations/sugarcrm/configurations/{id}",
25357     "title": "Deletes a SugarCRM Configuration",
25358     "examples": [
25359       {
25360         "title": "Example usage:",
25361         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25362         "type": "json"
25363       }
25364     ],
25365     "name": "DeleteSugarCRM_Configurations",
25366     "group": "SugarCRM_Configurations",
25367     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25368     "version": "0.0.0",
25369     "filename": "server/api/intSugarcrmConfiguration/index.js",
25370     "groupTitle": "SugarCRM_Configurations"
25371   },
25372   {
25373     "type": "get",
25374     "url": "/api/integrations/sugarcrm/configurations",
25375     "title": "Gets a list of SugarCRM Configurations",
25376     "examples": [
25377       {
25378         "title": "Example usage:",
25379         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25380         "type": "json"
25381       }
25382     ],
25383     "name": "GetSugarCRM_Configurations",
25384     "group": "SugarCRM_Configurations",
25385     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25386     "version": "0.0.0",
25387     "filename": "server/api/intSugarcrmConfiguration/index.js",
25388     "groupTitle": "SugarCRM_Configurations"
25389   },
25390   {
25391     "type": "get",
25392     "url": "/api/integrations/sugarcrm/configurations/{id}",
25393     "title": "Gets a single SugarCRM Configuration",
25394     "examples": [
25395       {
25396         "title": "Example usage:",
25397         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25398         "type": "json"
25399       }
25400     ],
25401     "name": "ShowSugarCRM_Configurations",
25402     "group": "SugarCRM_Configurations",
25403     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25404     "version": "0.0.0",
25405     "filename": "server/api/intSugarcrmConfiguration/index.js",
25406     "groupTitle": "SugarCRM_Configurations"
25407   },
25408   {
25409     "type": "put",
25410     "url": "/api/integrations/sugarcrm/configurations/{id}",
25411     "title": "Update an existing SugarCRM Configuration",
25412     "examples": [
25413       {
25414         "title": "Example usage:",
25415         "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",
25416         "type": "json"
25417       }
25418     ],
25419     "name": "updateSugarCRM_Configurations",
25420     "group": "SugarCRM_Configurations",
25421     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25422     "version": "0.0.0",
25423     "filename": "server/api/intSugarcrmConfiguration/index.js",
25424     "groupTitle": "SugarCRM_Configurations"
25425   },
25426   {
25427     "type": "post",
25428     "url": "/api/integrations/sugarcrm/accounts",
25429     "title": "Creates a new Sugarcrm Account",
25430     "examples": [
25431       {
25432         "title": "Example usage:",
25433         "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",
25434         "type": "json"
25435       }
25436     ],
25437     "name": "CreateSugarcrm_Accounts",
25438     "group": "Sugarcrm_Accounts",
25439     "parameter": {
25440       "fields": {
25441         "Body": [
25442           {
25443             "group": "Body",
25444             "type": "String",
25445             "optional": true,
25446             "field": "name",
25447             "description": ""
25448           },
25449           {
25450             "group": "Body",
25451             "type": "String",
25452             "optional": true,
25453             "field": "description",
25454             "description": ""
25455           },
25456           {
25457             "group": "Body",
25458             "type": "String",
25459             "optional": true,
25460             "field": "username",
25461             "description": ""
25462           },
25463           {
25464             "group": "Body",
25465             "type": "String",
25466             "optional": true,
25467             "field": "password",
25468             "description": ""
25469           },
25470           {
25471             "group": "Body",
25472             "type": "String",
25473             "optional": true,
25474             "field": "remoteUri",
25475             "description": ""
25476           },
25477           {
25478             "group": "Body",
25479             "type": "String",
25480             "optional": false,
25481             "field": "serverUrl",
25482             "description": ""
25483           }
25484         ]
25485       }
25486     },
25487     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25488     "version": "0.0.0",
25489     "filename": "server/api/intSugarcrmAccount/index.js",
25490     "groupTitle": "Sugarcrm_Accounts"
25491   },
25492   {
25493     "type": "delete",
25494     "url": "/api/integrations/sugarcrm/accounts/{id}",
25495     "title": "Deletes a Sugarcrm Account",
25496     "examples": [
25497       {
25498         "title": "Example usage:",
25499         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25500         "type": "json"
25501       }
25502     ],
25503     "name": "DeleteSugarcrm_Accounts",
25504     "group": "Sugarcrm_Accounts",
25505     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25506     "version": "0.0.0",
25507     "filename": "server/api/intSugarcrmAccount/index.js",
25508     "groupTitle": "Sugarcrm_Accounts"
25509   },
25510   {
25511     "type": "get",
25512     "url": "/api/integrations/sugarcrm/accounts",
25513     "title": "Gets a list of Sugarcrm Accounts",
25514     "examples": [
25515       {
25516         "title": "Example usage:",
25517         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25518         "type": "json"
25519       }
25520     ],
25521     "name": "GetSugarcrm_Accounts",
25522     "group": "Sugarcrm_Accounts",
25523     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25524     "version": "0.0.0",
25525     "filename": "server/api/intSugarcrmAccount/index.js",
25526     "groupTitle": "Sugarcrm_Accounts"
25527   },
25528   {
25529     "type": "get",
25530     "url": "/api/integrations/sugarcrm/accounts/{id}",
25531     "title": "Gets a single Sugarcrm Account",
25532     "examples": [
25533       {
25534         "title": "Example usage:",
25535         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25536         "type": "json"
25537       }
25538     ],
25539     "name": "ShowSugarcrm_Accounts",
25540     "group": "Sugarcrm_Accounts",
25541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25542     "version": "0.0.0",
25543     "filename": "server/api/intSugarcrmAccount/index.js",
25544     "groupTitle": "Sugarcrm_Accounts"
25545   },
25546   {
25547     "type": "post",
25548     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25549     "title": "Creates new configuration",
25550     "examples": [
25551       {
25552         "title": "Example usage:",
25553         "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",
25554         "type": "json"
25555       }
25556     ],
25557     "name": "addConfiguration",
25558     "group": "Sugarcrm_Accounts",
25559     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25560     "version": "0.0.0",
25561     "filename": "server/api/intSugarcrmAccount/index.js",
25562     "groupTitle": "Sugarcrm_Accounts"
25563   },
25564   {
25565     "type": "get",
25566     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25567     "title": "Gets account configurations",
25568     "examples": [
25569       {
25570         "title": "Example usage:",
25571         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25572         "type": "json"
25573       }
25574     ],
25575     "name": "getConfigurations",
25576     "group": "Sugarcrm_Accounts",
25577     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25578     "version": "0.0.0",
25579     "filename": "server/api/intSugarcrmAccount/index.js",
25580     "groupTitle": "Sugarcrm_Accounts"
25581   },
25582   {
25583     "type": "get",
25584     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25585     "title": "Gets account fields",
25586     "examples": [
25587       {
25588         "title": "Example usage:",
25589         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25590         "type": "json"
25591       }
25592     ],
25593     "name": "getFields",
25594     "group": "Sugarcrm_Accounts",
25595     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25596     "version": "0.0.0",
25597     "filename": "server/api/intSugarcrmAccount/index.js",
25598     "groupTitle": "Sugarcrm_Accounts"
25599   },
25600   {
25601     "type": "put",
25602     "url": "/api/integrations/sugarcrm/accounts/{id}",
25603     "title": "Update an existing Sugarcrm Account",
25604     "examples": [
25605       {
25606         "title": "Example usage:",
25607         "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",
25608         "type": "json"
25609       }
25610     ],
25611     "name": "updateSugarcrm_Accounts",
25612     "group": "Sugarcrm_Accounts",
25613     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25614     "version": "0.0.0",
25615     "filename": "server/api/intSugarcrmAccount/index.js",
25616     "groupTitle": "Sugarcrm_Accounts"
25617   },
25618   {
25619     "type": "get",
25620     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25621     "title": "Gets configurations descriptions",
25622     "examples": [
25623       {
25624         "title": "Example usage:",
25625         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25626         "type": "json"
25627       }
25628     ],
25629     "name": "getDescriptions",
25630     "group": "Sugarcrm_Configurations",
25631     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25632     "version": "0.0.0",
25633     "filename": "server/api/intSugarcrmConfiguration/index.js",
25634     "groupTitle": "Sugarcrm_Configurations"
25635   },
25636   {
25637     "type": "get",
25638     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25639     "title": "Gets configurations fields",
25640     "examples": [
25641       {
25642         "title": "Example usage:",
25643         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25644         "type": "json"
25645       }
25646     ],
25647     "name": "getFields",
25648     "group": "Sugarcrm_Configurations",
25649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25650     "version": "0.0.0",
25651     "filename": "server/api/intSugarcrmConfiguration/index.js",
25652     "groupTitle": "Sugarcrm_Configurations"
25653   },
25654   {
25655     "type": "get",
25656     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25657     "title": "Gets configurations subjects",
25658     "examples": [
25659       {
25660         "title": "Example usage:",
25661         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25662         "type": "json"
25663       }
25664     ],
25665     "name": "getSubjects",
25666     "group": "Sugarcrm_Configurations",
25667     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25668     "version": "0.0.0",
25669     "filename": "server/api/intSugarcrmConfiguration/index.js",
25670     "groupTitle": "Sugarcrm_Configurations"
25671   },
25672   {
25673     "type": "post",
25674     "url": "/api/integrations/sugarcrm/fields",
25675     "title": "Creates a new Sugarcrm Field",
25676     "examples": [
25677       {
25678         "title": "Example usage:",
25679         "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",
25680         "type": "json"
25681       }
25682     ],
25683     "name": "CreateSugarcrm_Fields",
25684     "group": "Sugarcrm_Fields",
25685     "parameter": {
25686       "fields": {
25687         "Body": [
25688           {
25689             "group": "Body",
25690             "type": "String",
25691             "allowedValues": [
25692               "\"string\"",
25693               "\"variable\"",
25694               "\"customVariable\"",
25695               "\"keyValue\"",
25696               "\"picklist\""
25697             ],
25698             "optional": true,
25699             "field": "type",
25700             "description": ""
25701           },
25702           {
25703             "group": "Body",
25704             "type": "String",
25705             "optional": true,
25706             "field": "content",
25707             "description": ""
25708           },
25709           {
25710             "group": "Body",
25711             "type": "String",
25712             "optional": true,
25713             "field": "key",
25714             "description": ""
25715           },
25716           {
25717             "group": "Body",
25718             "type": "String",
25719             "allowedValues": [
25720               "\"string\"",
25721               "\"variable\"",
25722               "\"customVariable\""
25723             ],
25724             "optional": true,
25725             "field": "keyType",
25726             "description": ""
25727           },
25728           {
25729             "group": "Body",
25730             "type": "String",
25731             "optional": true,
25732             "field": "keyContent",
25733             "description": ""
25734           },
25735           {
25736             "group": "Body",
25737             "type": "String",
25738             "optional": true,
25739             "field": "idField",
25740             "description": ""
25741           },
25742           {
25743             "group": "Body",
25744             "type": "String",
25745             "optional": true,
25746             "field": "nameField",
25747             "description": ""
25748           },
25749           {
25750             "group": "Body",
25751             "type": "Boolean",
25752             "optional": true,
25753             "field": "customField",
25754             "description": ""
25755           },
25756           {
25757             "group": "Body",
25758             "type": "String",
25759             "optional": true,
25760             "field": "variableName",
25761             "description": ""
25762           }
25763         ]
25764       }
25765     },
25766     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25767     "version": "0.0.0",
25768     "filename": "server/api/intSugarcrmField/index.js",
25769     "groupTitle": "Sugarcrm_Fields"
25770   },
25771   {
25772     "type": "delete",
25773     "url": "/api/integrations/sugarcrm/fields/{id}",
25774     "title": "Deletes a Sugarcrm Field",
25775     "examples": [
25776       {
25777         "title": "Example usage:",
25778         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25779         "type": "json"
25780       }
25781     ],
25782     "name": "DeleteSugarcrm_Fields",
25783     "group": "Sugarcrm_Fields",
25784     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25785     "version": "0.0.0",
25786     "filename": "server/api/intSugarcrmField/index.js",
25787     "groupTitle": "Sugarcrm_Fields"
25788   },
25789   {
25790     "type": "get",
25791     "url": "/api/integrations/sugarcrm/fields",
25792     "title": "Gets a list of Sugarcrm Fields",
25793     "examples": [
25794       {
25795         "title": "Example usage:",
25796         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25797         "type": "json"
25798       }
25799     ],
25800     "name": "GetSugarcrm_Fields",
25801     "group": "Sugarcrm_Fields",
25802     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25803     "version": "0.0.0",
25804     "filename": "server/api/intSugarcrmField/index.js",
25805     "groupTitle": "Sugarcrm_Fields"
25806   },
25807   {
25808     "type": "get",
25809     "url": "/api/integrations/sugarcrm/fields/{id}",
25810     "title": "Gets a single Sugarcrm Field",
25811     "examples": [
25812       {
25813         "title": "Example usage:",
25814         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25815         "type": "json"
25816       }
25817     ],
25818     "name": "ShowSugarcrm_Fields",
25819     "group": "Sugarcrm_Fields",
25820     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25821     "version": "0.0.0",
25822     "filename": "server/api/intSugarcrmField/index.js",
25823     "groupTitle": "Sugarcrm_Fields"
25824   },
25825   {
25826     "type": "put",
25827     "url": "/api/integrations/sugarcrm/fields/{id}",
25828     "title": "Update an existing Sugarcrm Field",
25829     "examples": [
25830       {
25831         "title": "Example usage:",
25832         "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",
25833         "type": "json"
25834       }
25835     ],
25836     "name": "updateSugarcrm_Fields",
25837     "group": "Sugarcrm_Fields",
25838     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25839     "version": "0.0.0",
25840     "filename": "server/api/intSugarcrmField/index.js",
25841     "groupTitle": "Sugarcrm_Fields"
25842   },
25843   {
25844     "type": "get",
25845     "url": "/api/system",
25846     "title": "Gets system information",
25847     "examples": [
25848       {
25849         "title": "Example usage:",
25850         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25851         "type": "json"
25852       }
25853     ],
25854     "name": "GetSystemInformation",
25855     "group": "System_Information",
25856     "description": "<p>Motion returns the system information.</p>",
25857     "version": "0.0.0",
25858     "filename": "server/api/system/index.js",
25859     "groupTitle": "System_Information"
25860   },
25861   {
25862     "type": "get",
25863     "url": "/api/system/process",
25864     "title": "Gets system information",
25865     "examples": [
25866       {
25867         "title": "Example usage:",
25868         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25869         "type": "json"
25870       }
25871     ],
25872     "name": "GetSystemInformation",
25873     "group": "System_Information",
25874     "description": "<p>Motion returns the system information.</p>",
25875     "version": "0.0.0",
25876     "filename": "server/api/system/index.js",
25877     "groupTitle": "System_Information"
25878   },
25879   {
25880     "type": "post",
25881     "url": "/api/tags",
25882     "title": "Creates a new Tag",
25883     "examples": [
25884       {
25885         "title": "Example usage:",
25886         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25887         "type": "json"
25888       }
25889     ],
25890     "name": "CreateTags",
25891     "group": "Tags",
25892     "parameter": {
25893       "fields": {
25894         "Body": [
25895           {
25896             "group": "Body",
25897             "type": "String",
25898             "optional": false,
25899             "field": "name",
25900             "description": ""
25901           },
25902           {
25903             "group": "Body",
25904             "type": "String",
25905             "optional": true,
25906             "field": "color",
25907             "description": ""
25908           },
25909           {
25910             "group": "Body",
25911             "type": "String",
25912             "optional": true,
25913             "field": "description",
25914             "description": ""
25915           }
25916         ]
25917       }
25918     },
25919     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25920     "version": "0.0.0",
25921     "filename": "server/api/tag/index.js",
25922     "groupTitle": "Tags"
25923   },
25924   {
25925     "type": "delete",
25926     "url": "/api/tags/{id}",
25927     "title": "Deletes a Tag",
25928     "examples": [
25929       {
25930         "title": "Example usage:",
25931         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25932         "type": "json"
25933       }
25934     ],
25935     "name": "DeleteTags",
25936     "group": "Tags",
25937     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25938     "version": "0.0.0",
25939     "filename": "server/api/tag/index.js",
25940     "groupTitle": "Tags"
25941   },
25942   {
25943     "type": "get",
25944     "url": "/api/tags",
25945     "title": "Gets a list of Tags",
25946     "examples": [
25947       {
25948         "title": "Example usage:",
25949         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25950         "type": "json"
25951       }
25952     ],
25953     "name": "GetTags",
25954     "group": "Tags",
25955     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25956     "version": "0.0.0",
25957     "filename": "server/api/tag/index.js",
25958     "groupTitle": "Tags"
25959   },
25960   {
25961     "type": "get",
25962     "url": "/api/tags/{id}",
25963     "title": "Gets a single Tag",
25964     "examples": [
25965       {
25966         "title": "Example usage:",
25967         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25968         "type": "json"
25969       }
25970     ],
25971     "name": "ShowTags",
25972     "group": "Tags",
25973     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25974     "version": "0.0.0",
25975     "filename": "server/api/tag/index.js",
25976     "groupTitle": "Tags"
25977   },
25978   {
25979     "type": "put",
25980     "url": "/api/tags/{id}",
25981     "title": "Update an existing Tag",
25982     "examples": [
25983       {
25984         "title": "Example usage:",
25985         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25986         "type": "json"
25987       }
25988     ],
25989     "name": "updateTags",
25990     "group": "Tags",
25991     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25992     "version": "0.0.0",
25993     "filename": "server/api/tag/index.js",
25994     "groupTitle": "Tags"
25995   },
25996   {
25997     "type": "post",
25998     "url": "/api/teams/{id}/queues",
25999     "title": "Add queues to a team",
26000     "examples": [
26001       {
26002         "title": "Example usage:",
26003         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26004         "type": "json"
26005       }
26006     ],
26007     "name": "AddQueues",
26008     "group": "Teams",
26009     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26010     "version": "0.0.0",
26011     "filename": "server/api/team/index.js",
26012     "groupTitle": "Teams"
26013   },
26014   {
26015     "type": "post",
26016     "url": "/api/teams",
26017     "title": "Creates a new Team",
26018     "examples": [
26019       {
26020         "title": "Example usage:",
26021         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26022         "type": "json"
26023       }
26024     ],
26025     "name": "CreateTeams",
26026     "group": "Teams",
26027     "parameter": {
26028       "fields": {
26029         "Body": [
26030           {
26031             "group": "Body",
26032             "type": "String",
26033             "optional": false,
26034             "field": "name",
26035             "description": ""
26036           },
26037           {
26038             "group": "Body",
26039             "type": "String",
26040             "optional": true,
26041             "field": "description",
26042             "description": ""
26043           }
26044         ]
26045       }
26046     },
26047     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26048     "version": "0.0.0",
26049     "filename": "server/api/team/index.js",
26050     "groupTitle": "Teams"
26051   },
26052   {
26053     "type": "delete",
26054     "url": "/api/teams/{id}",
26055     "title": "Deletes a Team",
26056     "examples": [
26057       {
26058         "title": "Example usage:",
26059         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26060         "type": "json"
26061       }
26062     ],
26063     "name": "DeleteTeams",
26064     "group": "Teams",
26065     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26066     "version": "0.0.0",
26067     "filename": "server/api/team/index.js",
26068     "groupTitle": "Teams"
26069   },
26070   {
26071     "type": "get",
26072     "url": "/api/teams/{id}/users",
26073     "title": "Gets agents from team",
26074     "examples": [
26075       {
26076         "title": "Example usage:",
26077         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26078         "type": "json"
26079       }
26080     ],
26081     "name": "GetAgents",
26082     "group": "Teams",
26083     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26084     "version": "0.0.0",
26085     "filename": "server/api/team/index.js",
26086     "groupTitle": "Teams"
26087   },
26088   {
26089     "type": "get",
26090     "url": "/api/teams/{id}/queues?channel={channel}",
26091     "title": "Gets Queues list",
26092     "examples": [
26093       {
26094         "title": "Example usage:",
26095         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26096         "type": "json"
26097       }
26098     ],
26099     "name": "GetQueues",
26100     "group": "Teams",
26101     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26102     "version": "0.0.0",
26103     "filename": "server/api/team/index.js",
26104     "groupTitle": "Teams"
26105   },
26106   {
26107     "type": "get",
26108     "url": "/api/teams",
26109     "title": "Gets a list of Teams",
26110     "examples": [
26111       {
26112         "title": "Example usage:",
26113         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26114         "type": "json"
26115       }
26116     ],
26117     "name": "GetTeams",
26118     "group": "Teams",
26119     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26120     "version": "0.0.0",
26121     "filename": "server/api/team/index.js",
26122     "groupTitle": "Teams"
26123   },
26124   {
26125     "type": "delete",
26126     "url": "/api/teams/{id}/users",
26127     "title": "Removes agents from a team",
26128     "examples": [
26129       {
26130         "title": "Example usage:",
26131         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26132         "type": "json"
26133       }
26134     ],
26135     "name": "RemoveAgents",
26136     "group": "Teams",
26137     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26138     "version": "0.0.0",
26139     "filename": "server/api/team/index.js",
26140     "groupTitle": "Teams"
26141   },
26142   {
26143     "type": "delete",
26144     "url": "/api/teams/{id}/queues",
26145     "title": "Remove queues to a team",
26146     "examples": [
26147       {
26148         "title": "Example usage:",
26149         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26150         "type": "json"
26151       }
26152     ],
26153     "name": "RemoveQueues",
26154     "group": "Teams",
26155     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26156     "version": "0.0.0",
26157     "filename": "server/api/team/index.js",
26158     "groupTitle": "Teams"
26159   },
26160   {
26161     "type": "delete",
26162     "url": "/api/chat/queues/{id}/teams",
26163     "title": "Remove teams from a queue",
26164     "examples": [
26165       {
26166         "title": "Example usage:",
26167         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26168         "type": "json"
26169       }
26170     ],
26171     "name": "RemoveTeams",
26172     "group": "Teams",
26173     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26174     "version": "0.0.0",
26175     "filename": "server/api/chatQueue/index.js",
26176     "groupTitle": "Teams"
26177   },
26178   {
26179     "type": "delete",
26180     "url": "/api/fax/queues/{id}/teams",
26181     "title": "Remove teams from a queue",
26182     "examples": [
26183       {
26184         "title": "Example usage:",
26185         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26186         "type": "json"
26187       }
26188     ],
26189     "name": "RemoveTeams",
26190     "group": "Teams",
26191     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26192     "version": "0.0.0",
26193     "filename": "server/api/faxQueue/index.js",
26194     "groupTitle": "Teams"
26195   },
26196   {
26197     "type": "delete",
26198     "url": "/api/mail/queues/{id}/teams",
26199     "title": "Remove teams from a queue",
26200     "examples": [
26201       {
26202         "title": "Example usage:",
26203         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26204         "type": "json"
26205       }
26206     ],
26207     "name": "RemoveTeams",
26208     "group": "Teams",
26209     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26210     "version": "0.0.0",
26211     "filename": "server/api/mailQueue/index.js",
26212     "groupTitle": "Teams"
26213   },
26214   {
26215     "type": "delete",
26216     "url": "/api/sms/queues/{id}/teams",
26217     "title": "Remove teams from a queue",
26218     "examples": [
26219       {
26220         "title": "Example usage:",
26221         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26222         "type": "json"
26223       }
26224     ],
26225     "name": "RemoveTeams",
26226     "group": "Teams",
26227     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26228     "version": "0.0.0",
26229     "filename": "server/api/smsQueue/index.js",
26230     "groupTitle": "Teams"
26231   },
26232   {
26233     "type": "delete",
26234     "url": "/api/whatsapp/queues/{id}/teams",
26235     "title": "Remove teams from a queue",
26236     "examples": [
26237       {
26238         "title": "Example usage:",
26239         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26240         "type": "json"
26241       }
26242     ],
26243     "name": "RemoveTeams",
26244     "group": "Teams",
26245     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26246     "version": "0.0.0",
26247     "filename": "server/api/whatsappQueue/index.js",
26248     "groupTitle": "Teams"
26249   },
26250   {
26251     "type": "delete",
26252     "url": "/api/openchannel/queues/{id}/teams",
26253     "title": "Remove teams from a queue",
26254     "examples": [
26255       {
26256         "title": "Example usage:",
26257         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26258         "type": "json"
26259       }
26260     ],
26261     "name": "RemoveTeams",
26262     "group": "Teams",
26263     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26264     "version": "0.0.0",
26265     "filename": "server/api/openchannelQueue/index.js",
26266     "groupTitle": "Teams"
26267   },
26268   {
26269     "type": "delete",
26270     "url": "/api/voice/queues/{id}/teams",
26271     "title": "Remove teams from a queue",
26272     "examples": [
26273       {
26274         "title": "Example usage:",
26275         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26276         "type": "json"
26277       }
26278     ],
26279     "name": "RemoveTeams",
26280     "group": "Teams",
26281     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26282     "version": "0.0.0",
26283     "filename": "server/api/voiceQueue/index.js",
26284     "groupTitle": "Teams"
26285   },
26286   {
26287     "type": "get",
26288     "url": "/api/teams/{id}",
26289     "title": "Gets a single Team",
26290     "examples": [
26291       {
26292         "title": "Example usage:",
26293         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26294         "type": "json"
26295       }
26296     ],
26297     "name": "ShowTeams",
26298     "group": "Teams",
26299     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26300     "version": "0.0.0",
26301     "filename": "server/api/team/index.js",
26302     "groupTitle": "Teams"
26303   },
26304   {
26305     "type": "post",
26306     "url": "/api/teams/{id}/users",
26307     "title": "Adds agents to a team",
26308     "examples": [
26309       {
26310         "title": "Example usage:",
26311         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26312         "type": "json"
26313       }
26314     ],
26315     "name": "addAgents",
26316     "group": "Teams",
26317     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26318     "version": "0.0.0",
26319     "filename": "server/api/team/index.js",
26320     "groupTitle": "Teams"
26321   },
26322   {
26323     "type": "put",
26324     "url": "/api/teams/{id}",
26325     "title": "Update an existing Team",
26326     "examples": [
26327       {
26328         "title": "Example usage:",
26329         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26330         "type": "json"
26331       }
26332     ],
26333     "name": "updateTeams",
26334     "group": "Teams",
26335     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26336     "version": "0.0.0",
26337     "filename": "server/api/team/index.js",
26338     "groupTitle": "Teams"
26339   },
26340   {
26341     "type": "post",
26342     "url": "/api/templates",
26343     "title": "Creates a new Template",
26344     "examples": [
26345       {
26346         "title": "Example usage:",
26347         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26348         "type": "json"
26349       }
26350     ],
26351     "name": "CreateTemplates",
26352     "group": "Templates",
26353     "parameter": {
26354       "fields": {
26355         "Body": [
26356           {
26357             "group": "Body",
26358             "type": "String",
26359             "optional": true,
26360             "field": "name",
26361             "description": ""
26362           },
26363           {
26364             "group": "Body",
26365             "type": "String",
26366             "optional": true,
26367             "field": "description",
26368             "description": ""
26369           },
26370           {
26371             "group": "Body",
26372             "type": "Text",
26373             "optional": true,
26374             "field": "html",
26375             "description": ""
26376           }
26377         ]
26378       }
26379     },
26380     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26381     "version": "0.0.0",
26382     "filename": "server/api/template/index.js",
26383     "groupTitle": "Templates"
26384   },
26385   {
26386     "type": "delete",
26387     "url": "/api/templates/{id}",
26388     "title": "Deletes a Template",
26389     "examples": [
26390       {
26391         "title": "Example usage:",
26392         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26393         "type": "json"
26394       }
26395     ],
26396     "name": "DeleteTemplates",
26397     "group": "Templates",
26398     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/template/index.js",
26401     "groupTitle": "Templates"
26402   },
26403   {
26404     "type": "get",
26405     "url": "/api/templates",
26406     "title": "Gets a list of Templates",
26407     "examples": [
26408       {
26409         "title": "Example usage:",
26410         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26411         "type": "json"
26412       }
26413     ],
26414     "name": "GetTemplates",
26415     "group": "Templates",
26416     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26417     "version": "0.0.0",
26418     "filename": "server/api/template/index.js",
26419     "groupTitle": "Templates"
26420   },
26421   {
26422     "type": "get",
26423     "url": "/api/templates/{id}",
26424     "title": "Gets a single Template",
26425     "examples": [
26426       {
26427         "title": "Example usage:",
26428         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26429         "type": "json"
26430       }
26431     ],
26432     "name": "ShowTemplates",
26433     "group": "Templates",
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/template/index.js",
26437     "groupTitle": "Templates"
26438   },
26439   {
26440     "type": "put",
26441     "url": "/api/templates/{id}",
26442     "title": "Update an existing Template",
26443     "examples": [
26444       {
26445         "title": "Example usage:",
26446         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26447         "type": "json"
26448       }
26449     ],
26450     "name": "updateTemplates",
26451     "group": "Templates",
26452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26453     "version": "0.0.0",
26454     "filename": "server/api/template/index.js",
26455     "groupTitle": "Templates"
26456   },
26457   {
26458     "type": "post",
26459     "url": "/api/triggers",
26460     "title": "Creates a new Trigger",
26461     "examples": [
26462       {
26463         "title": "Example usage:",
26464         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26465         "type": "json"
26466       }
26467     ],
26468     "name": "CreateTriggers",
26469     "group": "Triggers",
26470     "parameter": {
26471       "fields": {
26472         "Body": [
26473           {
26474             "group": "Body",
26475             "type": "String",
26476             "optional": true,
26477             "field": "name",
26478             "description": ""
26479           },
26480           {
26481             "group": "Body",
26482             "type": "String",
26483             "optional": true,
26484             "field": "channel",
26485             "description": ""
26486           },
26487           {
26488             "group": "Body",
26489             "type": "String",
26490             "optional": true,
26491             "field": "description",
26492             "description": ""
26493           },
26494           {
26495             "group": "Body",
26496             "type": "Boolean",
26497             "optional": true,
26498             "field": "status",
26499             "description": ""
26500           }
26501         ]
26502       }
26503     },
26504     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26505     "version": "0.0.0",
26506     "filename": "server/api/trigger/index.js",
26507     "groupTitle": "Triggers"
26508   },
26509   {
26510     "type": "delete",
26511     "url": "/api/triggers/{id}",
26512     "title": "Deletes a Trigger",
26513     "examples": [
26514       {
26515         "title": "Example usage:",
26516         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26517         "type": "json"
26518       }
26519     ],
26520     "name": "DeleteTriggers",
26521     "group": "Triggers",
26522     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26523     "version": "0.0.0",
26524     "filename": "server/api/trigger/index.js",
26525     "groupTitle": "Triggers"
26526   },
26527   {
26528     "type": "get",
26529     "url": "/api/triggers",
26530     "title": "Gets a list of Triggers",
26531     "examples": [
26532       {
26533         "title": "Example usage:",
26534         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26535         "type": "json"
26536       }
26537     ],
26538     "name": "GetTriggers",
26539     "group": "Triggers",
26540     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26541     "version": "0.0.0",
26542     "filename": "server/api/trigger/index.js",
26543     "groupTitle": "Triggers"
26544   },
26545   {
26546     "type": "get",
26547     "url": "/api/triggers/{id}",
26548     "title": "Gets a single Trigger",
26549     "examples": [
26550       {
26551         "title": "Example usage:",
26552         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26553         "type": "json"
26554       }
26555     ],
26556     "name": "ShowTriggers",
26557     "group": "Triggers",
26558     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26559     "version": "0.0.0",
26560     "filename": "server/api/trigger/index.js",
26561     "groupTitle": "Triggers"
26562   },
26563   {
26564     "type": "post",
26565     "url": "/api/triggers/{id}/actions",
26566     "title": "Creates new actions",
26567     "examples": [
26568       {
26569         "title": "Example usage:",
26570         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26571         "type": "json"
26572       }
26573     ],
26574     "name": "addAction",
26575     "group": "Triggers",
26576     "parameter": {
26577       "fields": {
26578         "Body": [
26579           {
26580             "group": "Body",
26581             "type": "Virtual",
26582             "optional": true,
26583             "field": "name",
26584             "description": ""
26585           },
26586           {
26587             "group": "Body",
26588             "type": "String",
26589             "optional": false,
26590             "field": "action",
26591             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26592           },
26593           {
26594             "group": "Body",
26595             "type": "String",
26596             "optional": true,
26597             "field": "data1",
26598             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26599           },
26600           {
26601             "group": "Body",
26602             "type": "String",
26603             "optional": true,
26604             "field": "data2",
26605             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26606           },
26607           {
26608             "group": "Body",
26609             "type": "String",
26610             "optional": true,
26611             "field": "data3",
26612             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26613           },
26614           {
26615             "group": "Body",
26616             "type": "String",
26617             "optional": true,
26618             "field": "data4",
26619             "description": ""
26620           },
26621           {
26622             "group": "Body",
26623             "type": "String",
26624             "optional": true,
26625             "field": "data5",
26626             "description": ""
26627           },
26628           {
26629             "group": "Body",
26630             "type": "String",
26631             "optional": true,
26632             "field": "data6",
26633             "description": ""
26634           },
26635           {
26636             "group": "Body",
26637             "type": "Text",
26638             "optional": true,
26639             "field": "data7",
26640             "description": ""
26641           }
26642         ]
26643       }
26644     },
26645     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26646     "version": "0.0.0",
26647     "filename": "server/api/trigger/index.js",
26648     "groupTitle": "Triggers"
26649   },
26650   {
26651     "type": "post",
26652     "url": "/api/triggers/{id}/all_conditions",
26653     "title": "Creates a new \"AND\"condition",
26654     "examples": [
26655       {
26656         "title": "Example usage:",
26657         "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",
26658         "type": "json"
26659       }
26660     ],
26661     "name": "addAllCondition",
26662     "group": "Triggers",
26663     "parameter": {
26664       "fields": {
26665         "Body": [
26666           {
26667             "group": "Body",
26668             "type": "Virtual",
26669             "optional": true,
26670             "field": "name",
26671             "description": ""
26672           },
26673           {
26674             "group": "Body",
26675             "type": "String",
26676             "optional": false,
26677             "field": "field",
26678             "description": ""
26679           },
26680           {
26681             "group": "Body",
26682             "type": "String",
26683             "optional": false,
26684             "field": "operator",
26685             "description": ""
26686           },
26687           {
26688             "group": "Body",
26689             "type": "String",
26690             "optional": false,
26691             "field": "value",
26692             "description": ""
26693           }
26694         ]
26695       }
26696     },
26697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26698     "version": "0.0.0",
26699     "filename": "server/api/trigger/index.js",
26700     "groupTitle": "Triggers"
26701   },
26702   {
26703     "type": "post",
26704     "url": "/api/triggers/{id}/any_conditions",
26705     "title": "Creates a new \"OR\"condition",
26706     "examples": [
26707       {
26708         "title": "Example usage:",
26709         "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",
26710         "type": "json"
26711       }
26712     ],
26713     "name": "addAnyCondition",
26714     "group": "Triggers",
26715     "parameter": {
26716       "fields": {
26717         "Body": [
26718           {
26719             "group": "Body",
26720             "type": "Virtual",
26721             "optional": true,
26722             "field": "name",
26723             "description": ""
26724           },
26725           {
26726             "group": "Body",
26727             "type": "String",
26728             "optional": false,
26729             "field": "field",
26730             "description": ""
26731           },
26732           {
26733             "group": "Body",
26734             "type": "String",
26735             "optional": false,
26736             "field": "operator",
26737             "description": ""
26738           },
26739           {
26740             "group": "Body",
26741             "type": "String",
26742             "optional": false,
26743             "field": "value",
26744             "description": ""
26745           }
26746         ]
26747       }
26748     },
26749     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26750     "version": "0.0.0",
26751     "filename": "server/api/trigger/index.js",
26752     "groupTitle": "Triggers"
26753   },
26754   {
26755     "type": "get",
26756     "url": "/api/triggers/{id}/actions",
26757     "title": "Gets Trigger Actions",
26758     "examples": [
26759       {
26760         "title": "Example usage:",
26761         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26762         "type": "json"
26763       }
26764     ],
26765     "name": "getActions",
26766     "group": "Triggers",
26767     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26768     "version": "0.0.0",
26769     "filename": "server/api/trigger/index.js",
26770     "groupTitle": "Triggers"
26771   },
26772   {
26773     "type": "get",
26774     "url": "/api/triggers/{id}/all_conditions",
26775     "title": "Gets \"AND\" Trigger Conditions",
26776     "examples": [
26777       {
26778         "title": "Example usage:",
26779         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26780         "type": "json"
26781       }
26782     ],
26783     "name": "getAllConditions",
26784     "group": "Triggers",
26785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26786     "version": "0.0.0",
26787     "filename": "server/api/trigger/index.js",
26788     "groupTitle": "Triggers"
26789   },
26790   {
26791     "type": "get",
26792     "url": "/api/triggers/{id}/any_conditions",
26793     "title": "Gets \"OR\" Trigger Conditions",
26794     "examples": [
26795       {
26796         "title": "Example usage:",
26797         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26798         "type": "json"
26799       }
26800     ],
26801     "name": "getAnyConditions",
26802     "group": "Triggers",
26803     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26804     "version": "0.0.0",
26805     "filename": "server/api/trigger/index.js",
26806     "groupTitle": "Triggers"
26807   },
26808   {
26809     "type": "put",
26810     "url": "/api/triggers/{id}",
26811     "title": "Update an existing Trigger",
26812     "examples": [
26813       {
26814         "title": "Example usage:",
26815         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26816         "type": "json"
26817       }
26818     ],
26819     "name": "updateTriggers",
26820     "group": "Triggers",
26821     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26822     "version": "0.0.0",
26823     "filename": "server/api/trigger/index.js",
26824     "groupTitle": "Triggers"
26825   },
26826   {
26827     "type": "post",
26828     "url": "/api/trunks/clone",
26829     "title": "Clone an existing Trunk",
26830     "examples": [
26831       {
26832         "title": "Example usage:",
26833         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26834         "type": "json"
26835       }
26836     ],
26837     "name": "CloneTrunks",
26838     "group": "Trunks",
26839     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26840     "version": "0.0.0",
26841     "filename": "server/api/trunk/index.js",
26842     "groupTitle": "Trunks"
26843   },
26844   {
26845     "type": "post",
26846     "url": "/api/trunks",
26847     "title": "Create a new trunk",
26848     "examples": [
26849       {
26850         "title": "Example usage:",
26851         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26852         "type": "json"
26853       }
26854     ],
26855     "name": "Create",
26856     "group": "Trunks",
26857     "parameter": {
26858       "fields": {
26859         "Body": [
26860           {
26861             "group": "Body",
26862             "type": "String",
26863             "optional": false,
26864             "field": "name",
26865             "description": ""
26866           },
26867           {
26868             "group": "Body",
26869             "type": "String",
26870             "allowedValues": [
26871               "\"friend\"",
26872               "\"user\"",
26873               "\"peer\""
26874             ],
26875             "optional": false,
26876             "field": "type",
26877             "description": ""
26878           },
26879           {
26880             "group": "Body",
26881             "type": "String",
26882             "optional": false,
26883             "field": "context",
26884             "description": ""
26885           },
26886           {
26887             "group": "Body",
26888             "type": "String",
26889             "allowedValues": [
26890               "\"ALLOWED_NOT_SCREENED\"",
26891               "\"ALLOWED_PASSED_SCREEN\"",
26892               "\"ALLOWED_FAILED_SCREEN\"",
26893               "\"ALLOWED\"",
26894               "\"PROHIB_NOT_SCREENED\"",
26895               "\"PROHIB_PASSED_SCREEN\"",
26896               "\"PROHIB_FAILED_SCREEN\"",
26897               "\"PROHIB\""
26898             ],
26899             "optional": true,
26900             "field": "callingpres",
26901             "description": ""
26902           },
26903           {
26904             "group": "Body",
26905             "type": "String",
26906             "optional": true,
26907             "field": "deny",
26908             "description": ""
26909           },
26910           {
26911             "group": "Body",
26912             "type": "String",
26913             "optional": true,
26914             "field": "permit",
26915             "description": ""
26916           },
26917           {
26918             "group": "Body",
26919             "type": "String",
26920             "optional": true,
26921             "field": "secret",
26922             "description": ""
26923           },
26924           {
26925             "group": "Body",
26926             "type": "String",
26927             "optional": true,
26928             "field": "md5secret",
26929             "description": ""
26930           },
26931           {
26932             "group": "Body",
26933             "type": "String",
26934             "optional": true,
26935             "field": "remotesecret",
26936             "description": ""
26937           },
26938           {
26939             "group": "Body",
26940             "type": "String",
26941             "optional": true,
26942             "field": "transport",
26943             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
26944           },
26945           {
26946             "group": "Body",
26947             "type": "String",
26948             "allowedValues": [
26949               "\"rfc2833\"",
26950               "\"info\"",
26951               "\"shortinfo\"",
26952               "\"inband\"",
26953               "\"auto\""
26954             ],
26955             "optional": true,
26956             "field": "dtmfmode",
26957             "description": ""
26958           },
26959           {
26960             "group": "Body",
26961             "type": "String",
26962             "allowedValues": [
26963               "\"yes\"",
26964               "\"no\"",
26965               "\"nonat\"",
26966               "\"update\"",
26967               "\"outgoing\""
26968             ],
26969             "optional": true,
26970             "field": "directmedia",
26971             "description": ""
26972           },
26973           {
26974             "group": "Body",
26975             "type": "String",
26976             "allowedValues": [
26977               "\"yes\"",
26978               "\"no\""
26979             ],
26980             "optional": true,
26981             "field": "directrtpsetup",
26982             "description": ""
26983           },
26984           {
26985             "group": "Body",
26986             "type": "String",
26987             "optional": true,
26988             "field": "directmediapermit",
26989             "description": ""
26990           },
26991           {
26992             "group": "Body",
26993             "type": "String",
26994             "optional": true,
26995             "field": "directmediadeny",
26996             "description": ""
26997           },
26998           {
26999             "group": "Body",
27000             "type": "String",
27001             "optional": true,
27002             "field": "nat",
27003             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
27004           },
27005           {
27006             "group": "Body",
27007             "type": "String",
27008             "optional": true,
27009             "field": "callgroup",
27010             "description": ""
27011           },
27012           {
27013             "group": "Body",
27014             "type": "String",
27015             "optional": true,
27016             "field": "namedcallgroup",
27017             "description": ""
27018           },
27019           {
27020             "group": "Body",
27021             "type": "String",
27022             "optional": true,
27023             "field": "pickupgroup",
27024             "description": ""
27025           },
27026           {
27027             "group": "Body",
27028             "type": "String",
27029             "optional": true,
27030             "field": "namedpickupgroup",
27031             "description": ""
27032           },
27033           {
27034             "group": "Body",
27035             "type": "String",
27036             "optional": true,
27037             "field": "language",
27038             "description": ""
27039           },
27040           {
27041             "group": "Body",
27042             "type": "String",
27043             "optional": true,
27044             "field": "tonezone",
27045             "description": ""
27046           },
27047           {
27048             "group": "Body",
27049             "type": "String",
27050             "optional": true,
27051             "field": "disallow",
27052             "description": ""
27053           },
27054           {
27055             "group": "Body",
27056             "type": "String",
27057             "optional": false,
27058             "field": "allow",
27059             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
27060           },
27061           {
27062             "group": "Body",
27063             "type": "String",
27064             "allowedValues": [
27065               "\"yes\"",
27066               "\"no\""
27067             ],
27068             "optional": true,
27069             "field": "autoframing",
27070             "description": ""
27071           },
27072           {
27073             "group": "Body",
27074             "type": "String",
27075             "optional": true,
27076             "field": "insecure",
27077             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
27078           },
27079           {
27080             "group": "Body",
27081             "type": "String",
27082             "allowedValues": [
27083               "\"yes\"",
27084               "\"no\""
27085             ],
27086             "optional": true,
27087             "field": "trustrpid",
27088             "description": ""
27089           },
27090           {
27091             "group": "Body",
27092             "type": "String",
27093             "allowedValues": [
27094               "\"yes\"",
27095               "\"no\""
27096             ],
27097             "optional": true,
27098             "field": "trust_id_outbound",
27099             "description": ""
27100           },
27101           {
27102             "group": "Body",
27103             "type": "String",
27104             "allowedValues": [
27105               "\"yes\"",
27106               "\"no\"",
27107               "\"never\""
27108             ],
27109             "optional": true,
27110             "field": "progressinband",
27111             "description": ""
27112           },
27113           {
27114             "group": "Body",
27115             "type": "String",
27116             "allowedValues": [
27117               "\"yes\"",
27118               "\"no\""
27119             ],
27120             "optional": true,
27121             "field": "promiscredir",
27122             "description": ""
27123           },
27124           {
27125             "group": "Body",
27126             "type": "String",
27127             "allowedValues": [
27128               "\"yes\"",
27129               "\"no\""
27130             ],
27131             "optional": true,
27132             "field": "useclientcode",
27133             "description": ""
27134           },
27135           {
27136             "group": "Body",
27137             "type": "Integer",
27138             "optional": true,
27139             "field": "accountcode",
27140             "description": ""
27141           },
27142           {
27143             "group": "Body",
27144             "type": "String",
27145             "optional": true,
27146             "field": "setvar",
27147             "description": ""
27148           },
27149           {
27150             "group": "Body",
27151             "type": "String",
27152             "optional": true,
27153             "field": "callerid",
27154             "description": ""
27155           },
27156           {
27157             "group": "Body",
27158             "type": "String",
27159             "optional": true,
27160             "field": "amaflags",
27161             "description": ""
27162           },
27163           {
27164             "group": "Body",
27165             "type": "String",
27166             "allowedValues": [
27167               "\"yes\"",
27168               "\"no\""
27169             ],
27170             "optional": true,
27171             "field": "callcounter",
27172             "description": ""
27173           },
27174           {
27175             "group": "Body",
27176             "type": "Integer",
27177             "optional": true,
27178             "field": "busylevel",
27179             "description": ""
27180           },
27181           {
27182             "group": "Body",
27183             "type": "String",
27184             "allowedValues": [
27185               "\"yes\"",
27186               "\"no\""
27187             ],
27188             "optional": true,
27189             "field": "allowoverlap",
27190             "description": ""
27191           },
27192           {
27193             "group": "Body",
27194             "type": "String",
27195             "allowedValues": [
27196               "\"yes\"",
27197               "\"no\""
27198             ],
27199             "optional": true,
27200             "field": "allowsubscribe",
27201             "description": ""
27202           },
27203           {
27204             "group": "Body",
27205             "type": "String",
27206             "allowedValues": [
27207               "\"yes\"",
27208               "\"no\""
27209             ],
27210             "optional": true,
27211             "field": "allowtransfer",
27212             "description": ""
27213           },
27214           {
27215             "group": "Body",
27216             "type": "String",
27217             "allowedValues": [
27218               "\"yes\"",
27219               "\"no\""
27220             ],
27221             "optional": true,
27222             "field": "ignoresdpversion",
27223             "description": ""
27224           },
27225           {
27226             "group": "Body",
27227             "type": "String",
27228             "optional": true,
27229             "field": "subscribecontext",
27230             "description": ""
27231           },
27232           {
27233             "group": "Body",
27234             "type": "String",
27235             "optional": true,
27236             "field": "template",
27237             "description": ""
27238           },
27239           {
27240             "group": "Body",
27241             "type": "String",
27242             "allowedValues": [
27243               "\"yes\"",
27244               "\"no\"",
27245               "\"always\""
27246             ],
27247             "optional": true,
27248             "field": "videosupport",
27249             "description": ""
27250           },
27251           {
27252             "group": "Body",
27253             "type": "Integer",
27254             "optional": true,
27255             "field": "maxcallbitrate",
27256             "description": ""
27257           },
27258           {
27259             "group": "Body",
27260             "type": "String",
27261             "allowedValues": [
27262               "\"yes\"",
27263               "\"no\""
27264             ],
27265             "optional": true,
27266             "field": "rfc2833compensate",
27267             "description": ""
27268           },
27269           {
27270             "group": "Body",
27271             "type": "String",
27272             "optional": true,
27273             "field": "mailbox",
27274             "description": ""
27275           },
27276           {
27277             "group": "Body",
27278             "type": "String",
27279             "allowedValues": [
27280               "\"accept\"",
27281               "\"refuse\"",
27282               "\"originate\""
27283             ],
27284             "optional": true,
27285             "field": "session_timers",
27286             "description": ""
27287           },
27288           {
27289             "group": "Body",
27290             "type": "Integer",
27291             "optional": true,
27292             "field": "session_expires",
27293             "description": ""
27294           },
27295           {
27296             "group": "Body",
27297             "type": "Integer",
27298             "optional": true,
27299             "field": "session_minse",
27300             "description": ""
27301           },
27302           {
27303             "group": "Body",
27304             "type": "String",
27305             "allowedValues": [
27306               "\"uac\"",
27307               "\"uas\""
27308             ],
27309             "optional": true,
27310             "field": "session_refresher",
27311             "description": ""
27312           },
27313           {
27314             "group": "Body",
27315             "type": "String",
27316             "optional": true,
27317             "field": "t38pt_usertpsource",
27318             "description": ""
27319           },
27320           {
27321             "group": "Body",
27322             "type": "String",
27323             "optional": true,
27324             "field": "regexten",
27325             "description": ""
27326           },
27327           {
27328             "group": "Body",
27329             "type": "String",
27330             "optional": true,
27331             "field": "fromdomain",
27332             "description": ""
27333           },
27334           {
27335             "group": "Body",
27336             "type": "String",
27337             "optional": true,
27338             "field": "fromuser",
27339             "description": ""
27340           },
27341           {
27342             "group": "Body",
27343             "type": "Integer",
27344             "optional": true,
27345             "field": "port",
27346             "description": ""
27347           },
27348           {
27349             "group": "Body",
27350             "type": "String",
27351             "allowedValues": [
27352               "\"yes\"",
27353               "\"no\""
27354             ],
27355             "optional": true,
27356             "field": "qualify",
27357             "description": ""
27358           },
27359           {
27360             "group": "Body",
27361             "type": "Integer",
27362             "optional": true,
27363             "field": "keepalive",
27364             "description": ""
27365           },
27366           {
27367             "group": "Body",
27368             "type": "String",
27369             "optional": true,
27370             "field": "defaultip",
27371             "description": ""
27372           },
27373           {
27374             "group": "Body",
27375             "type": "String",
27376             "optional": true,
27377             "field": "defaultuser",
27378             "description": ""
27379           },
27380           {
27381             "group": "Body",
27382             "type": "Integer",
27383             "optional": true,
27384             "field": "rtptimeout",
27385             "description": ""
27386           },
27387           {
27388             "group": "Body",
27389             "type": "Integer",
27390             "optional": true,
27391             "field": "rtpholdtimeout",
27392             "description": ""
27393           },
27394           {
27395             "group": "Body",
27396             "type": "Integer",
27397             "optional": true,
27398             "field": "rtpkeepalive",
27399             "description": ""
27400           },
27401           {
27402             "group": "Body",
27403             "type": "String",
27404             "allowedValues": [
27405               "\"yes\"",
27406               "\"no\"",
27407               "\"pai\""
27408             ],
27409             "optional": true,
27410             "field": "sendrpid",
27411             "description": ""
27412           },
27413           {
27414             "group": "Body",
27415             "type": "String",
27416             "optional": true,
27417             "field": "outboundproxy",
27418             "description": ""
27419           },
27420           {
27421             "group": "Body",
27422             "type": "String",
27423             "optional": true,
27424             "field": "callbackextension",
27425             "description": ""
27426           },
27427           {
27428             "group": "Body",
27429             "type": "Integer",
27430             "optional": true,
27431             "field": "timert1",
27432             "description": ""
27433           },
27434           {
27435             "group": "Body",
27436             "type": "Integer",
27437             "optional": true,
27438             "field": "timerb",
27439             "description": ""
27440           },
27441           {
27442             "group": "Body",
27443             "type": "Integer",
27444             "optional": true,
27445             "field": "qualifyfreq",
27446             "description": ""
27447           },
27448           {
27449             "group": "Body",
27450             "type": "String",
27451             "optional": true,
27452             "field": "contactpermit",
27453             "description": ""
27454           },
27455           {
27456             "group": "Body",
27457             "type": "String",
27458             "optional": true,
27459             "field": "contactdeny",
27460             "description": ""
27461           },
27462           {
27463             "group": "Body",
27464             "type": "String",
27465             "optional": true,
27466             "field": "contactacl",
27467             "description": ""
27468           },
27469           {
27470             "group": "Body",
27471             "type": "String",
27472             "optional": true,
27473             "field": "unsolicited_mailbox",
27474             "description": ""
27475           },
27476           {
27477             "group": "Body",
27478             "type": "String",
27479             "optional": true,
27480             "field": "use_q850_reason",
27481             "description": ""
27482           },
27483           {
27484             "group": "Body",
27485             "type": "Integer",
27486             "optional": true,
27487             "field": "maxforwards",
27488             "description": ""
27489           },
27490           {
27491             "group": "Body",
27492             "type": "String",
27493             "allowedValues": [
27494               "\"yes\"",
27495               "\"no\""
27496             ],
27497             "optional": true,
27498             "field": "encryption",
27499             "description": ""
27500           },
27501           {
27502             "group": "Body",
27503             "type": "String",
27504             "allowedValues": [
27505               "\"yes\"",
27506               "\"no\""
27507             ],
27508             "optional": true,
27509             "field": "avpf",
27510             "description": ""
27511           },
27512           {
27513             "group": "Body",
27514             "type": "String",
27515             "allowedValues": [
27516               "\"yes\"",
27517               "\"no\""
27518             ],
27519             "optional": true,
27520             "field": "force_avp",
27521             "description": ""
27522           },
27523           {
27524             "group": "Body",
27525             "type": "String",
27526             "allowedValues": [
27527               "\"yes\"",
27528               "\"no\""
27529             ],
27530             "optional": true,
27531             "field": "icesupport",
27532             "description": ""
27533           },
27534           {
27535             "group": "Body",
27536             "type": "String",
27537             "allowedValues": [
27538               "\"yes\"",
27539               "\"no\""
27540             ],
27541             "optional": true,
27542             "field": "dtlsenable",
27543             "description": ""
27544           },
27545           {
27546             "group": "Body",
27547             "type": "String",
27548             "allowedValues": [
27549               "\"yes\"",
27550               "\"no\"",
27551               "\"fingerprint\"",
27552               "\"certificate\""
27553             ],
27554             "optional": true,
27555             "field": "dtlsverify",
27556             "description": ""
27557           },
27558           {
27559             "group": "Body",
27560             "type": "Integer",
27561             "optional": true,
27562             "field": "dtlsrekey",
27563             "description": ""
27564           },
27565           {
27566             "group": "Body",
27567             "type": "String",
27568             "optional": true,
27569             "field": "dtlscertfile",
27570             "description": ""
27571           },
27572           {
27573             "group": "Body",
27574             "type": "String",
27575             "optional": true,
27576             "field": "dtlsprivatekey",
27577             "description": ""
27578           },
27579           {
27580             "group": "Body",
27581             "type": "String",
27582             "optional": true,
27583             "field": "dtlscipher",
27584             "description": ""
27585           },
27586           {
27587             "group": "Body",
27588             "type": "String",
27589             "optional": true,
27590             "field": "dtlscafile",
27591             "description": ""
27592           },
27593           {
27594             "group": "Body",
27595             "type": "String",
27596             "optional": true,
27597             "field": "dtlscapath",
27598             "description": ""
27599           },
27600           {
27601             "group": "Body",
27602             "type": "String",
27603             "allowedValues": [
27604               "\"active\"",
27605               "\"passive\"",
27606               "\"actpass\""
27607             ],
27608             "optional": true,
27609             "field": "dtlssetup",
27610             "description": ""
27611           },
27612           {
27613             "group": "Body",
27614             "type": "String",
27615             "optional": true,
27616             "field": "dtlsfingerprint",
27617             "description": ""
27618           },
27619           {
27620             "group": "Body",
27621             "type": "String",
27622             "allowedValues": [
27623               "\"yes\"",
27624               "\"no\""
27625             ],
27626             "optional": true,
27627             "field": "usereqphone",
27628             "description": ""
27629           },
27630           {
27631             "group": "Body",
27632             "type": "String",
27633             "optional": true,
27634             "field": "recordonfeature",
27635             "description": ""
27636           },
27637           {
27638             "group": "Body",
27639             "type": "String",
27640             "optional": true,
27641             "field": "recordofffeature",
27642             "description": ""
27643           },
27644           {
27645             "group": "Body",
27646             "type": "Integer",
27647             "optional": true,
27648             "field": "call_limit",
27649             "description": ""
27650           },
27651           {
27652             "group": "Body",
27653             "type": "String",
27654             "allowedValues": [
27655               "\"yes\"",
27656               "\"no\""
27657             ],
27658             "optional": true,
27659             "field": "registertrying",
27660             "description": ""
27661           },
27662           {
27663             "group": "Body",
27664             "type": "String",
27665             "allowedValues": [
27666               "\"yes\"",
27667               "\"no\""
27668             ],
27669             "optional": true,
27670             "field": "subscribemwi",
27671             "description": ""
27672           },
27673           {
27674             "group": "Body",
27675             "type": "String",
27676             "optional": true,
27677             "field": "vmexten",
27678             "description": ""
27679           },
27680           {
27681             "group": "Body",
27682             "type": "String",
27683             "optional": true,
27684             "field": "mohinterpret",
27685             "description": ""
27686           },
27687           {
27688             "group": "Body",
27689             "type": "String",
27690             "optional": true,
27691             "field": "mohsuggest",
27692             "description": ""
27693           },
27694           {
27695             "group": "Body",
27696             "type": "String",
27697             "optional": true,
27698             "field": "parkinglot",
27699             "description": ""
27700           },
27701           {
27702             "group": "Body",
27703             "type": "String",
27704             "optional": true,
27705             "field": "description",
27706             "description": ""
27707           },
27708           {
27709             "group": "Body",
27710             "type": "String",
27711             "optional": true,
27712             "field": "host",
27713             "description": ""
27714           },
27715           {
27716             "group": "Body",
27717             "type": "String",
27718             "allowedValues": [
27719               "\"yes\"",
27720               "\"no\"",
27721               "\"nonat\"",
27722               "\"update\"",
27723               "\"update,nonat\""
27724             ],
27725             "optional": true,
27726             "field": "canreinvite",
27727             "description": ""
27728           },
27729           {
27730             "group": "Body",
27731             "type": "String",
27732             "optional": true,
27733             "field": "registry",
27734             "description": ""
27735           },
27736           {
27737             "group": "Body",
27738             "type": "String",
27739             "optional": true,
27740             "field": "otherFields",
27741             "description": ""
27742           },
27743           {
27744             "group": "Body",
27745             "type": "Boolean",
27746             "optional": false,
27747             "field": "active",
27748             "description": ""
27749           },
27750           {
27751             "group": "Body",
27752             "type": "String",
27753             "optional": true,
27754             "field": "t38pt_udptl",
27755             "description": ""
27756           }
27757         ]
27758       }
27759     },
27760     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27761     "version": "0.0.0",
27762     "filename": "server/api/trunk/index.js",
27763     "groupTitle": "Trunks"
27764   },
27765   {
27766     "type": "delete",
27767     "url": "/api/trunks/{id}",
27768     "title": "Deletes a trunk",
27769     "examples": [
27770       {
27771         "title": "Example usage:",
27772         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27773         "type": "json"
27774       }
27775     ],
27776     "name": "Delete",
27777     "group": "Trunks",
27778     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27779     "version": "0.0.0",
27780     "filename": "server/api/trunk/index.js",
27781     "groupTitle": "Trunks"
27782   },
27783   {
27784     "type": "get",
27785     "url": "/api/trunks",
27786     "title": "Gets a list of Trunks",
27787     "examples": [
27788       {
27789         "title": "Example usage:",
27790         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27791         "type": "json"
27792       }
27793     ],
27794     "name": "GetTrunks",
27795     "group": "Trunks",
27796     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27797     "version": "0.0.0",
27798     "filename": "server/api/trunk/index.js",
27799     "groupTitle": "Trunks"
27800   },
27801   {
27802     "type": "get",
27803     "url": "/api/trunks/{id}",
27804     "title": "Gets a single Trunk",
27805     "examples": [
27806       {
27807         "title": "Example usage:",
27808         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27809         "type": "json"
27810       }
27811     ],
27812     "name": "ShowTrunks",
27813     "group": "Trunks",
27814     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27815     "version": "0.0.0",
27816     "filename": "server/api/trunk/index.js",
27817     "groupTitle": "Trunks"
27818   },
27819   {
27820     "type": "put",
27821     "url": "/api/trunks/{id}",
27822     "title": "Update an existing trunk",
27823     "examples": [
27824       {
27825         "title": "Example usage:",
27826         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27827         "type": "json"
27828       }
27829     ],
27830     "name": "Update",
27831     "group": "Trunks",
27832     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27833     "version": "0.0.0",
27834     "filename": "server/api/trunk/index.js",
27835     "groupTitle": "Trunks"
27836   },
27837   {
27838     "type": "post",
27839     "url": "/api/userNotifications",
27840     "title": "Send notification to user",
27841     "examples": [
27842       {
27843         "title": "Example usage:",
27844         "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27845         "type": "json"
27846       }
27847     ],
27848     "name": "Send",
27849     "group": "UserNotifications",
27850     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27851     "version": "0.0.0",
27852     "filename": "server/api/userNotification/index.js",
27853     "groupTitle": "UserNotifications"
27854   },
27855   {
27856     "type": "post",
27857     "url": "/api/userProfile/resources",
27858     "title": "Creates a new User Profile Resource",
27859     "examples": [
27860       {
27861         "title": "Example usage:",
27862         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27863         "type": "json"
27864       }
27865     ],
27866     "name": "CreateUser_Profile_Resources",
27867     "group": "User_Profile_Resources",
27868     "parameter": {
27869       "fields": {
27870         "Body": [
27871           {
27872             "group": "Body",
27873             "type": "String",
27874             "optional": false,
27875             "field": "name",
27876             "description": ""
27877           },
27878           {
27879             "group": "Body",
27880             "type": "Integer",
27881             "optional": false,
27882             "field": "resourceId",
27883             "description": ""
27884           },
27885           {
27886             "group": "Body",
27887             "type": "String",
27888             "optional": false,
27889             "field": "type",
27890             "description": ""
27891           }
27892         ]
27893       }
27894     },
27895     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27896     "version": "0.0.0",
27897     "filename": "server/api/userProfileResource/index.js",
27898     "groupTitle": "User_Profile_Resources"
27899   },
27900   {
27901     "type": "delete",
27902     "url": "/api/userProfile/resources/{id}",
27903     "title": "Deletes a User Profile Resource",
27904     "examples": [
27905       {
27906         "title": "Example usage:",
27907         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27908         "type": "json"
27909       }
27910     ],
27911     "name": "DeleteUser_Profile_Resources",
27912     "group": "User_Profile_Resources",
27913     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/userProfileResource/index.js",
27916     "groupTitle": "User_Profile_Resources"
27917   },
27918   {
27919     "type": "get",
27920     "url": "/api/userProfile/resources/describe",
27921     "title": "Gets table info about User Profile Resources",
27922     "examples": [
27923       {
27924         "title": "Example usage:",
27925         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27926         "type": "json"
27927       }
27928     ],
27929     "name": "DescribeUser_Profile_Resources",
27930     "group": "User_Profile_Resources",
27931     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27932     "version": "0.0.0",
27933     "filename": "server/api/userProfileResource/index.js",
27934     "groupTitle": "User_Profile_Resources"
27935   },
27936   {
27937     "type": "get",
27938     "url": "/api/userProfile/resources",
27939     "title": "Gets a list of User Profile Resources",
27940     "examples": [
27941       {
27942         "title": "Example usage:",
27943         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27944         "type": "json"
27945       }
27946     ],
27947     "name": "GetUser_Profile_Resources",
27948     "group": "User_Profile_Resources",
27949     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27950     "version": "0.0.0",
27951     "filename": "server/api/userProfileResource/index.js",
27952     "groupTitle": "User_Profile_Resources"
27953   },
27954   {
27955     "type": "get",
27956     "url": "/api/userProfile/resources/{id}",
27957     "title": "Gets a single User Profile Resource",
27958     "examples": [
27959       {
27960         "title": "Example usage:",
27961         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27962         "type": "json"
27963       }
27964     ],
27965     "name": "ShowUser_Profile_Resources",
27966     "group": "User_Profile_Resources",
27967     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27968     "version": "0.0.0",
27969     "filename": "server/api/userProfileResource/index.js",
27970     "groupTitle": "User_Profile_Resources"
27971   },
27972   {
27973     "type": "put",
27974     "url": "/api/userProfile/resources/{id}",
27975     "title": "Update an existing User Profile Resource",
27976     "examples": [
27977       {
27978         "title": "Example usage:",
27979         "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",
27980         "type": "json"
27981       }
27982     ],
27983     "name": "updateUser_Profile_Resources",
27984     "group": "User_Profile_Resources",
27985     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27986     "version": "0.0.0",
27987     "filename": "server/api/userProfileResource/index.js",
27988     "groupTitle": "User_Profile_Resources"
27989   },
27990   {
27991     "type": "post",
27992     "url": "/api/userProfile/sections",
27993     "title": "Creates a new User Profile Section",
27994     "examples": [
27995       {
27996         "title": "Example usage:",
27997         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27998         "type": "json"
27999       }
28000     ],
28001     "name": "CreateUser_Profile_Sections",
28002     "group": "User_Profile_Sections",
28003     "parameter": {
28004       "fields": {
28005         "Body": [
28006           {
28007             "group": "Body",
28008             "type": "String",
28009             "optional": false,
28010             "field": "name",
28011             "description": ""
28012           },
28013           {
28014             "group": "Body",
28015             "type": "String",
28016             "optional": false,
28017             "field": "category",
28018             "description": ""
28019           },
28020           {
28021             "group": "Body",
28022             "type": "Integer",
28023             "optional": false,
28024             "field": "sectionId",
28025             "description": ""
28026           },
28027           {
28028             "group": "Body",
28029             "type": "Boolean",
28030             "optional": true,
28031             "field": "enabled",
28032             "description": ""
28033           },
28034           {
28035             "group": "Body",
28036             "type": "Boolean",
28037             "optional": true,
28038             "field": "autoAssociation",
28039             "description": ""
28040           },
28041           {
28042             "group": "Body",
28043             "type": "String",
28044             "optional": true,
28045             "field": "crudPermissions",
28046             "description": ""
28047           }
28048         ]
28049       }
28050     },
28051     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28052     "version": "0.0.0",
28053     "filename": "server/api/userProfileSection/index.js",
28054     "groupTitle": "User_Profile_Sections"
28055   },
28056   {
28057     "type": "delete",
28058     "url": "/api/userProfile/sections/{id}",
28059     "title": "Deletes a User Profile Section",
28060     "examples": [
28061       {
28062         "title": "Example usage:",
28063         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28064         "type": "json"
28065       }
28066     ],
28067     "name": "DeleteUser_Profile_Sections",
28068     "group": "User_Profile_Sections",
28069     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28070     "version": "0.0.0",
28071     "filename": "server/api/userProfileSection/index.js",
28072     "groupTitle": "User_Profile_Sections"
28073   },
28074   {
28075     "type": "get",
28076     "url": "/api/userProfile/sections/describe",
28077     "title": "Gets table info about User Profile Sections",
28078     "examples": [
28079       {
28080         "title": "Example usage:",
28081         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28082         "type": "json"
28083       }
28084     ],
28085     "name": "DescribeUser_Profile_Sections",
28086     "group": "User_Profile_Sections",
28087     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28088     "version": "0.0.0",
28089     "filename": "server/api/userProfileSection/index.js",
28090     "groupTitle": "User_Profile_Sections"
28091   },
28092   {
28093     "type": "get",
28094     "url": "/api/userProfile/sections",
28095     "title": "Gets a list of User Profile Sections",
28096     "examples": [
28097       {
28098         "title": "Example usage:",
28099         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28100         "type": "json"
28101       }
28102     ],
28103     "name": "GetUser_Profile_Sections",
28104     "group": "User_Profile_Sections",
28105     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28106     "version": "0.0.0",
28107     "filename": "server/api/userProfileSection/index.js",
28108     "groupTitle": "User_Profile_Sections"
28109   },
28110   {
28111     "type": "get",
28112     "url": "/api/userProfile/sections/{id}",
28113     "title": "Gets a single User Profile Section",
28114     "examples": [
28115       {
28116         "title": "Example usage:",
28117         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28118         "type": "json"
28119       }
28120     ],
28121     "name": "ShowUser_Profile_Sections",
28122     "group": "User_Profile_Sections",
28123     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28124     "version": "0.0.0",
28125     "filename": "server/api/userProfileSection/index.js",
28126     "groupTitle": "User_Profile_Sections"
28127   },
28128   {
28129     "type": "put",
28130     "url": "/api/userProfile/sections/{id}",
28131     "title": "Update an existing User Profile Section",
28132     "examples": [
28133       {
28134         "title": "Example usage:",
28135         "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",
28136         "type": "json"
28137       }
28138     ],
28139     "name": "updateUser_Profile_Sections",
28140     "group": "User_Profile_Sections",
28141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28142     "version": "0.0.0",
28143     "filename": "server/api/userProfileSection/index.js",
28144     "groupTitle": "User_Profile_Sections"
28145   },
28146   {
28147     "type": "post",
28148     "url": "/api/userProfiles/{id}/resources",
28149     "title": "Add resources' permissions to User Profile",
28150     "examples": [
28151       {
28152         "title": "Example usage:",
28153         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28154         "type": "json"
28155       }
28156     ],
28157     "name": "AddResources",
28158     "group": "User_Profiles",
28159     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28160     "version": "0.0.0",
28161     "filename": "server/api/userProfile/index.js",
28162     "groupTitle": "User_Profiles"
28163   },
28164   {
28165     "type": "post",
28166     "url": "/api/userProfiles/{id}/sections",
28167     "title": "Add sections' permissions to User Profile",
28168     "examples": [
28169       {
28170         "title": "Example usage:",
28171         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28172         "type": "json"
28173       }
28174     ],
28175     "name": "AddSections",
28176     "group": "User_Profiles",
28177     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28178     "version": "0.0.0",
28179     "filename": "server/api/userProfile/index.js",
28180     "groupTitle": "User_Profiles"
28181   },
28182   {
28183     "type": "post",
28184     "url": "/api/userProfiles/clone",
28185     "title": "Clone an existing User Profile",
28186     "examples": [
28187       {
28188         "title": "Example usage:",
28189         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28190         "type": "json"
28191       }
28192     ],
28193     "name": "CloneUser_Profiles",
28194     "group": "User_Profiles",
28195     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28196     "version": "0.0.0",
28197     "filename": "server/api/userProfile/index.js",
28198     "groupTitle": "User_Profiles"
28199   },
28200   {
28201     "type": "post",
28202     "url": "/api/userProfiles",
28203     "title": "Creates a new User Profile",
28204     "examples": [
28205       {
28206         "title": "Example usage:",
28207         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28208         "type": "json"
28209       }
28210     ],
28211     "name": "CreateUser_Profiles",
28212     "group": "User_Profiles",
28213     "parameter": {
28214       "fields": {
28215         "Body": [
28216           {
28217             "group": "Body",
28218             "type": "String",
28219             "optional": false,
28220             "field": "name",
28221             "description": ""
28222           },
28223           {
28224             "group": "Body",
28225             "type": "String",
28226             "optional": false,
28227             "field": "crudPermissions",
28228             "description": ""
28229           },
28230           {
28231             "group": "Body",
28232             "type": "String",
28233             "optional": true,
28234             "field": "description",
28235             "description": ""
28236           },
28237           {
28238             "group": "Body",
28239             "type": "Boolean",
28240             "optional": true,
28241             "field": "privacyEnabled",
28242             "description": ""
28243           }
28244         ]
28245       }
28246     },
28247     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28248     "version": "0.0.0",
28249     "filename": "server/api/userProfile/index.js",
28250     "groupTitle": "User_Profiles"
28251   },
28252   {
28253     "type": "delete",
28254     "url": "/api/userProfiles/{id}",
28255     "title": "Deletes a User Profile",
28256     "examples": [
28257       {
28258         "title": "Example usage:",
28259         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28260         "type": "json"
28261       }
28262     ],
28263     "name": "DeleteUser_Profiles",
28264     "group": "User_Profiles",
28265     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28266     "version": "0.0.0",
28267     "filename": "server/api/userProfile/index.js",
28268     "groupTitle": "User_Profiles"
28269   },
28270   {
28271     "type": "get",
28272     "url": "/api/userProfiles/describe",
28273     "title": "Gets table info about User Profiles",
28274     "examples": [
28275       {
28276         "title": "Example usage:",
28277         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28278         "type": "json"
28279       }
28280     ],
28281     "name": "DescribeUser_Profiles",
28282     "group": "User_Profiles",
28283     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28284     "version": "0.0.0",
28285     "filename": "server/api/userProfile/index.js",
28286     "groupTitle": "User_Profiles"
28287   },
28288   {
28289     "type": "get",
28290     "url": "/api/userProfiles/{id}/resources?section={section}",
28291     "title": "Get Resources assigned to a Section",
28292     "examples": [
28293       {
28294         "title": "Example usage:",
28295         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28296         "type": "json"
28297       }
28298     ],
28299     "name": "GetResources",
28300     "group": "User_Profiles",
28301     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28302     "version": "0.0.0",
28303     "filename": "server/api/userProfile/index.js",
28304     "groupTitle": "User_Profiles"
28305   },
28306   {
28307     "type": "get",
28308     "url": "/api/userProfiles/{id}/sections",
28309     "title": "Get sections associated to a User Profile",
28310     "examples": [
28311       {
28312         "title": "Example usage:",
28313         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28314         "type": "json"
28315       }
28316     ],
28317     "name": "GetSections",
28318     "group": "User_Profiles",
28319     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28320     "version": "0.0.0",
28321     "filename": "server/api/userProfile/index.js",
28322     "groupTitle": "User_Profiles"
28323   },
28324   {
28325     "type": "get",
28326     "url": "/api/userProfiles",
28327     "title": "Gets a list of User Profiles",
28328     "examples": [
28329       {
28330         "title": "Example usage:",
28331         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28332         "type": "json"
28333       }
28334     ],
28335     "name": "GetUser_Profiles",
28336     "group": "User_Profiles",
28337     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28338     "version": "0.0.0",
28339     "filename": "server/api/userProfile/index.js",
28340     "groupTitle": "User_Profiles"
28341   },
28342   {
28343     "type": "delete",
28344     "url": "/api/userProfiles/{id}/resources",
28345     "title": "Removes resources' permissions from User Profile",
28346     "examples": [
28347       {
28348         "title": "Example usage:",
28349         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28350         "type": "json"
28351       }
28352     ],
28353     "name": "RemoveResources",
28354     "group": "User_Profiles",
28355     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28356     "version": "0.0.0",
28357     "filename": "server/api/userProfile/index.js",
28358     "groupTitle": "User_Profiles"
28359   },
28360   {
28361     "type": "delete",
28362     "url": "/api/userProfiles/{id}/sections",
28363     "title": "Removes sections' permissions from User Profile",
28364     "examples": [
28365       {
28366         "title": "Example usage:",
28367         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28368         "type": "json"
28369       }
28370     ],
28371     "name": "RemoveSections",
28372     "group": "User_Profiles",
28373     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28374     "version": "0.0.0",
28375     "filename": "server/api/userProfile/index.js",
28376     "groupTitle": "User_Profiles"
28377   },
28378   {
28379     "type": "get",
28380     "url": "/api/userProfiles/{id}",
28381     "title": "Gets a single User Profile",
28382     "examples": [
28383       {
28384         "title": "Example usage:",
28385         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28386         "type": "json"
28387       }
28388     ],
28389     "name": "ShowUser_Profiles",
28390     "group": "User_Profiles",
28391     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28392     "version": "0.0.0",
28393     "filename": "server/api/userProfile/index.js",
28394     "groupTitle": "User_Profiles"
28395   },
28396   {
28397     "type": "put",
28398     "url": "/api/userProfiles/{id}",
28399     "title": "Update an existing User Profile",
28400     "examples": [
28401       {
28402         "title": "Example usage:",
28403         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28404         "type": "json"
28405       }
28406     ],
28407     "name": "updateUser_Profiles",
28408     "group": "User_Profiles",
28409     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28410     "version": "0.0.0",
28411     "filename": "server/api/userProfile/index.js",
28412     "groupTitle": "User_Profiles"
28413   },
28414   {
28415     "type": "post",
28416     "url": "/api/users/{id}/chat_interactions",
28417     "title": "Add chat interaction tabs to an agent",
28418     "examples": [
28419       {
28420         "title": "Example usage:",
28421         "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",
28422         "type": "json"
28423       }
28424     ],
28425     "name": "AddChatInteractions",
28426     "group": "Users",
28427     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28428     "version": "0.0.0",
28429     "filename": "server/api/user/index.js",
28430     "groupTitle": "Users"
28431   },
28432   {
28433     "type": "post",
28434     "url": "/api/users/{id}/chat_websites",
28435     "title": "Add a Chat Website to a user",
28436     "examples": [
28437       {
28438         "title": "Example usage:",
28439         "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",
28440         "type": "json"
28441       }
28442     ],
28443     "name": "AddChatWebsites",
28444     "group": "Users",
28445     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28446     "version": "0.0.0",
28447     "filename": "server/api/user/index.js",
28448     "groupTitle": "Users"
28449   },
28450   {
28451     "type": "post",
28452     "url": "/api/users/{id}/contacts",
28453     "title": "Add contacts to a user",
28454     "examples": [
28455       {
28456         "title": "Example usage:",
28457         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28458         "type": "json"
28459       }
28460     ],
28461     "name": "AddContacts",
28462     "group": "Users",
28463     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28464     "version": "0.0.0",
28465     "filename": "server/api/user/index.js",
28466     "groupTitle": "Users"
28467   },
28468   {
28469     "type": "post",
28470     "url": "/api/users/{id}/fax_accounts",
28471     "title": "Add a Fax Account to a user",
28472     "examples": [
28473       {
28474         "title": "Example usage:",
28475         "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",
28476         "type": "json"
28477       }
28478     ],
28479     "name": "AddFaxAccounts",
28480     "group": "Users",
28481     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28482     "version": "0.0.0",
28483     "filename": "server/api/user/index.js",
28484     "groupTitle": "Users"
28485   },
28486   {
28487     "type": "post",
28488     "url": "/api/users/{id}/fax_interactions",
28489     "title": "Add fax interaction tabs to an agent",
28490     "examples": [
28491       {
28492         "title": "Example usage:",
28493         "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",
28494         "type": "json"
28495       }
28496     ],
28497     "name": "AddFaxInteractions",
28498     "group": "Users",
28499     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28500     "version": "0.0.0",
28501     "filename": "server/api/user/index.js",
28502     "groupTitle": "Users"
28503   },
28504   {
28505     "type": "post",
28506     "url": "/api/users/{id}/mail_accounts",
28507     "title": "Add a Mail Account to a user",
28508     "examples": [
28509       {
28510         "title": "Example usage:",
28511         "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",
28512         "type": "json"
28513       }
28514     ],
28515     "name": "AddMailAccounts",
28516     "group": "Users",
28517     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28518     "version": "0.0.0",
28519     "filename": "server/api/user/index.js",
28520     "groupTitle": "Users"
28521   },
28522   {
28523     "type": "post",
28524     "url": "/api/users/{id}/mail_interactions",
28525     "title": "Add mail interaction tabs to an agent",
28526     "examples": [
28527       {
28528         "title": "Example usage:",
28529         "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",
28530         "type": "json"
28531       }
28532     ],
28533     "name": "AddMailInteractions",
28534     "group": "Users",
28535     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28536     "version": "0.0.0",
28537     "filename": "server/api/user/index.js",
28538     "groupTitle": "Users"
28539   },
28540   {
28541     "type": "post",
28542     "url": "/api/users/{id}/openchannel_accounts",
28543     "title": "Add a Open Channel Account to a user",
28544     "examples": [
28545       {
28546         "title": "Example usage:",
28547         "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",
28548         "type": "json"
28549       }
28550     ],
28551     "name": "AddOpenchannelAccounts",
28552     "group": "Users",
28553     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28554     "version": "0.0.0",
28555     "filename": "server/api/user/index.js",
28556     "groupTitle": "Users"
28557   },
28558   {
28559     "type": "post",
28560     "url": "/api/users/{id}/openchannel_interactions",
28561     "title": "Add openchannel interaction tabs to an agent",
28562     "examples": [
28563       {
28564         "title": "Example usage:",
28565         "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",
28566         "type": "json"
28567       }
28568     ],
28569     "name": "AddOpenchannelInteractions",
28570     "group": "Users",
28571     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28572     "version": "0.0.0",
28573     "filename": "server/api/user/index.js",
28574     "groupTitle": "Users"
28575   },
28576   {
28577     "type": "post",
28578     "url": "/api/users/{id}/queues",
28579     "title": "Add queues to an agent",
28580     "examples": [
28581       {
28582         "title": "Example usage:",
28583         "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",
28584         "type": "json"
28585       }
28586     ],
28587     "name": "AddQueues",
28588     "group": "Users",
28589     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28590     "version": "0.0.0",
28591     "filename": "server/api/user/index.js",
28592     "groupTitle": "Users"
28593   },
28594   {
28595     "type": "post",
28596     "url": "/api/users/{id}/sms_accounts",
28597     "title": "Add a Sms Account to a user",
28598     "examples": [
28599       {
28600         "title": "Example usage:",
28601         "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",
28602         "type": "json"
28603       }
28604     ],
28605     "name": "AddSmsAccounts",
28606     "group": "Users",
28607     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28608     "version": "0.0.0",
28609     "filename": "server/api/user/index.js",
28610     "groupTitle": "Users"
28611   },
28612   {
28613     "type": "post",
28614     "url": "/api/users/{id}/sms_interactions",
28615     "title": "Add sms interaction tabs to an agent",
28616     "examples": [
28617       {
28618         "title": "Example usage:",
28619         "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",
28620         "type": "json"
28621       }
28622     ],
28623     "name": "AddSmsInteractions",
28624     "group": "Users",
28625     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28626     "version": "0.0.0",
28627     "filename": "server/api/user/index.js",
28628     "groupTitle": "Users"
28629   },
28630   {
28631     "type": "post",
28632     "url": "/api/users/{id}/square_projects",
28633     "title": "Add a Square Project to a user",
28634     "examples": [
28635       {
28636         "title": "Example usage:",
28637         "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",
28638         "type": "json"
28639       }
28640     ],
28641     "name": "AddSquareProjects",
28642     "group": "Users",
28643     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28644     "version": "0.0.0",
28645     "filename": "server/api/user/index.js",
28646     "groupTitle": "Users"
28647   },
28648   {
28649     "type": "post",
28650     "url": "/api/users/{id}/teams",
28651     "title": "Add teams to an agent",
28652     "examples": [
28653       {
28654         "title": "Example usage:",
28655         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28656         "type": "json"
28657       }
28658     ],
28659     "name": "AddTeams",
28660     "group": "Users",
28661     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28662     "version": "0.0.0",
28663     "filename": "server/api/user/index.js",
28664     "groupTitle": "Users"
28665   },
28666   {
28667     "type": "post",
28668     "url": "/api/users/{id}/whatsapp_accounts",
28669     "title": "Add a Whatsapp Account to a user",
28670     "examples": [
28671       {
28672         "title": "Example usage:",
28673         "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",
28674         "type": "json"
28675       }
28676     ],
28677     "name": "AddWhatsappAccounts",
28678     "group": "Users",
28679     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28680     "version": "0.0.0",
28681     "filename": "server/api/user/index.js",
28682     "groupTitle": "Users"
28683   },
28684   {
28685     "type": "post",
28686     "url": "/api/users/{id}/whatsapp_interactions",
28687     "title": "Add Whatsapp interaction tabs to an agent",
28688     "examples": [
28689       {
28690         "title": "Example usage:",
28691         "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",
28692         "type": "json"
28693       }
28694     ],
28695     "name": "AddWhatsappInteractions",
28696     "group": "Users",
28697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28698     "version": "0.0.0",
28699     "filename": "server/api/user/index.js",
28700     "groupTitle": "Users"
28701   },
28702   {
28703     "type": "put",
28704     "url": "/api/users/{id}/password",
28705     "title": "Change user password",
28706     "examples": [
28707       {
28708         "title": "Example usage:",
28709         "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",
28710         "type": "json"
28711       }
28712     ],
28713     "name": "ChangePwd",
28714     "group": "Users",
28715     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28716     "version": "0.0.0",
28717     "filename": "server/api/user/index.js",
28718     "groupTitle": "Users"
28719   },
28720   {
28721     "type": "post",
28722     "url": "/api/users",
28723     "title": "Create a new user",
28724     "examples": [
28725       {
28726         "title": "Example usage:",
28727         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28728         "type": "json"
28729       }
28730     ],
28731     "name": "Create",
28732     "group": "Users",
28733     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28734     "version": "0.0.0",
28735     "filename": "server/api/user/index.js",
28736     "groupTitle": "Users"
28737   },
28738   {
28739     "type": "post",
28740     "url": "/api/users/{id}/api_key",
28741     "title": "Create a new API access key for the user",
28742     "examples": [
28743       {
28744         "title": "Example usage:",
28745         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28746         "type": "json"
28747       }
28748     ],
28749     "name": "CreateApiKey",
28750     "group": "Users",
28751     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28752     "version": "0.0.0",
28753     "filename": "server/api/user/index.js",
28754     "groupTitle": "Users"
28755   },
28756   {
28757     "type": "delete",
28758     "url": "/api/users/{id}",
28759     "title": "Deletes a user",
28760     "examples": [
28761       {
28762         "title": "Example usage:",
28763         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
28764         "type": "json"
28765       }
28766     ],
28767     "name": "Delete",
28768     "group": "Users",
28769     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28770     "version": "0.0.0",
28771     "filename": "server/api/user/index.js",
28772     "groupTitle": "Users"
28773   },
28774   {
28775     "type": "get",
28776     "url": "/api/users/describe",
28777     "title": "Gets table info about Users",
28778     "examples": [
28779       {
28780         "title": "Example usage:",
28781         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
28782         "type": "json"
28783       }
28784     ],
28785     "name": "DescribeUsers",
28786     "group": "Users",
28787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28788     "version": "0.0.0",
28789     "filename": "server/api/user/index.js",
28790     "groupTitle": "Users"
28791   },
28792   {
28793     "type": "get",
28794     "url": "/api/users/{id}/agents",
28795     "title": "GetAgents",
28796     "examples": [
28797       {
28798         "title": "Example usage:",
28799         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
28800         "type": "json"
28801       }
28802     ],
28803     "name": "GetAgents",
28804     "group": "Users",
28805     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28806     "version": "0.0.0",
28807     "filename": "server/api/user/index.js",
28808     "groupTitle": "Users"
28809   },
28810   {
28811     "type": "get",
28812     "url": "/api/users/{id}/api_key",
28813     "title": "Get the API access key for the user",
28814     "examples": [
28815       {
28816         "title": "Example usage:",
28817         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
28818         "type": "json"
28819       }
28820     ],
28821     "name": "GetApiKey",
28822     "group": "Users",
28823     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28824     "version": "0.0.0",
28825     "filename": "server/api/user/index.js",
28826     "groupTitle": "Users"
28827   },
28828   {
28829     "type": "get",
28830     "url": "/api/users/{id}/groups",
28831     "title": "GetChatGroups",
28832     "examples": [
28833       {
28834         "title": "Example usage:",
28835         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
28836         "type": "json"
28837       }
28838     ],
28839     "name": "GetChatGroups",
28840     "group": "Users",
28841     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28842     "version": "0.0.0",
28843     "filename": "server/api/user/index.js",
28844     "groupTitle": "Users"
28845   },
28846   {
28847     "type": "get",
28848     "url": "/api/users/{id}/chat/interactions",
28849     "title": "GetChatInteractions",
28850     "examples": [
28851       {
28852         "title": "Example usage:",
28853         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
28854         "type": "json"
28855       }
28856     ],
28857     "name": "GetChatInteractions",
28858     "group": "Users",
28859     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28860     "version": "0.0.0",
28861     "filename": "server/api/user/index.js",
28862     "groupTitle": "Users"
28863   },
28864   {
28865     "type": "get",
28866     "url": "/api/users/{id}/chat_websites",
28867     "title": "GetChatWebsites",
28868     "examples": [
28869       {
28870         "title": "Example usage:",
28871         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
28872         "type": "json"
28873       }
28874     ],
28875     "name": "GetChatWebsites",
28876     "group": "Users",
28877     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28878     "version": "0.0.0",
28879     "filename": "server/api/user/index.js",
28880     "groupTitle": "Users"
28881   },
28882   {
28883     "type": "get",
28884     "url": "/api/users/{id}/contacts",
28885     "title": "GetContacts",
28886     "examples": [
28887       {
28888         "title": "Example usage:",
28889         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
28890         "type": "json"
28891       }
28892     ],
28893     "name": "GetContacts",
28894     "group": "Users",
28895     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28896     "version": "0.0.0",
28897     "filename": "server/api/user/index.js",
28898     "groupTitle": "Users"
28899   },
28900   {
28901     "type": "get",
28902     "url": "/api/users/{id}/fax_accounts",
28903     "title": "GetFaxAccounts",
28904     "examples": [
28905       {
28906         "title": "Example usage:",
28907         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
28908         "type": "json"
28909       }
28910     ],
28911     "name": "GetFaxAccounts",
28912     "group": "Users",
28913     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28914     "version": "0.0.0",
28915     "filename": "server/api/user/index.js",
28916     "groupTitle": "Users"
28917   },
28918   {
28919     "type": "get",
28920     "url": "/api/users/{id}/fax/interactions",
28921     "title": "GetFaxInteractions",
28922     "examples": [
28923       {
28924         "title": "Example usage:",
28925         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
28926         "type": "json"
28927       }
28928     ],
28929     "name": "GetFaxInteractions",
28930     "group": "Users",
28931     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28932     "version": "0.0.0",
28933     "filename": "server/api/user/index.js",
28934     "groupTitle": "Users"
28935   },
28936   {
28937     "type": "get",
28938     "url": "/api/users/{id}/lists",
28939     "title": "GetLists",
28940     "examples": [
28941       {
28942         "title": "Example usage:",
28943         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
28944         "type": "json"
28945       }
28946     ],
28947     "name": "GetLists",
28948     "group": "Users",
28949     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28950     "version": "0.0.0",
28951     "filename": "server/api/user/index.js",
28952     "groupTitle": "Users"
28953   },
28954   {
28955     "type": "get",
28956     "url": "/api/users/{id}/mail_accounts",
28957     "title": "GetMailAccounts",
28958     "examples": [
28959       {
28960         "title": "Example usage:",
28961         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
28962         "type": "json"
28963       }
28964     ],
28965     "name": "GetMailAccounts",
28966     "group": "Users",
28967     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28968     "version": "0.0.0",
28969     "filename": "server/api/user/index.js",
28970     "groupTitle": "Users"
28971   },
28972   {
28973     "type": "get",
28974     "url": "/api/users/{id}/mail/interactions",
28975     "title": "GetMailInteractions",
28976     "examples": [
28977       {
28978         "title": "Example usage:",
28979         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
28980         "type": "json"
28981       }
28982     ],
28983     "name": "GetMailInteractions",
28984     "group": "Users",
28985     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28986     "version": "0.0.0",
28987     "filename": "server/api/user/index.js",
28988     "groupTitle": "Users"
28989   },
28990   {
28991     "type": "get",
28992     "url": "/api/users/{id}/openchannel_accounts",
28993     "title": "GetOpenchannelAccounts",
28994     "examples": [
28995       {
28996         "title": "Example usage:",
28997         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
28998         "type": "json"
28999       }
29000     ],
29001     "name": "GetOpenchannelAccounts",
29002     "group": "Users",
29003     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29004     "version": "0.0.0",
29005     "filename": "server/api/user/index.js",
29006     "groupTitle": "Users"
29007   },
29008   {
29009     "type": "get",
29010     "url": "/api/users/{id}/openchannel/interactions",
29011     "title": "GetOpenchannelInteractions",
29012     "examples": [
29013       {
29014         "title": "Example usage:",
29015         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29016         "type": "json"
29017       }
29018     ],
29019     "name": "GetOpenchannelInteractions",
29020     "group": "Users",
29021     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29022     "version": "0.0.0",
29023     "filename": "server/api/user/index.js",
29024     "groupTitle": "Users"
29025   },
29026   {
29027     "type": "get",
29028     "url": "/api/users/{id}/prefixes",
29029     "title": "GetPrefixes",
29030     "examples": [
29031       {
29032         "title": "Example usage:",
29033         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29034         "type": "json"
29035       }
29036     ],
29037     "name": "GetPrefixes",
29038     "group": "Users",
29039     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29040     "version": "0.0.0",
29041     "filename": "server/api/user/index.js",
29042     "groupTitle": "Users"
29043   },
29044   {
29045     "type": "get",
29046     "url": "/api/users/{id}/queues?channel={channel}",
29047     "title": "Gets Queues list",
29048     "examples": [
29049       {
29050         "title": "Example usage:",
29051         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29052         "type": "json"
29053       }
29054     ],
29055     "name": "GetQueues",
29056     "group": "Users",
29057     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29058     "version": "0.0.0",
29059     "filename": "server/api/user/index.js",
29060     "groupTitle": "Users"
29061   },
29062   {
29063     "type": "get",
29064     "url": "/api/users/{id}/recordings",
29065     "title": "GetRecordings",
29066     "examples": [
29067       {
29068         "title": "Example usage:",
29069         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29070         "type": "json"
29071       }
29072     ],
29073     "name": "GetRecordings",
29074     "group": "Users",
29075     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29076     "version": "0.0.0",
29077     "filename": "server/api/user/index.js",
29078     "groupTitle": "Users"
29079   },
29080   {
29081     "type": "get",
29082     "url": "/api/users/{id}/scheduled_calls",
29083     "title": "GetScheduledCalls",
29084     "examples": [
29085       {
29086         "title": "Example usage:",
29087         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29088         "type": "json"
29089       }
29090     ],
29091     "name": "GetScheduledCalls",
29092     "group": "Users",
29093     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29094     "version": "0.0.0",
29095     "filename": "server/api/user/index.js",
29096     "groupTitle": "Users"
29097   },
29098   {
29099     "type": "get",
29100     "url": "/api/users/{id}/screen_recordings",
29101     "title": "GetScreenRecordings",
29102     "examples": [
29103       {
29104         "title": "Example usage:",
29105         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29106         "type": "json"
29107       }
29108     ],
29109     "name": "GetScreenRecordings",
29110     "group": "Users",
29111     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29112     "version": "0.0.0",
29113     "filename": "server/api/user/index.js",
29114     "groupTitle": "Users"
29115   },
29116   {
29117     "type": "get",
29118     "url": "/api/users/{id}/sms_accounts",
29119     "title": "GetSmsAccounts",
29120     "examples": [
29121       {
29122         "title": "Example usage:",
29123         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29124         "type": "json"
29125       }
29126     ],
29127     "name": "GetSmsAccounts",
29128     "group": "Users",
29129     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29130     "version": "0.0.0",
29131     "filename": "server/api/user/index.js",
29132     "groupTitle": "Users"
29133   },
29134   {
29135     "type": "get",
29136     "url": "/api/users/{id}/sms/interactions",
29137     "title": "GetSmsInteractions",
29138     "examples": [
29139       {
29140         "title": "Example usage:",
29141         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29142         "type": "json"
29143       }
29144     ],
29145     "name": "GetSmsInteractions",
29146     "group": "Users",
29147     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29148     "version": "0.0.0",
29149     "filename": "server/api/user/index.js",
29150     "groupTitle": "Users"
29151   },
29152   {
29153     "type": "get",
29154     "url": "/api/users/{id}/square_projects",
29155     "title": "GetSquareProjects",
29156     "examples": [
29157       {
29158         "title": "Example usage:",
29159         "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29160         "type": "json"
29161       }
29162     ],
29163     "name": "GetSquareProjects",
29164     "group": "Users",
29165     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29166     "version": "0.0.0",
29167     "filename": "server/api/user/index.js",
29168     "groupTitle": "Users"
29169   },
29170   {
29171     "type": "get",
29172     "url": "/api/users/{id}/teams",
29173     "title": "GetTeams",
29174     "examples": [
29175       {
29176         "title": "Example usage:",
29177         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29178         "type": "json"
29179       }
29180     ],
29181     "name": "GetTeams",
29182     "group": "Users",
29183     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29184     "version": "0.0.0",
29185     "filename": "server/api/user/index.js",
29186     "groupTitle": "Users"
29187   },
29188   {
29189     "type": "get",
29190     "url": "/api/users",
29191     "title": "Gets a list of Users",
29192     "examples": [
29193       {
29194         "title": "Example usage:",
29195         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29196         "type": "json"
29197       }
29198     ],
29199     "name": "GetUsers",
29200     "group": "Users",
29201     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29202     "version": "0.0.0",
29203     "filename": "server/api/user/index.js",
29204     "groupTitle": "Users"
29205   },
29206   {
29207     "type": "get",
29208     "url": "/api/users/{id}/queues_rt",
29209     "title": "GetVoiceQueuesRt",
29210     "examples": [
29211       {
29212         "title": "Example usage:",
29213         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29214         "type": "json"
29215       }
29216     ],
29217     "name": "GetVoiceQueuesRt",
29218     "group": "Users",
29219     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29220     "version": "0.0.0",
29221     "filename": "server/api/user/index.js",
29222     "groupTitle": "Users"
29223   },
29224   {
29225     "type": "get",
29226     "url": "/api/users/{id}/whatsapp_accounts",
29227     "title": "GetWhatsappAccounts",
29228     "examples": [
29229       {
29230         "title": "Example usage:",
29231         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29232         "type": "json"
29233       }
29234     ],
29235     "name": "GetWhatsappAccounts",
29236     "group": "Users",
29237     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29238     "version": "0.0.0",
29239     "filename": "server/api/user/index.js",
29240     "groupTitle": "Users"
29241   },
29242   {
29243     "type": "get",
29244     "url": "/api/users/{id}/whatsapp/interactions",
29245     "title": "GetWhatsappInteractions",
29246     "examples": [
29247       {
29248         "title": "Example usage:",
29249         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29250         "type": "json"
29251       }
29252     ],
29253     "name": "GetWhatsappInteractions",
29254     "group": "Users",
29255     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29256     "version": "0.0.0",
29257     "filename": "server/api/user/index.js",
29258     "groupTitle": "Users"
29259   },
29260   {
29261     "type": "post",
29262     "url": "/api/users/{id}/login",
29263     "title": "Login",
29264     "examples": [
29265       {
29266         "title": "Example usage:",
29267         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
29268         "type": "json"
29269       }
29270     ],
29271     "name": "Login",
29272     "group": "Users",
29273     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29274     "version": "0.0.0",
29275     "filename": "server/api/user/index.js",
29276     "groupTitle": "Users"
29277   },
29278   {
29279     "type": "post",
29280     "url": "/api/users/{id}/logout",
29281     "title": "Logout",
29282     "examples": [
29283       {
29284         "title": "Example usage:",
29285         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29286         "type": "json"
29287       }
29288     ],
29289     "name": "Logout",
29290     "group": "Users",
29291     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29292     "version": "0.0.0",
29293     "filename": "server/api/user/index.js",
29294     "groupTitle": "Users"
29295   },
29296   {
29297     "type": "post",
29298     "url": "/api/users/{id}/pause",
29299     "title": "Pause",
29300     "examples": [
29301       {
29302         "title": "Example usage:",
29303         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29304         "type": "json"
29305       }
29306     ],
29307     "name": "Pause",
29308     "group": "Users",
29309     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29310     "version": "0.0.0",
29311     "filename": "server/api/user/index.js",
29312     "groupTitle": "Users"
29313   },
29314   {
29315     "type": "delete",
29316     "url": "/api/users/{id}/api_key",
29317     "title": "Remove API access key for the user",
29318     "examples": [
29319       {
29320         "title": "Example usage:",
29321         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29322         "type": "json"
29323       }
29324     ],
29325     "name": "RemoveApiKey",
29326     "group": "Users",
29327     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29328     "version": "0.0.0",
29329     "filename": "server/api/user/index.js",
29330     "groupTitle": "Users"
29331   },
29332   {
29333     "type": "delete",
29334     "url": "/api/users/{id}/chat_interactions",
29335     "title": "Removes interactions from an agent",
29336     "examples": [
29337       {
29338         "title": "Example usage:",
29339         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29340         "type": "json"
29341       }
29342     ],
29343     "name": "RemoveChatInteractions",
29344     "group": "Users",
29345     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29346     "version": "0.0.0",
29347     "filename": "server/api/user/index.js",
29348     "groupTitle": "Users"
29349   },
29350   {
29351     "type": "delete",
29352     "url": "/api/users/{id}/chat_websites",
29353     "title": "Removes a Chat Website from a user",
29354     "examples": [
29355       {
29356         "title": "Example usage:",
29357         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29358         "type": "json"
29359       }
29360     ],
29361     "name": "RemoveChatWebsites",
29362     "group": "Users",
29363     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29364     "version": "0.0.0",
29365     "filename": "server/api/user/index.js",
29366     "groupTitle": "Users"
29367   },
29368   {
29369     "type": "delete",
29370     "url": "/api/users/{id}/fax_accounts",
29371     "title": "Removes a Fax Account from a user",
29372     "examples": [
29373       {
29374         "title": "Example usage:",
29375         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29376         "type": "json"
29377       }
29378     ],
29379     "name": "RemoveFaxAccounts",
29380     "group": "Users",
29381     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29382     "version": "0.0.0",
29383     "filename": "server/api/user/index.js",
29384     "groupTitle": "Users"
29385   },
29386   {
29387     "type": "delete",
29388     "url": "/api/users/{id}/fax_interactions",
29389     "title": "Removes interactions from an agent",
29390     "examples": [
29391       {
29392         "title": "Example usage:",
29393         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29394         "type": "json"
29395       }
29396     ],
29397     "name": "RemoveFaxInteractions",
29398     "group": "Users",
29399     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29400     "version": "0.0.0",
29401     "filename": "server/api/user/index.js",
29402     "groupTitle": "Users"
29403   },
29404   {
29405     "type": "delete",
29406     "url": "/api/users/{id}/mail_accounts",
29407     "title": "Removes a Mail Account from a user",
29408     "examples": [
29409       {
29410         "title": "Example usage:",
29411         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29412         "type": "json"
29413       }
29414     ],
29415     "name": "RemoveMailAccounts",
29416     "group": "Users",
29417     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29418     "version": "0.0.0",
29419     "filename": "server/api/user/index.js",
29420     "groupTitle": "Users"
29421   },
29422   {
29423     "type": "delete",
29424     "url": "/api/users/{id}/mail_interactions",
29425     "title": "Removes interactions from an agent",
29426     "examples": [
29427       {
29428         "title": "Example usage:",
29429         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29430         "type": "json"
29431       }
29432     ],
29433     "name": "RemoveMailInteractions",
29434     "group": "Users",
29435     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29436     "version": "0.0.0",
29437     "filename": "server/api/user/index.js",
29438     "groupTitle": "Users"
29439   },
29440   {
29441     "type": "delete",
29442     "url": "/api/users/{id}/openchannel_accounts",
29443     "title": "Removes a Open Channel Account from a user",
29444     "examples": [
29445       {
29446         "title": "Example usage:",
29447         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29448         "type": "json"
29449       }
29450     ],
29451     "name": "RemoveOpenchannelAccounts",
29452     "group": "Users",
29453     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29454     "version": "0.0.0",
29455     "filename": "server/api/user/index.js",
29456     "groupTitle": "Users"
29457   },
29458   {
29459     "type": "delete",
29460     "url": "/api/users/{id}/openchannel_interactions",
29461     "title": "Removes openchannel interactions from an agent",
29462     "examples": [
29463       {
29464         "title": "Example usage:",
29465         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29466         "type": "json"
29467       }
29468     ],
29469     "name": "RemoveOpenchannelInteractions",
29470     "group": "Users",
29471     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29472     "version": "0.0.0",
29473     "filename": "server/api/user/index.js",
29474     "groupTitle": "Users"
29475   },
29476   {
29477     "type": "delete",
29478     "url": "/api/users/{id}/queues",
29479     "title": "Remove queues to an agent",
29480     "examples": [
29481       {
29482         "title": "Example usage:",
29483         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29484         "type": "json"
29485       }
29486     ],
29487     "name": "RemoveQueues",
29488     "group": "Users",
29489     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29490     "version": "0.0.0",
29491     "filename": "server/api/user/index.js",
29492     "groupTitle": "Users"
29493   },
29494   {
29495     "type": "delete",
29496     "url": "/api/users/{id}/sms_accounts",
29497     "title": "Removes a Sms Account from a user",
29498     "examples": [
29499       {
29500         "title": "Example usage:",
29501         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29502         "type": "json"
29503       }
29504     ],
29505     "name": "RemoveSmsAccounts",
29506     "group": "Users",
29507     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29508     "version": "0.0.0",
29509     "filename": "server/api/user/index.js",
29510     "groupTitle": "Users"
29511   },
29512   {
29513     "type": "delete",
29514     "url": "/api/users/{id}/sms_interactions",
29515     "title": "Removes interactions from an agent",
29516     "examples": [
29517       {
29518         "title": "Example usage:",
29519         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29520         "type": "json"
29521       }
29522     ],
29523     "name": "RemoveSmsInteractions",
29524     "group": "Users",
29525     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29526     "version": "0.0.0",
29527     "filename": "server/api/user/index.js",
29528     "groupTitle": "Users"
29529   },
29530   {
29531     "type": "delete",
29532     "url": "/api/users/{id}/square_projects",
29533     "title": "Removes a Square Project from a user",
29534     "examples": [
29535       {
29536         "title": "Example usage:",
29537         "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29538         "type": "json"
29539       }
29540     ],
29541     "name": "RemoveSquareProjects",
29542     "group": "Users",
29543     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29544     "version": "0.0.0",
29545     "filename": "server/api/user/index.js",
29546     "groupTitle": "Users"
29547   },
29548   {
29549     "type": "delete",
29550     "url": "/api/users/{id}/teams",
29551     "title": "Removes teams from an agent",
29552     "examples": [
29553       {
29554         "title": "Example usage:",
29555         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29556         "type": "json"
29557       }
29558     ],
29559     "name": "RemoveTeams",
29560     "group": "Users",
29561     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29562     "version": "0.0.0",
29563     "filename": "server/api/user/index.js",
29564     "groupTitle": "Users"
29565   },
29566   {
29567     "type": "delete",
29568     "url": "/api/users/{id}/whatsapp_accounts",
29569     "title": "Removes a Whatsapp Account from a user",
29570     "examples": [
29571       {
29572         "title": "Example usage:",
29573         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29574         "type": "json"
29575       }
29576     ],
29577     "name": "RemoveWhatsappAccounts",
29578     "group": "Users",
29579     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29580     "version": "0.0.0",
29581     "filename": "server/api/user/index.js",
29582     "groupTitle": "Users"
29583   },
29584   {
29585     "type": "delete",
29586     "url": "/api/users/{id}/whatsapp_interactions",
29587     "title": "Removes Whatsapp interactions from an agent",
29588     "examples": [
29589       {
29590         "title": "Example usage:",
29591         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29592         "type": "json"
29593       }
29594     ],
29595     "name": "RemoveWhatsappInteractions",
29596     "group": "Users",
29597     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29598     "version": "0.0.0",
29599     "filename": "server/api/user/index.js",
29600     "groupTitle": "Users"
29601   },
29602   {
29603     "type": "get",
29604     "url": "/api/users/{id}",
29605     "title": "Gets a single User",
29606     "examples": [
29607       {
29608         "title": "Example usage:",
29609         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29610         "type": "json"
29611       }
29612     ],
29613     "name": "ShowUsers",
29614     "group": "Users",
29615     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29616     "version": "0.0.0",
29617     "filename": "server/api/user/index.js",
29618     "groupTitle": "Users"
29619   },
29620   {
29621     "type": "post",
29622     "url": "/api/users/{id}/unpause",
29623     "title": "Unpause",
29624     "examples": [
29625       {
29626         "title": "Example usage:",
29627         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29628         "type": "json"
29629       }
29630     ],
29631     "name": "Unpause",
29632     "group": "Users",
29633     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29634     "version": "0.0.0",
29635     "filename": "server/api/user/index.js",
29636     "groupTitle": "Users"
29637   },
29638   {
29639     "type": "get",
29640     "url": "/api/users/whoami",
29641     "title": "WhoAmI",
29642     "examples": [
29643       {
29644         "title": "Example usage:",
29645         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29646         "type": "json"
29647       }
29648     ],
29649     "name": "WhoAmI",
29650     "group": "Users",
29651     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29652     "version": "0.0.0",
29653     "filename": "server/api/user/index.js",
29654     "groupTitle": "Users"
29655   },
29656   {
29657     "type": "post",
29658     "url": "/api/users/{id}/avatar",
29659     "title": "Add avatar",
29660     "examples": [
29661       {
29662         "title": "Example usage:",
29663         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29664         "type": "json"
29665       }
29666     ],
29667     "name": "addAvatar",
29668     "group": "Users",
29669     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29670     "version": "0.0.0",
29671     "filename": "server/api/user/index.js",
29672     "groupTitle": "Users"
29673   },
29674   {
29675     "type": "post",
29676     "url": "/api/users/create_many",
29677     "title": "Create Users",
29678     "examples": [
29679       {
29680         "title": "Example usage:",
29681         "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29682         "type": "json"
29683       }
29684     ],
29685     "name": "bulkCreate",
29686     "group": "Users",
29687     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29688     "version": "0.0.0",
29689     "filename": "server/api/user/index.js",
29690     "groupTitle": "Users"
29691   },
29692   {
29693     "type": "get",
29694     "url": "/api/users/{id}/avatar",
29695     "title": "Get avatar",
29696     "examples": [
29697       {
29698         "title": "Example usage:",
29699         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29700         "type": "json"
29701       }
29702     ],
29703     "name": "getAvatar",
29704     "group": "Users",
29705     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29706     "version": "0.0.0",
29707     "filename": "server/api/user/index.js",
29708     "groupTitle": "Users"
29709   },
29710   {
29711     "type": "get",
29712     "url": "/api/users/{id}/open_tabs",
29713     "title": "Get interactions opened tabs",
29714     "examples": [
29715       {
29716         "title": "Example usage:",
29717         "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
29718         "type": "json"
29719       }
29720     ],
29721     "name": "getOpenTabs",
29722     "group": "Users",
29723     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29724     "version": "0.0.0",
29725     "filename": "server/api/user/index.js",
29726     "groupTitle": "Users"
29727   },
29728   {
29729     "type": "get",
29730     "url": "/api/users/presence",
29731     "title": "Gets agent presence",
29732     "examples": [
29733       {
29734         "title": "Example usage:",
29735         "content": "curl https://{domain}/api/users/presence -v -u {name}:{password}  -X GET",
29736         "type": "json"
29737       }
29738     ],
29739     "name": "getPresence",
29740     "group": "Users",
29741     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29742     "version": "0.0.0",
29743     "filename": "server/api/user/index.js",
29744     "groupTitle": "Users"
29745   },
29746   {
29747     "type": "put",
29748     "url": "/api/users/{id}",
29749     "title": "Update an existing User",
29750     "examples": [
29751       {
29752         "title": "Example usage:",
29753         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29754         "type": "json"
29755       }
29756     ],
29757     "name": "updateUsers",
29758     "group": "Users",
29759     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29760     "version": "0.0.0",
29761     "filename": "server/api/user/index.js",
29762     "groupTitle": "Users"
29763   },
29764   {
29765     "type": "post",
29766     "url": "/api/variables",
29767     "title": "Creates a new Variable",
29768     "examples": [
29769       {
29770         "title": "Example usage:",
29771         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29772         "type": "json"
29773       }
29774     ],
29775     "name": "CreateVariables",
29776     "group": "Variables",
29777     "parameter": {
29778       "fields": {
29779         "Body": [
29780           {
29781             "group": "Body",
29782             "type": "String",
29783             "optional": false,
29784             "field": "name",
29785             "description": ""
29786           },
29787           {
29788             "group": "Body",
29789             "type": "String",
29790             "optional": true,
29791             "field": "description",
29792             "description": ""
29793           }
29794         ]
29795       }
29796     },
29797     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29798     "version": "0.0.0",
29799     "filename": "server/api/variable/index.js",
29800     "groupTitle": "Variables"
29801   },
29802   {
29803     "type": "delete",
29804     "url": "/api/variables/{id}",
29805     "title": "Deletes a Variable",
29806     "examples": [
29807       {
29808         "title": "Example usage:",
29809         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
29810         "type": "json"
29811       }
29812     ],
29813     "name": "DeleteVariables",
29814     "group": "Variables",
29815     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29816     "version": "0.0.0",
29817     "filename": "server/api/variable/index.js",
29818     "groupTitle": "Variables"
29819   },
29820   {
29821     "type": "get",
29822     "url": "/api/variables",
29823     "title": "Gets a list of Variables",
29824     "examples": [
29825       {
29826         "title": "Example usage:",
29827         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
29828         "type": "json"
29829       }
29830     ],
29831     "name": "GetVariables",
29832     "group": "Variables",
29833     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29834     "version": "0.0.0",
29835     "filename": "server/api/variable/index.js",
29836     "groupTitle": "Variables"
29837   },
29838   {
29839     "type": "get",
29840     "url": "/api/variables/{id}",
29841     "title": "Gets a single Variable",
29842     "examples": [
29843       {
29844         "title": "Example usage:",
29845         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
29846         "type": "json"
29847       }
29848     ],
29849     "name": "ShowVariables",
29850     "group": "Variables",
29851     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29852     "version": "0.0.0",
29853     "filename": "server/api/variable/index.js",
29854     "groupTitle": "Variables"
29855   },
29856   {
29857     "type": "put",
29858     "url": "/api/variables/{id}",
29859     "title": "Update an existing Variable",
29860     "examples": [
29861       {
29862         "title": "Example usage:",
29863         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29864         "type": "json"
29865       }
29866     ],
29867     "name": "updateVariables",
29868     "group": "Variables",
29869     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29870     "version": "0.0.0",
29871     "filename": "server/api/variable/index.js",
29872     "groupTitle": "Variables"
29873   },
29874   {
29875     "type": "get",
29876     "url": "/api/version/fetch",
29877     "title": "Fetch git version",
29878     "examples": [
29879       {
29880         "title": "Example usage:",
29881         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
29882         "type": "json"
29883       }
29884     ],
29885     "name": "FetchVersion",
29886     "group": "Version",
29887     "description": "<p>Motion run the following command: git fetch origin master</p>",
29888     "version": "0.0.0",
29889     "filename": "server/api/version/index.js",
29890     "groupTitle": "Version"
29891   },
29892   {
29893     "type": "get",
29894     "url": "/api/version",
29895     "title": "Gets version",
29896     "examples": [
29897       {
29898         "title": "Example usage:",
29899         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
29900         "type": "json"
29901       }
29902     ],
29903     "name": "GetVersion",
29904     "group": "Version",
29905     "description": "<p>Motion returns the current and latest motion version.</p>",
29906     "version": "0.0.0",
29907     "filename": "server/api/version/index.js",
29908     "groupTitle": "Version"
29909   },
29910   {
29911     "type": "get",
29912     "url": "/api/version/migrations",
29913     "title": "Launch database migrations",
29914     "examples": [
29915       {
29916         "title": "Example usage:",
29917         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
29918         "type": "json"
29919       }
29920     ],
29921     "name": "MigrateVersion",
29922     "group": "Version",
29923     "description": "<p>Motion launch the database migrations, according to the application version</p>",
29924     "version": "0.0.0",
29925     "filename": "server/api/version/index.js",
29926     "groupTitle": "Version"
29927   },
29928   {
29929     "type": "get",
29930     "url": "/api/version/pull",
29931     "title": "Pull git version",
29932     "examples": [
29933       {
29934         "title": "Example usage:",
29935         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
29936         "type": "json"
29937       }
29938     ],
29939     "name": "PullVersion",
29940     "group": "Version",
29941     "description": "<p>Motion run the following command: git pull</p>",
29942     "version": "0.0.0",
29943     "filename": "server/api/version/index.js",
29944     "groupTitle": "Version"
29945   },
29946   {
29947     "type": "get",
29948     "url": "/api/version/reset",
29949     "title": "Reset git version",
29950     "examples": [
29951       {
29952         "title": "Example usage:",
29953         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
29954         "type": "json"
29955       }
29956     ],
29957     "name": "ResetVersion",
29958     "group": "Version",
29959     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
29960     "version": "0.0.0",
29961     "filename": "server/api/version/index.js",
29962     "groupTitle": "Version"
29963   },
29964   {
29965     "type": "get",
29966     "url": "/api/version/restart",
29967     "title": "Restart motion2 after update",
29968     "examples": [
29969       {
29970         "title": "Example usage:",
29971         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
29972         "type": "json"
29973       }
29974     ],
29975     "name": "RestartVersion",
29976     "group": "Version",
29977     "description": "<p>Motion run the following command: pm2 restart motion</p>",
29978     "version": "0.0.0",
29979     "filename": "server/api/version/index.js",
29980     "groupTitle": "Version"
29981   },
29982   {
29983     "type": "get",
29984     "url": "/api/voice/agents/reports/describe",
29985     "title": "Gets table info about Agent Reports",
29986     "examples": [
29987       {
29988         "title": "Example usage:",
29989         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
29990         "type": "json"
29991       }
29992     ],
29993     "name": "DescribeAgent_Reports",
29994     "group": "Voice_Agent_Reports",
29995     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29996     "version": "0.0.0",
29997     "filename": "server/api/voiceAgentReport/index.js",
29998     "groupTitle": "Voice_Agent_Reports"
29999   },
30000   {
30001     "type": "get",
30002     "url": "/api/voice/agents/reports",
30003     "title": "Gets a list of Agent Reports",
30004     "examples": [
30005       {
30006         "title": "Example usage:",
30007         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30008         "type": "json"
30009       }
30010     ],
30011     "name": "GetAgent_Reports",
30012     "group": "Voice_Agent_Reports",
30013     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30014     "version": "0.0.0",
30015     "filename": "server/api/voiceAgentReport/index.js",
30016     "groupTitle": "Voice_Agent_Reports"
30017   },
30018   {
30019     "type": "get",
30020     "url": "/api/voice/agents/reports/{id}",
30021     "title": "Gets a single Agent Report",
30022     "examples": [
30023       {
30024         "title": "Example usage:",
30025         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30026         "type": "json"
30027       }
30028     ],
30029     "name": "ShowAgent_Reports",
30030     "group": "Voice_Agent_Reports",
30031     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30032     "version": "0.0.0",
30033     "filename": "server/api/voiceAgentReport/index.js",
30034     "groupTitle": "Voice_Agent_Reports"
30035   },
30036   {
30037     "type": "get",
30038     "url": "/api/voice/calls/reports/describe",
30039     "title": "Gets table info about Call Reports",
30040     "examples": [
30041       {
30042         "title": "Example usage:",
30043         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30044         "type": "json"
30045       }
30046     ],
30047     "name": "DescribeCall_Reports",
30048     "group": "Voice_Call_Reports",
30049     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30050     "version": "0.0.0",
30051     "filename": "server/api/voiceCallReport/index.js",
30052     "groupTitle": "Voice_Call_Reports"
30053   },
30054   {
30055     "type": "get",
30056     "url": "/api/voice/calls/reports",
30057     "title": "Gets a list of Call Reports",
30058     "examples": [
30059       {
30060         "title": "Example usage:",
30061         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30062         "type": "json"
30063       }
30064     ],
30065     "name": "GetCall_Reports",
30066     "group": "Voice_Call_Reports",
30067     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30068     "version": "0.0.0",
30069     "filename": "server/api/voiceCallReport/index.js",
30070     "groupTitle": "Voice_Call_Reports"
30071   },
30072   {
30073     "type": "get",
30074     "url": "/api/voice/calls/reports/{id}",
30075     "title": "Gets a single Call Report",
30076     "examples": [
30077       {
30078         "title": "Example usage:",
30079         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30080         "type": "json"
30081       }
30082     ],
30083     "name": "ShowCall_Reports",
30084     "group": "Voice_Call_Reports",
30085     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30086     "version": "0.0.0",
30087     "filename": "server/api/voiceCallReport/index.js",
30088     "groupTitle": "Voice_Call_Reports"
30089   },
30090   {
30091     "type": "put",
30092     "url": "/api/voice/calls/reports/{id}",
30093     "title": "Update a single cdr",
30094     "examples": [
30095       {
30096         "title": "Example usage:",
30097         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30098         "type": "json"
30099       }
30100     ],
30101     "name": "update",
30102     "group": "Voice_Call_Reports",
30103     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30104     "version": "0.0.0",
30105     "filename": "server/api/voiceCallReport/index.js",
30106     "groupTitle": "Voice_Call_Reports"
30107   },
30108   {
30109     "type": "post",
30110     "url": "/api/voice/chanspy",
30111     "title": "Creates a new ChanSpy",
30112     "examples": [
30113       {
30114         "title": "Example usage:",
30115         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30116         "type": "json"
30117       }
30118     ],
30119     "name": "CreateChanSpy",
30120     "group": "Voice_ChanSpy",
30121     "parameter": {
30122       "fields": {
30123         "Body": [
30124           {
30125             "group": "Body",
30126             "type": "String",
30127             "optional": true,
30128             "field": "name",
30129             "description": ""
30130           },
30131           {
30132             "group": "Body",
30133             "type": "String",
30134             "optional": false,
30135             "field": "prefix",
30136             "description": ""
30137           },
30138           {
30139             "group": "Body",
30140             "type": "String",
30141             "optional": true,
30142             "field": "options",
30143             "description": ""
30144           },
30145           {
30146             "group": "Body",
30147             "type": "Boolean",
30148             "optional": true,
30149             "field": "auth",
30150             "description": ""
30151           },
30152           {
30153             "group": "Body",
30154             "type": "String",
30155             "optional": true,
30156             "field": "password",
30157             "description": ""
30158           },
30159           {
30160             "group": "Body",
30161             "type": "Boolean",
30162             "optional": true,
30163             "field": "record",
30164             "description": ""
30165           },
30166           {
30167             "group": "Body",
30168             "type": "String",
30169             "optional": true,
30170             "field": "recordingFormat",
30171             "description": ""
30172           },
30173           {
30174             "group": "Body",
30175             "type": "String",
30176             "optional": true,
30177             "field": "description",
30178             "description": ""
30179           }
30180         ]
30181       }
30182     },
30183     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30184     "version": "0.0.0",
30185     "filename": "server/api/voiceChanSpy/index.js",
30186     "groupTitle": "Voice_ChanSpy"
30187   },
30188   {
30189     "type": "delete",
30190     "url": "/api/voice/chanspy/{id}",
30191     "title": "Deletes a ChanSpy",
30192     "examples": [
30193       {
30194         "title": "Example usage:",
30195         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30196         "type": "json"
30197       }
30198     ],
30199     "name": "DeleteChanSpy",
30200     "group": "Voice_ChanSpy",
30201     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30202     "version": "0.0.0",
30203     "filename": "server/api/voiceChanSpy/index.js",
30204     "groupTitle": "Voice_ChanSpy"
30205   },
30206   {
30207     "type": "get",
30208     "url": "/api/voice/chanspy",
30209     "title": "Gets a list of ChanSpy",
30210     "examples": [
30211       {
30212         "title": "Example usage:",
30213         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30214         "type": "json"
30215       }
30216     ],
30217     "name": "GetChanSpy",
30218     "group": "Voice_ChanSpy",
30219     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30220     "version": "0.0.0",
30221     "filename": "server/api/voiceChanSpy/index.js",
30222     "groupTitle": "Voice_ChanSpy"
30223   },
30224   {
30225     "type": "get",
30226     "url": "/api/voice/chanspy/{id}",
30227     "title": "Gets a single ChanSpy",
30228     "examples": [
30229       {
30230         "title": "Example usage:",
30231         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30232         "type": "json"
30233       }
30234     ],
30235     "name": "ShowChanSpy",
30236     "group": "Voice_ChanSpy",
30237     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30238     "version": "0.0.0",
30239     "filename": "server/api/voiceChanSpy/index.js",
30240     "groupTitle": "Voice_ChanSpy"
30241   },
30242   {
30243     "type": "put",
30244     "url": "/api/voice/chanspy/{id}",
30245     "title": "Update an existing ChanSpy",
30246     "examples": [
30247       {
30248         "title": "Example usage:",
30249         "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",
30250         "type": "json"
30251       }
30252     ],
30253     "name": "updateChanSpy",
30254     "group": "Voice_ChanSpy",
30255     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30256     "version": "0.0.0",
30257     "filename": "server/api/voiceChanSpy/index.js",
30258     "groupTitle": "Voice_ChanSpy"
30259   },
30260   {
30261     "type": "post",
30262     "url": "/api/voice/contexts",
30263     "title": "Create a new context",
30264     "examples": [
30265       {
30266         "title": "Example usage:",
30267         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30268         "type": "json"
30269       }
30270     ],
30271     "name": "Create",
30272     "group": "Voice_Contexts",
30273     "parameter": {
30274       "fields": {
30275         "Body": [
30276           {
30277             "group": "Body",
30278             "type": "String",
30279             "optional": true,
30280             "field": "name",
30281             "description": ""
30282           },
30283           {
30284             "group": "Body",
30285             "type": "String",
30286             "optional": true,
30287             "field": "description",
30288             "description": ""
30289           },
30290           {
30291             "group": "Body",
30292             "type": "Boolean",
30293             "optional": true,
30294             "field": "defaultEntry",
30295             "description": ""
30296           }
30297         ]
30298       }
30299     },
30300     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30301     "version": "0.0.0",
30302     "filename": "server/api/voiceContext/index.js",
30303     "groupTitle": "Voice_Contexts"
30304   },
30305   {
30306     "type": "delete",
30307     "url": "/api/voice/contexts/{id}",
30308     "title": "Deletes a context",
30309     "examples": [
30310       {
30311         "title": "Example usage:",
30312         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30313         "type": "json"
30314       }
30315     ],
30316     "name": "Delete",
30317     "group": "Voice_Contexts",
30318     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30319     "version": "0.0.0",
30320     "filename": "server/api/voiceContext/index.js",
30321     "groupTitle": "Voice_Contexts"
30322   },
30323   {
30324     "type": "get",
30325     "url": "/api/voice/contexts",
30326     "title": "Gets a list of Contexts",
30327     "examples": [
30328       {
30329         "title": "Example usage:",
30330         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30331         "type": "json"
30332       }
30333     ],
30334     "name": "GetContexts",
30335     "group": "Voice_Contexts",
30336     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30337     "version": "0.0.0",
30338     "filename": "server/api/voiceContext/index.js",
30339     "groupTitle": "Voice_Contexts"
30340   },
30341   {
30342     "type": "get",
30343     "url": "/api/voice/contexts/{id}",
30344     "title": "Gets a single Context",
30345     "examples": [
30346       {
30347         "title": "Example usage:",
30348         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30349         "type": "json"
30350       }
30351     ],
30352     "name": "ShowContexts",
30353     "group": "Voice_Contexts",
30354     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30355     "version": "0.0.0",
30356     "filename": "server/api/voiceContext/index.js",
30357     "groupTitle": "Voice_Contexts"
30358   },
30359   {
30360     "type": "put",
30361     "url": "/api/voice/contexts/{id}",
30362     "title": "Update an existing context",
30363     "examples": [
30364       {
30365         "title": "Example usage:",
30366         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30367         "type": "json"
30368       }
30369     ],
30370     "name": "Update",
30371     "group": "Voice_Contexts",
30372     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30373     "version": "0.0.0",
30374     "filename": "server/api/voiceContext/index.js",
30375     "groupTitle": "Voice_Contexts"
30376   },
30377   {
30378     "type": "get",
30379     "url": "/api/voice/dials/reports/describe",
30380     "title": "Gets table info about Dial Reports",
30381     "examples": [
30382       {
30383         "title": "Example usage:",
30384         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30385         "type": "json"
30386       }
30387     ],
30388     "name": "DescribeDial_Reports",
30389     "group": "Voice_Dial_Reports",
30390     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30391     "version": "0.0.0",
30392     "filename": "server/api/voiceDialReport/index.js",
30393     "groupTitle": "Voice_Dial_Reports"
30394   },
30395   {
30396     "type": "get",
30397     "url": "/api/voice/dials/reports",
30398     "title": "Gets a list of Dial Reports",
30399     "examples": [
30400       {
30401         "title": "Example usage:",
30402         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30403         "type": "json"
30404       }
30405     ],
30406     "name": "GetDial_Reports",
30407     "group": "Voice_Dial_Reports",
30408     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30409     "version": "0.0.0",
30410     "filename": "server/api/voiceDialReport/index.js",
30411     "groupTitle": "Voice_Dial_Reports"
30412   },
30413   {
30414     "type": "get",
30415     "url": "/api/voice/dials/reports/{id}",
30416     "title": "Gets a single Dial Report",
30417     "examples": [
30418       {
30419         "title": "Example usage:",
30420         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30421         "type": "json"
30422       }
30423     ],
30424     "name": "ShowDial_Reports",
30425     "group": "Voice_Dial_Reports",
30426     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30427     "version": "0.0.0",
30428     "filename": "server/api/voiceDialReport/index.js",
30429     "groupTitle": "Voice_Dial_Reports"
30430   },
30431   {
30432     "type": "delete",
30433     "url": "/api/voice/extensions/{id}",
30434     "title": "Deletes a Extension",
30435     "examples": [
30436       {
30437         "title": "Example usage:",
30438         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30439         "type": "json"
30440       }
30441     ],
30442     "name": "DeleteExtensions",
30443     "group": "Voice_Extensions",
30444     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30445     "version": "0.0.0",
30446     "filename": "server/api/voiceExtension/index.js",
30447     "groupTitle": "Voice_Extensions"
30448   },
30449   {
30450     "type": "get",
30451     "url": "/api/voice/extensions",
30452     "title": "Gets a list of Extensions",
30453     "examples": [
30454       {
30455         "title": "Example usage:",
30456         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30457         "type": "json"
30458       }
30459     ],
30460     "name": "GetExtensions",
30461     "group": "Voice_Extensions",
30462     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30463     "version": "0.0.0",
30464     "filename": "server/api/voiceExtension/index.js",
30465     "groupTitle": "Voice_Extensions"
30466   },
30467   {
30468     "type": "get",
30469     "url": "/api/voice/extensions/{id}",
30470     "title": "Gets a single Extension",
30471     "examples": [
30472       {
30473         "title": "Example usage:",
30474         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30475         "type": "json"
30476       }
30477     ],
30478     "name": "ShowExtensions",
30479     "group": "Voice_Extensions",
30480     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30481     "version": "0.0.0",
30482     "filename": "server/api/voiceExtension/index.js",
30483     "groupTitle": "Voice_Extensions"
30484   },
30485   {
30486     "type": "post",
30487     "url": "/api/voice/extensions",
30488     "title": "Create new applications",
30489     "examples": [
30490       {
30491         "title": "Example usage:",
30492         "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",
30493         "type": "json"
30494       }
30495     ],
30496     "name": "addApplications",
30497     "group": "Voice_Extensions",
30498     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30499     "version": "0.0.0",
30500     "filename": "server/api/voiceExtension/index.js",
30501     "groupTitle": "Voice_Extensions"
30502   },
30503   {
30504     "type": "post",
30505     "url": "/api/voice/extensions",
30506     "title": "Create an extension",
30507     "examples": [
30508       {
30509         "title": "Example usage:",
30510         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30511         "type": "json"
30512       }
30513     ],
30514     "name": "create",
30515     "group": "Voice_Extensions",
30516     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30517     "version": "0.0.0",
30518     "filename": "server/api/voiceExtension/index.js",
30519     "groupTitle": "Voice_Extensions"
30520   },
30521   {
30522     "type": "put",
30523     "url": "/api/voice/extensions/{id}",
30524     "title": "Update an extension",
30525     "examples": [
30526       {
30527         "title": "Example usage:",
30528         "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",
30529         "type": "json"
30530       }
30531     ],
30532     "name": "update",
30533     "group": "Voice_Extensions",
30534     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30535     "version": "0.0.0",
30536     "filename": "server/api/voiceExtension/index.js",
30537     "groupTitle": "Voice_Extensions"
30538   },
30539   {
30540     "type": "post",
30541     "url": "/api/voice/mohs",
30542     "title": "Create a new a new MOH",
30543     "examples": [
30544       {
30545         "title": "Example usage:",
30546         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30547         "type": "json"
30548       }
30549     ],
30550     "name": "AddMoh",
30551     "group": "Voice_MOHs",
30552     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30553     "version": "0.0.0",
30554     "filename": "server/api/voiceMusicOnHold/index.js",
30555     "groupTitle": "Voice_MOHs"
30556   },
30557   {
30558     "type": "post",
30559     "url": "/api/voice/mohs/{id}/sounds",
30560     "title": "Add sound to MOH",
30561     "examples": [
30562       {
30563         "title": "Example usage:",
30564         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30565         "type": "json"
30566       }
30567     ],
30568     "name": "AddSound",
30569     "group": "Voice_MOHs",
30570     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30571     "version": "0.0.0",
30572     "filename": "server/api/voiceMusicOnHold/index.js",
30573     "groupTitle": "Voice_MOHs"
30574   },
30575   {
30576     "type": "delete",
30577     "url": "/api/voice/mohs/{id}",
30578     "title": "Deletes an MOH",
30579     "examples": [
30580       {
30581         "title": "Example usage:",
30582         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30583         "type": "json"
30584       }
30585     ],
30586     "name": "DestroyMoh",
30587     "group": "Voice_MOHs",
30588     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30589     "version": "0.0.0",
30590     "filename": "server/api/voiceMusicOnHold/index.js",
30591     "groupTitle": "Voice_MOHs"
30592   },
30593   {
30594     "type": "get",
30595     "url": "/api/voice/mohs",
30596     "title": "Gets a list of Music On Holds",
30597     "examples": [
30598       {
30599         "title": "Example usage:",
30600         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30601         "type": "json"
30602       }
30603     ],
30604     "name": "GetMusic_On_Holds",
30605     "group": "Voice_MOHs",
30606     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30607     "version": "0.0.0",
30608     "filename": "server/api/voiceMusicOnHold/index.js",
30609     "groupTitle": "Voice_MOHs"
30610   },
30611   {
30612     "type": "get",
30613     "url": "/api/voice/mohs/{id}/sounds",
30614     "title": "Gets sounds from MOH",
30615     "examples": [
30616       {
30617         "title": "Example usage:",
30618         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30619         "type": "json"
30620       }
30621     ],
30622     "name": "GetSounds",
30623     "group": "Voice_MOHs",
30624     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30625     "version": "0.0.0",
30626     "filename": "server/api/voiceMusicOnHold/index.js",
30627     "groupTitle": "Voice_MOHs"
30628   },
30629   {
30630     "type": "delete",
30631     "url": "/api/voice/mohs/{id}/sounds/{id2}",
30632     "title": "Remove sound from MOH",
30633     "examples": [
30634       {
30635         "title": "Example usage:",
30636         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30637         "type": "json"
30638       }
30639     ],
30640     "name": "RemoveSound",
30641     "group": "Voice_MOHs",
30642     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30643     "version": "0.0.0",
30644     "filename": "server/api/voiceMusicOnHold/index.js",
30645     "groupTitle": "Voice_MOHs"
30646   },
30647   {
30648     "type": "get",
30649     "url": "/api/voice/mohs/{id}",
30650     "title": "Gets a single Music On Hold",
30651     "examples": [
30652       {
30653         "title": "Example usage:",
30654         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30655         "type": "json"
30656       }
30657     ],
30658     "name": "ShowMusic_On_Holds",
30659     "group": "Voice_MOHs",
30660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30661     "version": "0.0.0",
30662     "filename": "server/api/voiceMusicOnHold/index.js",
30663     "groupTitle": "Voice_MOHs"
30664   },
30665   {
30666     "type": "put",
30667     "url": "/api/voice/mohs/{id}",
30668     "title": "Update an existing Music On Hold",
30669     "examples": [
30670       {
30671         "title": "Example usage:",
30672         "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",
30673         "type": "json"
30674       }
30675     ],
30676     "name": "updateMusic_On_Holds",
30677     "group": "Voice_MOHs",
30678     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30679     "version": "0.0.0",
30680     "filename": "server/api/voiceMusicOnHold/index.js",
30681     "groupTitle": "Voice_MOHs"
30682   },
30683   {
30684     "type": "post",
30685     "url": "/api/voice/mails",
30686     "title": "Creates a new Mail",
30687     "examples": [
30688       {
30689         "title": "Example usage:",
30690         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30691         "type": "json"
30692       }
30693     ],
30694     "name": "CreateMails",
30695     "group": "Voice_Mails",
30696     "parameter": {
30697       "fields": {
30698         "Body": [
30699           {
30700             "group": "Body",
30701             "type": "String",
30702             "optional": true,
30703             "field": "customer_id",
30704             "description": ""
30705           },
30706           {
30707             "group": "Body",
30708             "type": "String",
30709             "optional": true,
30710             "field": "context",
30711             "description": ""
30712           },
30713           {
30714             "group": "Body",
30715             "type": "String",
30716             "optional": false,
30717             "field": "mailbox",
30718             "description": ""
30719           },
30720           {
30721             "group": "Body",
30722             "type": "String",
30723             "optional": true,
30724             "field": "password",
30725             "description": ""
30726           },
30727           {
30728             "group": "Body",
30729             "type": "String",
30730             "optional": true,
30731             "field": "fullname",
30732             "description": ""
30733           },
30734           {
30735             "group": "Body",
30736             "type": "String",
30737             "optional": true,
30738             "field": "email",
30739             "description": ""
30740           },
30741           {
30742             "group": "Body",
30743             "type": "String",
30744             "optional": true,
30745             "field": "pager",
30746             "description": ""
30747           },
30748           {
30749             "group": "Body",
30750             "type": "String",
30751             "optional": true,
30752             "field": "tz",
30753             "description": ""
30754           },
30755           {
30756             "group": "Body",
30757             "type": "String",
30758             "allowedValues": [
30759               "\"yes\"",
30760               "\"no\""
30761             ],
30762             "optional": false,
30763             "field": "attach",
30764             "description": ""
30765           },
30766           {
30767             "group": "Body",
30768             "type": "String",
30769             "allowedValues": [
30770               "\"yes\"",
30771               "\"no\""
30772             ],
30773             "optional": false,
30774             "field": "saycid",
30775             "description": ""
30776           },
30777           {
30778             "group": "Body",
30779             "type": "String",
30780             "optional": true,
30781             "field": "dialout",
30782             "description": ""
30783           },
30784           {
30785             "group": "Body",
30786             "type": "String",
30787             "optional": true,
30788             "field": "callback",
30789             "description": ""
30790           },
30791           {
30792             "group": "Body",
30793             "type": "String",
30794             "allowedValues": [
30795               "\"yes\"",
30796               "\"no\""
30797             ],
30798             "optional": false,
30799             "field": "review",
30800             "description": ""
30801           },
30802           {
30803             "group": "Body",
30804             "type": "String",
30805             "allowedValues": [
30806               "\"yes\"",
30807               "\"no\""
30808             ],
30809             "optional": false,
30810             "field": "operator",
30811             "description": ""
30812           },
30813           {
30814             "group": "Body",
30815             "type": "String",
30816             "allowedValues": [
30817               "\"yes\"",
30818               "\"no\""
30819             ],
30820             "optional": false,
30821             "field": "envelope",
30822             "description": ""
30823           },
30824           {
30825             "group": "Body",
30826             "type": "String",
30827             "allowedValues": [
30828               "\"yes\"",
30829               "\"no\""
30830             ],
30831             "optional": false,
30832             "field": "sayduration",
30833             "description": ""
30834           },
30835           {
30836             "group": "Body",
30837             "type": "String",
30838             "optional": false,
30839             "field": "saydurationm",
30840             "description": ""
30841           },
30842           {
30843             "group": "Body",
30844             "type": "String",
30845             "allowedValues": [
30846               "\"yes\"",
30847               "\"no\""
30848             ],
30849             "optional": false,
30850             "field": "sendvoicemail",
30851             "description": ""
30852           },
30853           {
30854             "group": "Body",
30855             "type": "String",
30856             "allowedValues": [
30857               "\"yes\"",
30858               "\"no\""
30859             ],
30860             "optional": false,
30861             "field": "delete",
30862             "description": ""
30863           },
30864           {
30865             "group": "Body",
30866             "type": "String",
30867             "allowedValues": [
30868               "\"yes\"",
30869               "\"no\""
30870             ],
30871             "optional": false,
30872             "field": "nextaftercmd",
30873             "description": ""
30874           },
30875           {
30876             "group": "Body",
30877             "type": "String",
30878             "allowedValues": [
30879               "\"yes\"",
30880               "\"no\""
30881             ],
30882             "optional": false,
30883             "field": "forcename",
30884             "description": ""
30885           },
30886           {
30887             "group": "Body",
30888             "type": "String",
30889             "allowedValues": [
30890               "\"yes\"",
30891               "\"no\""
30892             ],
30893             "optional": false,
30894             "field": "forcegreetings",
30895             "description": ""
30896           },
30897           {
30898             "group": "Body",
30899             "type": "String",
30900             "allowedValues": [
30901               "\"yes\"",
30902               "\"no\""
30903             ],
30904             "optional": false,
30905             "field": "hidefromdir",
30906             "description": ""
30907           },
30908           {
30909             "group": "Body",
30910             "type": "String",
30911             "optional": true,
30912             "field": "stamp",
30913             "description": ""
30914           },
30915           {
30916             "group": "Body",
30917             "type": "String",
30918             "optional": true,
30919             "field": "emailsubject",
30920             "description": ""
30921           },
30922           {
30923             "group": "Body",
30924             "type": "String",
30925             "optional": true,
30926             "field": "emailbody",
30927             "description": ""
30928           },
30929           {
30930             "group": "Body",
30931             "type": "Integer",
30932             "optional": false,
30933             "field": "maxsecs",
30934             "description": ""
30935           },
30936           {
30937             "group": "Body",
30938             "type": "Integer",
30939             "optional": false,
30940             "field": "maxmsg",
30941             "description": ""
30942           },
30943           {
30944             "group": "Body",
30945             "type": "Virtual",
30946             "optional": true,
30947             "field": "name",
30948             "description": ""
30949           }
30950         ]
30951       }
30952     },
30953     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30954     "version": "0.0.0",
30955     "filename": "server/api/voiceMail/index.js",
30956     "groupTitle": "Voice_Mails"
30957   },
30958   {
30959     "type": "delete",
30960     "url": "/api/voice/mails/{id}",
30961     "title": "Deletes a Mail",
30962     "examples": [
30963       {
30964         "title": "Example usage:",
30965         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
30966         "type": "json"
30967       }
30968     ],
30969     "name": "DeleteMails",
30970     "group": "Voice_Mails",
30971     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30972     "version": "0.0.0",
30973     "filename": "server/api/voiceMail/index.js",
30974     "groupTitle": "Voice_Mails"
30975   },
30976   {
30977     "type": "get",
30978     "url": "/api/voice/mails",
30979     "title": "Gets a list of Mails",
30980     "examples": [
30981       {
30982         "title": "Example usage:",
30983         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
30984         "type": "json"
30985       }
30986     ],
30987     "name": "GetMails",
30988     "group": "Voice_Mails",
30989     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30990     "version": "0.0.0",
30991     "filename": "server/api/voiceMail/index.js",
30992     "groupTitle": "Voice_Mails"
30993   },
30994   {
30995     "type": "get",
30996     "url": "/api/voice/mails/{id}",
30997     "title": "Gets a single Mail",
30998     "examples": [
30999       {
31000         "title": "Example usage:",
31001         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31002         "type": "json"
31003       }
31004     ],
31005     "name": "ShowMails",
31006     "group": "Voice_Mails",
31007     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31008     "version": "0.0.0",
31009     "filename": "server/api/voiceMail/index.js",
31010     "groupTitle": "Voice_Mails"
31011   },
31012   {
31013     "type": "get",
31014     "url": "/api/voice/mails/{id}/messages",
31015     "title": "Gets voice mail messages",
31016     "examples": [
31017       {
31018         "title": "Example usage:",
31019         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31020         "type": "json"
31021       }
31022     ],
31023     "name": "getMessages",
31024     "group": "Voice_Mails",
31025     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31026     "version": "0.0.0",
31027     "filename": "server/api/voiceMail/index.js",
31028     "groupTitle": "Voice_Mails"
31029   },
31030   {
31031     "type": "put",
31032     "url": "/api/voice/mails/{id}",
31033     "title": "Update an existing Mail",
31034     "examples": [
31035       {
31036         "title": "Example usage:",
31037         "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",
31038         "type": "json"
31039       }
31040     ],
31041     "name": "updateMails",
31042     "group": "Voice_Mails",
31043     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31044     "version": "0.0.0",
31045     "filename": "server/api/voiceMail/index.js",
31046     "groupTitle": "Voice_Mails"
31047   },
31048   {
31049     "type": "post",
31050     "url": "/api/voice/mails/messages",
31051     "title": "Creates a new Message",
31052     "examples": [
31053       {
31054         "title": "Example usage:",
31055         "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",
31056         "type": "json"
31057       }
31058     ],
31059     "name": "CreateMessages",
31060     "group": "Voice_Messages",
31061     "parameter": {
31062       "fields": {
31063         "Body": [
31064           {
31065             "group": "Body",
31066             "type": "Virtual",
31067             "optional": true,
31068             "field": "name",
31069             "description": ""
31070           },
31071           {
31072             "group": "Body",
31073             "type": "Integer",
31074             "optional": false,
31075             "field": "msgnum",
31076             "description": ""
31077           },
31078           {
31079             "group": "Body",
31080             "type": "String",
31081             "optional": true,
31082             "field": "dir",
31083             "description": ""
31084           },
31085           {
31086             "group": "Body",
31087             "type": "String",
31088             "optional": true,
31089             "field": "context",
31090             "description": ""
31091           },
31092           {
31093             "group": "Body",
31094             "type": "String",
31095             "optional": true,
31096             "field": "macrocontext",
31097             "description": ""
31098           },
31099           {
31100             "group": "Body",
31101             "type": "String",
31102             "optional": true,
31103             "field": "callerid",
31104             "description": ""
31105           },
31106           {
31107             "group": "Body",
31108             "type": "String",
31109             "optional": true,
31110             "field": "origtime",
31111             "description": ""
31112           },
31113           {
31114             "group": "Body",
31115             "type": "String",
31116             "optional": true,
31117             "field": "duration",
31118             "description": ""
31119           },
31120           {
31121             "group": "Body",
31122             "type": "String",
31123             "optional": true,
31124             "field": "mailboxuser",
31125             "description": ""
31126           },
31127           {
31128             "group": "Body",
31129             "type": "String",
31130             "optional": true,
31131             "field": "mailboxcontext",
31132             "description": ""
31133           },
31134           {
31135             "group": "Body",
31136             "type": "Blob",
31137             "optional": true,
31138             "field": "recording",
31139             "description": ""
31140           },
31141           {
31142             "group": "Body",
31143             "type": "String",
31144             "optional": true,
31145             "field": "flag",
31146             "description": ""
31147           },
31148           {
31149             "group": "Body",
31150             "type": "String",
31151             "optional": true,
31152             "field": "msg_id",
31153             "description": ""
31154           },
31155           {
31156             "group": "Body",
31157             "type": "String",
31158             "optional": true,
31159             "field": "stamp",
31160             "description": ""
31161           }
31162         ]
31163       }
31164     },
31165     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31166     "version": "0.0.0",
31167     "filename": "server/api/voiceMailMessage/index.js",
31168     "groupTitle": "Voice_Messages"
31169   },
31170   {
31171     "type": "delete",
31172     "url": "/api/voice/mails/messages/{id}",
31173     "title": "Deletes a Message",
31174     "examples": [
31175       {
31176         "title": "Example usage:",
31177         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31178         "type": "json"
31179       }
31180     ],
31181     "name": "DeleteMessages",
31182     "group": "Voice_Messages",
31183     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31184     "version": "0.0.0",
31185     "filename": "server/api/voiceMailMessage/index.js",
31186     "groupTitle": "Voice_Messages"
31187   },
31188   {
31189     "type": "get",
31190     "url": "/api/voice/mails/messages",
31191     "title": "Gets a list of Messages",
31192     "examples": [
31193       {
31194         "title": "Example usage:",
31195         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31196         "type": "json"
31197       }
31198     ],
31199     "name": "GetMessages",
31200     "group": "Voice_Messages",
31201     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31202     "version": "0.0.0",
31203     "filename": "server/api/voiceMailMessage/index.js",
31204     "groupTitle": "Voice_Messages"
31205   },
31206   {
31207     "type": "get",
31208     "url": "/api/voice/mails/messages/{id}",
31209     "title": "Gets a single Message",
31210     "examples": [
31211       {
31212         "title": "Example usage:",
31213         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31214         "type": "json"
31215       }
31216     ],
31217     "name": "ShowMessages",
31218     "group": "Voice_Messages",
31219     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31220     "version": "0.0.0",
31221     "filename": "server/api/voiceMailMessage/index.js",
31222     "groupTitle": "Voice_Messages"
31223   },
31224   {
31225     "type": "get",
31226     "url": "voice/mails/messages/{id}/download",
31227     "title": "Download Voice Message",
31228     "examples": [
31229       {
31230         "title": "Example usage:",
31231         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31232         "type": "json"
31233       }
31234     ],
31235     "name": "download",
31236     "group": "Voice_Messages",
31237     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31238     "version": "0.0.0",
31239     "filename": "server/api/voiceMailMessage/index.js",
31240     "groupTitle": "Voice_Messages"
31241   },
31242   {
31243     "type": "put",
31244     "url": "/api/voice/mails/messages/{id}",
31245     "title": "Update an existing Message",
31246     "examples": [
31247       {
31248         "title": "Example usage:",
31249         "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",
31250         "type": "json"
31251       }
31252     ],
31253     "name": "updateMessages",
31254     "group": "Voice_Messages",
31255     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31256     "version": "0.0.0",
31257     "filename": "server/api/voiceMailMessage/index.js",
31258     "groupTitle": "Voice_Messages"
31259   },
31260   {
31261     "type": "post",
31262     "url": "/api/voice/prefixes/{id}/users",
31263     "title": "Add agents to a prefix",
31264     "examples": [
31265       {
31266         "title": "Example usage:",
31267         "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",
31268         "type": "json"
31269       }
31270     ],
31271     "name": "AddAgents",
31272     "group": "Voice_Prefixes",
31273     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31274     "version": "0.0.0",
31275     "filename": "server/api/voicePrefix/index.js",
31276     "groupTitle": "Voice_Prefixes"
31277   },
31278   {
31279     "type": "delete",
31280     "url": "/api/voice/prefixes/{id}",
31281     "title": "Deletes a Prefix",
31282     "examples": [
31283       {
31284         "title": "Example usage:",
31285         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31286         "type": "json"
31287       }
31288     ],
31289     "name": "DeletePrefixes",
31290     "group": "Voice_Prefixes",
31291     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31292     "version": "0.0.0",
31293     "filename": "server/api/voicePrefix/index.js",
31294     "groupTitle": "Voice_Prefixes"
31295   },
31296   {
31297     "type": "get",
31298     "url": "/api/voice/prefixes/describe",
31299     "title": "Gets table info about Prefixes",
31300     "examples": [
31301       {
31302         "title": "Example usage:",
31303         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31304         "type": "json"
31305       }
31306     ],
31307     "name": "DescribePrefixes",
31308     "group": "Voice_Prefixes",
31309     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31310     "version": "0.0.0",
31311     "filename": "server/api/voicePrefix/index.js",
31312     "groupTitle": "Voice_Prefixes"
31313   },
31314   {
31315     "type": "get",
31316     "url": "/api/voice/prefixes/{id}/users",
31317     "title": "Gets agents from prefix",
31318     "examples": [
31319       {
31320         "title": "Example usage:",
31321         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31322         "type": "json"
31323       }
31324     ],
31325     "name": "GetAgents",
31326     "group": "Voice_Prefixes",
31327     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31328     "version": "0.0.0",
31329     "filename": "server/api/voicePrefix/index.js",
31330     "groupTitle": "Voice_Prefixes"
31331   },
31332   {
31333     "type": "get",
31334     "url": "/api/voice/prefixes",
31335     "title": "Gets a list of Prefixes",
31336     "examples": [
31337       {
31338         "title": "Example usage:",
31339         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31340         "type": "json"
31341       }
31342     ],
31343     "name": "GetPrefixes",
31344     "group": "Voice_Prefixes",
31345     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31346     "version": "0.0.0",
31347     "filename": "server/api/voicePrefix/index.js",
31348     "groupTitle": "Voice_Prefixes"
31349   },
31350   {
31351     "type": "delete",
31352     "url": "/api/voice/prefixes/{id}/users",
31353     "title": "Removes agents from a prefix",
31354     "examples": [
31355       {
31356         "title": "Example usage:",
31357         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31358         "type": "json"
31359       }
31360     ],
31361     "name": "RemoveAgents",
31362     "group": "Voice_Prefixes",
31363     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31364     "version": "0.0.0",
31365     "filename": "server/api/voicePrefix/index.js",
31366     "groupTitle": "Voice_Prefixes"
31367   },
31368   {
31369     "type": "get",
31370     "url": "/api/voice/prefixes/{id}",
31371     "title": "Gets a single Prefix",
31372     "examples": [
31373       {
31374         "title": "Example usage:",
31375         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31376         "type": "json"
31377       }
31378     ],
31379     "name": "ShowPrefixes",
31380     "group": "Voice_Prefixes",
31381     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31382     "version": "0.0.0",
31383     "filename": "server/api/voicePrefix/index.js",
31384     "groupTitle": "Voice_Prefixes"
31385   },
31386   {
31387     "type": "put",
31388     "url": "/api/voice/prefixes/{id}",
31389     "title": "Update an existing prefix",
31390     "examples": [
31391       {
31392         "title": "Example usage:",
31393         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31394         "type": "json"
31395       }
31396     ],
31397     "name": "Update",
31398     "group": "Voice_Prefixes",
31399     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31400     "version": "0.0.0",
31401     "filename": "server/api/voicePrefix/index.js",
31402     "groupTitle": "Voice_Prefixes"
31403   },
31404   {
31405     "type": "post",
31406     "url": "/api/voice/prefixes",
31407     "title": "Create a prefix",
31408     "examples": [
31409       {
31410         "title": "Example usage:",
31411         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31412         "type": "json"
31413       }
31414     ],
31415     "name": "create",
31416     "group": "Voice_Prefixes",
31417     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31418     "version": "0.0.0",
31419     "filename": "server/api/voicePrefix/index.js",
31420     "groupTitle": "Voice_Prefixes"
31421   },
31422   {
31423     "type": "get",
31424     "url": "/api/voice/queues/reports/describe",
31425     "title": "Gets table info about Queue Reports",
31426     "examples": [
31427       {
31428         "title": "Example usage:",
31429         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31430         "type": "json"
31431       }
31432     ],
31433     "name": "DescribeQueue_Reports",
31434     "group": "Voice_Queue_Reports",
31435     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31436     "version": "0.0.0",
31437     "filename": "server/api/voiceQueueReport/index.js",
31438     "groupTitle": "Voice_Queue_Reports"
31439   },
31440   {
31441     "type": "get",
31442     "url": "/api/voice/queues/reports",
31443     "title": "Gets a list of Queue Reports",
31444     "examples": [
31445       {
31446         "title": "Example usage:",
31447         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31448         "type": "json"
31449       }
31450     ],
31451     "name": "GetQueue_Reports",
31452     "group": "Voice_Queue_Reports",
31453     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31454     "version": "0.0.0",
31455     "filename": "server/api/voiceQueueReport/index.js",
31456     "groupTitle": "Voice_Queue_Reports"
31457   },
31458   {
31459     "type": "get",
31460     "url": "/api/voice/queues/reports/{id}",
31461     "title": "Gets a single Queue Report",
31462     "examples": [
31463       {
31464         "title": "Example usage:",
31465         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31466         "type": "json"
31467       }
31468     ],
31469     "name": "ShowQueue_Reports",
31470     "group": "Voice_Queue_Reports",
31471     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31472     "version": "0.0.0",
31473     "filename": "server/api/voiceQueueReport/index.js",
31474     "groupTitle": "Voice_Queue_Reports"
31475   },
31476   {
31477     "type": "get",
31478     "url": "/api/voice/queues/reports/index",
31479     "title": "Get Voice Queues Report",
31480     "examples": [
31481       {
31482         "title": "Example usage:",
31483         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31484         "type": "json"
31485       }
31486     ],
31487     "name": "getVoiceQueuesReport",
31488     "group": "Voice_Queue_Reports",
31489     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31490     "version": "0.0.0",
31491     "filename": "server/api/voiceQueueReport/index.js",
31492     "groupTitle": "Voice_Queue_Reports"
31493   },
31494   {
31495     "type": "post",
31496     "url": "/api/voice/queues/{id}/users",
31497     "title": "Add agents to queue",
31498     "examples": [
31499       {
31500         "title": "Example usage:",
31501         "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",
31502         "type": "json"
31503       }
31504     ],
31505     "name": "AddAgents",
31506     "group": "Voice_Queues",
31507     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31508     "version": "0.0.0",
31509     "filename": "server/api/voiceQueue/index.js",
31510     "groupTitle": "Voice_Queues"
31511   },
31512   {
31513     "type": "post",
31514     "url": "/api/voice/queues/{id}/blacklists",
31515     "title": "Add blacklists to a queue",
31516     "examples": [
31517       {
31518         "title": "Example usage:",
31519         "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",
31520         "type": "json"
31521       }
31522     ],
31523     "name": "AddBlackLists",
31524     "group": "Voice_Queues",
31525     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31526     "version": "0.0.0",
31527     "filename": "server/api/voiceQueue/index.js",
31528     "groupTitle": "Voice_Queues"
31529   },
31530   {
31531     "type": "post",
31532     "url": "/api/voice/queues/{id}/lists",
31533     "title": "Add lists to a queue",
31534     "examples": [
31535       {
31536         "title": "Example usage:",
31537         "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",
31538         "type": "json"
31539       }
31540     ],
31541     "name": "AddLists",
31542     "group": "Voice_Queues",
31543     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31544     "version": "0.0.0",
31545     "filename": "server/api/voiceQueue/index.js",
31546     "groupTitle": "Voice_Queues"
31547   },
31548   {
31549     "type": "post",
31550     "url": "/api/voice/queues/{id}/teams",
31551     "title": "Add teams to queue",
31552     "examples": [
31553       {
31554         "title": "Example usage:",
31555         "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",
31556         "type": "json"
31557       }
31558     ],
31559     "name": "AddTeams",
31560     "group": "Voice_Queues",
31561     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31562     "version": "0.0.0",
31563     "filename": "server/api/voiceQueue/index.js",
31564     "groupTitle": "Voice_Queues"
31565   },
31566   {
31567     "type": "post",
31568     "url": "/api/voice/queues/clone",
31569     "title": "Clone an existing Queue",
31570     "examples": [
31571       {
31572         "title": "Example usage:",
31573         "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",
31574         "type": "json"
31575       }
31576     ],
31577     "name": "CloneQueues",
31578     "group": "Voice_Queues",
31579     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31580     "version": "0.0.0",
31581     "filename": "server/api/voiceQueue/index.js",
31582     "groupTitle": "Voice_Queues"
31583   },
31584   {
31585     "type": "post",
31586     "url": "/api/voice/queues",
31587     "title": "Creates a new Queue",
31588     "examples": [
31589       {
31590         "title": "Example usage:",
31591         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31592         "type": "json"
31593       }
31594     ],
31595     "name": "CreateQueues",
31596     "group": "Voice_Queues",
31597     "parameter": {
31598       "fields": {
31599         "Body": [
31600           {
31601             "group": "Body",
31602             "type": "String",
31603             "optional": false,
31604             "field": "name",
31605             "description": ""
31606           },
31607           {
31608             "group": "Body",
31609             "type": "String",
31610             "allowedValues": [
31611               "\"inbound\"",
31612               "\"outbound\""
31613             ],
31614             "optional": false,
31615             "field": "type",
31616             "description": ""
31617           },
31618           {
31619             "group": "Body",
31620             "type": "String",
31621             "optional": true,
31622             "field": "musiconhold",
31623             "description": ""
31624           },
31625           {
31626             "group": "Body",
31627             "type": "String",
31628             "optional": true,
31629             "field": "announce",
31630             "description": ""
31631           },
31632           {
31633             "group": "Body",
31634             "type": "String",
31635             "allowedValues": [
31636               "\"rr\"",
31637               "\"ringall\"",
31638               "\"leastrecent\"",
31639               "\"fewestcalls\"",
31640               "\"random\"",
31641               "\"rrmemory\"",
31642               "\"linear\"",
31643               "\"wrandom\"",
31644               "\"rrordered\""
31645             ],
31646             "optional": false,
31647             "field": "strategy",
31648             "description": ""
31649           },
31650           {
31651             "group": "Body",
31652             "type": "Integer",
31653             "optional": true,
31654             "field": "servicelevel",
31655             "description": ""
31656           },
31657           {
31658             "group": "Body",
31659             "type": "String",
31660             "optional": true,
31661             "field": "context",
31662             "description": ""
31663           },
31664           {
31665             "group": "Body",
31666             "type": "Integer",
31667             "optional": true,
31668             "field": "penaltymemberslimit",
31669             "description": ""
31670           },
31671           {
31672             "group": "Body",
31673             "type": "Integer",
31674             "optional": true,
31675             "field": "timeout",
31676             "description": ""
31677           },
31678           {
31679             "group": "Body",
31680             "type": "Integer",
31681             "optional": true,
31682             "field": "retry",
31683             "description": ""
31684           },
31685           {
31686             "group": "Body",
31687             "type": "String",
31688             "optional": true,
31689             "field": "timeoutpriority",
31690             "description": ""
31691           },
31692           {
31693             "group": "Body",
31694             "type": "Integer",
31695             "optional": true,
31696             "field": "weight",
31697             "description": ""
31698           },
31699           {
31700             "group": "Body",
31701             "type": "Integer",
31702             "optional": true,
31703             "field": "wrapuptime",
31704             "description": ""
31705           },
31706           {
31707             "group": "Body",
31708             "type": "String",
31709             "allowedValues": [
31710               "\"yes\"",
31711               "\"no\""
31712             ],
31713             "optional": true,
31714             "field": "autofill",
31715             "description": ""
31716           },
31717           {
31718             "group": "Body",
31719             "type": "String",
31720             "allowedValues": [
31721               "\"yes\"",
31722               "\"no\"",
31723               "\"all\""
31724             ],
31725             "optional": true,
31726             "field": "autopause",
31727             "description": ""
31728           },
31729           {
31730             "group": "Body",
31731             "type": "Integer",
31732             "optional": true,
31733             "field": "autopausedelay",
31734             "description": ""
31735           },
31736           {
31737             "group": "Body",
31738             "type": "String",
31739             "allowedValues": [
31740               "\"yes\"",
31741               "\"no\""
31742             ],
31743             "optional": true,
31744             "field": "autopausebusy",
31745             "description": ""
31746           },
31747           {
31748             "group": "Body",
31749             "type": "String",
31750             "allowedValues": [
31751               "\"yes\"",
31752               "\"no\""
31753             ],
31754             "optional": true,
31755             "field": "autopauseunavail",
31756             "description": ""
31757           },
31758           {
31759             "group": "Body",
31760             "type": "Integer",
31761             "optional": true,
31762             "field": "maxlen",
31763             "description": ""
31764           },
31765           {
31766             "group": "Body",
31767             "type": "String",
31768             "allowedValues": [
31769               "\"yes\"",
31770               "\"no\""
31771             ],
31772             "optional": true,
31773             "field": "setinterfacevar",
31774             "description": ""
31775           },
31776           {
31777             "group": "Body",
31778             "type": "String",
31779             "allowedValues": [
31780               "\"yes\"",
31781               "\"no\""
31782             ],
31783             "optional": true,
31784             "field": "setqueueentryvar",
31785             "description": ""
31786           },
31787           {
31788             "group": "Body",
31789             "type": "String",
31790             "allowedValues": [
31791               "\"yes\"",
31792               "\"no\""
31793             ],
31794             "optional": true,
31795             "field": "setqueuevar",
31796             "description": ""
31797           },
31798           {
31799             "group": "Body",
31800             "type": "String",
31801             "allowedValues": [
31802               "\"yes\"",
31803               "\"no\""
31804             ],
31805             "optional": true,
31806             "field": "eventmemberstatus",
31807             "description": ""
31808           },
31809           {
31810             "group": "Body",
31811             "type": "String",
31812             "optional": true,
31813             "field": "membermacro",
31814             "description": ""
31815           },
31816           {
31817             "group": "Body",
31818             "type": "String",
31819             "optional": true,
31820             "field": "membergosub",
31821             "description": ""
31822           },
31823           {
31824             "group": "Body",
31825             "type": "Integer",
31826             "optional": true,
31827             "field": "announce_frequency",
31828             "description": ""
31829           },
31830           {
31831             "group": "Body",
31832             "type": "Integer",
31833             "optional": true,
31834             "field": "min_announce_frequency",
31835             "description": ""
31836           },
31837           {
31838             "group": "Body",
31839             "type": "Integer",
31840             "optional": true,
31841             "field": "periodic_announce_frequency",
31842             "description": ""
31843           },
31844           {
31845             "group": "Body",
31846             "type": "String",
31847             "allowedValues": [
31848               "\"yes\"",
31849               "\"no\""
31850             ],
31851             "optional": true,
31852             "field": "random_periodic_announce",
31853             "description": ""
31854           },
31855           {
31856             "group": "Body",
31857             "type": "String",
31858             "allowedValues": [
31859               "\"yes\"",
31860               "\"no\""
31861             ],
31862             "optional": true,
31863             "field": "relative_periodic_announce",
31864             "description": ""
31865           },
31866           {
31867             "group": "Body",
31868             "type": "String",
31869             "allowedValues": [
31870               "\"yes\"",
31871               "\"no\"",
31872               "\"once\""
31873             ],
31874             "optional": true,
31875             "field": "announce_holdtime",
31876             "description": ""
31877           },
31878           {
31879             "group": "Body",
31880             "type": "String",
31881             "optional": true,
31882             "field": "announce_position",
31883             "description": ""
31884           },
31885           {
31886             "group": "Body",
31887             "type": "String",
31888             "allowedValues": [
31889               "\"yes\"",
31890               "\"no\""
31891             ],
31892             "optional": true,
31893             "field": "announce_to_first_user",
31894             "description": ""
31895           },
31896           {
31897             "group": "Body",
31898             "type": "Integer",
31899             "optional": true,
31900             "field": "announce_position_limit",
31901             "description": ""
31902           },
31903           {
31904             "group": "Body",
31905             "type": "String",
31906             "allowedValues": [
31907               "\"0\"",
31908               "\"5\"",
31909               "\"10\"",
31910               "\"15\"",
31911               "\"20\"",
31912               "\"30\""
31913             ],
31914             "optional": true,
31915             "field": "announce_round_seconds",
31916             "description": ""
31917           },
31918           {
31919             "group": "Body",
31920             "type": "String",
31921             "optional": true,
31922             "field": "monitor_format",
31923             "description": ""
31924           },
31925           {
31926             "group": "Body",
31927             "type": "String",
31928             "optional": true,
31929             "field": "monitor_type",
31930             "description": ""
31931           },
31932           {
31933             "group": "Body",
31934             "type": "String",
31935             "optional": true,
31936             "field": "queue_youarenext",
31937             "description": ""
31938           },
31939           {
31940             "group": "Body",
31941             "type": "String",
31942             "optional": true,
31943             "field": "queue_thereare",
31944             "description": ""
31945           },
31946           {
31947             "group": "Body",
31948             "type": "String",
31949             "optional": true,
31950             "field": "queue_callswaiting",
31951             "description": ""
31952           },
31953           {
31954             "group": "Body",
31955             "type": "String",
31956             "optional": true,
31957             "field": "queue_holdtime",
31958             "description": ""
31959           },
31960           {
31961             "group": "Body",
31962             "type": "String",
31963             "optional": true,
31964             "field": "queue_minute",
31965             "description": ""
31966           },
31967           {
31968             "group": "Body",
31969             "type": "String",
31970             "optional": true,
31971             "field": "queue_minutes",
31972             "description": ""
31973           },
31974           {
31975             "group": "Body",
31976             "type": "String",
31977             "optional": true,
31978             "field": "queue_seconds",
31979             "description": ""
31980           },
31981           {
31982             "group": "Body",
31983             "type": "String",
31984             "optional": true,
31985             "field": "queue_thankyou",
31986             "description": ""
31987           },
31988           {
31989             "group": "Body",
31990             "type": "String",
31991             "optional": true,
31992             "field": "queue_reporthold",
31993             "description": ""
31994           },
31995           {
31996             "group": "Body",
31997             "type": "String",
31998             "optional": true,
31999             "field": "queue_quantity1",
32000             "description": ""
32001           },
32002           {
32003             "group": "Body",
32004             "type": "String",
32005             "optional": true,
32006             "field": "queue_quantity2",
32007             "description": ""
32008           },
32009           {
32010             "group": "Body",
32011             "type": "String",
32012             "optional": true,
32013             "field": "queue_periodic_announce",
32014             "description": ""
32015           },
32016           {
32017             "group": "Body",
32018             "type": "String",
32019             "optional": true,
32020             "field": "queue_less_than",
32021             "description": ""
32022           },
32023           {
32024             "group": "Body",
32025             "type": "Text",
32026             "optional": true,
32027             "field": "periodic_announce",
32028             "description": ""
32029           },
32030           {
32031             "group": "Body",
32032             "type": "String",
32033             "optional": true,
32034             "field": "joinempty",
32035             "description": ""
32036           },
32037           {
32038             "group": "Body",
32039             "type": "String",
32040             "optional": true,
32041             "field": "leavewhenempty",
32042             "description": ""
32043           },
32044           {
32045             "group": "Body",
32046             "type": "String",
32047             "allowedValues": [
32048               "\"yes\"",
32049               "\"no\""
32050             ],
32051             "optional": true,
32052             "field": "reportholdtime",
32053             "description": ""
32054           },
32055           {
32056             "group": "Body",
32057             "type": "String",
32058             "allowedValues": [
32059               "\"yes\"",
32060               "\"no\""
32061             ],
32062             "optional": true,
32063             "field": "ringinuse",
32064             "description": ""
32065           },
32066           {
32067             "group": "Body",
32068             "type": "Integer",
32069             "optional": true,
32070             "field": "memberdelay",
32071             "description": ""
32072           },
32073           {
32074             "group": "Body",
32075             "type": "String",
32076             "allowedValues": [
32077               "\"yes\"",
32078               "\"no\""
32079             ],
32080             "optional": true,
32081             "field": "timeoutrestart",
32082             "description": ""
32083           },
32084           {
32085             "group": "Body",
32086             "type": "String",
32087             "optional": true,
32088             "field": "defaultrule",
32089             "description": ""
32090           },
32091           {
32092             "group": "Body",
32093             "type": "String",
32094             "optional": true,
32095             "field": "description",
32096             "description": ""
32097           },
32098           {
32099             "group": "Body",
32100             "type": "Boolean",
32101             "optional": true,
32102             "field": "acw",
32103             "description": ""
32104           },
32105           {
32106             "group": "Body",
32107             "type": "Integer",
32108             "optional": true,
32109             "field": "acwTimeout",
32110             "description": ""
32111           },
32112           {
32113             "group": "Body",
32114             "type": "Boolean",
32115             "optional": true,
32116             "field": "dialActive",
32117             "description": "<p>Active/Disactive Campaign</p>"
32118           },
32119           {
32120             "group": "Body",
32121             "type": "String",
32122             "allowedValues": [
32123               "\"preview\"",
32124               "\"progressive\"",
32125               "\"power\"",
32126               "\"predictive\"",
32127               "\"booked\""
32128             ],
32129             "optional": true,
32130             "field": "dialMethod",
32131             "description": "<p>Dial Method.</p>"
32132           },
32133           {
32134             "group": "Body",
32135             "type": "Integer",
32136             "optional": true,
32137             "field": "dialLimitChannel",
32138             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32139           },
32140           {
32141             "group": "Body",
32142             "type": "Integer",
32143             "optional": true,
32144             "field": "dialLimitQueue",
32145             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32146           },
32147           {
32148             "group": "Body",
32149             "type": "Float",
32150             "optional": true,
32151             "field": "dialPowerLevel",
32152             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32153           },
32154           {
32155             "group": "Body",
32156             "type": "String",
32157             "allowedValues": [
32158               "\"agentBusyFactor\"",
32159               "\"dropRate\""
32160             ],
32161             "optional": true,
32162             "field": "dialPredictiveOptimization",
32163             "description": "<p>Only for predictive method.</p>"
32164           },
32165           {
32166             "group": "Body",
32167             "type": "Float",
32168             "optional": true,
32169             "field": "dialPredictiveOptimizationPercentage",
32170             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32171           },
32172           {
32173             "group": "Body",
32174             "type": "Integer",
32175             "optional": true,
32176             "field": "dialPredictiveInterval",
32177             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32178           },
32179           {
32180             "group": "Body",
32181             "type": "String",
32182             "optional": true,
32183             "field": "dialOriginateCallerIdName",
32184             "description": ""
32185           },
32186           {
32187             "group": "Body",
32188             "type": "String",
32189             "optional": true,
32190             "field": "dialOriginateCallerIdNumber",
32191             "description": ""
32192           },
32193           {
32194             "group": "Body",
32195             "type": "Integer",
32196             "optional": true,
32197             "field": "dialOriginateTimeout",
32198             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32199           },
32200           {
32201             "group": "Body",
32202             "type": "String",
32203             "optional": true,
32204             "field": "dialQueueOptions",
32205             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32206           },
32207           {
32208             "group": "Body",
32209             "type": "Integer",
32210             "optional": true,
32211             "field": "dialQueueTimeout",
32212             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32213           },
32214           {
32215             "group": "Body",
32216             "type": "String",
32217             "optional": true,
32218             "field": "dialQueueProject",
32219             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32220           },
32221           {
32222             "group": "Body",
32223             "type": "Integer",
32224             "optional": true,
32225             "field": "dialCongestionMaxRetry",
32226             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32227           },
32228           {
32229             "group": "Body",
32230             "type": "Integer",
32231             "optional": true,
32232             "field": "dialCongestionRetryFrequency",
32233             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32234           },
32235           {
32236             "group": "Body",
32237             "type": "Integer",
32238             "optional": true,
32239             "field": "dialBusyMaxRetry",
32240             "description": "<p>#Busy Retry (min:1, max:999)</p>"
32241           },
32242           {
32243             "group": "Body",
32244             "type": "Integer",
32245             "optional": true,
32246             "field": "dialBusyRetryFrequency",
32247             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32248           },
32249           {
32250             "group": "Body",
32251             "type": "Integer",
32252             "optional": true,
32253             "field": "dialNoAnswerMaxRetry",
32254             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32255           },
32256           {
32257             "group": "Body",
32258             "type": "Integer",
32259             "optional": true,
32260             "field": "dialNoAnswerRetryFrequency",
32261             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32262           },
32263           {
32264             "group": "Body",
32265             "type": "Integer",
32266             "optional": true,
32267             "field": "dialGlobalMaxRetry",
32268             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32269           },
32270           {
32271             "group": "Body",
32272             "type": "String",
32273             "optional": true,
32274             "field": "dialTimezone",
32275             "description": ""
32276           },
32277           {
32278             "group": "Body",
32279             "type": "String",
32280             "optional": true,
32281             "field": "dialGlobalInterval",
32282             "description": ""
32283           },
32284           {
32285             "group": "Body",
32286             "type": "String",
32287             "optional": true,
32288             "field": "dialPrefix",
32289             "description": ""
32290           },
32291           {
32292             "group": "Body",
32293             "type": "String",
32294             "allowedValues": [
32295               "\"always\"",
32296               "\"never\"",
32297               "\"onlyIfOpen\""
32298             ],
32299             "optional": true,
32300             "field": "dialCheckDuplicateType",
32301             "description": ""
32302           },
32303           {
32304             "group": "Body",
32305             "type": "Boolean",
32306             "optional": true,
32307             "field": "dialAMDActive",
32308             "description": "<p>Active/Disactive AMD</p>"
32309           },
32310           {
32311             "group": "Body",
32312             "type": "Integer",
32313             "optional": true,
32314             "field": "dialAMDInitialSilence",
32315             "description": "<p>#AMD Initial Silence</p>"
32316           },
32317           {
32318             "group": "Body",
32319             "type": "Integer",
32320             "optional": true,
32321             "field": "dialAMDGreeting",
32322             "description": "<p>#AMD Greeting</p>"
32323           },
32324           {
32325             "group": "Body",
32326             "type": "Integer",
32327             "optional": true,
32328             "field": "dialAMDAfterGreetingSilence",
32329             "description": "<p>#AMD After Greeting Silence</p>"
32330           },
32331           {
32332             "group": "Body",
32333             "type": "Integer",
32334             "optional": true,
32335             "field": "dialAMDTotalAnalysisTime",
32336             "description": "<p>#AMD Total Analysis Time</p>"
32337           },
32338           {
32339             "group": "Body",
32340             "type": "Integer",
32341             "optional": true,
32342             "field": "dialAMDMinWordLength",
32343             "description": "<p>#AMD Min Word Length</p>"
32344           },
32345           {
32346             "group": "Body",
32347             "type": "Integer",
32348             "optional": true,
32349             "field": "dialAMDBetweenWordsSilence",
32350             "description": "<p>#AMD Between Words Silence</p>"
32351           },
32352           {
32353             "group": "Body",
32354             "type": "Integer",
32355             "optional": true,
32356             "field": "dialAMDMaximumNumberOfWords",
32357             "description": "<p>#AMD Maximum Number Of Words</p>"
32358           },
32359           {
32360             "group": "Body",
32361             "type": "Integer",
32362             "optional": true,
32363             "field": "dialAMDSilenceThreshold",
32364             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32365           },
32366           {
32367             "group": "Body",
32368             "type": "Integer",
32369             "optional": true,
32370             "field": "dialAMDMaximumWordLength",
32371             "description": "<p>#AMD Maximum Word Length</p>"
32372           },
32373           {
32374             "group": "Body",
32375             "type": "Integer",
32376             "optional": true,
32377             "field": "dialRecallMeTimeout",
32378             "description": "<p>#RecallMe Timeout (min:1)</p>"
32379           },
32380           {
32381             "group": "Body",
32382             "type": "Boolean",
32383             "optional": true,
32384             "field": "dialRecallInQueue",
32385             "description": "<p>Active/Disactive Recall In Queue</p>"
32386           },
32387           {
32388             "group": "Body",
32389             "type": "String",
32390             "allowedValues": [
32391               "\"DESC\"",
32392               "\"ASC\""
32393             ],
32394             "optional": true,
32395             "field": "dialOrderByScheduledAt",
32396             "description": ""
32397           },
32398           {
32399             "group": "Body",
32400             "type": "String",
32401             "optional": true,
32402             "field": "dialQueueProject2",
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": "Boolean",
32408             "optional": true,
32409             "field": "dialAgiAfterHangupClient",
32410             "description": ""
32411           },
32412           {
32413             "group": "Body",
32414             "type": "Boolean",
32415             "optional": true,
32416             "field": "dialAgiAfterHangupAgent",
32417             "description": ""
32418           },
32419           {
32420             "group": "Body",
32421             "type": "Integer",
32422             "optional": true,
32423             "field": "dialRandomLastDigitCallerIdNumber",
32424             "description": "<p>Random Last Digit (min:1, max:15)</p>"
32425           },
32426           {
32427             "group": "Body",
32428             "type": "Integer",
32429             "optional": true,
32430             "field": "dialCutDigit",
32431             "description": "<p>Cut Digit (min:1, max:15)</p>"
32432           },
32433           {
32434             "group": "Body",
32435             "type": "Integer",
32436             "optional": true,
32437             "field": "dialNoSuchNumberMaxRetry",
32438             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32439           },
32440           {
32441             "group": "Body",
32442             "type": "Integer",
32443             "optional": true,
32444             "field": "dialNoSuchNumberRetryFrequency",
32445             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32446           },
32447           {
32448             "group": "Body",
32449             "type": "Integer",
32450             "optional": true,
32451             "field": "dialDropMaxRetry",
32452             "description": "<p>#Drop Retry (min:1, max:999)</p>"
32453           },
32454           {
32455             "group": "Body",
32456             "type": "Integer",
32457             "optional": true,
32458             "field": "dialDropRetryFrequency",
32459             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32460           },
32461           {
32462             "group": "Body",
32463             "type": "Integer",
32464             "optional": true,
32465             "field": "dialAbandonedMaxRetry",
32466             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32467           },
32468           {
32469             "group": "Body",
32470             "type": "Integer",
32471             "optional": true,
32472             "field": "dialAbandonedRetryFrequency",
32473             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32474           },
32475           {
32476             "group": "Body",
32477             "type": "Integer",
32478             "optional": true,
32479             "field": "dialMachineMaxRetry",
32480             "description": "<p>#Machine Retry (min:1, max:999)</p>"
32481           },
32482           {
32483             "group": "Body",
32484             "type": "Integer",
32485             "optional": true,
32486             "field": "dialMachineRetryFrequency",
32487             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32488           },
32489           {
32490             "group": "Body",
32491             "type": "Integer",
32492             "optional": true,
32493             "field": "dialAgentRejectMaxRetry",
32494             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32495           },
32496           {
32497             "group": "Body",
32498             "type": "Integer",
32499             "optional": true,
32500             "field": "dialAgentRejectRetryFrequency",
32501             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32502           },
32503           {
32504             "group": "Body",
32505             "type": "Integer",
32506             "optional": true,
32507             "field": "mandatoryDispositionPauseId",
32508             "description": "<p>Status to put when mandatory disposition is enabled</p>"
32509           },
32510           {
32511             "group": "Body",
32512             "type": "Boolean",
32513             "optional": true,
32514             "field": "mandatoryDisposition",
32515             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32516           },
32517           {
32518             "group": "Body",
32519             "type": "Integer",
32520             "optional": true,
32521             "field": "dialPredictiveIntervalMaxThreshold",
32522             "description": ""
32523           },
32524           {
32525             "group": "Body",
32526             "type": "Integer",
32527             "optional": true,
32528             "field": "dialPredictiveIntervalMinThreshold",
32529             "description": ""
32530           }
32531         ]
32532       }
32533     },
32534     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32535     "version": "0.0.0",
32536     "filename": "server/api/voiceQueue/index.js",
32537     "groupTitle": "Voice_Queues"
32538   },
32539   {
32540     "type": "delete",
32541     "url": "/api/voice/queues/{id}",
32542     "title": "Deletes a Queue",
32543     "examples": [
32544       {
32545         "title": "Example usage:",
32546         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32547         "type": "json"
32548       }
32549     ],
32550     "name": "DeleteQueues",
32551     "group": "Voice_Queues",
32552     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32553     "version": "0.0.0",
32554     "filename": "server/api/voiceQueue/index.js",
32555     "groupTitle": "Voice_Queues"
32556   },
32557   {
32558     "type": "get",
32559     "url": "/api/voice/queues/{id}/users",
32560     "title": "Gets queue agents",
32561     "examples": [
32562       {
32563         "title": "Example usage:",
32564         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32565         "type": "json"
32566       }
32567     ],
32568     "name": "GetAgents",
32569     "group": "Voice_Queues",
32570     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32571     "version": "0.0.0",
32572     "filename": "server/api/voiceQueue/index.js",
32573     "groupTitle": "Voice_Queues"
32574   },
32575   {
32576     "type": "get",
32577     "url": "/api/voice/queues/{id}/blacklists",
32578     "title": "Get queue blacklists",
32579     "examples": [
32580       {
32581         "title": "Example usage:",
32582         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32583         "type": "json"
32584       }
32585     ],
32586     "name": "GetBlackLists",
32587     "group": "Voice_Queues",
32588     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32589     "version": "0.0.0",
32590     "filename": "server/api/voiceQueue/index.js",
32591     "groupTitle": "Voice_Queues"
32592   },
32593   {
32594     "type": "get",
32595     "url": "/api/voice/queues/{id}/finals",
32596     "title": "Gets queue hopper finals",
32597     "examples": [
32598       {
32599         "title": "Example usage:",
32600         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
32601         "type": "json"
32602       }
32603     ],
32604     "name": "GetHopperFinals",
32605     "group": "Voice_Queues",
32606     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32607     "version": "0.0.0",
32608     "filename": "server/api/voiceQueue/index.js",
32609     "groupTitle": "Voice_Queues"
32610   },
32611   {
32612     "type": "get",
32613     "url": "/api/voice/queues/{id}/hopper_histories",
32614     "title": "Gets queue hopper histories",
32615     "examples": [
32616       {
32617         "title": "Example usage:",
32618         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32619         "type": "json"
32620       }
32621     ],
32622     "name": "GetHopperHistories",
32623     "group": "Voice_Queues",
32624     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32625     "version": "0.0.0",
32626     "filename": "server/api/voiceQueue/index.js",
32627     "groupTitle": "Voice_Queues"
32628   },
32629   {
32630     "type": "get",
32631     "url": "/api/voice/queues/{id}/hoppers",
32632     "title": "Gets queue hoppers",
32633     "examples": [
32634       {
32635         "title": "Example usage:",
32636         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32637         "type": "json"
32638       }
32639     ],
32640     "name": "GetHoppers",
32641     "group": "Voice_Queues",
32642     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32643     "version": "0.0.0",
32644     "filename": "server/api/voiceQueue/index.js",
32645     "groupTitle": "Voice_Queues"
32646   },
32647   {
32648     "type": "get",
32649     "url": "/api/voice/queues/{id}/lists",
32650     "title": "Get queue lists",
32651     "examples": [
32652       {
32653         "title": "Example usage:",
32654         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32655         "type": "json"
32656       }
32657     ],
32658     "name": "GetLists",
32659     "group": "Voice_Queues",
32660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32661     "version": "0.0.0",
32662     "filename": "server/api/voiceQueue/index.js",
32663     "groupTitle": "Voice_Queues"
32664   },
32665   {
32666     "type": "get",
32667     "url": "/api/voice/queues/{id}/members",
32668     "title": "Gets queue members",
32669     "examples": [
32670       {
32671         "title": "Example usage:",
32672         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32673         "type": "json"
32674       }
32675     ],
32676     "name": "GetMembers",
32677     "group": "Voice_Queues",
32678     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32679     "version": "0.0.0",
32680     "filename": "server/api/voiceQueue/index.js",
32681     "groupTitle": "Voice_Queues"
32682   },
32683   {
32684     "type": "get",
32685     "url": "/api/voice/queues",
32686     "title": "Gets a list of Queues",
32687     "examples": [
32688       {
32689         "title": "Example usage:",
32690         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32691         "type": "json"
32692       }
32693     ],
32694     "name": "GetQueues",
32695     "group": "Voice_Queues",
32696     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32697     "version": "0.0.0",
32698     "filename": "server/api/voiceQueue/index.js",
32699     "groupTitle": "Voice_Queues"
32700   },
32701   {
32702     "type": "get",
32703     "url": "/api/voice/queues/{id}/teams",
32704     "title": "Gets queue team",
32705     "examples": [
32706       {
32707         "title": "Example usage:",
32708         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
32709         "type": "json"
32710       }
32711     ],
32712     "name": "GetTeams",
32713     "group": "Voice_Queues",
32714     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32715     "version": "0.0.0",
32716     "filename": "server/api/voiceQueue/index.js",
32717     "groupTitle": "Voice_Queues"
32718   },
32719   {
32720     "type": "delete",
32721     "url": "/api/voice/queues/{id}/users",
32722     "title": "Removes agents from a queue",
32723     "examples": [
32724       {
32725         "title": "Example usage:",
32726         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32727         "type": "json"
32728       }
32729     ],
32730     "name": "RemoveAgents",
32731     "group": "Voice_Queues",
32732     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32733     "version": "0.0.0",
32734     "filename": "server/api/voiceQueue/index.js",
32735     "groupTitle": "Voice_Queues"
32736   },
32737   {
32738     "type": "delete",
32739     "url": "/api/voice/queues/{id}/blacklists",
32740     "title": "Remove blacklists from a queue",
32741     "examples": [
32742       {
32743         "title": "Example usage:",
32744         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32745         "type": "json"
32746       }
32747     ],
32748     "name": "RemoveBlackLists",
32749     "group": "Voice_Queues",
32750     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32751     "version": "0.0.0",
32752     "filename": "server/api/voiceQueue/index.js",
32753     "groupTitle": "Voice_Queues"
32754   },
32755   {
32756     "type": "delete",
32757     "url": "/api/voice/queues/{id}/lists",
32758     "title": "Remove lists from a queue",
32759     "examples": [
32760       {
32761         "title": "Example usage:",
32762         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32763         "type": "json"
32764       }
32765     ],
32766     "name": "RemoveLists",
32767     "group": "Voice_Queues",
32768     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32769     "version": "0.0.0",
32770     "filename": "server/api/voiceQueue/index.js",
32771     "groupTitle": "Voice_Queues"
32772   },
32773   {
32774     "type": "get",
32775     "url": "/api/voice/queues/{id}",
32776     "title": "Gets a single Queue",
32777     "examples": [
32778       {
32779         "title": "Example usage:",
32780         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
32781         "type": "json"
32782       }
32783     ],
32784     "name": "ShowQueues",
32785     "group": "Voice_Queues",
32786     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32787     "version": "0.0.0",
32788     "filename": "server/api/voiceQueue/index.js",
32789     "groupTitle": "Voice_Queues"
32790   },
32791   {
32792     "type": "get",
32793     "url": "/api/voice/queues/{id}/blacks",
32794     "title": "Gets queue hopper blacks",
32795     "examples": [
32796       {
32797         "title": "Example usage:",
32798         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
32799         "type": "json"
32800       }
32801     ],
32802     "name": "getHopperBlacks",
32803     "group": "Voice_Queues",
32804     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32805     "version": "0.0.0",
32806     "filename": "server/api/voiceQueue/index.js",
32807     "groupTitle": "Voice_Queues"
32808   },
32809   {
32810     "type": "put",
32811     "url": "/api/voice/queues/{id}",
32812     "title": "Update an existing Queue",
32813     "examples": [
32814       {
32815         "title": "Example usage:",
32816         "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",
32817         "type": "json"
32818       }
32819     ],
32820     "name": "updateQueues",
32821     "group": "Voice_Queues",
32822     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32823     "version": "0.0.0",
32824     "filename": "server/api/voiceQueue/index.js",
32825     "groupTitle": "Voice_Queues"
32826   },
32827   {
32828     "type": "post",
32829     "url": "/api/voice/recordings",
32830     "title": "Creates a new Recording",
32831     "examples": [
32832       {
32833         "title": "Example usage:",
32834         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32835         "type": "json"
32836       }
32837     ],
32838     "name": "CreateRecordings",
32839     "group": "Voice_Recordings",
32840     "parameter": {
32841       "fields": {
32842         "Body": [
32843           {
32844             "group": "Body",
32845             "type": "Virtual",
32846             "optional": true,
32847             "field": "format",
32848             "description": ""
32849           },
32850           {
32851             "group": "Body",
32852             "type": "String",
32853             "optional": true,
32854             "field": "uniqueid",
32855             "description": ""
32856           },
32857           {
32858             "group": "Body",
32859             "type": "String",
32860             "optional": true,
32861             "field": "channel",
32862             "description": ""
32863           },
32864           {
32865             "group": "Body",
32866             "type": "String",
32867             "optional": true,
32868             "field": "membername",
32869             "description": ""
32870           },
32871           {
32872             "group": "Body",
32873             "type": "String",
32874             "optional": true,
32875             "field": "calleridnum",
32876             "description": ""
32877           },
32878           {
32879             "group": "Body",
32880             "type": "String",
32881             "optional": true,
32882             "field": "calleridname",
32883             "description": ""
32884           },
32885           {
32886             "group": "Body",
32887             "type": "String",
32888             "optional": true,
32889             "field": "connectedlinenum",
32890             "description": ""
32891           },
32892           {
32893             "group": "Body",
32894             "type": "String",
32895             "optional": true,
32896             "field": "connectedlinename",
32897             "description": ""
32898           },
32899           {
32900             "group": "Body",
32901             "type": "String",
32902             "optional": true,
32903             "field": "accountcode",
32904             "description": ""
32905           },
32906           {
32907             "group": "Body",
32908             "type": "String",
32909             "optional": true,
32910             "field": "context",
32911             "description": ""
32912           },
32913           {
32914             "group": "Body",
32915             "type": "String",
32916             "optional": true,
32917             "field": "exten",
32918             "description": ""
32919           },
32920           {
32921             "group": "Body",
32922             "type": "String",
32923             "optional": true,
32924             "field": "value",
32925             "description": ""
32926           },
32927           {
32928             "group": "Body",
32929             "type": "String",
32930             "optional": true,
32931             "field": "type",
32932             "description": ""
32933           },
32934           {
32935             "group": "Body",
32936             "type": "Integer",
32937             "optional": true,
32938             "field": "rating",
32939             "description": ""
32940           },
32941           {
32942             "group": "Body",
32943             "type": "String",
32944             "optional": true,
32945             "field": "queue",
32946             "description": ""
32947           },
32948           {
32949             "group": "Body",
32950             "type": "String",
32951             "optional": true,
32952             "field": "userDisposition",
32953             "description": ""
32954           },
32955           {
32956             "group": "Body",
32957             "type": "String",
32958             "optional": true,
32959             "field": "userSecondDisposition",
32960             "description": ""
32961           },
32962           {
32963             "group": "Body",
32964             "type": "String",
32965             "optional": true,
32966             "field": "userThirdDisposition",
32967             "description": ""
32968           },
32969           {
32970             "group": "Body",
32971             "type": "Text",
32972             "optional": true,
32973             "field": "location",
32974             "description": ""
32975           },
32976           {
32977             "group": "Body",
32978             "type": "String",
32979             "optional": true,
32980             "field": "transcribeName",
32981             "description": ""
32982           },
32983           {
32984             "group": "Body",
32985             "type": "String",
32986             "optional": true,
32987             "field": "transcribeStatus",
32988             "description": ""
32989           },
32990           {
32991             "group": "Body",
32992             "type": "Text",
32993             "optional": true,
32994             "field": "fileUri",
32995             "description": ""
32996           },
32997           {
32998             "group": "Body",
32999             "type": "Text",
33000             "optional": true,
33001             "field": "fileText",
33002             "description": ""
33003           },
33004           {
33005             "group": "Body",
33006             "type": "Text",
33007             "optional": true,
33008             "field": "failureReason",
33009             "description": ""
33010           },
33011           {
33012             "group": "Body",
33013             "type": "String",
33014             "optional": true,
33015             "field": "sentiment",
33016             "description": ""
33017           },
33018           {
33019             "group": "Body",
33020             "type": "Float",
33021             "optional": true,
33022             "field": "sPositive",
33023             "description": ""
33024           },
33025           {
33026             "group": "Body",
33027             "type": "Float",
33028             "optional": true,
33029             "field": "sNegative",
33030             "description": ""
33031           },
33032           {
33033             "group": "Body",
33034             "type": "Float",
33035             "optional": true,
33036             "field": "sNeutral",
33037             "description": ""
33038           },
33039           {
33040             "group": "Body",
33041             "type": "Float",
33042             "optional": true,
33043             "field": "sMixed",
33044             "description": ""
33045           },
33046           {
33047             "group": "Body",
33048             "type": "Boolean",
33049             "optional": true,
33050             "field": "tempSentiment",
33051             "description": ""
33052           },
33053           {
33054             "group": "Body",
33055             "type": "String",
33056             "optional": true,
33057             "field": "createdAt",
33058             "description": ""
33059           },
33060           {
33061             "group": "Body",
33062             "type": "String",
33063             "optional": true,
33064             "field": "updatedAt",
33065             "description": ""
33066           }
33067         ]
33068       }
33069     },
33070     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33071     "version": "0.0.0",
33072     "filename": "server/api/voiceRecording/index.js",
33073     "groupTitle": "Voice_Recordings"
33074   },
33075   {
33076     "type": "get",
33077     "url": "/api/voice/recordings/describe",
33078     "title": "Gets table info about Recordings",
33079     "examples": [
33080       {
33081         "title": "Example usage:",
33082         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33083         "type": "json"
33084       }
33085     ],
33086     "name": "DescribeRecordings",
33087     "group": "Voice_Recordings",
33088     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33089     "version": "0.0.0",
33090     "filename": "server/api/voiceRecording/index.js",
33091     "groupTitle": "Voice_Recordings"
33092   },
33093   {
33094     "type": "get",
33095     "url": "/api/voice/recordings",
33096     "title": "Gets a list of Recordings",
33097     "examples": [
33098       {
33099         "title": "Example usage:",
33100         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33101         "type": "json"
33102       }
33103     ],
33104     "name": "GetRecordings",
33105     "group": "Voice_Recordings",
33106     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33107     "version": "0.0.0",
33108     "filename": "server/api/voiceRecording/index.js",
33109     "groupTitle": "Voice_Recordings"
33110   },
33111   {
33112     "type": "get",
33113     "url": "/api/voice/recordings/{id}",
33114     "title": "Gets a single Recording",
33115     "examples": [
33116       {
33117         "title": "Example usage:",
33118         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33119         "type": "json"
33120       }
33121     ],
33122     "name": "ShowRecordings",
33123     "group": "Voice_Recordings",
33124     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33125     "version": "0.0.0",
33126     "filename": "server/api/voiceRecording/index.js",
33127     "groupTitle": "Voice_Recordings"
33128   },
33129   {
33130     "type": "delete",
33131     "url": "/api/voice/recordings/{id}",
33132     "title": "Delete voice recording",
33133     "examples": [
33134       {
33135         "title": "Example usage:",
33136         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33137         "type": "json"
33138       }
33139     ],
33140     "name": "destroy",
33141     "group": "Voice_Recordings",
33142     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33143     "version": "0.0.0",
33144     "filename": "server/api/voiceRecording/index.js",
33145     "groupTitle": "Voice_Recordings"
33146   },
33147   {
33148     "type": "get",
33149     "url": "/api/voice/recordings/{id}/download",
33150     "title": "Download Recording",
33151     "examples": [
33152       {
33153         "title": "Example usage:",
33154         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33155         "type": "json"
33156       }
33157     ],
33158     "name": "download",
33159     "group": "Voice_Recordings",
33160     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33161     "version": "0.0.0",
33162     "filename": "server/api/voiceRecording/index.js",
33163     "groupTitle": "Voice_Recordings"
33164   },
33165   {
33166     "type": "get",
33167     "url": "/api/voice/recordings/{id}/downloads",
33168     "title": "Download Recording",
33169     "examples": [
33170       {
33171         "title": "Example usage:",
33172         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33173         "type": "json"
33174       }
33175     ],
33176     "name": "downloads",
33177     "group": "Voice_Recordings",
33178     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33179     "version": "0.0.0",
33180     "filename": "server/api/voiceRecording/index.js",
33181     "groupTitle": "Voice_Recordings"
33182   },
33183   {
33184     "type": "post",
33185     "url": "/api/voice/recordings/{id}/transcribe",
33186     "title": "Run Transcribe Recording",
33187     "examples": [
33188       {
33189         "title": "Example usage:",
33190         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33191         "type": "json"
33192       }
33193     ],
33194     "name": "transcribe",
33195     "group": "Voice_Recordings",
33196     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33197     "version": "0.0.0",
33198     "filename": "server/api/voiceRecording/index.js",
33199     "groupTitle": "Voice_Recordings"
33200   },
33201   {
33202     "type": "get",
33203     "url": "/api/voice/recordings/{id}/transcribe",
33204     "title": "Run Transcribe Recording",
33205     "examples": [
33206       {
33207         "title": "Example usage:",
33208         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33209         "type": "json"
33210       }
33211     ],
33212     "name": "transcribe",
33213     "group": "Voice_Recordings",
33214     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33215     "version": "0.0.0",
33216     "filename": "server/api/voiceRecording/index.js",
33217     "groupTitle": "Voice_Recordings"
33218   },
33219   {
33220     "type": "put",
33221     "url": "/api/voice/recordings/{id}",
33222     "title": "Update an existing Recording",
33223     "examples": [
33224       {
33225         "title": "Example usage:",
33226         "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",
33227         "type": "json"
33228       }
33229     ],
33230     "name": "updateRecordings",
33231     "group": "Voice_Recordings",
33232     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33233     "version": "0.0.0",
33234     "filename": "server/api/voiceRecording/index.js",
33235     "groupTitle": "Voice_Recordings"
33236   },
33237   {
33238     "type": "post",
33239     "url": "/api/voice/transfers/reports",
33240     "title": "Creates a new Transfer Report",
33241     "examples": [
33242       {
33243         "title": "Example usage:",
33244         "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",
33245         "type": "json"
33246       }
33247     ],
33248     "name": "CreateTransfer_Reports",
33249     "group": "Voice_Transfer_Reports",
33250     "parameter": {
33251       "fields": {
33252         "Body": [
33253           {
33254             "group": "Body",
33255             "type": "String",
33256             "allowedValues": [
33257               "\"blind\"",
33258               "\"attended\""
33259             ],
33260             "optional": true,
33261             "field": "type",
33262             "description": ""
33263           },
33264           {
33265             "group": "Body",
33266             "type": "String",
33267             "optional": true,
33268             "field": "result",
33269             "description": ""
33270           },
33271           {
33272             "group": "Body",
33273             "type": "String",
33274             "optional": true,
33275             "field": "transfererchannel",
33276             "description": ""
33277           },
33278           {
33279             "group": "Body",
33280             "type": "String",
33281             "optional": true,
33282             "field": "transferercalleridnum",
33283             "description": ""
33284           },
33285           {
33286             "group": "Body",
33287             "type": "String",
33288             "optional": true,
33289             "field": "transferercalleridname",
33290             "description": ""
33291           },
33292           {
33293             "group": "Body",
33294             "type": "String",
33295             "optional": true,
33296             "field": "transfererconnectedlinenum",
33297             "description": ""
33298           },
33299           {
33300             "group": "Body",
33301             "type": "String",
33302             "optional": true,
33303             "field": "transfererconnectedlinename",
33304             "description": ""
33305           },
33306           {
33307             "group": "Body",
33308             "type": "String",
33309             "optional": true,
33310             "field": "transfereraccountcode",
33311             "description": ""
33312           },
33313           {
33314             "group": "Body",
33315             "type": "String",
33316             "optional": true,
33317             "field": "transferercontext",
33318             "description": ""
33319           },
33320           {
33321             "group": "Body",
33322             "type": "String",
33323             "optional": true,
33324             "field": "transfererexten",
33325             "description": ""
33326           },
33327           {
33328             "group": "Body",
33329             "type": "String",
33330             "optional": true,
33331             "field": "transfererlinkedid",
33332             "description": ""
33333           },
33334           {
33335             "group": "Body",
33336             "type": "String",
33337             "optional": true,
33338             "field": "transfereechannel",
33339             "description": ""
33340           },
33341           {
33342             "group": "Body",
33343             "type": "String",
33344             "optional": true,
33345             "field": "transfereecalleridnum",
33346             "description": ""
33347           },
33348           {
33349             "group": "Body",
33350             "type": "String",
33351             "optional": true,
33352             "field": "transfereecalleridname",
33353             "description": ""
33354           },
33355           {
33356             "group": "Body",
33357             "type": "String",
33358             "optional": true,
33359             "field": "transfereeconnectedlinenum",
33360             "description": ""
33361           },
33362           {
33363             "group": "Body",
33364             "type": "String",
33365             "optional": true,
33366             "field": "transfereeconnectedlinename",
33367             "description": ""
33368           },
33369           {
33370             "group": "Body",
33371             "type": "String",
33372             "optional": true,
33373             "field": "transfereeaccountcode",
33374             "description": ""
33375           },
33376           {
33377             "group": "Body",
33378             "type": "String",
33379             "optional": true,
33380             "field": "transfereecontext",
33381             "description": ""
33382           },
33383           {
33384             "group": "Body",
33385             "type": "String",
33386             "optional": true,
33387             "field": "transfereeexten",
33388             "description": ""
33389           },
33390           {
33391             "group": "Body",
33392             "type": "String",
33393             "optional": true,
33394             "field": "transfereelinkedid",
33395             "description": ""
33396           },
33397           {
33398             "group": "Body",
33399             "type": "String",
33400             "allowedValues": [
33401               "\"Yes\"",
33402               "\"No\""
33403             ],
33404             "optional": true,
33405             "field": "isexternal",
33406             "description": ""
33407           },
33408           {
33409             "group": "Body",
33410             "type": "String",
33411             "optional": true,
33412             "field": "context",
33413             "description": ""
33414           },
33415           {
33416             "group": "Body",
33417             "type": "String",
33418             "optional": true,
33419             "field": "extension",
33420             "description": ""
33421           }
33422         ]
33423       }
33424     },
33425     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33426     "version": "0.0.0",
33427     "filename": "server/api/voiceTransferReport/index.js",
33428     "groupTitle": "Voice_Transfer_Reports"
33429   },
33430   {
33431     "type": "delete",
33432     "url": "/api/voice/transfers/reports/{id}",
33433     "title": "Deletes a Transfer Report",
33434     "examples": [
33435       {
33436         "title": "Example usage:",
33437         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33438         "type": "json"
33439       }
33440     ],
33441     "name": "DeleteTransfer_Reports",
33442     "group": "Voice_Transfer_Reports",
33443     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33444     "version": "0.0.0",
33445     "filename": "server/api/voiceTransferReport/index.js",
33446     "groupTitle": "Voice_Transfer_Reports"
33447   },
33448   {
33449     "type": "get",
33450     "url": "/api/voice/transfers/reports/describe",
33451     "title": "Gets table info about Transfer Reports",
33452     "examples": [
33453       {
33454         "title": "Example usage:",
33455         "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
33456         "type": "json"
33457       }
33458     ],
33459     "name": "DescribeTransfer_Reports",
33460     "group": "Voice_Transfer_Reports",
33461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33462     "version": "0.0.0",
33463     "filename": "server/api/voiceTransferReport/index.js",
33464     "groupTitle": "Voice_Transfer_Reports"
33465   },
33466   {
33467     "type": "get",
33468     "url": "/api/voice/transfers/reports",
33469     "title": "Gets a list of Transfer Reports",
33470     "examples": [
33471       {
33472         "title": "Example usage:",
33473         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33474         "type": "json"
33475       }
33476     ],
33477     "name": "GetTransfer_Reports",
33478     "group": "Voice_Transfer_Reports",
33479     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33480     "version": "0.0.0",
33481     "filename": "server/api/voiceTransferReport/index.js",
33482     "groupTitle": "Voice_Transfer_Reports"
33483   },
33484   {
33485     "type": "get",
33486     "url": "/api/voice/transfers/reports/{id}",
33487     "title": "Gets a single Transfer Report",
33488     "examples": [
33489       {
33490         "title": "Example usage:",
33491         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33492         "type": "json"
33493       }
33494     ],
33495     "name": "ShowTransfer_Reports",
33496     "group": "Voice_Transfer_Reports",
33497     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33498     "version": "0.0.0",
33499     "filename": "server/api/voiceTransferReport/index.js",
33500     "groupTitle": "Voice_Transfer_Reports"
33501   },
33502   {
33503     "type": "put",
33504     "url": "/api/voice/transfers/reports/{id}",
33505     "title": "Update an existing Transfer Report",
33506     "examples": [
33507       {
33508         "title": "Example usage:",
33509         "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",
33510         "type": "json"
33511       }
33512     ],
33513     "name": "updateTransfer_Reports",
33514     "group": "Voice_Transfer_Reports",
33515     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33516     "version": "0.0.0",
33517     "filename": "server/api/voiceTransferReport/index.js",
33518     "groupTitle": "Voice_Transfer_Reports"
33519   },
33520   {
33521     "type": "post",
33522     "url": "/api/integrations/vtiger/accounts",
33523     "title": "Creates a new Vtiger Account",
33524     "examples": [
33525       {
33526         "title": "Example usage:",
33527         "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",
33528         "type": "json"
33529       }
33530     ],
33531     "name": "CreateVtiger_Accounts",
33532     "group": "Vtiger_Accounts",
33533     "parameter": {
33534       "fields": {
33535         "Body": [
33536           {
33537             "group": "Body",
33538             "type": "String",
33539             "optional": false,
33540             "field": "name",
33541             "description": ""
33542           },
33543           {
33544             "group": "Body",
33545             "type": "String",
33546             "optional": true,
33547             "field": "description",
33548             "description": ""
33549           },
33550           {
33551             "group": "Body",
33552             "type": "String",
33553             "optional": false,
33554             "field": "username",
33555             "description": ""
33556           },
33557           {
33558             "group": "Body",
33559             "type": "String",
33560             "optional": false,
33561             "field": "moduleName",
33562             "description": ""
33563           },
33564           {
33565             "group": "Body",
33566             "type": "String",
33567             "optional": false,
33568             "field": "remoteUri",
33569             "description": ""
33570           },
33571           {
33572             "group": "Body",
33573             "type": "String",
33574             "optional": false,
33575             "field": "serverUrl",
33576             "description": ""
33577           },
33578           {
33579             "group": "Body",
33580             "type": "String",
33581             "optional": false,
33582             "field": "accessKey",
33583             "description": ""
33584           }
33585         ]
33586       }
33587     },
33588     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33589     "version": "0.0.0",
33590     "filename": "server/api/intVtigerAccount/index.js",
33591     "groupTitle": "Vtiger_Accounts"
33592   },
33593   {
33594     "type": "delete",
33595     "url": "/api/integrations/vtiger/accounts/{id}",
33596     "title": "Deletes a Vtiger Account",
33597     "examples": [
33598       {
33599         "title": "Example usage:",
33600         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33601         "type": "json"
33602       }
33603     ],
33604     "name": "DeleteVtiger_Accounts",
33605     "group": "Vtiger_Accounts",
33606     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33607     "version": "0.0.0",
33608     "filename": "server/api/intVtigerAccount/index.js",
33609     "groupTitle": "Vtiger_Accounts"
33610   },
33611   {
33612     "type": "get",
33613     "url": "/api/integrations/vtiger/accounts",
33614     "title": "Gets a list of Vtiger Accounts",
33615     "examples": [
33616       {
33617         "title": "Example usage:",
33618         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33619         "type": "json"
33620       }
33621     ],
33622     "name": "GetVtiger_Accounts",
33623     "group": "Vtiger_Accounts",
33624     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33625     "version": "0.0.0",
33626     "filename": "server/api/intVtigerAccount/index.js",
33627     "groupTitle": "Vtiger_Accounts"
33628   },
33629   {
33630     "type": "get",
33631     "url": "/api/integrations/vtiger/accounts/{id}",
33632     "title": "Gets a single Vtiger Account",
33633     "examples": [
33634       {
33635         "title": "Example usage:",
33636         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33637         "type": "json"
33638       }
33639     ],
33640     "name": "ShowVtiger_Accounts",
33641     "group": "Vtiger_Accounts",
33642     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33643     "version": "0.0.0",
33644     "filename": "server/api/intVtigerAccount/index.js",
33645     "groupTitle": "Vtiger_Accounts"
33646   },
33647   {
33648     "type": "post",
33649     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33650     "title": "Creates new configuration",
33651     "examples": [
33652       {
33653         "title": "Example usage:",
33654         "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",
33655         "type": "json"
33656       }
33657     ],
33658     "name": "addConfiguration",
33659     "group": "Vtiger_Accounts",
33660     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33661     "version": "0.0.0",
33662     "filename": "server/api/intVtigerAccount/index.js",
33663     "groupTitle": "Vtiger_Accounts"
33664   },
33665   {
33666     "type": "get",
33667     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33668     "title": "Gets account configurations",
33669     "examples": [
33670       {
33671         "title": "Example usage:",
33672         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33673         "type": "json"
33674       }
33675     ],
33676     "name": "getConfigurations",
33677     "group": "Vtiger_Accounts",
33678     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33679     "version": "0.0.0",
33680     "filename": "server/api/intVtigerAccount/index.js",
33681     "groupTitle": "Vtiger_Accounts"
33682   },
33683   {
33684     "type": "get",
33685     "url": "/api/integrations/vtiger/accounts/{id}/fields",
33686     "title": "Gets account fields",
33687     "examples": [
33688       {
33689         "title": "Example usage:",
33690         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33691         "type": "json"
33692       }
33693     ],
33694     "name": "getFields",
33695     "group": "Vtiger_Accounts",
33696     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33697     "version": "0.0.0",
33698     "filename": "server/api/intVtigerAccount/index.js",
33699     "groupTitle": "Vtiger_Accounts"
33700   },
33701   {
33702     "type": "put",
33703     "url": "/api/integrations/vtiger/accounts/{id}",
33704     "title": "Update an existing Vtiger Account",
33705     "examples": [
33706       {
33707         "title": "Example usage:",
33708         "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",
33709         "type": "json"
33710       }
33711     ],
33712     "name": "updateVtiger_Accounts",
33713     "group": "Vtiger_Accounts",
33714     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33715     "version": "0.0.0",
33716     "filename": "server/api/intVtigerAccount/index.js",
33717     "groupTitle": "Vtiger_Accounts"
33718   },
33719   {
33720     "type": "post",
33721     "url": "/api/integrations/vtiger/configurations",
33722     "title": "Creates a new Vtiger Configuration",
33723     "examples": [
33724       {
33725         "title": "Example usage:",
33726         "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",
33727         "type": "json"
33728       }
33729     ],
33730     "name": "CreateVtiger_Configurations",
33731     "group": "Vtiger_Configurations",
33732     "parameter": {
33733       "fields": {
33734         "Body": [
33735           {
33736             "group": "Body",
33737             "type": "String",
33738             "optional": true,
33739             "field": "name",
33740             "description": ""
33741           },
33742           {
33743             "group": "Body",
33744             "type": "String",
33745             "optional": true,
33746             "field": "description",
33747             "description": ""
33748           }
33749         ]
33750       }
33751     },
33752     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33753     "version": "0.0.0",
33754     "filename": "server/api/intVtigerConfiguration/index.js",
33755     "groupTitle": "Vtiger_Configurations"
33756   },
33757   {
33758     "type": "delete",
33759     "url": "/api/integrations/vtiger/configurations/{id}",
33760     "title": "Deletes a Vtiger Configuration",
33761     "examples": [
33762       {
33763         "title": "Example usage:",
33764         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
33765         "type": "json"
33766       }
33767     ],
33768     "name": "DeleteVtiger_Configurations",
33769     "group": "Vtiger_Configurations",
33770     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33771     "version": "0.0.0",
33772     "filename": "server/api/intVtigerConfiguration/index.js",
33773     "groupTitle": "Vtiger_Configurations"
33774   },
33775   {
33776     "type": "get",
33777     "url": "/api/integrations/vtiger/configurations",
33778     "title": "Gets a list of Vtiger Configurations",
33779     "examples": [
33780       {
33781         "title": "Example usage:",
33782         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
33783         "type": "json"
33784       }
33785     ],
33786     "name": "GetVtiger_Configurations",
33787     "group": "Vtiger_Configurations",
33788     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33789     "version": "0.0.0",
33790     "filename": "server/api/intVtigerConfiguration/index.js",
33791     "groupTitle": "Vtiger_Configurations"
33792   },
33793   {
33794     "type": "get",
33795     "url": "/api/integrations/vtiger/configurations/{id}",
33796     "title": "Gets a single Vtiger Configuration",
33797     "examples": [
33798       {
33799         "title": "Example usage:",
33800         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
33801         "type": "json"
33802       }
33803     ],
33804     "name": "ShowVtiger_Configurations",
33805     "group": "Vtiger_Configurations",
33806     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33807     "version": "0.0.0",
33808     "filename": "server/api/intVtigerConfiguration/index.js",
33809     "groupTitle": "Vtiger_Configurations"
33810   },
33811   {
33812     "type": "get",
33813     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
33814     "title": "Gets configurations descriptions",
33815     "examples": [
33816       {
33817         "title": "Example usage:",
33818         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
33819         "type": "json"
33820       }
33821     ],
33822     "name": "getDescriptions",
33823     "group": "Vtiger_Configurations",
33824     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33825     "version": "0.0.0",
33826     "filename": "server/api/intVtigerConfiguration/index.js",
33827     "groupTitle": "Vtiger_Configurations"
33828   },
33829   {
33830     "type": "get",
33831     "url": "/api/integrations/vtiger/configurations/{id}/fields",
33832     "title": "Gets configurations fields",
33833     "examples": [
33834       {
33835         "title": "Example usage:",
33836         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
33837         "type": "json"
33838       }
33839     ],
33840     "name": "getFields",
33841     "group": "Vtiger_Configurations",
33842     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33843     "version": "0.0.0",
33844     "filename": "server/api/intVtigerConfiguration/index.js",
33845     "groupTitle": "Vtiger_Configurations"
33846   },
33847   {
33848     "type": "get",
33849     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
33850     "title": "Gets configurations subjects",
33851     "examples": [
33852       {
33853         "title": "Example usage:",
33854         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
33855         "type": "json"
33856       }
33857     ],
33858     "name": "getSubjects",
33859     "group": "Vtiger_Configurations",
33860     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33861     "version": "0.0.0",
33862     "filename": "server/api/intVtigerConfiguration/index.js",
33863     "groupTitle": "Vtiger_Configurations"
33864   },
33865   {
33866     "type": "put",
33867     "url": "/api/integrations/vtiger/configurations/{id}",
33868     "title": "Update an existing Vtiger Configuration",
33869     "examples": [
33870       {
33871         "title": "Example usage:",
33872         "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",
33873         "type": "json"
33874       }
33875     ],
33876     "name": "updateVtiger_Configurations",
33877     "group": "Vtiger_Configurations",
33878     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33879     "version": "0.0.0",
33880     "filename": "server/api/intVtigerConfiguration/index.js",
33881     "groupTitle": "Vtiger_Configurations"
33882   },
33883   {
33884     "type": "post",
33885     "url": "/api/integrations/vtiger/fields",
33886     "title": "Creates a new Vtiger Field",
33887     "examples": [
33888       {
33889         "title": "Example usage:",
33890         "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",
33891         "type": "json"
33892       }
33893     ],
33894     "name": "CreateVtiger_Fields",
33895     "group": "Vtiger_Fields",
33896     "parameter": {
33897       "fields": {
33898         "Body": [
33899           {
33900             "group": "Body",
33901             "type": "String",
33902             "allowedValues": [
33903               "\"string\"",
33904               "\"variable\"",
33905               "\"customVariable\"",
33906               "\"keyValue\"",
33907               "\"picklist\""
33908             ],
33909             "optional": true,
33910             "field": "type",
33911             "description": ""
33912           },
33913           {
33914             "group": "Body",
33915             "type": "String",
33916             "optional": true,
33917             "field": "content",
33918             "description": ""
33919           },
33920           {
33921             "group": "Body",
33922             "type": "String",
33923             "optional": true,
33924             "field": "key",
33925             "description": ""
33926           },
33927           {
33928             "group": "Body",
33929             "type": "String",
33930             "allowedValues": [
33931               "\"string\"",
33932               "\"variable\"",
33933               "\"customVariable\""
33934             ],
33935             "optional": true,
33936             "field": "keyType",
33937             "description": ""
33938           },
33939           {
33940             "group": "Body",
33941             "type": "String",
33942             "optional": true,
33943             "field": "keyContent",
33944             "description": ""
33945           },
33946           {
33947             "group": "Body",
33948             "type": "String",
33949             "optional": true,
33950             "field": "idField",
33951             "description": ""
33952           },
33953           {
33954             "group": "Body",
33955             "type": "String",
33956             "optional": true,
33957             "field": "nameField",
33958             "description": ""
33959           },
33960           {
33961             "group": "Body",
33962             "type": "Boolean",
33963             "optional": true,
33964             "field": "customField",
33965             "description": ""
33966           },
33967           {
33968             "group": "Body",
33969             "type": "String",
33970             "optional": true,
33971             "field": "variableName",
33972             "description": ""
33973           }
33974         ]
33975       }
33976     },
33977     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33978     "version": "0.0.0",
33979     "filename": "server/api/intVtigerField/index.js",
33980     "groupTitle": "Vtiger_Fields"
33981   },
33982   {
33983     "type": "delete",
33984     "url": "/api/integrations/vtiger/fields/{id}",
33985     "title": "Deletes a Vtiger Field",
33986     "examples": [
33987       {
33988         "title": "Example usage:",
33989         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
33990         "type": "json"
33991       }
33992     ],
33993     "name": "DeleteVtiger_Fields",
33994     "group": "Vtiger_Fields",
33995     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33996     "version": "0.0.0",
33997     "filename": "server/api/intVtigerField/index.js",
33998     "groupTitle": "Vtiger_Fields"
33999   },
34000   {
34001     "type": "get",
34002     "url": "/api/integrations/vtiger/fields",
34003     "title": "Gets a list of Vtiger Fields",
34004     "examples": [
34005       {
34006         "title": "Example usage:",
34007         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34008         "type": "json"
34009       }
34010     ],
34011     "name": "GetVtiger_Fields",
34012     "group": "Vtiger_Fields",
34013     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34014     "version": "0.0.0",
34015     "filename": "server/api/intVtigerField/index.js",
34016     "groupTitle": "Vtiger_Fields"
34017   },
34018   {
34019     "type": "get",
34020     "url": "/api/integrations/vtiger/fields/{id}",
34021     "title": "Gets a single Vtiger Field",
34022     "examples": [
34023       {
34024         "title": "Example usage:",
34025         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34026         "type": "json"
34027       }
34028     ],
34029     "name": "ShowVtiger_Fields",
34030     "group": "Vtiger_Fields",
34031     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34032     "version": "0.0.0",
34033     "filename": "server/api/intVtigerField/index.js",
34034     "groupTitle": "Vtiger_Fields"
34035   },
34036   {
34037     "type": "put",
34038     "url": "/api/integrations/vtiger/fields/{id}",
34039     "title": "Update an existing Vtiger Field",
34040     "examples": [
34041       {
34042         "title": "Example usage:",
34043         "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",
34044         "type": "json"
34045       }
34046     ],
34047     "name": "updateVtiger_Fields",
34048     "group": "Vtiger_Fields",
34049     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34050     "version": "0.0.0",
34051     "filename": "server/api/intVtigerField/index.js",
34052     "groupTitle": "Vtiger_Fields"
34053   },
34054   {
34055     "type": "post",
34056     "url": "/api/webbar/answer",
34057     "title": "answer webrtc call",
34058     "examples": [
34059       {
34060         "title": "Example usage:",
34061         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34062         "type": "json"
34063       }
34064     ],
34065     "name": "Web_Bar_answer",
34066     "group": "WebBar",
34067     "parameter": {
34068       "fields": {
34069         "Body": [
34070           {
34071             "group": "Body",
34072             "type": "String",
34073             "optional": false,
34074             "field": "sessionId",
34075             "description": ""
34076           },
34077           {
34078             "group": "Body",
34079             "type": "number",
34080             "optional": false,
34081             "field": "userId",
34082             "description": ""
34083           }
34084         ]
34085       }
34086     },
34087     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34088     "version": "0.0.0",
34089     "filename": "server/api/webbar/index.js",
34090     "groupTitle": "WebBar"
34091   },
34092   {
34093     "type": "post",
34094     "url": "/api/webbar/calls",
34095     "title": "webrtc call list",
34096     "examples": [
34097       {
34098         "title": "Example usage:",
34099         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34100         "type": "json"
34101       }
34102     ],
34103     "name": "Web_Bar_calls",
34104     "group": "WebBar",
34105     "parameter": {
34106       "fields": {
34107         "Body": [
34108           {
34109             "group": "Body",
34110             "type": "number",
34111             "optional": false,
34112             "field": "userId",
34113             "description": ""
34114           }
34115         ]
34116       }
34117     },
34118     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34119     "version": "0.0.0",
34120     "filename": "server/api/webbar/index.js",
34121     "groupTitle": "WebBar"
34122   },
34123   {
34124     "type": "post",
34125     "url": "/api/webbar/hangup",
34126     "title": "hangup webrtc call",
34127     "examples": [
34128       {
34129         "title": "Example usage:",
34130         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34131         "type": "json"
34132       }
34133     ],
34134     "name": "Web_Bar_hangup",
34135     "group": "WebBar",
34136     "parameter": {
34137       "fields": {
34138         "Body": [
34139           {
34140             "group": "Body",
34141             "type": "String",
34142             "optional": false,
34143             "field": "sessionId",
34144             "description": ""
34145           },
34146           {
34147             "group": "Body",
34148             "type": "number",
34149             "optional": false,
34150             "field": "userId",
34151             "description": ""
34152           }
34153         ]
34154       }
34155     },
34156     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34157     "version": "0.0.0",
34158     "filename": "server/api/webbar/index.js",
34159     "groupTitle": "WebBar"
34160   },
34161   {
34162     "type": "post",
34163     "url": "/api/webbar/unhold",
34164     "title": "unhold webrtc call",
34165     "examples": [
34166       {
34167         "title": "Example usage:",
34168         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34169         "type": "json"
34170       }
34171     ],
34172     "name": "Web_Bar_hold",
34173     "group": "WebBar",
34174     "parameter": {
34175       "fields": {
34176         "Body": [
34177           {
34178             "group": "Body",
34179             "type": "String",
34180             "optional": false,
34181             "field": "sessionId",
34182             "description": ""
34183           },
34184           {
34185             "group": "Body",
34186             "type": "number",
34187             "optional": false,
34188             "field": "userId",
34189             "description": ""
34190           }
34191         ]
34192       }
34193     },
34194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34195     "version": "0.0.0",
34196     "filename": "server/api/webbar/index.js",
34197     "groupTitle": "WebBar"
34198   },
34199   {
34200     "type": "post",
34201     "url": "/api/webbar/hold",
34202     "title": "hold webrtc call",
34203     "examples": [
34204       {
34205         "title": "Example usage:",
34206         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34207         "type": "json"
34208       }
34209     ],
34210     "name": "Web_Bar_hold",
34211     "group": "WebBar",
34212     "parameter": {
34213       "fields": {
34214         "Body": [
34215           {
34216             "group": "Body",
34217             "type": "String",
34218             "optional": true,
34219             "field": "sessionId",
34220             "description": ""
34221           },
34222           {
34223             "group": "Body",
34224             "type": "number",
34225             "optional": false,
34226             "field": "userId",
34227             "description": ""
34228           }
34229         ]
34230       }
34231     },
34232     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34233     "version": "0.0.0",
34234     "filename": "server/api/webbar/index.js",
34235     "groupTitle": "WebBar"
34236   },
34237   {
34238     "type": "post",
34239     "url": "/api/webbar/originate",
34240     "title": "Originate new webrtc call",
34241     "examples": [
34242       {
34243         "title": "Example usage:",
34244         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34245         "type": "json"
34246       }
34247     ],
34248     "name": "Web_Bar_originate",
34249     "group": "WebBar",
34250     "parameter": {
34251       "fields": {
34252         "Body": [
34253           {
34254             "group": "Body",
34255             "type": "String",
34256             "optional": false,
34257             "field": "callNumber",
34258             "description": ""
34259           },
34260           {
34261             "group": "Body",
34262             "type": "number",
34263             "optional": false,
34264             "field": "userId",
34265             "description": ""
34266           },
34267           {
34268             "group": "Body",
34269             "type": "String",
34270             "optional": false,
34271             "field": "callerId",
34272             "description": ""
34273           },
34274           {
34275             "group": "Body",
34276             "type": "String",
34277             "optional": false,
34278             "field": "callbackUrl",
34279             "description": ""
34280           }
34281         ]
34282       }
34283     },
34284     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34285     "version": "0.0.0",
34286     "filename": "server/api/webbar/index.js",
34287     "groupTitle": "WebBar"
34288   },
34289   {
34290     "type": "post",
34291     "url": "/api/webbar/transfer",
34292     "title": "blind transfer webrtc call",
34293     "examples": [
34294       {
34295         "title": "Example usage:",
34296         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34297         "type": "json"
34298       }
34299     ],
34300     "name": "Web_Bar_transfer",
34301     "group": "WebBar",
34302     "parameter": {
34303       "fields": {
34304         "Body": [
34305           {
34306             "group": "Body",
34307             "type": "number",
34308             "optional": false,
34309             "field": "userId",
34310             "description": ""
34311           },
34312           {
34313             "group": "Body",
34314             "type": "string",
34315             "optional": false,
34316             "field": "sessionId",
34317             "description": ""
34318           },
34319           {
34320             "group": "Body",
34321             "type": "string",
34322             "optional": false,
34323             "field": "transferNumber",
34324             "description": ""
34325           }
34326         ]
34327       }
34328     },
34329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34330     "version": "0.0.0",
34331     "filename": "server/api/webbar/index.js",
34332     "groupTitle": "WebBar"
34333   },
34334   {
34335     "type": "post",
34336     "url": "/api/whatsapp/accounts/{id}/users",
34337     "title": "Add agents to a whatsapp account",
34338     "examples": [
34339       {
34340         "title": "Example usage:",
34341         "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",
34342         "type": "json"
34343       }
34344     ],
34345     "name": "AddAgents",
34346     "group": "Whatsapp_Accounts",
34347     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34348     "version": "0.0.0",
34349     "filename": "server/api/whatsappAccount/index.js",
34350     "groupTitle": "Whatsapp_Accounts"
34351   },
34352   {
34353     "type": "post",
34354     "url": "/api/whatsapp/accounts",
34355     "title": "Creates a new Account",
34356     "examples": [
34357       {
34358         "title": "Example usage:",
34359         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34360         "type": "json"
34361       }
34362     ],
34363     "name": "CreateAccounts",
34364     "group": "Whatsapp_Accounts",
34365     "parameter": {
34366       "fields": {
34367         "Body": [
34368           {
34369             "group": "Body",
34370             "type": "String",
34371             "optional": false,
34372             "field": "name",
34373             "description": ""
34374           },
34375           {
34376             "group": "Body",
34377             "type": "String",
34378             "optional": false,
34379             "field": "key",
34380             "description": ""
34381           },
34382           {
34383             "group": "Body",
34384             "type": "String",
34385             "optional": false,
34386             "field": "remote",
34387             "description": ""
34388           },
34389           {
34390             "group": "Body",
34391             "type": "String",
34392             "optional": true,
34393             "field": "token",
34394             "description": ""
34395           },
34396           {
34397             "group": "Body",
34398             "type": "String",
34399             "optional": true,
34400             "field": "phone",
34401             "description": ""
34402           },
34403           {
34404             "group": "Body",
34405             "type": "String",
34406             "allowedValues": [
34407               "\"twilio\""
34408             ],
34409             "optional": true,
34410             "field": "type",
34411             "description": ""
34412           },
34413           {
34414             "group": "Body",
34415             "type": "String",
34416             "optional": true,
34417             "field": "accountSid",
34418             "description": ""
34419           },
34420           {
34421             "group": "Body",
34422             "type": "String",
34423             "optional": true,
34424             "field": "authToken",
34425             "description": ""
34426           },
34427           {
34428             "group": "Body",
34429             "type": "Text",
34430             "optional": true,
34431             "field": "notificationTemplate",
34432             "description": ""
34433           },
34434           {
34435             "group": "Body",
34436             "type": "Boolean",
34437             "optional": true,
34438             "field": "notificationSound",
34439             "description": ""
34440           },
34441           {
34442             "group": "Body",
34443             "type": "Boolean",
34444             "optional": true,
34445             "field": "notificationShake",
34446             "description": ""
34447           },
34448           {
34449             "group": "Body",
34450             "type": "Integer",
34451             "optional": true,
34452             "field": "waitForTheAssignedAgent",
34453             "description": ""
34454           },
34455           {
34456             "group": "Body",
34457             "type": "Boolean",
34458             "optional": true,
34459             "field": "queueTransfer",
34460             "description": ""
34461           },
34462           {
34463             "group": "Body",
34464             "type": "Integer",
34465             "optional": true,
34466             "field": "queueTransferTimeout",
34467             "description": ""
34468           },
34469           {
34470             "group": "Body",
34471             "type": "Boolean",
34472             "optional": true,
34473             "field": "agentTransfer",
34474             "description": ""
34475           },
34476           {
34477             "group": "Body",
34478             "type": "Integer",
34479             "optional": true,
34480             "field": "agentTransferTimeout",
34481             "description": ""
34482           },
34483           {
34484             "group": "Body",
34485             "type": "Integer",
34486             "optional": true,
34487             "field": "mandatoryDispositionPauseId",
34488             "description": "<p>Status to put when mandatory disposition is enabled</p>"
34489           },
34490           {
34491             "group": "Body",
34492             "type": "Boolean",
34493             "optional": true,
34494             "field": "mandatoryDisposition",
34495             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34496           },
34497           {
34498             "group": "Body",
34499             "type": "String",
34500             "optional": true,
34501             "field": "description",
34502             "description": ""
34503           }
34504         ]
34505       }
34506     },
34507     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34508     "version": "0.0.0",
34509     "filename": "server/api/whatsappAccount/index.js",
34510     "groupTitle": "Whatsapp_Accounts"
34511   },
34512   {
34513     "type": "delete",
34514     "url": "/api/whatsapp/accounts/{id}",
34515     "title": "Deletes a Account",
34516     "examples": [
34517       {
34518         "title": "Example usage:",
34519         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34520         "type": "json"
34521       }
34522     ],
34523     "name": "DeleteAccounts",
34524     "group": "Whatsapp_Accounts",
34525     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34526     "version": "0.0.0",
34527     "filename": "server/api/whatsappAccount/index.js",
34528     "groupTitle": "Whatsapp_Accounts"
34529   },
34530   {
34531     "type": "get",
34532     "url": "/api/whatsapp/accounts/describe",
34533     "title": "Gets table info about Accounts",
34534     "examples": [
34535       {
34536         "title": "Example usage:",
34537         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34538         "type": "json"
34539       }
34540     ],
34541     "name": "DescribeAccounts",
34542     "group": "Whatsapp_Accounts",
34543     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34544     "version": "0.0.0",
34545     "filename": "server/api/whatsappAccount/index.js",
34546     "groupTitle": "Whatsapp_Accounts"
34547   },
34548   {
34549     "type": "get",
34550     "url": "/api/whatsapp/accounts",
34551     "title": "Gets a list of Accounts",
34552     "examples": [
34553       {
34554         "title": "Example usage:",
34555         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34556         "type": "json"
34557       }
34558     ],
34559     "name": "GetAccounts",
34560     "group": "Whatsapp_Accounts",
34561     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34562     "version": "0.0.0",
34563     "filename": "server/api/whatsappAccount/index.js",
34564     "groupTitle": "Whatsapp_Accounts"
34565   },
34566   {
34567     "type": "get",
34568     "url": "/api/whatsapp/accounts/{id}/users",
34569     "title": "Gets agents from whatsapp account",
34570     "examples": [
34571       {
34572         "title": "Example usage:",
34573         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34574         "type": "json"
34575       }
34576     ],
34577     "name": "GetAgents",
34578     "group": "Whatsapp_Accounts",
34579     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34580     "version": "0.0.0",
34581     "filename": "server/api/whatsappAccount/index.js",
34582     "groupTitle": "Whatsapp_Accounts"
34583   },
34584   {
34585     "type": "delete",
34586     "url": "/api/whatsapp/accounts/{id}/users",
34587     "title": "Removes agents from a whatsapp account",
34588     "examples": [
34589       {
34590         "title": "Example usage:",
34591         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34592         "type": "json"
34593       }
34594     ],
34595     "name": "RemoveAgents",
34596     "group": "Whatsapp_Accounts",
34597     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34598     "version": "0.0.0",
34599     "filename": "server/api/whatsappAccount/index.js",
34600     "groupTitle": "Whatsapp_Accounts"
34601   },
34602   {
34603     "type": "delete",
34604     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34605     "title": "Removes canned answers from account",
34606     "examples": [
34607       {
34608         "title": "Example usage:",
34609         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34610         "type": "json"
34611       }
34612     ],
34613     "name": "RemoveAnswers",
34614     "group": "Whatsapp_Accounts",
34615     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34616     "version": "0.0.0",
34617     "filename": "server/api/whatsappAccount/index.js",
34618     "groupTitle": "Whatsapp_Accounts"
34619   },
34620   {
34621     "type": "delete",
34622     "url": "/api/whatsapp/accounts/{id}/dispositions",
34623     "title": "Removes dispositions from account",
34624     "examples": [
34625       {
34626         "title": "Example usage:",
34627         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34628         "type": "json"
34629       }
34630     ],
34631     "name": "RemoveDispositions",
34632     "group": "Whatsapp_Accounts",
34633     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34634     "version": "0.0.0",
34635     "filename": "server/api/whatsappAccount/index.js",
34636     "groupTitle": "Whatsapp_Accounts"
34637   },
34638   {
34639     "type": "get",
34640     "url": "/api/whatsapp/accounts/{id}",
34641     "title": "Gets a single Account",
34642     "examples": [
34643       {
34644         "title": "Example usage:",
34645         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34646         "type": "json"
34647       }
34648     ],
34649     "name": "ShowAccounts",
34650     "group": "Whatsapp_Accounts",
34651     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34652     "version": "0.0.0",
34653     "filename": "server/api/whatsappAccount/index.js",
34654     "groupTitle": "Whatsapp_Accounts"
34655   },
34656   {
34657     "type": "put",
34658     "url": "/api/whatsapp/messages/{id}/accept",
34659     "title": "Accepts message",
34660     "examples": [
34661       {
34662         "title": "Example usage:",
34663         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34664         "type": "json"
34665       }
34666     ],
34667     "name": "acceptMessage",
34668     "group": "Whatsapp_Accounts",
34669     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34670     "version": "0.0.0",
34671     "filename": "server/api/whatsappMessage/index.js",
34672     "groupTitle": "Whatsapp_Accounts"
34673   },
34674   {
34675     "type": "post",
34676     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34677     "title": "Creates new canned answer",
34678     "examples": [
34679       {
34680         "title": "Example usage:",
34681         "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",
34682         "type": "json"
34683       }
34684     ],
34685     "name": "addAnswer",
34686     "group": "Whatsapp_Accounts",
34687     "parameter": {
34688       "fields": {
34689         "Body": [
34690           {
34691             "group": "Body",
34692             "type": "String",
34693             "optional": false,
34694             "field": "key",
34695             "description": ""
34696           },
34697           {
34698             "group": "Body",
34699             "type": "Text",
34700             "optional": false,
34701             "field": "value",
34702             "description": ""
34703           },
34704           {
34705             "group": "Body",
34706             "type": "String",
34707             "optional": true,
34708             "field": "description",
34709             "description": ""
34710           },
34711           {
34712             "group": "Body",
34713             "type": "Virtual",
34714             "optional": true,
34715             "field": "name",
34716             "description": ""
34717           }
34718         ]
34719       }
34720     },
34721     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34722     "version": "0.0.0",
34723     "filename": "server/api/whatsappAccount/index.js",
34724     "groupTitle": "Whatsapp_Accounts"
34725   },
34726   {
34727     "type": "post",
34728     "url": "/api/whatsapp/accounts/{id}/applications",
34729     "title": "Creates new applications",
34730     "examples": [
34731       {
34732         "title": "Example usage:",
34733         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34734         "type": "json"
34735       }
34736     ],
34737     "name": "addApplications",
34738     "group": "Whatsapp_Accounts",
34739     "parameter": {
34740       "fields": {
34741         "Body": [
34742           {
34743             "group": "Body",
34744             "type": "Integer",
34745             "optional": false,
34746             "field": "priority",
34747             "description": ""
34748           },
34749           {
34750             "group": "Body",
34751             "type": "String",
34752             "optional": false,
34753             "field": "app",
34754             "description": ""
34755           },
34756           {
34757             "group": "Body",
34758             "type": "Text",
34759             "optional": true,
34760             "field": "appdata",
34761             "description": ""
34762           },
34763           {
34764             "group": "Body",
34765             "type": "String",
34766             "optional": true,
34767             "field": "description",
34768             "description": ""
34769           },
34770           {
34771             "group": "Body",
34772             "type": "String",
34773             "optional": true,
34774             "field": "interval",
34775             "description": ""
34776           }
34777         ]
34778       }
34779     },
34780     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34781     "version": "0.0.0",
34782     "filename": "server/api/whatsappAccount/index.js",
34783     "groupTitle": "Whatsapp_Accounts"
34784   },
34785   {
34786     "type": "post",
34787     "url": "/api/whatsapp/accounts/{id}/dispositions",
34788     "title": "Creates new disposition",
34789     "examples": [
34790       {
34791         "title": "Example usage:",
34792         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34793         "type": "json"
34794       }
34795     ],
34796     "name": "addDisposition",
34797     "group": "Whatsapp_Accounts",
34798     "parameter": {
34799       "fields": {
34800         "Body": [
34801           {
34802             "group": "Body",
34803             "type": "String",
34804             "optional": false,
34805             "field": "name",
34806             "description": ""
34807           },
34808           {
34809             "group": "Body",
34810             "type": "String",
34811             "allowedValues": [
34812               "\"first\"",
34813               "\"second\"",
34814               "\"third\""
34815             ],
34816             "optional": false,
34817             "field": "level",
34818             "description": ""
34819           },
34820           {
34821             "group": "Body",
34822             "type": "String",
34823             "optional": true,
34824             "field": "description",
34825             "description": ""
34826           }
34827         ]
34828       }
34829     },
34830     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34831     "version": "0.0.0",
34832     "filename": "server/api/whatsappAccount/index.js",
34833     "groupTitle": "Whatsapp_Accounts"
34834   },
34835   {
34836     "type": "get",
34837     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34838     "title": "Gets account canned answers",
34839     "examples": [
34840       {
34841         "title": "Example usage:",
34842         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
34843         "type": "json"
34844       }
34845     ],
34846     "name": "getAnswers",
34847     "group": "Whatsapp_Accounts",
34848     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34849     "version": "0.0.0",
34850     "filename": "server/api/whatsappAccount/index.js",
34851     "groupTitle": "Whatsapp_Accounts"
34852   },
34853   {
34854     "type": "get",
34855     "url": "/api/whatsapp/accounts/{id}/applications",
34856     "title": "Gets account applications",
34857     "examples": [
34858       {
34859         "title": "Example usage:",
34860         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
34861         "type": "json"
34862       }
34863     ],
34864     "name": "getApplications",
34865     "group": "Whatsapp_Accounts",
34866     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34867     "version": "0.0.0",
34868     "filename": "server/api/whatsappAccount/index.js",
34869     "groupTitle": "Whatsapp_Accounts"
34870   },
34871   {
34872     "type": "get",
34873     "url": "/api/whatsapp/accounts/{id}/dispositions",
34874     "title": "Gets account dispositions",
34875     "examples": [
34876       {
34877         "title": "Example usage:",
34878         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
34879         "type": "json"
34880       }
34881     ],
34882     "name": "getDispositions",
34883     "group": "Whatsapp_Accounts",
34884     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34885     "version": "0.0.0",
34886     "filename": "server/api/whatsappAccount/index.js",
34887     "groupTitle": "Whatsapp_Accounts"
34888   },
34889   {
34890     "type": "post",
34891     "url": "/api/whatsapp/accounts/{id}/notify",
34892     "title": "Notify new message",
34893     "examples": [
34894       {
34895         "title": "Example usage:",
34896         "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",
34897         "type": "json"
34898       }
34899     ],
34900     "name": "notify",
34901     "group": "Whatsapp_Accounts",
34902     "description": "<p>Motion 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>",
34903     "version": "0.0.0",
34904     "filename": "server/api/whatsappAccount/index.js",
34905     "groupTitle": "Whatsapp_Accounts"
34906   },
34907   {
34908     "type": "put",
34909     "url": "/api/whatsapp/messages/{id}/reject",
34910     "title": "Rejects message",
34911     "examples": [
34912       {
34913         "title": "Example usage:",
34914         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34915         "type": "json"
34916       }
34917     ],
34918     "name": "rejectMessage",
34919     "group": "Whatsapp_Accounts",
34920     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34921     "version": "0.0.0",
34922     "filename": "server/api/whatsappMessage/index.js",
34923     "groupTitle": "Whatsapp_Accounts"
34924   },
34925   {
34926     "type": "post",
34927     "url": "/api/whatsapp/accounts/{id}/send",
34928     "title": "Send new whatsapp message",
34929     "examples": [
34930       {
34931         "title": "Example usage:",
34932         "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",
34933         "type": "json"
34934       }
34935     ],
34936     "name": "sendWhatsapp",
34937     "group": "Whatsapp_Accounts",
34938     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34939     "version": "0.0.0",
34940     "filename": "server/api/whatsappAccount/index.js",
34941     "groupTitle": "Whatsapp_Accounts"
34942   },
34943   {
34944     "type": "post",
34945     "url": "/api/whatsapp/messages/{id}/status",
34946     "title": "Receive message status",
34947     "examples": [
34948       {
34949         "title": "Example usage:",
34950         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
34951         "type": "json"
34952       }
34953     ],
34954     "name": "statusMessage",
34955     "group": "Whatsapp_Accounts",
34956     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34957     "version": "0.0.0",
34958     "filename": "server/api/whatsappMessage/index.js",
34959     "groupTitle": "Whatsapp_Accounts"
34960   },
34961   {
34962     "type": "put",
34963     "url": "/api/whatsapp/accounts/{id}",
34964     "title": "Update an existing Account",
34965     "examples": [
34966       {
34967         "title": "Example usage:",
34968         "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",
34969         "type": "json"
34970       }
34971     ],
34972     "name": "updateAccounts",
34973     "group": "Whatsapp_Accounts",
34974     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34975     "version": "0.0.0",
34976     "filename": "server/api/whatsappAccount/index.js",
34977     "groupTitle": "Whatsapp_Accounts"
34978   },
34979   {
34980     "type": "post",
34981     "url": "/api/whatsapp/applications",
34982     "title": "Creates a new Application",
34983     "examples": [
34984       {
34985         "title": "Example usage:",
34986         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34987         "type": "json"
34988       }
34989     ],
34990     "name": "CreateApplications",
34991     "group": "Whatsapp_Applications",
34992     "parameter": {
34993       "fields": {
34994         "Body": [
34995           {
34996             "group": "Body",
34997             "type": "Integer",
34998             "optional": false,
34999             "field": "priority",
35000             "description": ""
35001           },
35002           {
35003             "group": "Body",
35004             "type": "String",
35005             "optional": false,
35006             "field": "app",
35007             "description": ""
35008           },
35009           {
35010             "group": "Body",
35011             "type": "Text",
35012             "optional": true,
35013             "field": "appdata",
35014             "description": ""
35015           },
35016           {
35017             "group": "Body",
35018             "type": "String",
35019             "optional": true,
35020             "field": "description",
35021             "description": ""
35022           },
35023           {
35024             "group": "Body",
35025             "type": "String",
35026             "optional": true,
35027             "field": "interval",
35028             "description": ""
35029           }
35030         ]
35031       }
35032     },
35033     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35034     "version": "0.0.0",
35035     "filename": "server/api/whatsappApplication/index.js",
35036     "groupTitle": "Whatsapp_Applications"
35037   },
35038   {
35039     "type": "delete",
35040     "url": "/api/whatsapp/applications/{id}",
35041     "title": "Deletes a Application",
35042     "examples": [
35043       {
35044         "title": "Example usage:",
35045         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35046         "type": "json"
35047       }
35048     ],
35049     "name": "DeleteApplications",
35050     "group": "Whatsapp_Applications",
35051     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35052     "version": "0.0.0",
35053     "filename": "server/api/whatsappApplication/index.js",
35054     "groupTitle": "Whatsapp_Applications"
35055   },
35056   {
35057     "type": "get",
35058     "url": "/api/whatsapp/applications",
35059     "title": "Gets a list of Applications",
35060     "examples": [
35061       {
35062         "title": "Example usage:",
35063         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35064         "type": "json"
35065       }
35066     ],
35067     "name": "GetApplications",
35068     "group": "Whatsapp_Applications",
35069     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35070     "version": "0.0.0",
35071     "filename": "server/api/whatsappApplication/index.js",
35072     "groupTitle": "Whatsapp_Applications"
35073   },
35074   {
35075     "type": "get",
35076     "url": "/api/whatsapp/applications/{id}",
35077     "title": "Gets a single Application",
35078     "examples": [
35079       {
35080         "title": "Example usage:",
35081         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35082         "type": "json"
35083       }
35084     ],
35085     "name": "ShowApplications",
35086     "group": "Whatsapp_Applications",
35087     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35088     "version": "0.0.0",
35089     "filename": "server/api/whatsappApplication/index.js",
35090     "groupTitle": "Whatsapp_Applications"
35091   },
35092   {
35093     "type": "put",
35094     "url": "/api/whatsapp/applications/{id}",
35095     "title": "Update an existing Application",
35096     "examples": [
35097       {
35098         "title": "Example usage:",
35099         "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",
35100         "type": "json"
35101       }
35102     ],
35103     "name": "updateApplications",
35104     "group": "Whatsapp_Applications",
35105     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35106     "version": "0.0.0",
35107     "filename": "server/api/whatsappApplication/index.js",
35108     "groupTitle": "Whatsapp_Applications"
35109   },
35110   {
35111     "type": "post",
35112     "url": "/api/whatsapp/interactions/{id}/tags",
35113     "title": "Add tags to the interaction",
35114     "examples": [
35115       {
35116         "title": "Example usage:",
35117         "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",
35118         "type": "json"
35119       }
35120     ],
35121     "name": "AddTags",
35122     "group": "Whatsapp_Interactions",
35123     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35124     "version": "0.0.0",
35125     "filename": "server/api/whatsappInteraction/index.js",
35126     "groupTitle": "Whatsapp_Interactions"
35127   },
35128   {
35129     "type": "post",
35130     "url": "/api/whatsapp/interactions",
35131     "title": "Creates a new Interaction",
35132     "examples": [
35133       {
35134         "title": "Example usage:",
35135         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35136         "type": "json"
35137       }
35138     ],
35139     "name": "CreateInteractions",
35140     "group": "Whatsapp_Interactions",
35141     "parameter": {
35142       "fields": {
35143         "Body": [
35144           {
35145             "group": "Body",
35146             "type": "Boolean",
35147             "optional": true,
35148             "field": "closed",
35149             "description": ""
35150           },
35151           {
35152             "group": "Body",
35153             "type": "String",
35154             "optional": true,
35155             "field": "closedAt",
35156             "description": ""
35157           },
35158           {
35159             "group": "Body",
35160             "type": "String",
35161             "optional": true,
35162             "field": "disposition",
35163             "description": ""
35164           },
35165           {
35166             "group": "Body",
35167             "type": "String",
35168             "optional": true,
35169             "field": "secondDisposition",
35170             "description": ""
35171           },
35172           {
35173             "group": "Body",
35174             "type": "String",
35175             "optional": true,
35176             "field": "thirdDisposition",
35177             "description": ""
35178           },
35179           {
35180             "group": "Body",
35181             "type": "String",
35182             "optional": true,
35183             "field": "note",
35184             "description": ""
35185           },
35186           {
35187             "group": "Body",
35188             "type": "String",
35189             "optional": true,
35190             "field": "phone",
35191             "description": ""
35192           },
35193           {
35194             "group": "Body",
35195             "type": "String",
35196             "optional": true,
35197             "field": "read1stAt",
35198             "description": ""
35199           },
35200           {
35201             "group": "Body",
35202             "type": "String",
35203             "allowedValues": [
35204               "\"in\"",
35205               "\"out\""
35206             ],
35207             "optional": false,
35208             "field": "firstMsgDirection",
35209             "description": ""
35210           },
35211           {
35212             "group": "Body",
35213             "type": "String",
35214             "optional": true,
35215             "field": "lastMsgAt",
35216             "description": ""
35217           },
35218           {
35219             "group": "Body",
35220             "type": "String",
35221             "allowedValues": [
35222               "\"in\"",
35223               "\"out\""
35224             ],
35225             "optional": false,
35226             "field": "lastMsgDirection",
35227             "description": ""
35228           }
35229         ]
35230       }
35231     },
35232     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35233     "version": "0.0.0",
35234     "filename": "server/api/whatsappInteraction/index.js",
35235     "groupTitle": "Whatsapp_Interactions"
35236   },
35237   {
35238     "type": "delete",
35239     "url": "/api/whatsapp/interactions/{id}",
35240     "title": "Deletes a Interaction",
35241     "examples": [
35242       {
35243         "title": "Example usage:",
35244         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35245         "type": "json"
35246       }
35247     ],
35248     "name": "DeleteInteractions",
35249     "group": "Whatsapp_Interactions",
35250     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35251     "version": "0.0.0",
35252     "filename": "server/api/whatsappInteraction/index.js",
35253     "groupTitle": "Whatsapp_Interactions"
35254   },
35255   {
35256     "type": "get",
35257     "url": "/api/whatsapp/interactions/describe",
35258     "title": "Gets table info about Interactions",
35259     "examples": [
35260       {
35261         "title": "Example usage:",
35262         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35263         "type": "json"
35264       }
35265     ],
35266     "name": "DescribeInteractions",
35267     "group": "Whatsapp_Interactions",
35268     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35269     "version": "0.0.0",
35270     "filename": "server/api/whatsappInteraction/index.js",
35271     "groupTitle": "Whatsapp_Interactions"
35272   },
35273   {
35274     "type": "get",
35275     "url": "/api/whatsapp/interactions",
35276     "title": "Gets a list of Interactions",
35277     "examples": [
35278       {
35279         "title": "Example usage:",
35280         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35281         "type": "json"
35282       }
35283     ],
35284     "name": "GetInteractions",
35285     "group": "Whatsapp_Interactions",
35286     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35287     "version": "0.0.0",
35288     "filename": "server/api/whatsappInteraction/index.js",
35289     "groupTitle": "Whatsapp_Interactions"
35290   },
35291   {
35292     "type": "delete",
35293     "url": "/api/whatsapp/interactions/{id}/tags",
35294     "title": "Removes tags from interaction",
35295     "examples": [
35296       {
35297         "title": "Example usage:",
35298         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35299         "type": "json"
35300       }
35301     ],
35302     "name": "RemoveTags",
35303     "group": "Whatsapp_Interactions",
35304     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35305     "version": "0.0.0",
35306     "filename": "server/api/whatsappInteraction/index.js",
35307     "groupTitle": "Whatsapp_Interactions"
35308   },
35309   {
35310     "type": "get",
35311     "url": "/api/whatsapp/interactions/{id}",
35312     "title": "Gets a single Interaction",
35313     "examples": [
35314       {
35315         "title": "Example usage:",
35316         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35317         "type": "json"
35318       }
35319     ],
35320     "name": "ShowInteractions",
35321     "group": "Whatsapp_Interactions",
35322     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35323     "version": "0.0.0",
35324     "filename": "server/api/whatsappInteraction/index.js",
35325     "groupTitle": "Whatsapp_Interactions"
35326   },
35327   {
35328     "type": "post",
35329     "url": "/api/whatsapp/interactions/{id}/messages",
35330     "title": "Creates new messages",
35331     "examples": [
35332       {
35333         "title": "Example usage:",
35334         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35335         "type": "json"
35336       }
35337     ],
35338     "name": "addMessage",
35339     "group": "Whatsapp_Interactions",
35340     "parameter": {
35341       "fields": {
35342         "Body": [
35343           {
35344             "group": "Body",
35345             "type": "Text",
35346             "optional": false,
35347             "field": "body",
35348             "description": ""
35349           },
35350           {
35351             "group": "Body",
35352             "type": "Boolean",
35353             "optional": true,
35354             "field": "read",
35355             "description": ""
35356           },
35357           {
35358             "group": "Body",
35359             "type": "String",
35360             "allowedValues": [
35361               "\"in\"",
35362               "\"out\""
35363             ],
35364             "optional": false,
35365             "field": "direction",
35366             "description": ""
35367           },
35368           {
35369             "group": "Body",
35370             "type": "String",
35371             "optional": true,
35372             "field": "messageId",
35373             "description": ""
35374           },
35375           {
35376             "group": "Body",
35377             "type": "String",
35378             "optional": true,
35379             "field": "phone",
35380             "description": ""
35381           },
35382           {
35383             "group": "Body",
35384             "type": "String",
35385             "optional": true,
35386             "field": "readAt",
35387             "description": ""
35388           },
35389           {
35390             "group": "Body",
35391             "type": "Boolean",
35392             "optional": true,
35393             "field": "secret",
35394             "description": ""
35395           },
35396           {
35397             "group": "Body",
35398             "type": "String",
35399             "optional": true,
35400             "field": "providerName",
35401             "description": ""
35402           },
35403           {
35404             "group": "Body",
35405             "type": "Text",
35406             "optional": true,
35407             "field": "providerResponse",
35408             "description": ""
35409           }
35410         ]
35411       }
35412     },
35413     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35414     "version": "0.0.0",
35415     "filename": "server/api/whatsappInteraction/index.js",
35416     "groupTitle": "Whatsapp_Interactions"
35417   },
35418   {
35419     "type": "get",
35420     "url": "/api/whatsapp/interactions/{id}/download",
35421     "title": "Gets interaction",
35422     "examples": [
35423       {
35424         "title": "Example usage:",
35425         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35426         "type": "json"
35427       }
35428     ],
35429     "name": "download",
35430     "group": "Whatsapp_Interactions",
35431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35432     "version": "0.0.0",
35433     "filename": "server/api/whatsappInteraction/index.js",
35434     "groupTitle": "Whatsapp_Interactions"
35435   },
35436   {
35437     "type": "get",
35438     "url": "/api/whatsapp/interactions/{id}/messages",
35439     "title": "Gets interaction messages",
35440     "examples": [
35441       {
35442         "title": "Example usage:",
35443         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35444         "type": "json"
35445       }
35446     ],
35447     "name": "getMessages",
35448     "group": "Whatsapp_Interactions",
35449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35450     "version": "0.0.0",
35451     "filename": "server/api/whatsappInteraction/index.js",
35452     "groupTitle": "Whatsapp_Interactions"
35453   },
35454   {
35455     "type": "put",
35456     "url": "/api/whatsapp/interactions/{id}",
35457     "title": "Update an existing Interaction",
35458     "examples": [
35459       {
35460         "title": "Example usage:",
35461         "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",
35462         "type": "json"
35463       }
35464     ],
35465     "name": "updateInteractions",
35466     "group": "Whatsapp_Interactions",
35467     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35468     "version": "0.0.0",
35469     "filename": "server/api/whatsappInteraction/index.js",
35470     "groupTitle": "Whatsapp_Interactions"
35471   },
35472   {
35473     "type": "post",
35474     "url": "/api/whatsapp/messages",
35475     "title": "Creates a new Message",
35476     "examples": [
35477       {
35478         "title": "Example usage:",
35479         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35480         "type": "json"
35481       }
35482     ],
35483     "name": "CreateMessages",
35484     "group": "Whatsapp_Messages",
35485     "parameter": {
35486       "fields": {
35487         "Body": [
35488           {
35489             "group": "Body",
35490             "type": "Text",
35491             "optional": false,
35492             "field": "body",
35493             "description": ""
35494           },
35495           {
35496             "group": "Body",
35497             "type": "Boolean",
35498             "optional": true,
35499             "field": "read",
35500             "description": ""
35501           },
35502           {
35503             "group": "Body",
35504             "type": "String",
35505             "allowedValues": [
35506               "\"in\"",
35507               "\"out\""
35508             ],
35509             "optional": false,
35510             "field": "direction",
35511             "description": ""
35512           },
35513           {
35514             "group": "Body",
35515             "type": "String",
35516             "optional": true,
35517             "field": "messageId",
35518             "description": ""
35519           },
35520           {
35521             "group": "Body",
35522             "type": "String",
35523             "optional": true,
35524             "field": "phone",
35525             "description": ""
35526           },
35527           {
35528             "group": "Body",
35529             "type": "String",
35530             "optional": true,
35531             "field": "readAt",
35532             "description": ""
35533           },
35534           {
35535             "group": "Body",
35536             "type": "Boolean",
35537             "optional": true,
35538             "field": "secret",
35539             "description": ""
35540           },
35541           {
35542             "group": "Body",
35543             "type": "String",
35544             "optional": true,
35545             "field": "providerName",
35546             "description": ""
35547           },
35548           {
35549             "group": "Body",
35550             "type": "Text",
35551             "optional": true,
35552             "field": "providerResponse",
35553             "description": ""
35554           }
35555         ]
35556       }
35557     },
35558     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35559     "version": "0.0.0",
35560     "filename": "server/api/whatsappMessage/index.js",
35561     "groupTitle": "Whatsapp_Messages"
35562   },
35563   {
35564     "type": "delete",
35565     "url": "/api/whatsapp/messages/{id}",
35566     "title": "Deletes a Message",
35567     "examples": [
35568       {
35569         "title": "Example usage:",
35570         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35571         "type": "json"
35572       }
35573     ],
35574     "name": "DeleteMessages",
35575     "group": "Whatsapp_Messages",
35576     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35577     "version": "0.0.0",
35578     "filename": "server/api/whatsappMessage/index.js",
35579     "groupTitle": "Whatsapp_Messages"
35580   },
35581   {
35582     "type": "get",
35583     "url": "/api/whatsapp/messages/describe",
35584     "title": "Gets table info about Messages",
35585     "examples": [
35586       {
35587         "title": "Example usage:",
35588         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35589         "type": "json"
35590       }
35591     ],
35592     "name": "DescribeMessages",
35593     "group": "Whatsapp_Messages",
35594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35595     "version": "0.0.0",
35596     "filename": "server/api/whatsappMessage/index.js",
35597     "groupTitle": "Whatsapp_Messages"
35598   },
35599   {
35600     "type": "get",
35601     "url": "/api/whatsapp/messages",
35602     "title": "Gets a list of Messages",
35603     "examples": [
35604       {
35605         "title": "Example usage:",
35606         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35607         "type": "json"
35608       }
35609     ],
35610     "name": "GetMessages",
35611     "group": "Whatsapp_Messages",
35612     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35613     "version": "0.0.0",
35614     "filename": "server/api/whatsappMessage/index.js",
35615     "groupTitle": "Whatsapp_Messages"
35616   },
35617   {
35618     "type": "get",
35619     "url": "/api/whatsapp/messages/{id}",
35620     "title": "Gets a single Message",
35621     "examples": [
35622       {
35623         "title": "Example usage:",
35624         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35625         "type": "json"
35626       }
35627     ],
35628     "name": "ShowMessages",
35629     "group": "Whatsapp_Messages",
35630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35631     "version": "0.0.0",
35632     "filename": "server/api/whatsappMessage/index.js",
35633     "groupTitle": "Whatsapp_Messages"
35634   },
35635   {
35636     "type": "put",
35637     "url": "/api/whatsapp/messages/{id}",
35638     "title": "Update an existing Message",
35639     "examples": [
35640       {
35641         "title": "Example usage:",
35642         "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",
35643         "type": "json"
35644       }
35645     ],
35646     "name": "updateMessages",
35647     "group": "Whatsapp_Messages",
35648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35649     "version": "0.0.0",
35650     "filename": "server/api/whatsappMessage/index.js",
35651     "groupTitle": "Whatsapp_Messages"
35652   },
35653   {
35654     "type": "post",
35655     "url": "/api/whatsapp/reports/queue",
35656     "title": "Creates a new Whatsapp Queue Report",
35657     "examples": [
35658       {
35659         "title": "Example usage:",
35660         "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",
35661         "type": "json"
35662       }
35663     ],
35664     "name": "CreateWhatsapp_Queue_Reports",
35665     "group": "Whatsapp_Queue_Reports",
35666     "parameter": {
35667       "fields": {
35668         "Body": [
35669           {
35670             "group": "Body",
35671             "type": "String",
35672             "optional": false,
35673             "field": "uniqueid",
35674             "description": ""
35675           },
35676           {
35677             "group": "Body",
35678             "type": "String",
35679             "optional": true,
35680             "field": "from",
35681             "description": ""
35682           },
35683           {
35684             "group": "Body",
35685             "type": "String",
35686             "optional": true,
35687             "field": "joinAt",
35688             "description": ""
35689           },
35690           {
35691             "group": "Body",
35692             "type": "String",
35693             "optional": true,
35694             "field": "leaveAt",
35695             "description": ""
35696           },
35697           {
35698             "group": "Body",
35699             "type": "String",
35700             "optional": true,
35701             "field": "acceptAt",
35702             "description": ""
35703           },
35704           {
35705             "group": "Body",
35706             "type": "String",
35707             "optional": true,
35708             "field": "exitAt",
35709             "description": ""
35710           },
35711           {
35712             "group": "Body",
35713             "type": "String",
35714             "optional": true,
35715             "field": "reason",
35716             "description": ""
35717           }
35718         ]
35719       }
35720     },
35721     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35722     "version": "0.0.0",
35723     "filename": "server/api/whatsappQueueReport/index.js",
35724     "groupTitle": "Whatsapp_Queue_Reports"
35725   },
35726   {
35727     "type": "delete",
35728     "url": "/api/whatsapp/reports/queue/{id}",
35729     "title": "Deletes a Whatsapp Queue Report",
35730     "examples": [
35731       {
35732         "title": "Example usage:",
35733         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
35734         "type": "json"
35735       }
35736     ],
35737     "name": "DeleteWhatsapp_Queue_Reports",
35738     "group": "Whatsapp_Queue_Reports",
35739     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35740     "version": "0.0.0",
35741     "filename": "server/api/whatsappQueueReport/index.js",
35742     "groupTitle": "Whatsapp_Queue_Reports"
35743   },
35744   {
35745     "type": "get",
35746     "url": "/api/whatsapp/reports/queue/describe",
35747     "title": "Gets table info about Whatsapp Queue Reports",
35748     "examples": [
35749       {
35750         "title": "Example usage:",
35751         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
35752         "type": "json"
35753       }
35754     ],
35755     "name": "DescribeWhatsapp_Queue_Reports",
35756     "group": "Whatsapp_Queue_Reports",
35757     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35758     "version": "0.0.0",
35759     "filename": "server/api/whatsappQueueReport/index.js",
35760     "groupTitle": "Whatsapp_Queue_Reports"
35761   },
35762   {
35763     "type": "get",
35764     "url": "/api/whatsapp/reports/queue",
35765     "title": "Gets a list of Whatsapp Queue Reports",
35766     "examples": [
35767       {
35768         "title": "Example usage:",
35769         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
35770         "type": "json"
35771       }
35772     ],
35773     "name": "GetWhatsapp_Queue_Reports",
35774     "group": "Whatsapp_Queue_Reports",
35775     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35776     "version": "0.0.0",
35777     "filename": "server/api/whatsappQueueReport/index.js",
35778     "groupTitle": "Whatsapp_Queue_Reports"
35779   },
35780   {
35781     "type": "get",
35782     "url": "/api/whatsapp/reports/queue/{id}",
35783     "title": "Gets a single Whatsapp Queue Report",
35784     "examples": [
35785       {
35786         "title": "Example usage:",
35787         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
35788         "type": "json"
35789       }
35790     ],
35791     "name": "ShowWhatsapp_Queue_Reports",
35792     "group": "Whatsapp_Queue_Reports",
35793     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35794     "version": "0.0.0",
35795     "filename": "server/api/whatsappQueueReport/index.js",
35796     "groupTitle": "Whatsapp_Queue_Reports"
35797   },
35798   {
35799     "type": "put",
35800     "url": "/api/whatsapp/reports/queue/{id}",
35801     "title": "Update an existing Whatsapp Queue Report",
35802     "examples": [
35803       {
35804         "title": "Example usage:",
35805         "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",
35806         "type": "json"
35807       }
35808     ],
35809     "name": "updateWhatsapp_Queue_Reports",
35810     "group": "Whatsapp_Queue_Reports",
35811     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35812     "version": "0.0.0",
35813     "filename": "server/api/whatsappQueueReport/index.js",
35814     "groupTitle": "Whatsapp_Queue_Reports"
35815   },
35816   {
35817     "type": "post",
35818     "url": "/api/whatsapp/queues/{id}/users",
35819     "title": "Add agents to a queue",
35820     "examples": [
35821       {
35822         "title": "Example usage:",
35823         "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",
35824         "type": "json"
35825       }
35826     ],
35827     "name": "AddAgents",
35828     "group": "Whatsapp_Queues",
35829     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35830     "version": "0.0.0",
35831     "filename": "server/api/whatsappQueue/index.js",
35832     "groupTitle": "Whatsapp_Queues"
35833   },
35834   {
35835     "type": "post",
35836     "url": "/api/whatsapp/queues/{id}/teams",
35837     "title": "Add teams to a queue",
35838     "examples": [
35839       {
35840         "title": "Example usage:",
35841         "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",
35842         "type": "json"
35843       }
35844     ],
35845     "name": "AddTeams",
35846     "group": "Whatsapp_Queues",
35847     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35848     "version": "0.0.0",
35849     "filename": "server/api/whatsappQueue/index.js",
35850     "groupTitle": "Whatsapp_Queues"
35851   },
35852   {
35853     "type": "post",
35854     "url": "/api/whatsapp/queues",
35855     "title": "Creates a new Queue",
35856     "examples": [
35857       {
35858         "title": "Example usage:",
35859         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35860         "type": "json"
35861       }
35862     ],
35863     "name": "CreateQueues",
35864     "group": "Whatsapp_Queues",
35865     "parameter": {
35866       "fields": {
35867         "Body": [
35868           {
35869             "group": "Body",
35870             "type": "String",
35871             "optional": true,
35872             "field": "name",
35873             "description": ""
35874           },
35875           {
35876             "group": "Body",
35877             "type": "Integer",
35878             "optional": true,
35879             "field": "timeout",
35880             "description": ""
35881           },
35882           {
35883             "group": "Body",
35884             "type": "String",
35885             "allowedValues": [
35886               "\"rrmemory\"",
35887               "\"beepall\"",
35888               "\"roundrobin\""
35889             ],
35890             "optional": true,
35891             "field": "strategy",
35892             "description": ""
35893           },
35894           {
35895             "group": "Body",
35896             "type": "String",
35897             "optional": true,
35898             "field": "description",
35899             "description": ""
35900           }
35901         ]
35902       }
35903     },
35904     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35905     "version": "0.0.0",
35906     "filename": "server/api/whatsappQueue/index.js",
35907     "groupTitle": "Whatsapp_Queues"
35908   },
35909   {
35910     "type": "delete",
35911     "url": "/api/whatsapp/queues/{id}",
35912     "title": "Deletes a Queue",
35913     "examples": [
35914       {
35915         "title": "Example usage:",
35916         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
35917         "type": "json"
35918       }
35919     ],
35920     "name": "DeleteQueues",
35921     "group": "Whatsapp_Queues",
35922     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35923     "version": "0.0.0",
35924     "filename": "server/api/whatsappQueue/index.js",
35925     "groupTitle": "Whatsapp_Queues"
35926   },
35927   {
35928     "type": "get",
35929     "url": "/api/whatsapp/queues/describe",
35930     "title": "Gets table info about Queues",
35931     "examples": [
35932       {
35933         "title": "Example usage:",
35934         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
35935         "type": "json"
35936       }
35937     ],
35938     "name": "DescribeQueues",
35939     "group": "Whatsapp_Queues",
35940     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35941     "version": "0.0.0",
35942     "filename": "server/api/whatsappQueue/index.js",
35943     "groupTitle": "Whatsapp_Queues"
35944   },
35945   {
35946     "type": "get",
35947     "url": "/api/whatsapp/queues/{id}/users",
35948     "title": "Gets queue agents",
35949     "examples": [
35950       {
35951         "title": "Example usage:",
35952         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
35953         "type": "json"
35954       }
35955     ],
35956     "name": "GetAgents",
35957     "group": "Whatsapp_Queues",
35958     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35959     "version": "0.0.0",
35960     "filename": "server/api/whatsappQueue/index.js",
35961     "groupTitle": "Whatsapp_Queues"
35962   },
35963   {
35964     "type": "get",
35965     "url": "/api/whatsapp/queues/{id}/members",
35966     "title": "GetMembers",
35967     "examples": [
35968       {
35969         "title": "Example usage:",
35970         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
35971         "type": "json"
35972       }
35973     ],
35974     "name": "GetMembers",
35975     "group": "Whatsapp_Queues",
35976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35977     "version": "0.0.0",
35978     "filename": "server/api/whatsappQueue/index.js",
35979     "groupTitle": "Whatsapp_Queues"
35980   },
35981   {
35982     "type": "get",
35983     "url": "/api/whatsapp/queues",
35984     "title": "Gets a list of Queues",
35985     "examples": [
35986       {
35987         "title": "Example usage:",
35988         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
35989         "type": "json"
35990       }
35991     ],
35992     "name": "GetQueues",
35993     "group": "Whatsapp_Queues",
35994     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35995     "version": "0.0.0",
35996     "filename": "server/api/whatsappQueue/index.js",
35997     "groupTitle": "Whatsapp_Queues"
35998   },
35999   {
36000     "type": "get",
36001     "url": "/api/whatsapp/queues/{id}/teams",
36002     "title": "Gets queues list",
36003     "examples": [
36004       {
36005         "title": "Example usage:",
36006         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36007         "type": "json"
36008       }
36009     ],
36010     "name": "GetTeams",
36011     "group": "Whatsapp_Queues",
36012     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36013     "version": "0.0.0",
36014     "filename": "server/api/whatsappQueue/index.js",
36015     "groupTitle": "Whatsapp_Queues"
36016   },
36017   {
36018     "type": "delete",
36019     "url": "/api/whatsapp/queues/{id}/users",
36020     "title": "Removes agents from a queue",
36021     "examples": [
36022       {
36023         "title": "Example usage:",
36024         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36025         "type": "json"
36026       }
36027     ],
36028     "name": "RemoveAgents",
36029     "group": "Whatsapp_Queues",
36030     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36031     "version": "0.0.0",
36032     "filename": "server/api/whatsappQueue/index.js",
36033     "groupTitle": "Whatsapp_Queues"
36034   },
36035   {
36036     "type": "get",
36037     "url": "/api/whatsapp/queues/{id}",
36038     "title": "Gets a single Queue",
36039     "examples": [
36040       {
36041         "title": "Example usage:",
36042         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36043         "type": "json"
36044       }
36045     ],
36046     "name": "ShowQueues",
36047     "group": "Whatsapp_Queues",
36048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36049     "version": "0.0.0",
36050     "filename": "server/api/whatsappQueue/index.js",
36051     "groupTitle": "Whatsapp_Queues"
36052   },
36053   {
36054     "type": "put",
36055     "url": "/api/whatsapp/queues/{id}",
36056     "title": "Update an existing Queue",
36057     "examples": [
36058       {
36059         "title": "Example usage:",
36060         "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",
36061         "type": "json"
36062       }
36063     ],
36064     "name": "updateQueues",
36065     "group": "Whatsapp_Queues",
36066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36067     "version": "0.0.0",
36068     "filename": "server/api/whatsappQueue/index.js",
36069     "groupTitle": "Whatsapp_Queues"
36070   },
36071   {
36072     "type": "post",
36073     "url": "/api/whatsapp/reports/transfer",
36074     "title": "Creates a new Whatsapp Transfer Report",
36075     "examples": [
36076       {
36077         "title": "Example usage:",
36078         "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",
36079         "type": "json"
36080       }
36081     ],
36082     "name": "CreateWhatsapp_Transfer_Reports",
36083     "group": "Whatsapp_Transfer_Reports",
36084     "parameter": {
36085       "fields": {
36086         "Body": [
36087           {
36088             "group": "Body",
36089             "type": "String",
36090             "optional": false,
36091             "field": "uniqueid",
36092             "description": ""
36093           },
36094           {
36095             "group": "Body",
36096             "type": "String",
36097             "allowedValues": [
36098               "\"account\"",
36099               "\"agent\"",
36100               "\"queue\""
36101             ],
36102             "optional": false,
36103             "field": "type",
36104             "description": ""
36105           },
36106           {
36107             "group": "Body",
36108             "type": "String",
36109             "optional": true,
36110             "field": "transferredAt",
36111             "description": ""
36112           }
36113         ]
36114       }
36115     },
36116     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36117     "version": "0.0.0",
36118     "filename": "server/api/whatsappTransferReport/index.js",
36119     "groupTitle": "Whatsapp_Transfer_Reports"
36120   },
36121   {
36122     "type": "delete",
36123     "url": "/api/whatsapp/reports/transfer/{id}",
36124     "title": "Deletes a Whatsapp Transfer Report",
36125     "examples": [
36126       {
36127         "title": "Example usage:",
36128         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36129         "type": "json"
36130       }
36131     ],
36132     "name": "DeleteWhatsapp_Transfer_Reports",
36133     "group": "Whatsapp_Transfer_Reports",
36134     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36135     "version": "0.0.0",
36136     "filename": "server/api/whatsappTransferReport/index.js",
36137     "groupTitle": "Whatsapp_Transfer_Reports"
36138   },
36139   {
36140     "type": "get",
36141     "url": "/api/whatsapp/reports/transfer/describe",
36142     "title": "Gets table info about Whatsapp Transfer Reports",
36143     "examples": [
36144       {
36145         "title": "Example usage:",
36146         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36147         "type": "json"
36148       }
36149     ],
36150     "name": "DescribeWhatsapp_Transfer_Reports",
36151     "group": "Whatsapp_Transfer_Reports",
36152     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36153     "version": "0.0.0",
36154     "filename": "server/api/whatsappTransferReport/index.js",
36155     "groupTitle": "Whatsapp_Transfer_Reports"
36156   },
36157   {
36158     "type": "get",
36159     "url": "/api/whatsapp/reports/transfer",
36160     "title": "Gets a list of Whatsapp Transfer Reports",
36161     "examples": [
36162       {
36163         "title": "Example usage:",
36164         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36165         "type": "json"
36166       }
36167     ],
36168     "name": "GetWhatsapp_Transfer_Reports",
36169     "group": "Whatsapp_Transfer_Reports",
36170     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36171     "version": "0.0.0",
36172     "filename": "server/api/whatsappTransferReport/index.js",
36173     "groupTitle": "Whatsapp_Transfer_Reports"
36174   },
36175   {
36176     "type": "get",
36177     "url": "/api/whatsapp/reports/transfer/{id}",
36178     "title": "Gets a single Whatsapp Transfer Report",
36179     "examples": [
36180       {
36181         "title": "Example usage:",
36182         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36183         "type": "json"
36184       }
36185     ],
36186     "name": "ShowWhatsapp_Transfer_Reports",
36187     "group": "Whatsapp_Transfer_Reports",
36188     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36189     "version": "0.0.0",
36190     "filename": "server/api/whatsappTransferReport/index.js",
36191     "groupTitle": "Whatsapp_Transfer_Reports"
36192   },
36193   {
36194     "type": "put",
36195     "url": "/api/whatsapp/reports/transfer/{id}",
36196     "title": "Update an existing Whatsapp Transfer Report",
36197     "examples": [
36198       {
36199         "title": "Example usage:",
36200         "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",
36201         "type": "json"
36202       }
36203     ],
36204     "name": "updateWhatsapp_Transfer_Reports",
36205     "group": "Whatsapp_Transfer_Reports",
36206     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36207     "version": "0.0.0",
36208     "filename": "server/api/whatsappTransferReport/index.js",
36209     "groupTitle": "Whatsapp_Transfer_Reports"
36210   },
36211   {
36212     "type": "post",
36213     "url": "/api/integrations/zendesk/accounts",
36214     "title": "Creates a new Zendesk Account",
36215     "examples": [
36216       {
36217         "title": "Example usage:",
36218         "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",
36219         "type": "json"
36220       }
36221     ],
36222     "name": "CreateZendesk_Accounts",
36223     "group": "Zendesk_Accounts",
36224     "parameter": {
36225       "fields": {
36226         "Body": [
36227           {
36228             "group": "Body",
36229             "type": "String",
36230             "optional": true,
36231             "field": "name",
36232             "description": ""
36233           },
36234           {
36235             "group": "Body",
36236             "type": "String",
36237             "optional": true,
36238             "field": "description",
36239             "description": ""
36240           },
36241           {
36242             "group": "Body",
36243             "type": "String",
36244             "optional": true,
36245             "field": "username",
36246             "description": ""
36247           },
36248           {
36249             "group": "Body",
36250             "type": "String",
36251             "optional": true,
36252             "field": "password",
36253             "description": ""
36254           },
36255           {
36256             "group": "Body",
36257             "type": "String",
36258             "optional": true,
36259             "field": "token",
36260             "description": ""
36261           },
36262           {
36263             "group": "Body",
36264             "type": "String",
36265             "optional": true,
36266             "field": "remoteUri",
36267             "description": ""
36268           },
36269           {
36270             "group": "Body",
36271             "type": "String",
36272             "allowedValues": [
36273               "\"password\"",
36274               "\"token\""
36275             ],
36276             "optional": true,
36277             "field": "authType",
36278             "description": ""
36279           },
36280           {
36281             "group": "Body",
36282             "type": "String",
36283             "optional": false,
36284             "field": "serverUrl",
36285             "description": ""
36286           },
36287           {
36288             "group": "Body",
36289             "type": "String",
36290             "allowedValues": [
36291               "\"integrationTab\"",
36292               "\"newTab\""
36293             ],
36294             "optional": true,
36295             "field": "type",
36296             "description": ""
36297           }
36298         ]
36299       }
36300     },
36301     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36302     "version": "0.0.0",
36303     "filename": "server/api/intZendeskAccount/index.js",
36304     "groupTitle": "Zendesk_Accounts"
36305   },
36306   {
36307     "type": "delete",
36308     "url": "/api/integrations/zendesk/accounts/{id}",
36309     "title": "Deletes a Zendesk Account",
36310     "examples": [
36311       {
36312         "title": "Example usage:",
36313         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36314         "type": "json"
36315       }
36316     ],
36317     "name": "DeleteZendesk_Accounts",
36318     "group": "Zendesk_Accounts",
36319     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36320     "version": "0.0.0",
36321     "filename": "server/api/intZendeskAccount/index.js",
36322     "groupTitle": "Zendesk_Accounts"
36323   },
36324   {
36325     "type": "get",
36326     "url": "/api/integrations/zendesk/accounts",
36327     "title": "Gets a list of Zendesk Accounts",
36328     "examples": [
36329       {
36330         "title": "Example usage:",
36331         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36332         "type": "json"
36333       }
36334     ],
36335     "name": "GetZendesk_Accounts",
36336     "group": "Zendesk_Accounts",
36337     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36338     "version": "0.0.0",
36339     "filename": "server/api/intZendeskAccount/index.js",
36340     "groupTitle": "Zendesk_Accounts"
36341   },
36342   {
36343     "type": "get",
36344     "url": "/api/integrations/zendesk/accounts/{id}",
36345     "title": "Gets a single Zendesk Account",
36346     "examples": [
36347       {
36348         "title": "Example usage:",
36349         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36350         "type": "json"
36351       }
36352     ],
36353     "name": "ShowZendesk_Accounts",
36354     "group": "Zendesk_Accounts",
36355     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36356     "version": "0.0.0",
36357     "filename": "server/api/intZendeskAccount/index.js",
36358     "groupTitle": "Zendesk_Accounts"
36359   },
36360   {
36361     "type": "post",
36362     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36363     "title": "Creates new configuration",
36364     "examples": [
36365       {
36366         "title": "Example usage:",
36367         "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",
36368         "type": "json"
36369       }
36370     ],
36371     "name": "addConfiguration",
36372     "group": "Zendesk_Accounts",
36373     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36374     "version": "0.0.0",
36375     "filename": "server/api/intZendeskAccount/index.js",
36376     "groupTitle": "Zendesk_Accounts"
36377   },
36378   {
36379     "type": "get",
36380     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36381     "title": "Gets account configurations",
36382     "examples": [
36383       {
36384         "title": "Example usage:",
36385         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36386         "type": "json"
36387       }
36388     ],
36389     "name": "getConfigurations",
36390     "group": "Zendesk_Accounts",
36391     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36392     "version": "0.0.0",
36393     "filename": "server/api/intZendeskAccount/index.js",
36394     "groupTitle": "Zendesk_Accounts"
36395   },
36396   {
36397     "type": "get",
36398     "url": "/api/integrations/zendesk/accounts/{id}/fields",
36399     "title": "Gets account fields",
36400     "examples": [
36401       {
36402         "title": "Example usage:",
36403         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36404         "type": "json"
36405       }
36406     ],
36407     "name": "getFields",
36408     "group": "Zendesk_Accounts",
36409     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36410     "version": "0.0.0",
36411     "filename": "server/api/intZendeskAccount/index.js",
36412     "groupTitle": "Zendesk_Accounts"
36413   },
36414   {
36415     "type": "put",
36416     "url": "/api/integrations/zendesk/accounts/{id}",
36417     "title": "Update an existing Zendesk Account",
36418     "examples": [
36419       {
36420         "title": "Example usage:",
36421         "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",
36422         "type": "json"
36423       }
36424     ],
36425     "name": "updateZendesk_Accounts",
36426     "group": "Zendesk_Accounts",
36427     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36428     "version": "0.0.0",
36429     "filename": "server/api/intZendeskAccount/index.js",
36430     "groupTitle": "Zendesk_Accounts"
36431   },
36432   {
36433     "type": "post",
36434     "url": "/api/integrations/zendesk/configurations",
36435     "title": "Creates a new Zendesk Configuration",
36436     "examples": [
36437       {
36438         "title": "Example usage:",
36439         "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",
36440         "type": "json"
36441       }
36442     ],
36443     "name": "CreateZendesk_Configurations",
36444     "group": "Zendesk_Configurations",
36445     "parameter": {
36446       "fields": {
36447         "Body": [
36448           {
36449             "group": "Body",
36450             "type": "String",
36451             "optional": true,
36452             "field": "name",
36453             "description": ""
36454           },
36455           {
36456             "group": "Body",
36457             "type": "String",
36458             "optional": true,
36459             "field": "description",
36460             "description": ""
36461           }
36462         ]
36463       }
36464     },
36465     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36466     "version": "0.0.0",
36467     "filename": "server/api/intZendeskConfiguration/index.js",
36468     "groupTitle": "Zendesk_Configurations"
36469   },
36470   {
36471     "type": "delete",
36472     "url": "/api/integrations/zendesk/configurations/{id}",
36473     "title": "Deletes a Zendesk Configuration",
36474     "examples": [
36475       {
36476         "title": "Example usage:",
36477         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36478         "type": "json"
36479       }
36480     ],
36481     "name": "DeleteZendesk_Configurations",
36482     "group": "Zendesk_Configurations",
36483     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36484     "version": "0.0.0",
36485     "filename": "server/api/intZendeskConfiguration/index.js",
36486     "groupTitle": "Zendesk_Configurations"
36487   },
36488   {
36489     "type": "get",
36490     "url": "/api/integrations/zendesk/configurations",
36491     "title": "Gets a list of Zendesk Configurations",
36492     "examples": [
36493       {
36494         "title": "Example usage:",
36495         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36496         "type": "json"
36497       }
36498     ],
36499     "name": "GetZendesk_Configurations",
36500     "group": "Zendesk_Configurations",
36501     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36502     "version": "0.0.0",
36503     "filename": "server/api/intZendeskConfiguration/index.js",
36504     "groupTitle": "Zendesk_Configurations"
36505   },
36506   {
36507     "type": "get",
36508     "url": "/api/integrations/zendesk/configurations/{id}",
36509     "title": "Gets a single Zendesk Configuration",
36510     "examples": [
36511       {
36512         "title": "Example usage:",
36513         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36514         "type": "json"
36515       }
36516     ],
36517     "name": "ShowZendesk_Configurations",
36518     "group": "Zendesk_Configurations",
36519     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36520     "version": "0.0.0",
36521     "filename": "server/api/intZendeskConfiguration/index.js",
36522     "groupTitle": "Zendesk_Configurations"
36523   },
36524   {
36525     "type": "get",
36526     "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36527     "title": "Gets configurations descriptions",
36528     "examples": [
36529       {
36530         "title": "Example usage:",
36531         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36532         "type": "json"
36533       }
36534     ],
36535     "name": "getDescriptions",
36536     "group": "Zendesk_Configurations",
36537     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36538     "version": "0.0.0",
36539     "filename": "server/api/intZendeskConfiguration/index.js",
36540     "groupTitle": "Zendesk_Configurations"
36541   },
36542   {
36543     "type": "get",
36544     "url": "/api/integrations/zendesk/configurations/{id}/fields",
36545     "title": "Gets configurations fields",
36546     "examples": [
36547       {
36548         "title": "Example usage:",
36549         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36550         "type": "json"
36551       }
36552     ],
36553     "name": "getFields",
36554     "group": "Zendesk_Configurations",
36555     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36556     "version": "0.0.0",
36557     "filename": "server/api/intZendeskConfiguration/index.js",
36558     "groupTitle": "Zendesk_Configurations"
36559   },
36560   {
36561     "type": "get",
36562     "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36563     "title": "Gets configurations subjects",
36564     "examples": [
36565       {
36566         "title": "Example usage:",
36567         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36568         "type": "json"
36569       }
36570     ],
36571     "name": "getSubjects",
36572     "group": "Zendesk_Configurations",
36573     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36574     "version": "0.0.0",
36575     "filename": "server/api/intZendeskConfiguration/index.js",
36576     "groupTitle": "Zendesk_Configurations"
36577   },
36578   {
36579     "type": "get",
36580     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36581     "title": "Gets configurations tags",
36582     "examples": [
36583       {
36584         "title": "Example usage:",
36585         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36586         "type": "json"
36587       }
36588     ],
36589     "name": "getTags",
36590     "group": "Zendesk_Configurations",
36591     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36592     "version": "0.0.0",
36593     "filename": "server/api/intZendeskConfiguration/index.js",
36594     "groupTitle": "Zendesk_Configurations"
36595   },
36596   {
36597     "type": "post",
36598     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36599     "title": "Sets new tags",
36600     "examples": [
36601       {
36602         "title": "Example usage:",
36603         "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",
36604         "type": "json"
36605       }
36606     ],
36607     "name": "setTags",
36608     "group": "Zendesk_Configurations",
36609     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36610     "version": "0.0.0",
36611     "filename": "server/api/intZendeskConfiguration/index.js",
36612     "groupTitle": "Zendesk_Configurations"
36613   },
36614   {
36615     "type": "put",
36616     "url": "/api/integrations/zendesk/configurations/{id}",
36617     "title": "Update an existing Zendesk Configuration",
36618     "examples": [
36619       {
36620         "title": "Example usage:",
36621         "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",
36622         "type": "json"
36623       }
36624     ],
36625     "name": "updateZendesk_Configurations",
36626     "group": "Zendesk_Configurations",
36627     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36628     "version": "0.0.0",
36629     "filename": "server/api/intZendeskConfiguration/index.js",
36630     "groupTitle": "Zendesk_Configurations"
36631   },
36632   {
36633     "type": "post",
36634     "url": "/api/integrations/zendesk/fields",
36635     "title": "Creates a new Zendesk Field",
36636     "examples": [
36637       {
36638         "title": "Example usage:",
36639         "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",
36640         "type": "json"
36641       }
36642     ],
36643     "name": "CreateZendesk_Fields",
36644     "group": "Zendesk_Fields",
36645     "parameter": {
36646       "fields": {
36647         "Body": [
36648           {
36649             "group": "Body",
36650             "type": "String",
36651             "allowedValues": [
36652               "\"string\"",
36653               "\"variable\"",
36654               "\"customVariable\"",
36655               "\"keyValue\"",
36656               "\"picklist\""
36657             ],
36658             "optional": true,
36659             "field": "type",
36660             "description": ""
36661           },
36662           {
36663             "group": "Body",
36664             "type": "String",
36665             "optional": true,
36666             "field": "content",
36667             "description": ""
36668           },
36669           {
36670             "group": "Body",
36671             "type": "String",
36672             "optional": true,
36673             "field": "key",
36674             "description": ""
36675           },
36676           {
36677             "group": "Body",
36678             "type": "String",
36679             "allowedValues": [
36680               "\"string\"",
36681               "\"variable\"",
36682               "\"customVariable\""
36683             ],
36684             "optional": true,
36685             "field": "keyType",
36686             "description": ""
36687           },
36688           {
36689             "group": "Body",
36690             "type": "String",
36691             "optional": true,
36692             "field": "keyContent",
36693             "description": ""
36694           },
36695           {
36696             "group": "Body",
36697             "type": "String",
36698             "optional": true,
36699             "field": "idField",
36700             "description": ""
36701           },
36702           {
36703             "group": "Body",
36704             "type": "String",
36705             "optional": true,
36706             "field": "nameField",
36707             "description": ""
36708           },
36709           {
36710             "group": "Body",
36711             "type": "Boolean",
36712             "optional": true,
36713             "field": "customField",
36714             "description": ""
36715           },
36716           {
36717             "group": "Body",
36718             "type": "String",
36719             "optional": true,
36720             "field": "variableName",
36721             "description": ""
36722           }
36723         ]
36724       }
36725     },
36726     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36727     "version": "0.0.0",
36728     "filename": "server/api/intZendeskField/index.js",
36729     "groupTitle": "Zendesk_Fields"
36730   },
36731   {
36732     "type": "delete",
36733     "url": "/api/integrations/zendesk/fields/{id}",
36734     "title": "Deletes a Zendesk Field",
36735     "examples": [
36736       {
36737         "title": "Example usage:",
36738         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
36739         "type": "json"
36740       }
36741     ],
36742     "name": "DeleteZendesk_Fields",
36743     "group": "Zendesk_Fields",
36744     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36745     "version": "0.0.0",
36746     "filename": "server/api/intZendeskField/index.js",
36747     "groupTitle": "Zendesk_Fields"
36748   },
36749   {
36750     "type": "get",
36751     "url": "/api/integrations/zendesk/fields",
36752     "title": "Gets a list of Zendesk Fields",
36753     "examples": [
36754       {
36755         "title": "Example usage:",
36756         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
36757         "type": "json"
36758       }
36759     ],
36760     "name": "GetZendesk_Fields",
36761     "group": "Zendesk_Fields",
36762     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36763     "version": "0.0.0",
36764     "filename": "server/api/intZendeskField/index.js",
36765     "groupTitle": "Zendesk_Fields"
36766   },
36767   {
36768     "type": "get",
36769     "url": "/api/integrations/zendesk/fields/{id}",
36770     "title": "Gets a single Zendesk Field",
36771     "examples": [
36772       {
36773         "title": "Example usage:",
36774         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
36775         "type": "json"
36776       }
36777     ],
36778     "name": "ShowZendesk_Fields",
36779     "group": "Zendesk_Fields",
36780     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36781     "version": "0.0.0",
36782     "filename": "server/api/intZendeskField/index.js",
36783     "groupTitle": "Zendesk_Fields"
36784   },
36785   {
36786     "type": "put",
36787     "url": "/api/integrations/zendesk/fields/{id}",
36788     "title": "Update an existing Zendesk Field",
36789     "examples": [
36790       {
36791         "title": "Example usage:",
36792         "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",
36793         "type": "json"
36794       }
36795     ],
36796     "name": "updateZendesk_Fields",
36797     "group": "Zendesk_Fields",
36798     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36799     "version": "0.0.0",
36800     "filename": "server/api/intZendeskField/index.js",
36801     "groupTitle": "Zendesk_Fields"
36802   },
36803   {
36804     "type": "post",
36805     "url": "/api/integrations/zoho/accounts",
36806     "title": "Creates a new Zoho Account",
36807     "examples": [
36808       {
36809         "title": "Example usage:",
36810         "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",
36811         "type": "json"
36812       }
36813     ],
36814     "name": "CreateZoho_Accounts",
36815     "group": "Zoho_Accounts",
36816     "parameter": {
36817       "fields": {
36818         "Body": [
36819           {
36820             "group": "Body",
36821             "type": "String",
36822             "optional": true,
36823             "field": "name",
36824             "description": ""
36825           },
36826           {
36827             "group": "Body",
36828             "type": "String",
36829             "optional": true,
36830             "field": "description",
36831             "description": ""
36832           },
36833           {
36834             "group": "Body",
36835             "type": "String",
36836             "optional": true,
36837             "field": "host",
36838             "description": ""
36839           },
36840           {
36841             "group": "Body",
36842             "type": "String",
36843             "optional": true,
36844             "field": "zone",
36845             "description": ""
36846           },
36847           {
36848             "group": "Body",
36849             "type": "String",
36850             "optional": true,
36851             "field": "clientId",
36852             "description": ""
36853           },
36854           {
36855             "group": "Body",
36856             "type": "String",
36857             "optional": true,
36858             "field": "clientSecret",
36859             "description": ""
36860           },
36861           {
36862             "group": "Body",
36863             "type": "String",
36864             "optional": false,
36865             "field": "serverUrl",
36866             "description": ""
36867           },
36868           {
36869             "group": "Body",
36870             "type": "String",
36871             "optional": true,
36872             "field": "code",
36873             "description": ""
36874           },
36875           {
36876             "group": "Body",
36877             "type": "String",
36878             "optional": true,
36879             "field": "refreshToken",
36880             "description": ""
36881           }
36882         ]
36883       }
36884     },
36885     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36886     "version": "0.0.0",
36887     "filename": "server/api/intZohoAccount/index.js",
36888     "groupTitle": "Zoho_Accounts"
36889   },
36890   {
36891     "type": "delete",
36892     "url": "/api/integrations/zoho/accounts/{id}",
36893     "title": "Deletes a Zoho Account",
36894     "examples": [
36895       {
36896         "title": "Example usage:",
36897         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
36898         "type": "json"
36899       }
36900     ],
36901     "name": "DeleteZoho_Accounts",
36902     "group": "Zoho_Accounts",
36903     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36904     "version": "0.0.0",
36905     "filename": "server/api/intZohoAccount/index.js",
36906     "groupTitle": "Zoho_Accounts"
36907   },
36908   {
36909     "type": "get",
36910     "url": "/api/integrations/zoho/accounts",
36911     "title": "Gets a list of Zoho Accounts",
36912     "examples": [
36913       {
36914         "title": "Example usage:",
36915         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
36916         "type": "json"
36917       }
36918     ],
36919     "name": "GetZoho_Accounts",
36920     "group": "Zoho_Accounts",
36921     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36922     "version": "0.0.0",
36923     "filename": "server/api/intZohoAccount/index.js",
36924     "groupTitle": "Zoho_Accounts"
36925   },
36926   {
36927     "type": "get",
36928     "url": "/api/integrations/zoho/accounts/{id}",
36929     "title": "Gets a single Zoho Account",
36930     "examples": [
36931       {
36932         "title": "Example usage:",
36933         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
36934         "type": "json"
36935       }
36936     ],
36937     "name": "ShowZoho_Accounts",
36938     "group": "Zoho_Accounts",
36939     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36940     "version": "0.0.0",
36941     "filename": "server/api/intZohoAccount/index.js",
36942     "groupTitle": "Zoho_Accounts"
36943   },
36944   {
36945     "type": "post",
36946     "url": "/api/integrations/zoho/accounts/{id}/configurations",
36947     "title": "Creates new configuration",
36948     "examples": [
36949       {
36950         "title": "Example usage:",
36951         "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",
36952         "type": "json"
36953       }
36954     ],
36955     "name": "addConfiguration",
36956     "group": "Zoho_Accounts",
36957     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36958     "version": "0.0.0",
36959     "filename": "server/api/intZohoAccount/index.js",
36960     "groupTitle": "Zoho_Accounts"
36961   },
36962   {
36963     "type": "get",
36964     "url": "/api/integrations/zoho/accounts/{id}/configurations",
36965     "title": "Gets account configurations",
36966     "examples": [
36967       {
36968         "title": "Example usage:",
36969         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36970         "type": "json"
36971       }
36972     ],
36973     "name": "getConfigurations",
36974     "group": "Zoho_Accounts",
36975     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36976     "version": "0.0.0",
36977     "filename": "server/api/intZohoAccount/index.js",
36978     "groupTitle": "Zoho_Accounts"
36979   },
36980   {
36981     "type": "get",
36982     "url": "/api/integrations/zoho/accounts/{id}/fields",
36983     "title": "Gets account fields",
36984     "examples": [
36985       {
36986         "title": "Example usage:",
36987         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
36988         "type": "json"
36989       }
36990     ],
36991     "name": "getFields",
36992     "group": "Zoho_Accounts",
36993     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36994     "version": "0.0.0",
36995     "filename": "server/api/intZohoAccount/index.js",
36996     "groupTitle": "Zoho_Accounts"
36997   },
36998   {
36999     "type": "put",
37000     "url": "/api/integrations/zoho/accounts/{id}",
37001     "title": "Update an existing Zoho Account",
37002     "examples": [
37003       {
37004         "title": "Example usage:",
37005         "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",
37006         "type": "json"
37007       }
37008     ],
37009     "name": "updateZoho_Accounts",
37010     "group": "Zoho_Accounts",
37011     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37012     "version": "0.0.0",
37013     "filename": "server/api/intZohoAccount/index.js",
37014     "groupTitle": "Zoho_Accounts"
37015   },
37016   {
37017     "type": "post",
37018     "url": "/api/integrations/zoho/configurations",
37019     "title": "Creates a new Zoho Configuration",
37020     "examples": [
37021       {
37022         "title": "Example usage:",
37023         "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",
37024         "type": "json"
37025       }
37026     ],
37027     "name": "CreateZoho_Configurations",
37028     "group": "Zoho_Configurations",
37029     "parameter": {
37030       "fields": {
37031         "Body": [
37032           {
37033             "group": "Body",
37034             "type": "String",
37035             "optional": true,
37036             "field": "name",
37037             "description": ""
37038           },
37039           {
37040             "group": "Body",
37041             "type": "String",
37042             "allowedValues": [
37043               "\"lead\"",
37044               "\"contact\"",
37045               "\"nothing\""
37046             ],
37047             "optional": true,
37048             "field": "moduleCreate",
37049             "description": ""
37050           },
37051           {
37052             "group": "Body",
37053             "type": "String",
37054             "allowedValues": [
37055               "\"contact_lead\"",
37056               "\"contact\"",
37057               "\"lead\""
37058             ],
37059             "optional": true,
37060             "field": "moduleSearch",
37061             "description": ""
37062           },
37063           {
37064             "group": "Body",
37065             "type": "String",
37066             "optional": true,
37067             "field": "description",
37068             "description": ""
37069           }
37070         ]
37071       }
37072     },
37073     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37074     "version": "0.0.0",
37075     "filename": "server/api/intZohoConfiguration/index.js",
37076     "groupTitle": "Zoho_Configurations"
37077   },
37078   {
37079     "type": "delete",
37080     "url": "/api/integrations/zoho/configurations/{id}",
37081     "title": "Deletes a Zoho Configuration",
37082     "examples": [
37083       {
37084         "title": "Example usage:",
37085         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37086         "type": "json"
37087       }
37088     ],
37089     "name": "DeleteZoho_Configurations",
37090     "group": "Zoho_Configurations",
37091     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37092     "version": "0.0.0",
37093     "filename": "server/api/intZohoConfiguration/index.js",
37094     "groupTitle": "Zoho_Configurations"
37095   },
37096   {
37097     "type": "get",
37098     "url": "/api/integrations/zoho/configurations",
37099     "title": "Gets a list of Zoho Configurations",
37100     "examples": [
37101       {
37102         "title": "Example usage:",
37103         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37104         "type": "json"
37105       }
37106     ],
37107     "name": "GetZoho_Configurations",
37108     "group": "Zoho_Configurations",
37109     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37110     "version": "0.0.0",
37111     "filename": "server/api/intZohoConfiguration/index.js",
37112     "groupTitle": "Zoho_Configurations"
37113   },
37114   {
37115     "type": "get",
37116     "url": "/api/integrations/zoho/configurations/{id}",
37117     "title": "Gets a single Zoho Configuration",
37118     "examples": [
37119       {
37120         "title": "Example usage:",
37121         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37122         "type": "json"
37123       }
37124     ],
37125     "name": "ShowZoho_Configurations",
37126     "group": "Zoho_Configurations",
37127     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37128     "version": "0.0.0",
37129     "filename": "server/api/intZohoConfiguration/index.js",
37130     "groupTitle": "Zoho_Configurations"
37131   },
37132   {
37133     "type": "get",
37134     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37135     "title": "Gets configurations descriptions",
37136     "examples": [
37137       {
37138         "title": "Example usage:",
37139         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37140         "type": "json"
37141       }
37142     ],
37143     "name": "getDescriptions",
37144     "group": "Zoho_Configurations",
37145     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37146     "version": "0.0.0",
37147     "filename": "server/api/intZohoConfiguration/index.js",
37148     "groupTitle": "Zoho_Configurations"
37149   },
37150   {
37151     "type": "get",
37152     "url": "/api/integrations/zoho/configurations/{id}/fields",
37153     "title": "Gets configurations fields",
37154     "examples": [
37155       {
37156         "title": "Example usage:",
37157         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37158         "type": "json"
37159       }
37160     ],
37161     "name": "getFields",
37162     "group": "Zoho_Configurations",
37163     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37164     "version": "0.0.0",
37165     "filename": "server/api/intZohoConfiguration/index.js",
37166     "groupTitle": "Zoho_Configurations"
37167   },
37168   {
37169     "type": "get",
37170     "url": "/api/integrations/zoho/configurations/{id}/subjects",
37171     "title": "Gets configurations subjects",
37172     "examples": [
37173       {
37174         "title": "Example usage:",
37175         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37176         "type": "json"
37177       }
37178     ],
37179     "name": "getSubjects",
37180     "group": "Zoho_Configurations",
37181     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37182     "version": "0.0.0",
37183     "filename": "server/api/intZohoConfiguration/index.js",
37184     "groupTitle": "Zoho_Configurations"
37185   },
37186   {
37187     "type": "put",
37188     "url": "/api/integrations/zoho/configurations/{id}",
37189     "title": "Update an existing Zoho Configuration",
37190     "examples": [
37191       {
37192         "title": "Example usage:",
37193         "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",
37194         "type": "json"
37195       }
37196     ],
37197     "name": "updateZoho_Configurations",
37198     "group": "Zoho_Configurations",
37199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37200     "version": "0.0.0",
37201     "filename": "server/api/intZohoConfiguration/index.js",
37202     "groupTitle": "Zoho_Configurations"
37203   },
37204   {
37205     "type": "post",
37206     "url": "/api/integrations/zoho/fields",
37207     "title": "Creates a new Zoho Field",
37208     "examples": [
37209       {
37210         "title": "Example usage:",
37211         "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",
37212         "type": "json"
37213       }
37214     ],
37215     "name": "CreateZoho_Fields",
37216     "group": "Zoho_Fields",
37217     "parameter": {
37218       "fields": {
37219         "Body": [
37220           {
37221             "group": "Body",
37222             "type": "String",
37223             "allowedValues": [
37224               "\"string\"",
37225               "\"variable\"",
37226               "\"customVariable\"",
37227               "\"keyValue\"",
37228               "\"picklist\""
37229             ],
37230             "optional": true,
37231             "field": "type",
37232             "description": ""
37233           },
37234           {
37235             "group": "Body",
37236             "type": "String",
37237             "optional": true,
37238             "field": "content",
37239             "description": ""
37240           },
37241           {
37242             "group": "Body",
37243             "type": "String",
37244             "optional": true,
37245             "field": "key",
37246             "description": ""
37247           },
37248           {
37249             "group": "Body",
37250             "type": "String",
37251             "allowedValues": [
37252               "\"string\"",
37253               "\"variable\"",
37254               "\"customVariable\""
37255             ],
37256             "optional": true,
37257             "field": "keyType",
37258             "description": ""
37259           },
37260           {
37261             "group": "Body",
37262             "type": "String",
37263             "optional": true,
37264             "field": "keyContent",
37265             "description": ""
37266           },
37267           {
37268             "group": "Body",
37269             "type": "String",
37270             "optional": true,
37271             "field": "idField",
37272             "description": ""
37273           },
37274           {
37275             "group": "Body",
37276             "type": "String",
37277             "optional": true,
37278             "field": "nameField",
37279             "description": ""
37280           },
37281           {
37282             "group": "Body",
37283             "type": "Boolean",
37284             "optional": true,
37285             "field": "customField",
37286             "description": ""
37287           },
37288           {
37289             "group": "Body",
37290             "type": "String",
37291             "optional": true,
37292             "field": "variableName",
37293             "description": ""
37294           }
37295         ]
37296       }
37297     },
37298     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37299     "version": "0.0.0",
37300     "filename": "server/api/intZohoField/index.js",
37301     "groupTitle": "Zoho_Fields"
37302   },
37303   {
37304     "type": "delete",
37305     "url": "/api/integrations/zoho/fields/{id}",
37306     "title": "Deletes a Zoho Field",
37307     "examples": [
37308       {
37309         "title": "Example usage:",
37310         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37311         "type": "json"
37312       }
37313     ],
37314     "name": "DeleteZoho_Fields",
37315     "group": "Zoho_Fields",
37316     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37317     "version": "0.0.0",
37318     "filename": "server/api/intZohoField/index.js",
37319     "groupTitle": "Zoho_Fields"
37320   },
37321   {
37322     "type": "get",
37323     "url": "/api/integrations/zoho/fields",
37324     "title": "Gets a list of Zoho Fields",
37325     "examples": [
37326       {
37327         "title": "Example usage:",
37328         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37329         "type": "json"
37330       }
37331     ],
37332     "name": "GetZoho_Fields",
37333     "group": "Zoho_Fields",
37334     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37335     "version": "0.0.0",
37336     "filename": "server/api/intZohoField/index.js",
37337     "groupTitle": "Zoho_Fields"
37338   },
37339   {
37340     "type": "get",
37341     "url": "/api/integrations/zoho/fields/{id}",
37342     "title": "Gets a single Zoho Field",
37343     "examples": [
37344       {
37345         "title": "Example usage:",
37346         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37347         "type": "json"
37348       }
37349     ],
37350     "name": "ShowZoho_Fields",
37351     "group": "Zoho_Fields",
37352     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37353     "version": "0.0.0",
37354     "filename": "server/api/intZohoField/index.js",
37355     "groupTitle": "Zoho_Fields"
37356   },
37357   {
37358     "type": "put",
37359     "url": "/api/integrations/zoho/fields/{id}",
37360     "title": "Update an existing Zoho Field",
37361     "examples": [
37362       {
37363         "title": "Example usage:",
37364         "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",
37365         "type": "json"
37366       }
37367     ],
37368     "name": "updateZoho_Fields",
37369     "group": "Zoho_Fields",
37370     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37371     "version": "0.0.0",
37372     "filename": "server/api/intZohoField/index.js",
37373     "groupTitle": "Zoho_Fields"
37374   },
37375   {
37376     "type": "post",
37377     "url": "/api/cdr",
37378     "title": "Creates a new Cdr",
37379     "examples": [
37380       {
37381         "title": "Example usage:",
37382         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37383         "type": "json"
37384       }
37385     ],
37386     "name": "CreateCdrs",
37387     "group": "cdr",
37388     "parameter": {
37389       "fields": {
37390         "Body": [
37391           {
37392             "group": "Body",
37393             "type": "String",
37394             "optional": false,
37395             "field": "calldate",
37396             "description": ""
37397           },
37398           {
37399             "group": "Body",
37400             "type": "String",
37401             "optional": true,
37402             "field": "clid",
37403             "description": ""
37404           },
37405           {
37406             "group": "Body",
37407             "type": "String",
37408             "optional": true,
37409             "field": "src",
37410             "description": ""
37411           },
37412           {
37413             "group": "Body",
37414             "type": "String",
37415             "optional": true,
37416             "field": "dst",
37417             "description": ""
37418           },
37419           {
37420             "group": "Body",
37421             "type": "String",
37422             "optional": true,
37423             "field": "dcontext",
37424             "description": ""
37425           },
37426           {
37427             "group": "Body",
37428             "type": "String",
37429             "optional": true,
37430             "field": "channel",
37431             "description": ""
37432           },
37433           {
37434             "group": "Body",
37435             "type": "String",
37436             "optional": true,
37437             "field": "dstchannel",
37438             "description": ""
37439           },
37440           {
37441             "group": "Body",
37442             "type": "String",
37443             "optional": true,
37444             "field": "lastapp",
37445             "description": ""
37446           },
37447           {
37448             "group": "Body",
37449             "type": "String",
37450             "optional": true,
37451             "field": "lastdata",
37452             "description": ""
37453           },
37454           {
37455             "group": "Body",
37456             "type": "Integer",
37457             "optional": false,
37458             "field": "duration",
37459             "description": ""
37460           },
37461           {
37462             "group": "Body",
37463             "type": "Integer",
37464             "optional": false,
37465             "field": "billsec",
37466             "description": ""
37467           },
37468           {
37469             "group": "Body",
37470             "type": "String",
37471             "optional": true,
37472             "field": "disposition",
37473             "description": ""
37474           },
37475           {
37476             "group": "Body",
37477             "type": "Integer",
37478             "optional": false,
37479             "field": "amaflags",
37480             "description": ""
37481           },
37482           {
37483             "group": "Body",
37484             "type": "String",
37485             "optional": true,
37486             "field": "accountcode",
37487             "description": ""
37488           },
37489           {
37490             "group": "Body",
37491             "type": "String",
37492             "optional": true,
37493             "field": "userfield",
37494             "description": ""
37495           },
37496           {
37497             "group": "Body",
37498             "type": "String",
37499             "optional": true,
37500             "field": "uniqueid",
37501             "description": ""
37502           },
37503           {
37504             "group": "Body",
37505             "type": "String",
37506             "optional": true,
37507             "field": "linkedid",
37508             "description": ""
37509           },
37510           {
37511             "group": "Body",
37512             "type": "String",
37513             "optional": true,
37514             "field": "sequence",
37515             "description": ""
37516           },
37517           {
37518             "group": "Body",
37519             "type": "String",
37520             "optional": true,
37521             "field": "peeraccount",
37522             "description": ""
37523           },
37524           {
37525             "group": "Body",
37526             "type": "String",
37527             "optional": true,
37528             "field": "type",
37529             "description": ""
37530           },
37531           {
37532             "group": "Body",
37533             "type": "String",
37534             "optional": true,
37535             "field": "tag",
37536             "description": ""
37537           }
37538         ]
37539       }
37540     },
37541     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37542     "version": "0.0.0",
37543     "filename": "server/api/cdr/index.js",
37544     "groupTitle": "cdr"
37545   },
37546   {
37547     "type": "delete",
37548     "url": "/api/cdr/{id}",
37549     "title": "Deletes a Cdr",
37550     "examples": [
37551       {
37552         "title": "Example usage:",
37553         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37554         "type": "json"
37555       }
37556     ],
37557     "name": "DeleteCdrs",
37558     "group": "cdr",
37559     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37560     "version": "0.0.0",
37561     "filename": "server/api/cdr/index.js",
37562     "groupTitle": "cdr"
37563   },
37564   {
37565     "type": "get",
37566     "url": "/api/cdr/describe",
37567     "title": "Gets table info about Cdrs",
37568     "examples": [
37569       {
37570         "title": "Example usage:",
37571         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37572         "type": "json"
37573       }
37574     ],
37575     "name": "DescribeCdrs",
37576     "group": "cdr",
37577     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37578     "version": "0.0.0",
37579     "filename": "server/api/cdr/index.js",
37580     "groupTitle": "cdr"
37581   },
37582   {
37583     "type": "get",
37584     "url": "/api/cdr",
37585     "title": "Gets a list of Cdrs",
37586     "examples": [
37587       {
37588         "title": "Example usage:",
37589         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37590         "type": "json"
37591       }
37592     ],
37593     "name": "GetCdrs",
37594     "group": "cdr",
37595     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37596     "version": "0.0.0",
37597     "filename": "server/api/cdr/index.js",
37598     "groupTitle": "cdr"
37599   },
37600   {
37601     "type": "get",
37602     "url": "/api/cdr/{id}",
37603     "title": "Gets a single Cdr",
37604     "examples": [
37605       {
37606         "title": "Example usage:",
37607         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37608         "type": "json"
37609       }
37610     ],
37611     "name": "ShowCdrs",
37612     "group": "cdr",
37613     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37614     "version": "0.0.0",
37615     "filename": "server/api/cdr/index.js",
37616     "groupTitle": "cdr"
37617   },
37618   {
37619     "type": "put",
37620     "url": "/api/cdr/{id}",
37621     "title": "Update an existing Cdr",
37622     "examples": [
37623       {
37624         "title": "Example usage:",
37625         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37626         "type": "json"
37627       }
37628     ],
37629     "name": "updateCdrs",
37630     "group": "cdr",
37631     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37632     "version": "0.0.0",
37633     "filename": "server/api/cdr/index.js",
37634     "groupTitle": "cdr"
37635   },
37636   {
37637     "type": "post",
37638     "url": "/api/voiceQueuesLog",
37639     "title": "Creates a new VoiceQueuesLog",
37640     "examples": [
37641       {
37642         "title": "Example usage:",
37643         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37644         "type": "json"
37645       }
37646     ],
37647     "name": "CreateVoiceQueuesLogs",
37648     "group": "voiceQueuesLog",
37649     "parameter": {
37650       "fields": {
37651         "Body": [
37652           {
37653             "group": "Body",
37654             "type": "String",
37655             "optional": true,
37656             "field": "time",
37657             "description": ""
37658           },
37659           {
37660             "group": "Body",
37661             "type": "String",
37662             "optional": false,
37663             "field": "callid",
37664             "description": ""
37665           },
37666           {
37667             "group": "Body",
37668             "type": "String",
37669             "optional": false,
37670             "field": "queuename",
37671             "description": ""
37672           },
37673           {
37674             "group": "Body",
37675             "type": "String",
37676             "optional": false,
37677             "field": "agent",
37678             "description": ""
37679           },
37680           {
37681             "group": "Body",
37682             "type": "String",
37683             "optional": false,
37684             "field": "event",
37685             "description": ""
37686           },
37687           {
37688             "group": "Body",
37689             "type": "String",
37690             "optional": false,
37691             "field": "data",
37692             "description": ""
37693           },
37694           {
37695             "group": "Body",
37696             "type": "String",
37697             "optional": false,
37698             "field": "data1",
37699             "description": ""
37700           },
37701           {
37702             "group": "Body",
37703             "type": "String",
37704             "optional": false,
37705             "field": "data2",
37706             "description": ""
37707           },
37708           {
37709             "group": "Body",
37710             "type": "String",
37711             "optional": false,
37712             "field": "data3",
37713             "description": ""
37714           },
37715           {
37716             "group": "Body",
37717             "type": "String",
37718             "optional": false,
37719             "field": "data4",
37720             "description": ""
37721           },
37722           {
37723             "group": "Body",
37724             "type": "String",
37725             "optional": false,
37726             "field": "data5",
37727             "description": ""
37728           },
37729           {
37730             "group": "Body",
37731             "type": "String",
37732             "optional": false,
37733             "field": "dtm",
37734             "description": ""
37735           }
37736         ]
37737       }
37738     },
37739     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37740     "version": "0.0.0",
37741     "filename": "server/api/voiceQueuesLog/index.js",
37742     "groupTitle": "voiceQueuesLog"
37743   },
37744   {
37745     "type": "delete",
37746     "url": "/api/voiceQueuesLog/{id}",
37747     "title": "Deletes a VoiceQueuesLog",
37748     "examples": [
37749       {
37750         "title": "Example usage:",
37751         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
37752         "type": "json"
37753       }
37754     ],
37755     "name": "DeleteVoiceQueuesLogs",
37756     "group": "voiceQueuesLog",
37757     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37758     "version": "0.0.0",
37759     "filename": "server/api/voiceQueuesLog/index.js",
37760     "groupTitle": "voiceQueuesLog"
37761   },
37762   {
37763     "type": "get",
37764     "url": "/api/voiceQueuesLog",
37765     "title": "Gets a list of VoiceQueuesLogs",
37766     "examples": [
37767       {
37768         "title": "Example usage:",
37769         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
37770         "type": "json"
37771       }
37772     ],
37773     "name": "GetVoiceQueuesLogs",
37774     "group": "voiceQueuesLog",
37775     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37776     "version": "0.0.0",
37777     "filename": "server/api/voiceQueuesLog/index.js",
37778     "groupTitle": "voiceQueuesLog"
37779   },
37780   {
37781     "type": "get",
37782     "url": "/api/voiceQueuesLog/{id}",
37783     "title": "Gets a single VoiceQueuesLog",
37784     "examples": [
37785       {
37786         "title": "Example usage:",
37787         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
37788         "type": "json"
37789       }
37790     ],
37791     "name": "ShowVoiceQueuesLogs",
37792     "group": "voiceQueuesLog",
37793     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37794     "version": "0.0.0",
37795     "filename": "server/api/voiceQueuesLog/index.js",
37796     "groupTitle": "voiceQueuesLog"
37797   },
37798   {
37799     "type": "put",
37800     "url": "/api/voiceQueuesLog/{id}",
37801     "title": "Update an existing VoiceQueuesLog",
37802     "examples": [
37803       {
37804         "title": "Example usage:",
37805         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37806         "type": "json"
37807       }
37808     ],
37809     "name": "updateVoiceQueuesLogs",
37810     "group": "voiceQueuesLog",
37811     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37812     "version": "0.0.0",
37813     "filename": "server/api/voiceQueuesLog/index.js",
37814     "groupTitle": "voiceQueuesLog"
37815   }
37816 ]