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/activedirectory",
1305     "title": "Creates a new User token",
1306     "examples": [
1307       {
1308         "title": "Example usage:",
1309         "content": "curl https://{domain}/api/auth/activedirectory -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/authActiveDirectory/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/auth/local",
1381     "title": "Creates a new User token",
1382     "examples": [
1383       {
1384         "title": "Example usage:",
1385         "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1386         "type": "json"
1387       }
1388     ],
1389     "name": "Local_login",
1390     "group": "Authentication",
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": false,
1405             "field": "password",
1406             "description": ""
1407           }
1408         ]
1409       }
1410     },
1411     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1412     "version": "0.0.0",
1413     "filename": "server/api/authLocal/index.js",
1414     "groupTitle": "Authentication"
1415   },
1416   {
1417     "type": "post",
1418     "url": "/api/automations",
1419     "title": "Creates a new Automation",
1420     "examples": [
1421       {
1422         "title": "Example usage:",
1423         "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1424         "type": "json"
1425       }
1426     ],
1427     "name": "CreateAutomations",
1428     "group": "Automations",
1429     "parameter": {
1430       "fields": {
1431         "Body": [
1432           {
1433             "group": "Body",
1434             "type": "String",
1435             "optional": false,
1436             "field": "name",
1437             "description": ""
1438           },
1439           {
1440             "group": "Body",
1441             "type": "String",
1442             "optional": true,
1443             "field": "channel",
1444             "description": ""
1445           },
1446           {
1447             "group": "Body",
1448             "type": "String",
1449             "optional": true,
1450             "field": "description",
1451             "description": ""
1452           },
1453           {
1454             "group": "Body",
1455             "type": "Boolean",
1456             "optional": true,
1457             "field": "status",
1458             "description": ""
1459           },
1460           {
1461             "group": "Body",
1462             "type": "Integer",
1463             "optional": true,
1464             "field": "timeout",
1465             "description": ""
1466           }
1467         ]
1468       }
1469     },
1470     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1471     "version": "0.0.0",
1472     "filename": "server/api/automation/index.js",
1473     "groupTitle": "Automations"
1474   },
1475   {
1476     "type": "delete",
1477     "url": "/api/automations/{id}",
1478     "title": "Deletes a Automation",
1479     "examples": [
1480       {
1481         "title": "Example usage:",
1482         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1483         "type": "json"
1484       }
1485     ],
1486     "name": "DeleteAutomations",
1487     "group": "Automations",
1488     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1489     "version": "0.0.0",
1490     "filename": "server/api/automation/index.js",
1491     "groupTitle": "Automations"
1492   },
1493   {
1494     "type": "get",
1495     "url": "/api/automations",
1496     "title": "Gets a list of Automations",
1497     "examples": [
1498       {
1499         "title": "Example usage:",
1500         "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1501         "type": "json"
1502       }
1503     ],
1504     "name": "GetAutomations",
1505     "group": "Automations",
1506     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1507     "version": "0.0.0",
1508     "filename": "server/api/automation/index.js",
1509     "groupTitle": "Automations"
1510   },
1511   {
1512     "type": "get",
1513     "url": "/api/automations/{id}",
1514     "title": "Gets a single Automation",
1515     "examples": [
1516       {
1517         "title": "Example usage:",
1518         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1519         "type": "json"
1520       }
1521     ],
1522     "name": "ShowAutomations",
1523     "group": "Automations",
1524     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1525     "version": "0.0.0",
1526     "filename": "server/api/automation/index.js",
1527     "groupTitle": "Automations"
1528   },
1529   {
1530     "type": "post",
1531     "url": "/api/automations/{id}/actions",
1532     "title": "Creates new actions",
1533     "examples": [
1534       {
1535         "title": "Example usage:",
1536         "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",
1537         "type": "json"
1538       }
1539     ],
1540     "name": "addActions",
1541     "group": "Automations",
1542     "parameter": {
1543       "fields": {
1544         "Body": [
1545           {
1546             "group": "Body",
1547             "type": "Virtual",
1548             "optional": true,
1549             "field": "name",
1550             "description": ""
1551           },
1552           {
1553             "group": "Body",
1554             "type": "String",
1555             "optional": false,
1556             "field": "action",
1557             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1558           },
1559           {
1560             "group": "Body",
1561             "type": "String",
1562             "optional": true,
1563             "field": "data1",
1564             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1565           },
1566           {
1567             "group": "Body",
1568             "type": "String",
1569             "optional": true,
1570             "field": "data2",
1571             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1572           },
1573           {
1574             "group": "Body",
1575             "type": "String",
1576             "optional": true,
1577             "field": "data3",
1578             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1579           },
1580           {
1581             "group": "Body",
1582             "type": "String",
1583             "optional": true,
1584             "field": "data4",
1585             "description": ""
1586           },
1587           {
1588             "group": "Body",
1589             "type": "String",
1590             "optional": true,
1591             "field": "data5",
1592             "description": ""
1593           },
1594           {
1595             "group": "Body",
1596             "type": "String",
1597             "optional": true,
1598             "field": "data6",
1599             "description": ""
1600           },
1601           {
1602             "group": "Body",
1603             "type": "Text",
1604             "optional": true,
1605             "field": "data7",
1606             "description": ""
1607           }
1608         ]
1609       }
1610     },
1611     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1612     "version": "0.0.0",
1613     "filename": "server/api/automation/index.js",
1614     "groupTitle": "Automations"
1615   },
1616   {
1617     "type": "post",
1618     "url": "/api/automations/{id}/conditions",
1619     "title": "Creates new conditions",
1620     "examples": [
1621       {
1622         "title": "Example usage:",
1623         "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",
1624         "type": "json"
1625       }
1626     ],
1627     "name": "addConditions",
1628     "group": "Automations",
1629     "parameter": {
1630       "fields": {
1631         "Body": [
1632           {
1633             "group": "Body",
1634             "type": "Virtual",
1635             "optional": true,
1636             "field": "name",
1637             "description": ""
1638           },
1639           {
1640             "group": "Body",
1641             "type": "String",
1642             "optional": false,
1643             "field": "field",
1644             "description": ""
1645           },
1646           {
1647             "group": "Body",
1648             "type": "String",
1649             "optional": false,
1650             "field": "operator",
1651             "description": ""
1652           },
1653           {
1654             "group": "Body",
1655             "type": "String",
1656             "optional": false,
1657             "field": "value",
1658             "description": ""
1659           }
1660         ]
1661       }
1662     },
1663     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1664     "version": "0.0.0",
1665     "filename": "server/api/automation/index.js",
1666     "groupTitle": "Automations"
1667   },
1668   {
1669     "type": "get",
1670     "url": "/api/automations/{id}/actions",
1671     "title": "Gets Automation Actions",
1672     "examples": [
1673       {
1674         "title": "Example usage:",
1675         "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1676         "type": "json"
1677       }
1678     ],
1679     "name": "getActions",
1680     "group": "Automations",
1681     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1682     "version": "0.0.0",
1683     "filename": "server/api/automation/index.js",
1684     "groupTitle": "Automations"
1685   },
1686   {
1687     "type": "get",
1688     "url": "/api/automations/{id}/conditions",
1689     "title": "Gets Automation Conditions",
1690     "examples": [
1691       {
1692         "title": "Example usage:",
1693         "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1694         "type": "json"
1695       }
1696     ],
1697     "name": "getConditions",
1698     "group": "Automations",
1699     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1700     "version": "0.0.0",
1701     "filename": "server/api/automation/index.js",
1702     "groupTitle": "Automations"
1703   },
1704   {
1705     "type": "put",
1706     "url": "/api/automations/{id}",
1707     "title": "Update an existing Automation",
1708     "examples": [
1709       {
1710         "title": "Example usage:",
1711         "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1712         "type": "json"
1713       }
1714     ],
1715     "name": "updateAutomations",
1716     "group": "Automations",
1717     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1718     "version": "0.0.0",
1719     "filename": "server/api/automation/index.js",
1720     "groupTitle": "Automations"
1721   },
1722   {
1723     "type": "post",
1724     "url": "/api/canned_answers",
1725     "title": "Create a new canned answer",
1726     "examples": [
1727       {
1728         "title": "Example usage:",
1729         "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1730         "type": "json"
1731       }
1732     ],
1733     "name": "Create",
1734     "group": "Canned_Answers",
1735     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1736     "version": "0.0.0",
1737     "filename": "server/api/cannedAnswer/index.js",
1738     "groupTitle": "Canned_Answers"
1739   },
1740   {
1741     "type": "delete",
1742     "url": "/api/canned_answers/{id}",
1743     "title": "Deletes a Canned Answer",
1744     "examples": [
1745       {
1746         "title": "Example usage:",
1747         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1748         "type": "json"
1749       }
1750     ],
1751     "name": "DeleteCanned_Answers",
1752     "group": "Canned_Answers",
1753     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1754     "version": "0.0.0",
1755     "filename": "server/api/cannedAnswer/index.js",
1756     "groupTitle": "Canned_Answers"
1757   },
1758   {
1759     "type": "get",
1760     "url": "/api/canned_answers",
1761     "title": "Gets a list of Canned Answers",
1762     "examples": [
1763       {
1764         "title": "Example usage:",
1765         "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1766         "type": "json"
1767       }
1768     ],
1769     "name": "GetCanned_Answers",
1770     "group": "Canned_Answers",
1771     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1772     "version": "0.0.0",
1773     "filename": "server/api/cannedAnswer/index.js",
1774     "groupTitle": "Canned_Answers"
1775   },
1776   {
1777     "type": "get",
1778     "url": "/api/canned_answers/{id}",
1779     "title": "Gets a single Canned Answer",
1780     "examples": [
1781       {
1782         "title": "Example usage:",
1783         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1784         "type": "json"
1785       }
1786     ],
1787     "name": "ShowCanned_Answers",
1788     "group": "Canned_Answers",
1789     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1790     "version": "0.0.0",
1791     "filename": "server/api/cannedAnswer/index.js",
1792     "groupTitle": "Canned_Answers"
1793   },
1794   {
1795     "type": "put",
1796     "url": "/api/canned_answers/{id}",
1797     "title": "Update an existing Canned Answer",
1798     "examples": [
1799       {
1800         "title": "Example usage:",
1801         "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",
1802         "type": "json"
1803       }
1804     ],
1805     "name": "updateCanned_Answers",
1806     "group": "Canned_Answers",
1807     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1808     "version": "0.0.0",
1809     "filename": "server/api/cannedAnswer/index.js",
1810     "groupTitle": "Canned_Answers"
1811   },
1812   {
1813     "type": "get",
1814     "url": "/chat/internal/users",
1815     "title": "Gets Users Last Messages",
1816     "examples": [
1817       {
1818         "title": "Example usage:",
1819         "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password}  -X GET",
1820         "type": "json"
1821       }
1822     ],
1823     "name": "getLastUsersMessages",
1824     "group": "ChatInternalMessage",
1825     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1826     "version": "0.0.0",
1827     "filename": "server/api/chatInternalMessage/index.js",
1828     "groupTitle": "ChatInternalMessage"
1829   },
1830   {
1831     "type": "delete",
1832     "url": "/api/chat/applications/{id}",
1833     "title": "Deletes a Application",
1834     "examples": [
1835       {
1836         "title": "Example usage:",
1837         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1838         "type": "json"
1839       }
1840     ],
1841     "name": "DeleteApplications",
1842     "group": "Chat_Applications",
1843     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1844     "version": "0.0.0",
1845     "filename": "server/api/chatApplication/index.js",
1846     "groupTitle": "Chat_Applications"
1847   },
1848   {
1849     "type": "get",
1850     "url": "/api/chat/applications/{id}",
1851     "title": "Gets a single Application",
1852     "examples": [
1853       {
1854         "title": "Example usage:",
1855         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1856         "type": "json"
1857       }
1858     ],
1859     "name": "ShowApplications",
1860     "group": "Chat_Applications",
1861     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1862     "version": "0.0.0",
1863     "filename": "server/api/chatApplication/index.js",
1864     "groupTitle": "Chat_Applications"
1865   },
1866   {
1867     "type": "put",
1868     "url": "/api/chat/applications/{id}",
1869     "title": "Update an existing Application",
1870     "examples": [
1871       {
1872         "title": "Example usage:",
1873         "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",
1874         "type": "json"
1875       }
1876     ],
1877     "name": "updateApplications",
1878     "group": "Chat_Applications",
1879     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1880     "version": "0.0.0",
1881     "filename": "server/api/chatApplication/index.js",
1882     "groupTitle": "Chat_Applications"
1883   },
1884   {
1885     "type": "post",
1886     "url": "/api/chat/groups",
1887     "title": "Creates a new Group",
1888     "examples": [
1889       {
1890         "title": "Example usage:",
1891         "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1892         "type": "json"
1893       }
1894     ],
1895     "name": "CreateGroups",
1896     "group": "Chat_Groups",
1897     "parameter": {
1898       "fields": {
1899         "Body": [
1900           {
1901             "group": "Body",
1902             "type": "String",
1903             "optional": false,
1904             "field": "name",
1905             "description": ""
1906           },
1907           {
1908             "group": "Body",
1909             "type": "String",
1910             "optional": true,
1911             "field": "description",
1912             "description": ""
1913           },
1914           {
1915             "group": "Body",
1916             "type": "Boolean",
1917             "optional": true,
1918             "field": "write",
1919             "description": ""
1920           }
1921         ]
1922       }
1923     },
1924     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1925     "version": "0.0.0",
1926     "filename": "server/api/chatGroup/index.js",
1927     "groupTitle": "Chat_Groups"
1928   },
1929   {
1930     "type": "delete",
1931     "url": "/api/chat/groups/{id}",
1932     "title": "Deletes a Group",
1933     "examples": [
1934       {
1935         "title": "Example usage:",
1936         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1937         "type": "json"
1938       }
1939     ],
1940     "name": "DeleteGroups",
1941     "group": "Chat_Groups",
1942     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1943     "version": "0.0.0",
1944     "filename": "server/api/chatGroup/index.js",
1945     "groupTitle": "Chat_Groups"
1946   },
1947   {
1948     "type": "get",
1949     "url": "/api/chat/groups/describe",
1950     "title": "Gets table info about Groups",
1951     "examples": [
1952       {
1953         "title": "Example usage:",
1954         "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1955         "type": "json"
1956       }
1957     ],
1958     "name": "DescribeGroups",
1959     "group": "Chat_Groups",
1960     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1961     "version": "0.0.0",
1962     "filename": "server/api/chatGroup/index.js",
1963     "groupTitle": "Chat_Groups"
1964   },
1965   {
1966     "type": "get",
1967     "url": "/api/chat/groups",
1968     "title": "Gets a list of Groups",
1969     "examples": [
1970       {
1971         "title": "Example usage:",
1972         "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1973         "type": "json"
1974       }
1975     ],
1976     "name": "GetGroups",
1977     "group": "Chat_Groups",
1978     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
1979     "version": "0.0.0",
1980     "filename": "server/api/chatGroup/index.js",
1981     "groupTitle": "Chat_Groups"
1982   },
1983   {
1984     "type": "delete",
1985     "url": "/api/chat/groups/{id}/members",
1986     "title": "Removes members from a group",
1987     "examples": [
1988       {
1989         "title": "Example usage:",
1990         "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
1991         "type": "json"
1992       }
1993     ],
1994     "name": "RemoveMembers",
1995     "group": "Chat_Groups",
1996     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1997     "version": "0.0.0",
1998     "filename": "server/api/chatGroup/index.js",
1999     "groupTitle": "Chat_Groups"
2000   },
2001   {
2002     "type": "get",
2003     "url": "/api/chat/groups/{id}",
2004     "title": "Gets a single Group",
2005     "examples": [
2006       {
2007         "title": "Example usage:",
2008         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
2009         "type": "json"
2010       }
2011     ],
2012     "name": "ShowGroups",
2013     "group": "Chat_Groups",
2014     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2015     "version": "0.0.0",
2016     "filename": "server/api/chatGroup/index.js",
2017     "groupTitle": "Chat_Groups"
2018   },
2019   {
2020     "type": "post",
2021     "url": "/api/chat/groups/{id}/members",
2022     "title": "Add members to chat group",
2023     "examples": [
2024       {
2025         "title": "Example usage:",
2026         "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",
2027         "type": "json"
2028       }
2029     ],
2030     "name": "addMembers",
2031     "group": "Chat_Groups",
2032     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2033     "version": "0.0.0",
2034     "filename": "server/api/chatGroup/index.js",
2035     "groupTitle": "Chat_Groups"
2036   },
2037   {
2038     "type": "post",
2039     "url": "/api/chat/groups/{id}/messages",
2040     "title": "Creates a new group message",
2041     "examples": [
2042       {
2043         "title": "Example usage:",
2044         "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2045         "type": "json"
2046       }
2047     ],
2048     "name": "addMessage",
2049     "group": "Chat_Groups",
2050     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2051     "version": "0.0.0",
2052     "filename": "server/api/chatGroup/index.js",
2053     "groupTitle": "Chat_Groups"
2054   },
2055   {
2056     "type": "get",
2057     "url": "/api/chat/groups/{id}/members",
2058     "title": "Gets Members",
2059     "examples": [
2060       {
2061         "title": "Example usage:",
2062         "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2063         "type": "json"
2064       }
2065     ],
2066     "name": "getMembers",
2067     "group": "Chat_Groups",
2068     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2069     "version": "0.0.0",
2070     "filename": "server/api/chatGroup/index.js",
2071     "groupTitle": "Chat_Groups"
2072   },
2073   {
2074     "type": "get",
2075     "url": "/api/chat/groups/{id}/messages",
2076     "title": "Gets Messages",
2077     "examples": [
2078       {
2079         "title": "Example usage:",
2080         "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2081         "type": "json"
2082       }
2083     ],
2084     "name": "getMessages",
2085     "group": "Chat_Groups",
2086     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2087     "version": "0.0.0",
2088     "filename": "server/api/chatGroup/index.js",
2089     "groupTitle": "Chat_Groups"
2090   },
2091   {
2092     "type": "get",
2093     "url": "/api/chat/groups/{id}/unread",
2094     "title": "Get unread chat group messages",
2095     "examples": [
2096       {
2097         "title": "Example usage:",
2098         "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2099         "type": "json"
2100       }
2101     ],
2102     "name": "getUread",
2103     "group": "Chat_Groups",
2104     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2105     "version": "0.0.0",
2106     "filename": "server/api/chatGroup/index.js",
2107     "groupTitle": "Chat_Groups"
2108   },
2109   {
2110     "type": "put",
2111     "url": "/api/chat/groups/{id}",
2112     "title": "Update an existing Group",
2113     "examples": [
2114       {
2115         "title": "Example usage:",
2116         "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",
2117         "type": "json"
2118       }
2119     ],
2120     "name": "updateGroups",
2121     "group": "Chat_Groups",
2122     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2123     "version": "0.0.0",
2124     "filename": "server/api/chatGroup/index.js",
2125     "groupTitle": "Chat_Groups"
2126   },
2127   {
2128     "type": "post",
2129     "url": "/api/chat/interactions/{id}/tags",
2130     "title": "Add tags to the interaction",
2131     "examples": [
2132       {
2133         "title": "Example usage:",
2134         "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",
2135         "type": "json"
2136       }
2137     ],
2138     "name": "AddTags",
2139     "group": "Chat_Interactions",
2140     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2141     "version": "0.0.0",
2142     "filename": "server/api/chatInteraction/index.js",
2143     "groupTitle": "Chat_Interactions"
2144   },
2145   {
2146     "type": "post",
2147     "url": "/api/chat/interactions",
2148     "title": "Creates a new Interaction",
2149     "examples": [
2150       {
2151         "title": "Example usage:",
2152         "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2153         "type": "json"
2154       }
2155     ],
2156     "name": "CreateInteractions",
2157     "group": "Chat_Interactions",
2158     "parameter": {
2159       "fields": {
2160         "Body": [
2161           {
2162             "group": "Body",
2163             "type": "Boolean",
2164             "optional": true,
2165             "field": "closed",
2166             "description": ""
2167           },
2168           {
2169             "group": "Body",
2170             "type": "Integer",
2171             "optional": true,
2172             "field": "ratingValue",
2173             "description": ""
2174           },
2175           {
2176             "group": "Body",
2177             "type": "String",
2178             "allowedValues": [
2179               "\"star\"",
2180               "\"thumb\""
2181             ],
2182             "optional": true,
2183             "field": "ratingType",
2184             "description": ""
2185           },
2186           {
2187             "group": "Body",
2188             "type": "Text",
2189             "optional": true,
2190             "field": "ratingMessage",
2191             "description": ""
2192           },
2193           {
2194             "group": "Body",
2195             "type": "Text",
2196             "optional": true,
2197             "field": "pathTranscript",
2198             "description": ""
2199           },
2200           {
2201             "group": "Body",
2202             "type": "String",
2203             "optional": true,
2204             "field": "mailTranscript",
2205             "description": ""
2206           },
2207           {
2208             "group": "Body",
2209             "type": "String",
2210             "optional": true,
2211             "field": "closedAt",
2212             "description": ""
2213           },
2214           {
2215             "group": "Body",
2216             "type": "String",
2217             "optional": true,
2218             "field": "disposition",
2219             "description": ""
2220           },
2221           {
2222             "group": "Body",
2223             "type": "String",
2224             "optional": true,
2225             "field": "secondDisposition",
2226             "description": ""
2227           },
2228           {
2229             "group": "Body",
2230             "type": "String",
2231             "optional": true,
2232             "field": "thirdDisposition",
2233             "description": ""
2234           },
2235           {
2236             "group": "Body",
2237             "type": "String",
2238             "optional": true,
2239             "field": "note",
2240             "description": ""
2241           },
2242           {
2243             "group": "Body",
2244             "type": "String",
2245             "optional": true,
2246             "field": "browserName",
2247             "description": ""
2248           },
2249           {
2250             "group": "Body",
2251             "type": "String",
2252             "optional": true,
2253             "field": "browserVersion",
2254             "description": ""
2255           },
2256           {
2257             "group": "Body",
2258             "type": "String",
2259             "optional": true,
2260             "field": "osName",
2261             "description": ""
2262           },
2263           {
2264             "group": "Body",
2265             "type": "String",
2266             "optional": true,
2267             "field": "osVersion",
2268             "description": ""
2269           },
2270           {
2271             "group": "Body",
2272             "type": "String",
2273             "optional": true,
2274             "field": "deviceModel",
2275             "description": ""
2276           },
2277           {
2278             "group": "Body",
2279             "type": "String",
2280             "optional": true,
2281             "field": "deviceVendor",
2282             "description": ""
2283           },
2284           {
2285             "group": "Body",
2286             "type": "String",
2287             "optional": true,
2288             "field": "deviceType",
2289             "description": ""
2290           },
2291           {
2292             "group": "Body",
2293             "type": "Text",
2294             "optional": true,
2295             "field": "referer",
2296             "description": ""
2297           },
2298           {
2299             "group": "Body",
2300             "type": "String",
2301             "optional": true,
2302             "field": "customerIp",
2303             "description": ""
2304           },
2305           {
2306             "group": "Body",
2307             "type": "Text",
2308             "optional": true,
2309             "field": "formData",
2310             "description": ""
2311           },
2312           {
2313             "group": "Body",
2314             "type": "String",
2315             "optional": true,
2316             "field": "read1stAt",
2317             "description": ""
2318           },
2319           {
2320             "group": "Body",
2321             "type": "String",
2322             "optional": true,
2323             "field": "lastMsgAt",
2324             "description": ""
2325           },
2326           {
2327             "group": "Body",
2328             "type": "String",
2329             "allowedValues": [
2330               "\"in\"",
2331               "\"out\""
2332             ],
2333             "optional": false,
2334             "field": "lastMsgDirection",
2335             "description": ""
2336           },
2337           {
2338             "group": "Body",
2339             "type": "String",
2340             "optional": true,
2341             "field": "closeReason",
2342             "description": ""
2343           },
2344           {
2345             "group": "Body",
2346             "type": "String",
2347             "optional": true,
2348             "field": "customerPort",
2349             "description": ""
2350           },
2351           {
2352             "group": "Body",
2353             "type": "Text",
2354             "optional": true,
2355             "field": "vidaooSessionId",
2356             "description": ""
2357           },
2358           {
2359             "group": "Body",
2360             "type": "Boolean",
2361             "optional": true,
2362             "field": "autoreplyExecuted",
2363             "description": ""
2364           }
2365         ]
2366       }
2367     },
2368     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2369     "version": "0.0.0",
2370     "filename": "server/api/chatInteraction/index.js",
2371     "groupTitle": "Chat_Interactions"
2372   },
2373   {
2374     "type": "delete",
2375     "url": "/api/chat/interactions/{id}",
2376     "title": "Deletes a Interaction",
2377     "examples": [
2378       {
2379         "title": "Example usage:",
2380         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2381         "type": "json"
2382       }
2383     ],
2384     "name": "DeleteInteractions",
2385     "group": "Chat_Interactions",
2386     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2387     "version": "0.0.0",
2388     "filename": "server/api/chatInteraction/index.js",
2389     "groupTitle": "Chat_Interactions"
2390   },
2391   {
2392     "type": "get",
2393     "url": "/api/chat/interactions/describe",
2394     "title": "Gets table info about Interactions",
2395     "examples": [
2396       {
2397         "title": "Example usage:",
2398         "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2399         "type": "json"
2400       }
2401     ],
2402     "name": "DescribeInteractions",
2403     "group": "Chat_Interactions",
2404     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2405     "version": "0.0.0",
2406     "filename": "server/api/chatInteraction/index.js",
2407     "groupTitle": "Chat_Interactions"
2408   },
2409   {
2410     "type": "get",
2411     "url": "/api/chat/interactions",
2412     "title": "Gets a list of Interactions",
2413     "examples": [
2414       {
2415         "title": "Example usage:",
2416         "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2417         "type": "json"
2418       }
2419     ],
2420     "name": "GetInteractions",
2421     "group": "Chat_Interactions",
2422     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2423     "version": "0.0.0",
2424     "filename": "server/api/chatInteraction/index.js",
2425     "groupTitle": "Chat_Interactions"
2426   },
2427   {
2428     "type": "delete",
2429     "url": "/api/chat/interactions/{id}/tags",
2430     "title": "Removes tags from interaction",
2431     "examples": [
2432       {
2433         "title": "Example usage:",
2434         "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2435         "type": "json"
2436       }
2437     ],
2438     "name": "RemoveTags",
2439     "group": "Chat_Interactions",
2440     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2441     "version": "0.0.0",
2442     "filename": "server/api/chatInteraction/index.js",
2443     "groupTitle": "Chat_Interactions"
2444   },
2445   {
2446     "type": "get",
2447     "url": "/api/chat/interactions/{id}",
2448     "title": "Gets a single Interaction",
2449     "examples": [
2450       {
2451         "title": "Example usage:",
2452         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2453         "type": "json"
2454       }
2455     ],
2456     "name": "ShowInteractions",
2457     "group": "Chat_Interactions",
2458     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2459     "version": "0.0.0",
2460     "filename": "server/api/chatInteraction/index.js",
2461     "groupTitle": "Chat_Interactions"
2462   },
2463   {
2464     "type": "put",
2465     "url": "/api/chat/interactions/{id}/abandon",
2466     "title": "Abandon interaction",
2467     "examples": [
2468       {
2469         "title": "Example usage:",
2470         "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2471         "type": "json"
2472       }
2473     ],
2474     "name": "abandon",
2475     "group": "Chat_Interactions",
2476     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2477     "version": "0.0.0",
2478     "filename": "server/api/chatInteraction/index.js",
2479     "groupTitle": "Chat_Interactions"
2480   },
2481   {
2482     "type": "post",
2483     "url": "/api/chat/interactions/{id}/messages",
2484     "title": "Creates new messages",
2485     "examples": [
2486       {
2487         "title": "Example usage:",
2488         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2489         "type": "json"
2490       }
2491     ],
2492     "name": "addMessage",
2493     "group": "Chat_Interactions",
2494     "parameter": {
2495       "fields": {
2496         "Body": [
2497           {
2498             "group": "Body",
2499             "type": "Text",
2500             "optional": false,
2501             "field": "body",
2502             "description": ""
2503           },
2504           {
2505             "group": "Body",
2506             "type": "Boolean",
2507             "optional": true,
2508             "field": "read",
2509             "description": ""
2510           },
2511           {
2512             "group": "Body",
2513             "type": "Boolean",
2514             "optional": true,
2515             "field": "secret",
2516             "description": ""
2517           },
2518           {
2519             "group": "Body",
2520             "type": "String",
2521             "allowedValues": [
2522               "\"in\"",
2523               "\"out\""
2524             ],
2525             "optional": false,
2526             "field": "direction",
2527             "description": ""
2528           },
2529           {
2530             "group": "Body",
2531             "type": "String",
2532             "optional": true,
2533             "field": "readAt",
2534             "description": ""
2535           },
2536           {
2537             "group": "Body",
2538             "type": "String",
2539             "optional": true,
2540             "field": "providerName",
2541             "description": ""
2542           },
2543           {
2544             "group": "Body",
2545             "type": "Text",
2546             "optional": true,
2547             "field": "providerResponse",
2548             "description": ""
2549           }
2550         ]
2551       }
2552     },
2553     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2554     "version": "0.0.0",
2555     "filename": "server/api/chatInteraction/index.js",
2556     "groupTitle": "Chat_Interactions"
2557   },
2558   {
2559     "type": "put",
2560     "url": "/api/chat/interactions/{id}/close",
2561     "title": "Close Interaction",
2562     "examples": [
2563       {
2564         "title": "Example usage:",
2565         "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2566         "type": "json"
2567       }
2568     ],
2569     "name": "addMessage",
2570     "group": "Chat_Interactions",
2571     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2572     "version": "0.0.0",
2573     "filename": "server/api/chatInteraction/index.js",
2574     "groupTitle": "Chat_Interactions"
2575   },
2576   {
2577     "type": "post",
2578     "url": "/api/chat/interactions/{id}/attachment_upload",
2579     "title": "Add attachment",
2580     "examples": [
2581       {
2582         "title": "Example usage:",
2583         "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",
2584         "type": "json"
2585       }
2586     ],
2587     "name": "attachmentUpload",
2588     "group": "Chat_Interactions",
2589     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2590     "version": "0.0.0",
2591     "filename": "server/api/chatInteraction/index.js",
2592     "groupTitle": "Chat_Interactions"
2593   },
2594   {
2595     "type": "post",
2596     "url": "/api/chat/interactions/{id}/vidaoo",
2597     "title": "Create Vidaoo Session",
2598     "examples": [
2599       {
2600         "title": "Example usage:",
2601         "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo  -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2602         "type": "json"
2603       }
2604     ],
2605     "name": "createVidaooSession",
2606     "group": "Chat_Interactions",
2607     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2608     "version": "0.0.0",
2609     "filename": "server/api/chatInteraction/index.js",
2610     "groupTitle": "Chat_Interactions"
2611   },
2612   {
2613     "type": "put",
2614     "url": "/api/chat/interactions/{id}/custom_update",
2615     "title": "Update interaction",
2616     "examples": [
2617       {
2618         "title": "Example usage:",
2619         "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",
2620         "type": "json"
2621       }
2622     ],
2623     "name": "customUpdate",
2624     "group": "Chat_Interactions",
2625     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2626     "version": "0.0.0",
2627     "filename": "server/api/chatInteraction/index.js",
2628     "groupTitle": "Chat_Interactions"
2629   },
2630   {
2631     "type": "get",
2632     "url": "/api/chat/interactions/{id}/download",
2633     "title": "Gets interaction",
2634     "examples": [
2635       {
2636         "title": "Example usage:",
2637         "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2638         "type": "json"
2639       }
2640     ],
2641     "name": "download",
2642     "group": "Chat_Interactions",
2643     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2644     "version": "0.0.0",
2645     "filename": "server/api/chatInteraction/index.js",
2646     "groupTitle": "Chat_Interactions"
2647   },
2648   {
2649     "type": "get",
2650     "url": "/api/chat/interactions/{id}/messages",
2651     "title": "Gets interaction messages",
2652     "examples": [
2653       {
2654         "title": "Example usage:",
2655         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2656         "type": "json"
2657       }
2658     ],
2659     "name": "getMessages",
2660     "group": "Chat_Interactions",
2661     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2662     "version": "0.0.0",
2663     "filename": "server/api/chatInteraction/index.js",
2664     "groupTitle": "Chat_Interactions"
2665   },
2666   {
2667     "type": "get",
2668     "url": "/api/chat/interactions/{id}/my_messages",
2669     "title": "Gets interaction messages",
2670     "examples": [
2671       {
2672         "title": "Example usage:",
2673         "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2674         "type": "json"
2675       }
2676     ],
2677     "name": "getMyMessages",
2678     "group": "Chat_Interactions",
2679     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2680     "version": "0.0.0",
2681     "filename": "server/api/chatInteraction/index.js",
2682     "groupTitle": "Chat_Interactions"
2683   },
2684   {
2685     "type": "put",
2686     "url": "/api/chat/interactions/{id}",
2687     "title": "Update an existing Interaction",
2688     "examples": [
2689       {
2690         "title": "Example usage:",
2691         "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",
2692         "type": "json"
2693       }
2694     ],
2695     "name": "updateInteractions",
2696     "group": "Chat_Interactions",
2697     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2698     "version": "0.0.0",
2699     "filename": "server/api/chatInteraction/index.js",
2700     "groupTitle": "Chat_Interactions"
2701   },
2702   {
2703     "type": "post",
2704     "url": "/api/chat/internal/messages",
2705     "title": "Creates a new Message",
2706     "examples": [
2707       {
2708         "title": "Example usage:",
2709         "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",
2710         "type": "json"
2711       }
2712     ],
2713     "name": "CreateMessages",
2714     "group": "Chat_Internal_Messages",
2715     "parameter": {
2716       "fields": {
2717         "Body": [
2718           {
2719             "group": "Body",
2720             "type": "Text",
2721             "optional": false,
2722             "field": "body",
2723             "description": ""
2724           },
2725           {
2726             "group": "Body",
2727             "type": "Boolean",
2728             "optional": true,
2729             "field": "read",
2730             "description": ""
2731           },
2732           {
2733             "group": "Body",
2734             "type": "Integer",
2735             "optional": true,
2736             "field": "ChatInternalMessageId",
2737             "description": ""
2738           }
2739         ]
2740       }
2741     },
2742     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2743     "version": "0.0.0",
2744     "filename": "server/api/chatInternalMessage/index.js",
2745     "groupTitle": "Chat_Internal_Messages"
2746   },
2747   {
2748     "type": "delete",
2749     "url": "/api/chat/internal/messages/{id}",
2750     "title": "Deletes a Message",
2751     "examples": [
2752       {
2753         "title": "Example usage:",
2754         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2755         "type": "json"
2756       }
2757     ],
2758     "name": "DeleteMessages",
2759     "group": "Chat_Internal_Messages",
2760     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2761     "version": "0.0.0",
2762     "filename": "server/api/chatInternalMessage/index.js",
2763     "groupTitle": "Chat_Internal_Messages"
2764   },
2765   {
2766     "type": "get",
2767     "url": "/api/chat/internal/messages/describe",
2768     "title": "Gets table info about Messages",
2769     "examples": [
2770       {
2771         "title": "Example usage:",
2772         "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2773         "type": "json"
2774       }
2775     ],
2776     "name": "DescribeMessages",
2777     "group": "Chat_Internal_Messages",
2778     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2779     "version": "0.0.0",
2780     "filename": "server/api/chatInternalMessage/index.js",
2781     "groupTitle": "Chat_Internal_Messages"
2782   },
2783   {
2784     "type": "get",
2785     "url": "/api/chat/internal/messages",
2786     "title": "Gets a list of Messages",
2787     "examples": [
2788       {
2789         "title": "Example usage:",
2790         "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2791         "type": "json"
2792       }
2793     ],
2794     "name": "GetMessages",
2795     "group": "Chat_Internal_Messages",
2796     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2797     "version": "0.0.0",
2798     "filename": "server/api/chatInternalMessage/index.js",
2799     "groupTitle": "Chat_Internal_Messages"
2800   },
2801   {
2802     "type": "get",
2803     "url": "/api/chat/internal/messages/{id}",
2804     "title": "Gets a single Message",
2805     "examples": [
2806       {
2807         "title": "Example usage:",
2808         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2809         "type": "json"
2810       }
2811     ],
2812     "name": "ShowMessages",
2813     "group": "Chat_Internal_Messages",
2814     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2815     "version": "0.0.0",
2816     "filename": "server/api/chatInternalMessage/index.js",
2817     "groupTitle": "Chat_Internal_Messages"
2818   },
2819   {
2820     "type": "put",
2821     "url": "/api/chat/internal/messages/{id}",
2822     "title": "Update an existing Message",
2823     "examples": [
2824       {
2825         "title": "Example usage:",
2826         "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",
2827         "type": "json"
2828       }
2829     ],
2830     "name": "updateMessages",
2831     "group": "Chat_Internal_Messages",
2832     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2833     "version": "0.0.0",
2834     "filename": "server/api/chatInternalMessage/index.js",
2835     "groupTitle": "Chat_Internal_Messages"
2836   },
2837   {
2838     "type": "post",
2839     "url": "/api/chat/messages",
2840     "title": "Creates a new Message",
2841     "examples": [
2842       {
2843         "title": "Example usage:",
2844         "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2845         "type": "json"
2846       }
2847     ],
2848     "name": "CreateMessages",
2849     "group": "Chat_Messages",
2850     "parameter": {
2851       "fields": {
2852         "Body": [
2853           {
2854             "group": "Body",
2855             "type": "Text",
2856             "optional": false,
2857             "field": "body",
2858             "description": ""
2859           },
2860           {
2861             "group": "Body",
2862             "type": "Boolean",
2863             "optional": true,
2864             "field": "read",
2865             "description": ""
2866           },
2867           {
2868             "group": "Body",
2869             "type": "Boolean",
2870             "optional": true,
2871             "field": "secret",
2872             "description": ""
2873           },
2874           {
2875             "group": "Body",
2876             "type": "String",
2877             "allowedValues": [
2878               "\"in\"",
2879               "\"out\""
2880             ],
2881             "optional": false,
2882             "field": "direction",
2883             "description": ""
2884           },
2885           {
2886             "group": "Body",
2887             "type": "String",
2888             "optional": true,
2889             "field": "readAt",
2890             "description": ""
2891           },
2892           {
2893             "group": "Body",
2894             "type": "String",
2895             "optional": true,
2896             "field": "providerName",
2897             "description": ""
2898           },
2899           {
2900             "group": "Body",
2901             "type": "Text",
2902             "optional": true,
2903             "field": "providerResponse",
2904             "description": ""
2905           }
2906         ]
2907       }
2908     },
2909     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2910     "version": "0.0.0",
2911     "filename": "server/api/chatMessage/index.js",
2912     "groupTitle": "Chat_Messages"
2913   },
2914   {
2915     "type": "delete",
2916     "url": "/api/chat/messages/{id}",
2917     "title": "Deletes a Message",
2918     "examples": [
2919       {
2920         "title": "Example usage:",
2921         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2922         "type": "json"
2923       }
2924     ],
2925     "name": "DeleteMessages",
2926     "group": "Chat_Messages",
2927     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2928     "version": "0.0.0",
2929     "filename": "server/api/chatMessage/index.js",
2930     "groupTitle": "Chat_Messages"
2931   },
2932   {
2933     "type": "get",
2934     "url": "/api/chat/messages/describe",
2935     "title": "Gets table info about Messages",
2936     "examples": [
2937       {
2938         "title": "Example usage:",
2939         "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2940         "type": "json"
2941       }
2942     ],
2943     "name": "DescribeMessages",
2944     "group": "Chat_Messages",
2945     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2946     "version": "0.0.0",
2947     "filename": "server/api/chatMessage/index.js",
2948     "groupTitle": "Chat_Messages"
2949   },
2950   {
2951     "type": "get",
2952     "url": "/api/chat/messages",
2953     "title": "Gets a list of Messages",
2954     "examples": [
2955       {
2956         "title": "Example usage:",
2957         "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2958         "type": "json"
2959       }
2960     ],
2961     "name": "GetMessages",
2962     "group": "Chat_Messages",
2963     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2964     "version": "0.0.0",
2965     "filename": "server/api/chatMessage/index.js",
2966     "groupTitle": "Chat_Messages"
2967   },
2968   {
2969     "type": "get",
2970     "url": "/api/chat/messages/{id}",
2971     "title": "Gets a single Message",
2972     "examples": [
2973       {
2974         "title": "Example usage:",
2975         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2976         "type": "json"
2977       }
2978     ],
2979     "name": "ShowMessages",
2980     "group": "Chat_Messages",
2981     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2982     "version": "0.0.0",
2983     "filename": "server/api/chatMessage/index.js",
2984     "groupTitle": "Chat_Messages"
2985   },
2986   {
2987     "type": "put",
2988     "url": "/api/chat/messages/{id}",
2989     "title": "Update an existing Message",
2990     "examples": [
2991       {
2992         "title": "Example usage:",
2993         "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",
2994         "type": "json"
2995       }
2996     ],
2997     "name": "updateMessages",
2998     "group": "Chat_Messages",
2999     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3000     "version": "0.0.0",
3001     "filename": "server/api/chatMessage/index.js",
3002     "groupTitle": "Chat_Messages"
3003   },
3004   {
3005     "type": "post",
3006     "url": "/api/chat/offline_messages",
3007     "title": "Creates a new OfflineMessage",
3008     "examples": [
3009       {
3010         "title": "Example usage:",
3011         "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",
3012         "type": "json"
3013       }
3014     ],
3015     "name": "CreateOfflineMessages",
3016     "group": "Chat_Offline_Messages",
3017     "parameter": {
3018       "fields": {
3019         "Body": [
3020           {
3021             "group": "Body",
3022             "type": "Text",
3023             "optional": false,
3024             "field": "body",
3025             "description": ""
3026           }
3027         ]
3028       }
3029     },
3030     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3031     "version": "0.0.0",
3032     "filename": "server/api/chatOfflineMessage/index.js",
3033     "groupTitle": "Chat_Offline_Messages"
3034   },
3035   {
3036     "type": "delete",
3037     "url": "/api/chat/offline_messages/{id}",
3038     "title": "Deletes a OfflineMessage",
3039     "examples": [
3040       {
3041         "title": "Example usage:",
3042         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
3043         "type": "json"
3044       }
3045     ],
3046     "name": "DeleteOfflineMessages",
3047     "group": "Chat_Offline_Messages",
3048     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3049     "version": "0.0.0",
3050     "filename": "server/api/chatOfflineMessage/index.js",
3051     "groupTitle": "Chat_Offline_Messages"
3052   },
3053   {
3054     "type": "get",
3055     "url": "/api/chat/offline_messages/describe",
3056     "title": "Gets table info about OfflineMessages",
3057     "examples": [
3058       {
3059         "title": "Example usage:",
3060         "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3061         "type": "json"
3062       }
3063     ],
3064     "name": "DescribeOfflineMessages",
3065     "group": "Chat_Offline_Messages",
3066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3067     "version": "0.0.0",
3068     "filename": "server/api/chatOfflineMessage/index.js",
3069     "groupTitle": "Chat_Offline_Messages"
3070   },
3071   {
3072     "type": "get",
3073     "url": "/api/chat/offline_messages",
3074     "title": "Gets a list of OfflineMessages",
3075     "examples": [
3076       {
3077         "title": "Example usage:",
3078         "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3079         "type": "json"
3080       }
3081     ],
3082     "name": "GetOfflineMessages",
3083     "group": "Chat_Offline_Messages",
3084     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3085     "version": "0.0.0",
3086     "filename": "server/api/chatOfflineMessage/index.js",
3087     "groupTitle": "Chat_Offline_Messages"
3088   },
3089   {
3090     "type": "get",
3091     "url": "/api/chat/offline_messages/{id}",
3092     "title": "Gets a single OfflineMessage",
3093     "examples": [
3094       {
3095         "title": "Example usage:",
3096         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3097         "type": "json"
3098       }
3099     ],
3100     "name": "ShowOfflineMessages",
3101     "group": "Chat_Offline_Messages",
3102     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3103     "version": "0.0.0",
3104     "filename": "server/api/chatOfflineMessage/index.js",
3105     "groupTitle": "Chat_Offline_Messages"
3106   },
3107   {
3108     "type": "put",
3109     "url": "/api/chat/offline_messages/{id}",
3110     "title": "Update an existing OfflineMessage",
3111     "examples": [
3112       {
3113         "title": "Example usage:",
3114         "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",
3115         "type": "json"
3116       }
3117     ],
3118     "name": "updateOfflineMessages",
3119     "group": "Chat_Offline_Messages",
3120     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3121     "version": "0.0.0",
3122     "filename": "server/api/chatOfflineMessage/index.js",
3123     "groupTitle": "Chat_Offline_Messages"
3124   },
3125   {
3126     "type": "post",
3127     "url": "/api/chat/proactive_actions",
3128     "title": "Creates a new Proactive Action",
3129     "examples": [
3130       {
3131         "title": "Example usage:",
3132         "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",
3133         "type": "json"
3134       }
3135     ],
3136     "name": "CreateProactive_Actions",
3137     "group": "Chat_Proactive_Actions",
3138     "parameter": {
3139       "fields": {
3140         "Body": [
3141           {
3142             "group": "Body",
3143             "type": "String",
3144             "optional": false,
3145             "field": "name",
3146             "description": ""
3147           },
3148           {
3149             "group": "Body",
3150             "type": "String",
3151             "allowedValues": [
3152               "\"mouseOver\"",
3153               "\"timeout\""
3154             ],
3155             "optional": true,
3156             "field": "type",
3157             "description": ""
3158           },
3159           {
3160             "group": "Body",
3161             "type": "String",
3162             "optional": true,
3163             "field": "selector",
3164             "description": ""
3165           },
3166           {
3167             "group": "Body",
3168             "type": "Integer",
3169             "optional": true,
3170             "field": "timeout",
3171             "description": ""
3172           }
3173         ]
3174       }
3175     },
3176     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3177     "version": "0.0.0",
3178     "filename": "server/api/chatProactiveAction/index.js",
3179     "groupTitle": "Chat_Proactive_Actions"
3180   },
3181   {
3182     "type": "delete",
3183     "url": "/api/chat/proactive_actions/{id}",
3184     "title": "Deletes a Proactive Action",
3185     "examples": [
3186       {
3187         "title": "Example usage:",
3188         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3189         "type": "json"
3190       }
3191     ],
3192     "name": "DeleteProactive_Actions",
3193     "group": "Chat_Proactive_Actions",
3194     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3195     "version": "0.0.0",
3196     "filename": "server/api/chatProactiveAction/index.js",
3197     "groupTitle": "Chat_Proactive_Actions"
3198   },
3199   {
3200     "type": "get",
3201     "url": "/api/chat/proactive_actions/{id}",
3202     "title": "Gets a single Proactive Action",
3203     "examples": [
3204       {
3205         "title": "Example usage:",
3206         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3207         "type": "json"
3208       }
3209     ],
3210     "name": "ShowProactive_Actions",
3211     "group": "Chat_Proactive_Actions",
3212     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3213     "version": "0.0.0",
3214     "filename": "server/api/chatProactiveAction/index.js",
3215     "groupTitle": "Chat_Proactive_Actions"
3216   },
3217   {
3218     "type": "put",
3219     "url": "/api/chat/proactive_actions/{id}",
3220     "title": "Update an existing Proactive Action",
3221     "examples": [
3222       {
3223         "title": "Example usage:",
3224         "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",
3225         "type": "json"
3226       }
3227     ],
3228     "name": "updateProactive_Actions",
3229     "group": "Chat_Proactive_Actions",
3230     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3231     "version": "0.0.0",
3232     "filename": "server/api/chatProactiveAction/index.js",
3233     "groupTitle": "Chat_Proactive_Actions"
3234   },
3235   {
3236     "type": "post",
3237     "url": "/api/chat/reports/queue",
3238     "title": "Creates a new Chat Queue Report",
3239     "examples": [
3240       {
3241         "title": "Example usage:",
3242         "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",
3243         "type": "json"
3244       }
3245     ],
3246     "name": "CreateChat_Queue_Reports",
3247     "group": "Chat_Queue_Reports",
3248     "parameter": {
3249       "fields": {
3250         "Body": [
3251           {
3252             "group": "Body",
3253             "type": "String",
3254             "optional": false,
3255             "field": "uniqueid",
3256             "description": ""
3257           },
3258           {
3259             "group": "Body",
3260             "type": "String",
3261             "optional": true,
3262             "field": "from",
3263             "description": ""
3264           },
3265           {
3266             "group": "Body",
3267             "type": "String",
3268             "optional": true,
3269             "field": "joinAt",
3270             "description": ""
3271           },
3272           {
3273             "group": "Body",
3274             "type": "String",
3275             "optional": true,
3276             "field": "leaveAt",
3277             "description": ""
3278           },
3279           {
3280             "group": "Body",
3281             "type": "String",
3282             "optional": true,
3283             "field": "acceptAt",
3284             "description": ""
3285           },
3286           {
3287             "group": "Body",
3288             "type": "String",
3289             "optional": true,
3290             "field": "exitAt",
3291             "description": ""
3292           },
3293           {
3294             "group": "Body",
3295             "type": "String",
3296             "optional": true,
3297             "field": "reason",
3298             "description": ""
3299           }
3300         ]
3301       }
3302     },
3303     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3304     "version": "0.0.0",
3305     "filename": "server/api/chatQueueReport/index.js",
3306     "groupTitle": "Chat_Queue_Reports"
3307   },
3308   {
3309     "type": "delete",
3310     "url": "/api/chat/reports/queue/{id}",
3311     "title": "Deletes a Chat Queue Report",
3312     "examples": [
3313       {
3314         "title": "Example usage:",
3315         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3316         "type": "json"
3317       }
3318     ],
3319     "name": "DeleteChat_Queue_Reports",
3320     "group": "Chat_Queue_Reports",
3321     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3322     "version": "0.0.0",
3323     "filename": "server/api/chatQueueReport/index.js",
3324     "groupTitle": "Chat_Queue_Reports"
3325   },
3326   {
3327     "type": "get",
3328     "url": "/api/chat/reports/queue/describe",
3329     "title": "Gets table info about Chat Queue Reports",
3330     "examples": [
3331       {
3332         "title": "Example usage:",
3333         "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3334         "type": "json"
3335       }
3336     ],
3337     "name": "DescribeChat_Queue_Reports",
3338     "group": "Chat_Queue_Reports",
3339     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3340     "version": "0.0.0",
3341     "filename": "server/api/chatQueueReport/index.js",
3342     "groupTitle": "Chat_Queue_Reports"
3343   },
3344   {
3345     "type": "get",
3346     "url": "/api/chat/reports/queue",
3347     "title": "Gets a list of Chat Queue Reports",
3348     "examples": [
3349       {
3350         "title": "Example usage:",
3351         "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3352         "type": "json"
3353       }
3354     ],
3355     "name": "GetChat_Queue_Reports",
3356     "group": "Chat_Queue_Reports",
3357     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3358     "version": "0.0.0",
3359     "filename": "server/api/chatQueueReport/index.js",
3360     "groupTitle": "Chat_Queue_Reports"
3361   },
3362   {
3363     "type": "get",
3364     "url": "/api/chat/reports/queue/{id}",
3365     "title": "Gets a single Chat Queue Report",
3366     "examples": [
3367       {
3368         "title": "Example usage:",
3369         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3370         "type": "json"
3371       }
3372     ],
3373     "name": "ShowChat_Queue_Reports",
3374     "group": "Chat_Queue_Reports",
3375     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3376     "version": "0.0.0",
3377     "filename": "server/api/chatQueueReport/index.js",
3378     "groupTitle": "Chat_Queue_Reports"
3379   },
3380   {
3381     "type": "put",
3382     "url": "/api/chat/reports/queue/{id}",
3383     "title": "Update an existing Chat Queue Report",
3384     "examples": [
3385       {
3386         "title": "Example usage:",
3387         "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",
3388         "type": "json"
3389       }
3390     ],
3391     "name": "updateChat_Queue_Reports",
3392     "group": "Chat_Queue_Reports",
3393     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3394     "version": "0.0.0",
3395     "filename": "server/api/chatQueueReport/index.js",
3396     "groupTitle": "Chat_Queue_Reports"
3397   },
3398   {
3399     "type": "post",
3400     "url": "/api/chat/queues/{id}/users",
3401     "title": "Add agents to a queue",
3402     "examples": [
3403       {
3404         "title": "Example usage:",
3405         "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",
3406         "type": "json"
3407       }
3408     ],
3409     "name": "AddAgents",
3410     "group": "Chat_Queues",
3411     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3412     "version": "0.0.0",
3413     "filename": "server/api/chatQueue/index.js",
3414     "groupTitle": "Chat_Queues"
3415   },
3416   {
3417     "type": "post",
3418     "url": "/api/chat/queues/{id}/teams",
3419     "title": "Add teams to a queue",
3420     "examples": [
3421       {
3422         "title": "Example usage:",
3423         "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",
3424         "type": "json"
3425       }
3426     ],
3427     "name": "AddTeams",
3428     "group": "Chat_Queues",
3429     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3430     "version": "0.0.0",
3431     "filename": "server/api/chatQueue/index.js",
3432     "groupTitle": "Chat_Queues"
3433   },
3434   {
3435     "type": "post",
3436     "url": "/api/chat/queues",
3437     "title": "Creates a new Queue",
3438     "examples": [
3439       {
3440         "title": "Example usage:",
3441         "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3442         "type": "json"
3443       }
3444     ],
3445     "name": "CreateQueues",
3446     "group": "Chat_Queues",
3447     "parameter": {
3448       "fields": {
3449         "Body": [
3450           {
3451             "group": "Body",
3452             "type": "String",
3453             "optional": false,
3454             "field": "name",
3455             "description": ""
3456           },
3457           {
3458             "group": "Body",
3459             "type": "String",
3460             "optional": true,
3461             "field": "description",
3462             "description": ""
3463           },
3464           {
3465             "group": "Body",
3466             "type": "Integer",
3467             "optional": true,
3468             "field": "timeout",
3469             "description": ""
3470           },
3471           {
3472             "group": "Body",
3473             "type": "String",
3474             "allowedValues": [
3475               "\"rrmemory\"",
3476               "\"beepall\"",
3477               "\"roundrobin\""
3478             ],
3479             "optional": true,
3480             "field": "strategy",
3481             "description": ""
3482           }
3483         ]
3484       }
3485     },
3486     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3487     "version": "0.0.0",
3488     "filename": "server/api/chatQueue/index.js",
3489     "groupTitle": "Chat_Queues"
3490   },
3491   {
3492     "type": "delete",
3493     "url": "/api/chat/queues/{id}",
3494     "title": "Deletes a Queue",
3495     "examples": [
3496       {
3497         "title": "Example usage:",
3498         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3499         "type": "json"
3500       }
3501     ],
3502     "name": "DeleteQueues",
3503     "group": "Chat_Queues",
3504     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3505     "version": "0.0.0",
3506     "filename": "server/api/chatQueue/index.js",
3507     "groupTitle": "Chat_Queues"
3508   },
3509   {
3510     "type": "get",
3511     "url": "/api/chat/queues/describe",
3512     "title": "Gets table info about Queues",
3513     "examples": [
3514       {
3515         "title": "Example usage:",
3516         "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3517         "type": "json"
3518       }
3519     ],
3520     "name": "DescribeQueues",
3521     "group": "Chat_Queues",
3522     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3523     "version": "0.0.0",
3524     "filename": "server/api/chatQueue/index.js",
3525     "groupTitle": "Chat_Queues"
3526   },
3527   {
3528     "type": "get",
3529     "url": "/api/chat/queues/{id}/users",
3530     "title": "Gets queue agents",
3531     "examples": [
3532       {
3533         "title": "Example usage:",
3534         "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3535         "type": "json"
3536       }
3537     ],
3538     "name": "GetAgents",
3539     "group": "Chat_Queues",
3540     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3541     "version": "0.0.0",
3542     "filename": "server/api/chatQueue/index.js",
3543     "groupTitle": "Chat_Queues"
3544   },
3545   {
3546     "type": "get",
3547     "url": "/api/chat/queues/{id}/members",
3548     "title": "GetMembers",
3549     "examples": [
3550       {
3551         "title": "Example usage:",
3552         "content": "curl https://{domain}/api/chat/queues/{id}/members  -v -u {name}:{password}",
3553         "type": "json"
3554       }
3555     ],
3556     "name": "GetMembers",
3557     "group": "Chat_Queues",
3558     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3559     "version": "0.0.0",
3560     "filename": "server/api/chatQueue/index.js",
3561     "groupTitle": "Chat_Queues"
3562   },
3563   {
3564     "type": "get",
3565     "url": "/api/chat/queues",
3566     "title": "Gets a list of Queues",
3567     "examples": [
3568       {
3569         "title": "Example usage:",
3570         "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3571         "type": "json"
3572       }
3573     ],
3574     "name": "GetQueues",
3575     "group": "Chat_Queues",
3576     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3577     "version": "0.0.0",
3578     "filename": "server/api/chatQueue/index.js",
3579     "groupTitle": "Chat_Queues"
3580   },
3581   {
3582     "type": "get",
3583     "url": "/api/chat/queues/{id}/teams",
3584     "title": "Gets queues list",
3585     "examples": [
3586       {
3587         "title": "Example usage:",
3588         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3589         "type": "json"
3590       }
3591     ],
3592     "name": "GetTeams",
3593     "group": "Chat_Queues",
3594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3595     "version": "0.0.0",
3596     "filename": "server/api/chatQueue/index.js",
3597     "groupTitle": "Chat_Queues"
3598   },
3599   {
3600     "type": "delete",
3601     "url": "/api/chat/queues/{id}/users",
3602     "title": "Removes agents from a queue",
3603     "examples": [
3604       {
3605         "title": "Example usage:",
3606         "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3607         "type": "json"
3608       }
3609     ],
3610     "name": "RemoveAgents",
3611     "group": "Chat_Queues",
3612     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3613     "version": "0.0.0",
3614     "filename": "server/api/chatQueue/index.js",
3615     "groupTitle": "Chat_Queues"
3616   },
3617   {
3618     "type": "get",
3619     "url": "/api/chat/queues/{id}",
3620     "title": "Gets a single Queue",
3621     "examples": [
3622       {
3623         "title": "Example usage:",
3624         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3625         "type": "json"
3626       }
3627     ],
3628     "name": "ShowQueues",
3629     "group": "Chat_Queues",
3630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3631     "version": "0.0.0",
3632     "filename": "server/api/chatQueue/index.js",
3633     "groupTitle": "Chat_Queues"
3634   },
3635   {
3636     "type": "put",
3637     "url": "/api/chat/queues/{id}",
3638     "title": "Update an existing Queue",
3639     "examples": [
3640       {
3641         "title": "Example usage:",
3642         "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",
3643         "type": "json"
3644       }
3645     ],
3646     "name": "updateQueues",
3647     "group": "Chat_Queues",
3648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3649     "version": "0.0.0",
3650     "filename": "server/api/chatQueue/index.js",
3651     "groupTitle": "Chat_Queues"
3652   },
3653   {
3654     "type": "post",
3655     "url": "/api/chat/reports/transfer",
3656     "title": "Creates a new Chat Transfer Report",
3657     "examples": [
3658       {
3659         "title": "Example usage:",
3660         "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",
3661         "type": "json"
3662       }
3663     ],
3664     "name": "CreateChat_Transfer_Reports",
3665     "group": "Chat_Transfer_Reports",
3666     "parameter": {
3667       "fields": {
3668         "Body": [
3669           {
3670             "group": "Body",
3671             "type": "String",
3672             "optional": false,
3673             "field": "uniqueid",
3674             "description": ""
3675           },
3676           {
3677             "group": "Body",
3678             "type": "String",
3679             "allowedValues": [
3680               "\"account\"",
3681               "\"agent\"",
3682               "\"queue\""
3683             ],
3684             "optional": false,
3685             "field": "type",
3686             "description": ""
3687           },
3688           {
3689             "group": "Body",
3690             "type": "String",
3691             "optional": false,
3692             "field": "transferredAt",
3693             "description": ""
3694           }
3695         ]
3696       }
3697     },
3698     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3699     "version": "0.0.0",
3700     "filename": "server/api/chatTransferReport/index.js",
3701     "groupTitle": "Chat_Transfer_Reports"
3702   },
3703   {
3704     "type": "delete",
3705     "url": "/api/chat/reports/transfer/{id}",
3706     "title": "Deletes a Chat Transfer Report",
3707     "examples": [
3708       {
3709         "title": "Example usage:",
3710         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3711         "type": "json"
3712       }
3713     ],
3714     "name": "DeleteChat_Transfer_Reports",
3715     "group": "Chat_Transfer_Reports",
3716     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3717     "version": "0.0.0",
3718     "filename": "server/api/chatTransferReport/index.js",
3719     "groupTitle": "Chat_Transfer_Reports"
3720   },
3721   {
3722     "type": "get",
3723     "url": "/api/chat/reports/transfer/describe",
3724     "title": "Gets table info about Chat Transfer Reports",
3725     "examples": [
3726       {
3727         "title": "Example usage:",
3728         "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3729         "type": "json"
3730       }
3731     ],
3732     "name": "DescribeChat_Transfer_Reports",
3733     "group": "Chat_Transfer_Reports",
3734     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3735     "version": "0.0.0",
3736     "filename": "server/api/chatTransferReport/index.js",
3737     "groupTitle": "Chat_Transfer_Reports"
3738   },
3739   {
3740     "type": "get",
3741     "url": "/api/chat/reports/transfer",
3742     "title": "Gets a list of Chat Transfer Reports",
3743     "examples": [
3744       {
3745         "title": "Example usage:",
3746         "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3747         "type": "json"
3748       }
3749     ],
3750     "name": "GetChat_Transfer_Reports",
3751     "group": "Chat_Transfer_Reports",
3752     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3753     "version": "0.0.0",
3754     "filename": "server/api/chatTransferReport/index.js",
3755     "groupTitle": "Chat_Transfer_Reports"
3756   },
3757   {
3758     "type": "get",
3759     "url": "/api/chat/reports/transfer/{id}",
3760     "title": "Gets a single Chat Transfer Report",
3761     "examples": [
3762       {
3763         "title": "Example usage:",
3764         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3765         "type": "json"
3766       }
3767     ],
3768     "name": "ShowChat_Transfer_Reports",
3769     "group": "Chat_Transfer_Reports",
3770     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3771     "version": "0.0.0",
3772     "filename": "server/api/chatTransferReport/index.js",
3773     "groupTitle": "Chat_Transfer_Reports"
3774   },
3775   {
3776     "type": "put",
3777     "url": "/api/chat/reports/transfer/{id}",
3778     "title": "Update an existing Chat Transfer Report",
3779     "examples": [
3780       {
3781         "title": "Example usage:",
3782         "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",
3783         "type": "json"
3784       }
3785     ],
3786     "name": "updateChat_Transfer_Reports",
3787     "group": "Chat_Transfer_Reports",
3788     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3789     "version": "0.0.0",
3790     "filename": "server/api/chatTransferReport/index.js",
3791     "groupTitle": "Chat_Transfer_Reports"
3792   },
3793   {
3794     "type": "post",
3795     "url": "/api/chat/websites/{id}/users",
3796     "title": "Add agents to a website",
3797     "examples": [
3798       {
3799         "title": "Example usage:",
3800         "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",
3801         "type": "json"
3802       }
3803     ],
3804     "name": "AddAgents",
3805     "group": "Chat_Websites",
3806     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3807     "version": "0.0.0",
3808     "filename": "server/api/chatWebsite/index.js",
3809     "groupTitle": "Chat_Websites"
3810   },
3811   {
3812     "type": "post",
3813     "url": "/api/chat/websites",
3814     "title": "Creates a new Website",
3815     "examples": [
3816       {
3817         "title": "Example usage:",
3818         "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3819         "type": "json"
3820       }
3821     ],
3822     "name": "CreateWebsites",
3823     "group": "Chat_Websites",
3824     "parameter": {
3825       "fields": {
3826         "Body": [
3827           {
3828             "group": "Body",
3829             "type": "String",
3830             "optional": false,
3831             "field": "name",
3832             "description": ""
3833           },
3834           {
3835             "group": "Body",
3836             "type": "String",
3837             "optional": false,
3838             "field": "address",
3839             "description": ""
3840           },
3841           {
3842             "group": "Body",
3843             "type": "String",
3844             "optional": true,
3845             "field": "description",
3846             "description": ""
3847           },
3848           {
3849             "group": "Body",
3850             "type": "String",
3851             "optional": true,
3852             "field": "mapKey",
3853             "description": ""
3854           },
3855           {
3856             "group": "Body",
3857             "type": "String",
3858             "optional": true,
3859             "field": "mapKeyOffline",
3860             "description": ""
3861           },
3862           {
3863             "group": "Body",
3864             "type": "String",
3865             "optional": false,
3866             "field": "key",
3867             "description": ""
3868           },
3869           {
3870             "group": "Body",
3871             "type": "String",
3872             "optional": true,
3873             "field": "agentAlias",
3874             "description": ""
3875           },
3876           {
3877             "group": "Body",
3878             "type": "String",
3879             "optional": true,
3880             "field": "customerAlias",
3881             "description": ""
3882           },
3883           {
3884             "group": "Body",
3885             "type": "String",
3886             "optional": false,
3887             "field": "color",
3888             "description": ""
3889           },
3890           {
3891             "group": "Body",
3892             "type": "String",
3893             "optional": false,
3894             "field": "color_button",
3895             "description": ""
3896           },
3897           {
3898             "group": "Body",
3899             "type": "String",
3900             "optional": false,
3901             "field": "textColor",
3902             "description": ""
3903           },
3904           {
3905             "group": "Body",
3906             "type": "Integer",
3907             "optional": true,
3908             "field": "fontSize",
3909             "description": ""
3910           },
3911           {
3912             "group": "Body",
3913             "type": "String",
3914             "optional": true,
3915             "field": "remote",
3916             "description": ""
3917           },
3918           {
3919             "group": "Body",
3920             "type": "Boolean",
3921             "optional": true,
3922             "field": "animation",
3923             "description": ""
3924           },
3925           {
3926             "group": "Body",
3927             "type": "String",
3928             "allowedValues": [
3929               "\"rounded\"",
3930               "\"squared\""
3931             ],
3932             "optional": true,
3933             "field": "header_shape",
3934             "description": ""
3935           },
3936           {
3937             "group": "Body",
3938             "type": "String",
3939             "optional": true,
3940             "field": "header_online",
3941             "description": ""
3942           },
3943           {
3944             "group": "Body",
3945             "type": "String",
3946             "optional": true,
3947             "field": "start_chat_button",
3948             "description": ""
3949           },
3950           {
3951             "group": "Body",
3952             "type": "String",
3953             "optional": true,
3954             "field": "offline_chat_button",
3955             "description": ""
3956           },
3957           {
3958             "group": "Body",
3959             "type": "String",
3960             "optional": true,
3961             "field": "header_offline",
3962             "description": ""
3963           },
3964           {
3965             "group": "Body",
3966             "type": "Boolean",
3967             "optional": true,
3968             "field": "download_transcript",
3969             "description": ""
3970           },
3971           {
3972             "group": "Body",
3973             "type": "Integer",
3974             "optional": true,
3975             "field": "timeout",
3976             "description": ""
3977           },
3978           {
3979             "group": "Body",
3980             "type": "String",
3981             "optional": true,
3982             "field": "whiteLabel",
3983             "description": ""
3984           },
3985           {
3986             "group": "Body",
3987             "type": "Boolean",
3988             "optional": true,
3989             "field": "defaultWhiteLabel",
3990             "description": ""
3991           },
3992           {
3993             "group": "Body",
3994             "type": "Text",
3995             "optional": true,
3996             "field": "sitepic",
3997             "description": ""
3998           },
3999           {
4000             "group": "Body",
4001             "type": "String",
4002             "optional": true,
4003             "field": "closingQuestion",
4004             "description": ""
4005           },
4006           {
4007             "group": "Body",
4008             "type": "String",
4009             "optional": true,
4010             "field": "formSubmitSuccessMessage",
4011             "description": ""
4012           },
4013           {
4014             "group": "Body",
4015             "type": "String",
4016             "optional": true,
4017             "field": "formSubmitFailureMessage",
4018             "description": ""
4019           },
4020           {
4021             "group": "Body",
4022             "type": "String",
4023             "optional": true,
4024             "field": "noteTitle",
4025             "description": ""
4026           },
4027           {
4028             "group": "Body",
4029             "type": "String",
4030             "optional": true,
4031             "field": "placeholderMessage",
4032             "description": ""
4033           },
4034           {
4035             "group": "Body",
4036             "type": "String",
4037             "optional": true,
4038             "field": "closingMessage",
4039             "description": ""
4040           },
4041           {
4042             "group": "Body",
4043             "type": "String",
4044             "optional": true,
4045             "field": "closingMessageButton",
4046             "description": ""
4047           },
4048           {
4049             "group": "Body",
4050             "type": "String",
4051             "optional": true,
4052             "field": "skipMessageButton",
4053             "description": ""
4054           },
4055           {
4056             "group": "Body",
4057             "type": "Boolean",
4058             "optional": true,
4059             "field": "conditionAgreement",
4060             "description": ""
4061           },
4062           {
4063             "group": "Body",
4064             "type": "Boolean",
4065             "optional": true,
4066             "field": "enableRating",
4067             "description": ""
4068           },
4069           {
4070             "group": "Body",
4071             "type": "Boolean",
4072             "optional": true,
4073             "field": "enableFeedback",
4074             "description": ""
4075           },
4076           {
4077             "group": "Body",
4078             "type": "Boolean",
4079             "optional": true,
4080             "field": "enableSendButton",
4081             "description": ""
4082           },
4083           {
4084             "group": "Body",
4085             "type": "String",
4086             "optional": true,
4087             "field": "feedbackTitle",
4088             "description": ""
4089           },
4090           {
4091             "group": "Body",
4092             "type": "String",
4093             "allowedValues": [
4094               "\"star\"",
4095               "\"thumb\""
4096             ],
4097             "optional": true,
4098             "field": "ratingType",
4099             "description": ""
4100           },
4101           {
4102             "group": "Body",
4103             "type": "Integer",
4104             "optional": true,
4105             "field": "ratingStarsNumber",
4106             "description": ""
4107           },
4108           {
4109             "group": "Body",
4110             "type": "Text",
4111             "optional": true,
4112             "field": "onlineForm",
4113             "description": ""
4114           },
4115           {
4116             "group": "Body",
4117             "type": "Text",
4118             "optional": true,
4119             "field": "offlineForm",
4120             "description": ""
4121           },
4122           {
4123             "group": "Body",
4124             "type": "String",
4125             "optional": true,
4126             "field": "token",
4127             "description": ""
4128           },
4129           {
4130             "group": "Body",
4131             "type": "Boolean",
4132             "optional": true,
4133             "field": "autoclose",
4134             "description": ""
4135           },
4136           {
4137             "group": "Body",
4138             "type": "Boolean",
4139             "optional": true,
4140             "field": "enableCustomerWriting",
4141             "description": ""
4142           },
4143           {
4144             "group": "Body",
4145             "type": "Boolean",
4146             "optional": true,
4147             "field": "forwardTranscript",
4148             "description": ""
4149           },
4150           {
4151             "group": "Body",
4152             "type": "String",
4153             "optional": true,
4154             "field": "forwardTranscriptMessage",
4155             "description": ""
4156           },
4157           {
4158             "group": "Body",
4159             "type": "Boolean",
4160             "optional": true,
4161             "field": "forwardOffline",
4162             "description": ""
4163           },
4164           {
4165             "group": "Body",
4166             "type": "String",
4167             "optional": true,
4168             "field": "forwardOfflineAddress",
4169             "description": ""
4170           },
4171           {
4172             "group": "Body",
4173             "type": "String",
4174             "optional": true,
4175             "field": "waitingTitle",
4176             "description": ""
4177           },
4178           {
4179             "group": "Body",
4180             "type": "String",
4181             "optional": true,
4182             "field": "waitingMessage",
4183             "description": ""
4184           },
4185           {
4186             "group": "Body",
4187             "type": "String",
4188             "optional": true,
4189             "field": "offlineMessageSubject",
4190             "description": ""
4191           },
4192           {
4193             "group": "Body",
4194             "type": "String",
4195             "optional": true,
4196             "field": "offlineMessageBody",
4197             "description": ""
4198           },
4199           {
4200             "group": "Body",
4201             "type": "Boolean",
4202             "optional": true,
4203             "field": "enableUnmanagedNote",
4204             "description": ""
4205           },
4206           {
4207             "group": "Body",
4208             "type": "String",
4209             "optional": true,
4210             "field": "unmanagedMessage",
4211             "description": ""
4212           },
4213           {
4214             "group": "Body",
4215             "type": "String",
4216             "optional": true,
4217             "field": "skipUnmanaged",
4218             "description": ""
4219           },
4220           {
4221             "group": "Body",
4222             "type": "String",
4223             "optional": true,
4224             "field": "sendUnmanaged",
4225             "description": ""
4226           },
4227           {
4228             "group": "Body",
4229             "type": "Boolean",
4230             "optional": true,
4231             "field": "enableCustomerAttachment",
4232             "description": ""
4233           },
4234           {
4235             "group": "Body",
4236             "type": "Boolean",
4237             "optional": true,
4238             "field": "enableCustomerCheckmarks",
4239             "description": ""
4240           },
4241           {
4242             "group": "Body",
4243             "type": "Text",
4244             "optional": true,
4245             "field": "agentAvatar",
4246             "description": ""
4247           },
4248           {
4249             "group": "Body",
4250             "type": "Boolean",
4251             "optional": true,
4252             "field": "showAgentAvatar",
4253             "description": ""
4254           },
4255           {
4256             "group": "Body",
4257             "type": "String",
4258             "optional": true,
4259             "field": "timezone",
4260             "description": ""
4261           },
4262           {
4263             "group": "Body",
4264             "type": "Text",
4265             "optional": true,
4266             "field": "notificationTemplate",
4267             "description": ""
4268           },
4269           {
4270             "group": "Body",
4271             "type": "Boolean",
4272             "optional": true,
4273             "field": "notificationSound",
4274             "description": ""
4275           },
4276           {
4277             "group": "Body",
4278             "type": "Boolean",
4279             "optional": true,
4280             "field": "notificationShake",
4281             "description": ""
4282           },
4283           {
4284             "group": "Body",
4285             "type": "Boolean",
4286             "optional": true,
4287             "field": "hideWhenOffline",
4288             "description": ""
4289           },
4290           {
4291             "group": "Body",
4292             "type": "String",
4293             "optional": true,
4294             "field": "agentIdentifier",
4295             "description": ""
4296           },
4297           {
4298             "group": "Body",
4299             "type": "Integer",
4300             "optional": true,
4301             "field": "waitForTheAssignedAgent",
4302             "description": ""
4303           },
4304           {
4305             "group": "Body",
4306             "type": "String",
4307             "optional": true,
4308             "field": "alignment",
4309             "description": ""
4310           },
4311           {
4312             "group": "Body",
4313             "type": "Integer",
4314             "optional": true,
4315             "field": "verticalAlignment",
4316             "description": ""
4317           },
4318           {
4319             "group": "Body",
4320             "type": "String",
4321             "optional": true,
4322             "field": "labelText",
4323             "description": ""
4324           },
4325           {
4326             "group": "Body",
4327             "type": "String",
4328             "optional": true,
4329             "field": "messagesAlignment",
4330             "description": ""
4331           },
4332           {
4333             "group": "Body",
4334             "type": "String",
4335             "optional": true,
4336             "field": "defaultTitle",
4337             "description": ""
4338           },
4339           {
4340             "group": "Body",
4341             "type": "Text",
4342             "optional": true,
4343             "field": "customerAvatar",
4344             "description": ""
4345           },
4346           {
4347             "group": "Body",
4348             "type": "Boolean",
4349             "optional": true,
4350             "field": "showCustomerAvatar",
4351             "description": ""
4352           },
4353           {
4354             "group": "Body",
4355             "type": "Integer",
4356             "optional": true,
4357             "field": "messageFontSize",
4358             "description": ""
4359           },
4360           {
4361             "group": "Body",
4362             "type": "String",
4363             "optional": false,
4364             "field": "backgroundColor",
4365             "description": ""
4366           },
4367           {
4368             "group": "Body",
4369             "type": "Boolean",
4370             "optional": true,
4371             "field": "queueTransfer",
4372             "description": ""
4373           },
4374           {
4375             "group": "Body",
4376             "type": "Integer",
4377             "optional": true,
4378             "field": "queueTransferTimeout",
4379             "description": ""
4380           },
4381           {
4382             "group": "Body",
4383             "type": "Boolean",
4384             "optional": true,
4385             "field": "agentTransfer",
4386             "description": ""
4387           },
4388           {
4389             "group": "Body",
4390             "type": "Integer",
4391             "optional": true,
4392             "field": "agentTransferTimeout",
4393             "description": ""
4394           },
4395           {
4396             "group": "Body",
4397             "type": "String",
4398             "optional": true,
4399             "field": "systemAlias",
4400             "description": ""
4401           },
4402           {
4403             "group": "Body",
4404             "type": "Text",
4405             "optional": true,
4406             "field": "systemAvatar",
4407             "description": ""
4408           },
4409           {
4410             "group": "Body",
4411             "type": "Integer",
4412             "optional": true,
4413             "field": "mandatoryDispositionPauseId",
4414             "description": "<p>Status to put when mandatory disposition is enabled</p>"
4415           },
4416           {
4417             "group": "Body",
4418             "type": "Boolean",
4419             "optional": true,
4420             "field": "mandatoryDisposition",
4421             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4422           },
4423           {
4424             "group": "Body",
4425             "type": "Boolean",
4426             "optional": true,
4427             "field": "vidaooEscalation",
4428             "description": ""
4429           },
4430           {
4431             "group": "Body",
4432             "type": "String",
4433             "optional": true,
4434             "field": "vidaooApiKey",
4435             "description": ""
4436           },
4437           {
4438             "group": "Body",
4439             "type": "String",
4440             "optional": false,
4441             "field": "vidaooTopic",
4442             "description": ""
4443           },
4444           {
4445             "group": "Body",
4446             "type": "String",
4447             "optional": true,
4448             "field": "vidaooNote",
4449             "description": ""
4450           },
4451           {
4452             "group": "Body",
4453             "type": "Text",
4454             "optional": true,
4455             "field": "vidaooMetadata",
4456             "description": ""
4457           },
4458           {
4459             "group": "Body",
4460             "type": "Boolean",
4461             "optional": true,
4462             "field": "openNewInteraction",
4463             "description": ""
4464           },
4465           {
4466             "group": "Body",
4467             "type": "Text",
4468             "optional": true,
4469             "field": "subjectOffline",
4470             "description": ""
4471           }
4472         ]
4473       }
4474     },
4475     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4476     "version": "0.0.0",
4477     "filename": "server/api/chatWebsite/index.js",
4478     "groupTitle": "Chat_Websites"
4479   },
4480   {
4481     "type": "delete",
4482     "url": "/api/chat/websites/{id}",
4483     "title": "Deletes a Website",
4484     "examples": [
4485       {
4486         "title": "Example usage:",
4487         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4488         "type": "json"
4489       }
4490     ],
4491     "name": "DeleteWebsites",
4492     "group": "Chat_Websites",
4493     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4494     "version": "0.0.0",
4495     "filename": "server/api/chatWebsite/index.js",
4496     "groupTitle": "Chat_Websites"
4497   },
4498   {
4499     "type": "get",
4500     "url": "/api/chat/websites/describe",
4501     "title": "Gets table info about Websites",
4502     "examples": [
4503       {
4504         "title": "Example usage:",
4505         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4506         "type": "json"
4507       }
4508     ],
4509     "name": "DescribeWebsites",
4510     "group": "Chat_Websites",
4511     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4512     "version": "0.0.0",
4513     "filename": "server/api/chatWebsite/index.js",
4514     "groupTitle": "Chat_Websites"
4515   },
4516   {
4517     "type": "get",
4518     "url": "/api/chat/websites/{id}/users",
4519     "title": "Gets agents from website",
4520     "examples": [
4521       {
4522         "title": "Example usage:",
4523         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4524         "type": "json"
4525       }
4526     ],
4527     "name": "GetAgents",
4528     "group": "Chat_Websites",
4529     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4530     "version": "0.0.0",
4531     "filename": "server/api/chatWebsite/index.js",
4532     "groupTitle": "Chat_Websites"
4533   },
4534   {
4535     "type": "get",
4536     "url": "/api/chat/websites",
4537     "title": "Gets a list of Websites",
4538     "examples": [
4539       {
4540         "title": "Example usage:",
4541         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4542         "type": "json"
4543       }
4544     ],
4545     "name": "GetWebsites",
4546     "group": "Chat_Websites",
4547     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4548     "version": "0.0.0",
4549     "filename": "server/api/chatWebsite/index.js",
4550     "groupTitle": "Chat_Websites"
4551   },
4552   {
4553     "type": "delete",
4554     "url": "/api/chat/websites/{id}/users",
4555     "title": "Removes agents from a website",
4556     "examples": [
4557       {
4558         "title": "Example usage:",
4559         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4560         "type": "json"
4561       }
4562     ],
4563     "name": "RemoveAgents",
4564     "group": "Chat_Websites",
4565     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4566     "version": "0.0.0",
4567     "filename": "server/api/chatWebsite/index.js",
4568     "groupTitle": "Chat_Websites"
4569   },
4570   {
4571     "type": "delete",
4572     "url": "/api/chat/websites/{id}/canned_answers",
4573     "title": "Removes canned answers from account",
4574     "examples": [
4575       {
4576         "title": "Example usage:",
4577         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4578         "type": "json"
4579       }
4580     ],
4581     "name": "RemoveAnswers",
4582     "group": "Chat_Websites",
4583     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4584     "version": "0.0.0",
4585     "filename": "server/api/chatWebsite/index.js",
4586     "groupTitle": "Chat_Websites"
4587   },
4588   {
4589     "type": "delete",
4590     "url": "/api/chat/websites/{id}/dispositions",
4591     "title": "Removes canned answers from account",
4592     "examples": [
4593       {
4594         "title": "Example usage:",
4595         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4596         "type": "json"
4597       }
4598     ],
4599     "name": "RemoveDispositions",
4600     "group": "Chat_Websites",
4601     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4602     "version": "0.0.0",
4603     "filename": "server/api/chatWebsite/index.js",
4604     "groupTitle": "Chat_Websites"
4605   },
4606   {
4607     "type": "get",
4608     "url": "/api/chat/websites/{id}",
4609     "title": "Gets a single Website",
4610     "examples": [
4611       {
4612         "title": "Example usage:",
4613         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4614         "type": "json"
4615       }
4616     ],
4617     "name": "ShowWebsites",
4618     "group": "Chat_Websites",
4619     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4620     "version": "0.0.0",
4621     "filename": "server/api/chatWebsite/index.js",
4622     "groupTitle": "Chat_Websites"
4623   },
4624   {
4625     "type": "put",
4626     "url": "/api/chat/messages/{id}/accept",
4627     "title": "Accepts message",
4628     "examples": [
4629       {
4630         "title": "Example usage:",
4631         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4632         "type": "json"
4633       }
4634     ],
4635     "name": "acceptMessage",
4636     "group": "Chat_Websites",
4637     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4638     "version": "0.0.0",
4639     "filename": "server/api/chatMessage/index.js",
4640     "groupTitle": "Chat_Websites"
4641   },
4642   {
4643     "type": "post",
4644     "url": "/api/chat/websites/{id}/canned_answers",
4645     "title": "Creates new canned answer",
4646     "examples": [
4647       {
4648         "title": "Example usage:",
4649         "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",
4650         "type": "json"
4651       }
4652     ],
4653     "name": "addAnswer",
4654     "group": "Chat_Websites",
4655     "parameter": {
4656       "fields": {
4657         "Body": [
4658           {
4659             "group": "Body",
4660             "type": "String",
4661             "optional": false,
4662             "field": "key",
4663             "description": ""
4664           },
4665           {
4666             "group": "Body",
4667             "type": "Text",
4668             "optional": false,
4669             "field": "value",
4670             "description": ""
4671           },
4672           {
4673             "group": "Body",
4674             "type": "String",
4675             "optional": true,
4676             "field": "description",
4677             "description": ""
4678           },
4679           {
4680             "group": "Body",
4681             "type": "Virtual",
4682             "optional": true,
4683             "field": "name",
4684             "description": ""
4685           }
4686         ]
4687       }
4688     },
4689     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4690     "version": "0.0.0",
4691     "filename": "server/api/chatWebsite/index.js",
4692     "groupTitle": "Chat_Websites"
4693   },
4694   {
4695     "type": "post",
4696     "url": "/api/chat/websites/{id}/applications",
4697     "title": "Creates new applications",
4698     "examples": [
4699       {
4700         "title": "Example usage:",
4701         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4702         "type": "json"
4703       }
4704     ],
4705     "name": "addApplications",
4706     "group": "Chat_Websites",
4707     "parameter": {
4708       "fields": {
4709         "Body": [
4710           {
4711             "group": "Body",
4712             "type": "Integer",
4713             "optional": false,
4714             "field": "priority",
4715             "description": ""
4716           },
4717           {
4718             "group": "Body",
4719             "type": "String",
4720             "optional": false,
4721             "field": "app",
4722             "description": ""
4723           },
4724           {
4725             "group": "Body",
4726             "type": "Text",
4727             "optional": true,
4728             "field": "appdata",
4729             "description": ""
4730           },
4731           {
4732             "group": "Body",
4733             "type": "String",
4734             "optional": true,
4735             "field": "description",
4736             "description": ""
4737           },
4738           {
4739             "group": "Body",
4740             "type": "String",
4741             "optional": true,
4742             "field": "interval",
4743             "description": ""
4744           }
4745         ]
4746       }
4747     },
4748     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4749     "version": "0.0.0",
4750     "filename": "server/api/chatWebsite/index.js",
4751     "groupTitle": "Chat_Websites"
4752   },
4753   {
4754     "type": "post",
4755     "url": "/api/chat/websites/{id}/avatar",
4756     "title": "Add avatar",
4757     "examples": [
4758       {
4759         "title": "Example usage:",
4760         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4761         "type": "json"
4762       }
4763     ],
4764     "name": "addAvatar",
4765     "group": "Chat_Websites",
4766     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4767     "version": "0.0.0",
4768     "filename": "server/api/chatWebsite/index.js",
4769     "groupTitle": "Chat_Websites"
4770   },
4771   {
4772     "type": "post",
4773     "url": "/api/chat/websites/{id}/customer_avatar",
4774     "title": "Add customer avatar",
4775     "examples": [
4776       {
4777         "title": "Example usage:",
4778         "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",
4779         "type": "json"
4780       }
4781     ],
4782     "name": "addCustomerAvatar",
4783     "group": "Chat_Websites",
4784     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4785     "version": "0.0.0",
4786     "filename": "server/api/chatWebsite/index.js",
4787     "groupTitle": "Chat_Websites"
4788   },
4789   {
4790     "type": "post",
4791     "url": "/api/chat/websites/{id}/dispositions",
4792     "title": "Creates new disposition",
4793     "examples": [
4794       {
4795         "title": "Example usage:",
4796         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4797         "type": "json"
4798       }
4799     ],
4800     "name": "addDisposition",
4801     "group": "Chat_Websites",
4802     "parameter": {
4803       "fields": {
4804         "Body": [
4805           {
4806             "group": "Body",
4807             "type": "String",
4808             "optional": false,
4809             "field": "name",
4810             "description": ""
4811           },
4812           {
4813             "group": "Body",
4814             "type": "String",
4815             "allowedValues": [
4816               "\"first\"",
4817               "\"second\"",
4818               "\"third\""
4819             ],
4820             "optional": false,
4821             "field": "level",
4822             "description": ""
4823           },
4824           {
4825             "group": "Body",
4826             "type": "String",
4827             "optional": true,
4828             "field": "description",
4829             "description": ""
4830           }
4831         ]
4832       }
4833     },
4834     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4835     "version": "0.0.0",
4836     "filename": "server/api/chatWebsite/index.js",
4837     "groupTitle": "Chat_Websites"
4838   },
4839   {
4840     "type": "post",
4841     "url": "/api/chat/accounts/{id}/interactions",
4842     "title": "Creates new interactions",
4843     "examples": [
4844       {
4845         "title": "Example usage:",
4846         "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",
4847         "type": "json"
4848       }
4849     ],
4850     "name": "addInteraction",
4851     "group": "Chat_Websites",
4852     "parameter": {
4853       "fields": {
4854         "Body": [
4855           {
4856             "group": "Body",
4857             "type": "Boolean",
4858             "optional": true,
4859             "field": "closed",
4860             "description": ""
4861           },
4862           {
4863             "group": "Body",
4864             "type": "Integer",
4865             "optional": true,
4866             "field": "ratingValue",
4867             "description": ""
4868           },
4869           {
4870             "group": "Body",
4871             "type": "String",
4872             "allowedValues": [
4873               "\"star\"",
4874               "\"thumb\""
4875             ],
4876             "optional": true,
4877             "field": "ratingType",
4878             "description": ""
4879           },
4880           {
4881             "group": "Body",
4882             "type": "Text",
4883             "optional": true,
4884             "field": "ratingMessage",
4885             "description": ""
4886           },
4887           {
4888             "group": "Body",
4889             "type": "Text",
4890             "optional": true,
4891             "field": "pathTranscript",
4892             "description": ""
4893           },
4894           {
4895             "group": "Body",
4896             "type": "String",
4897             "optional": true,
4898             "field": "mailTranscript",
4899             "description": ""
4900           },
4901           {
4902             "group": "Body",
4903             "type": "String",
4904             "optional": true,
4905             "field": "closedAt",
4906             "description": ""
4907           },
4908           {
4909             "group": "Body",
4910             "type": "String",
4911             "optional": true,
4912             "field": "disposition",
4913             "description": ""
4914           },
4915           {
4916             "group": "Body",
4917             "type": "String",
4918             "optional": true,
4919             "field": "secondDisposition",
4920             "description": ""
4921           },
4922           {
4923             "group": "Body",
4924             "type": "String",
4925             "optional": true,
4926             "field": "thirdDisposition",
4927             "description": ""
4928           },
4929           {
4930             "group": "Body",
4931             "type": "String",
4932             "optional": true,
4933             "field": "note",
4934             "description": ""
4935           },
4936           {
4937             "group": "Body",
4938             "type": "String",
4939             "optional": true,
4940             "field": "browserName",
4941             "description": ""
4942           },
4943           {
4944             "group": "Body",
4945             "type": "String",
4946             "optional": true,
4947             "field": "browserVersion",
4948             "description": ""
4949           },
4950           {
4951             "group": "Body",
4952             "type": "String",
4953             "optional": true,
4954             "field": "osName",
4955             "description": ""
4956           },
4957           {
4958             "group": "Body",
4959             "type": "String",
4960             "optional": true,
4961             "field": "osVersion",
4962             "description": ""
4963           },
4964           {
4965             "group": "Body",
4966             "type": "String",
4967             "optional": true,
4968             "field": "deviceModel",
4969             "description": ""
4970           },
4971           {
4972             "group": "Body",
4973             "type": "String",
4974             "optional": true,
4975             "field": "deviceVendor",
4976             "description": ""
4977           },
4978           {
4979             "group": "Body",
4980             "type": "String",
4981             "optional": true,
4982             "field": "deviceType",
4983             "description": ""
4984           },
4985           {
4986             "group": "Body",
4987             "type": "Text",
4988             "optional": true,
4989             "field": "referer",
4990             "description": ""
4991           },
4992           {
4993             "group": "Body",
4994             "type": "String",
4995             "optional": true,
4996             "field": "customerIp",
4997             "description": ""
4998           },
4999           {
5000             "group": "Body",
5001             "type": "Text",
5002             "optional": true,
5003             "field": "formData",
5004             "description": ""
5005           },
5006           {
5007             "group": "Body",
5008             "type": "String",
5009             "optional": true,
5010             "field": "read1stAt",
5011             "description": ""
5012           },
5013           {
5014             "group": "Body",
5015             "type": "String",
5016             "optional": true,
5017             "field": "lastMsgAt",
5018             "description": ""
5019           },
5020           {
5021             "group": "Body",
5022             "type": "String",
5023             "allowedValues": [
5024               "\"in\"",
5025               "\"out\""
5026             ],
5027             "optional": false,
5028             "field": "lastMsgDirection",
5029             "description": ""
5030           },
5031           {
5032             "group": "Body",
5033             "type": "String",
5034             "optional": true,
5035             "field": "closeReason",
5036             "description": ""
5037           },
5038           {
5039             "group": "Body",
5040             "type": "String",
5041             "optional": true,
5042             "field": "customerPort",
5043             "description": ""
5044           },
5045           {
5046             "group": "Body",
5047             "type": "Text",
5048             "optional": true,
5049             "field": "vidaooSessionId",
5050             "description": ""
5051           },
5052           {
5053             "group": "Body",
5054             "type": "Boolean",
5055             "optional": true,
5056             "field": "autoreplyExecuted",
5057             "description": ""
5058           }
5059         ]
5060       }
5061     },
5062     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5063     "version": "0.0.0",
5064     "filename": "server/api/chatWebsite/index.js",
5065     "groupTitle": "Chat_Websites"
5066   },
5067   {
5068     "type": "post",
5069     "url": "/api/chat/websites/{id}/logo",
5070     "title": "Add logo",
5071     "examples": [
5072       {
5073         "title": "Example usage:",
5074         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5075         "type": "json"
5076       }
5077     ],
5078     "name": "addLogo",
5079     "group": "Chat_Websites",
5080     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5081     "version": "0.0.0",
5082     "filename": "server/api/chatWebsite/index.js",
5083     "groupTitle": "Chat_Websites"
5084   },
5085   {
5086     "type": "post",
5087     "url": "/api/chat/websites/{id}/proactive_actions",
5088     "title": "Creates new Proactive Actions",
5089     "examples": [
5090       {
5091         "title": "Example usage:",
5092         "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",
5093         "type": "json"
5094       }
5095     ],
5096     "name": "addProactiveActions",
5097     "group": "Chat_Websites",
5098     "parameter": {
5099       "fields": {
5100         "Body": [
5101           {
5102             "group": "Body",
5103             "type": "String",
5104             "optional": false,
5105             "field": "name",
5106             "description": ""
5107           },
5108           {
5109             "group": "Body",
5110             "type": "String",
5111             "allowedValues": [
5112               "\"mouseOver\"",
5113               "\"timeout\""
5114             ],
5115             "optional": true,
5116             "field": "type",
5117             "description": ""
5118           },
5119           {
5120             "group": "Body",
5121             "type": "String",
5122             "optional": true,
5123             "field": "selector",
5124             "description": ""
5125           },
5126           {
5127             "group": "Body",
5128             "type": "Integer",
5129             "optional": true,
5130             "field": "timeout",
5131             "description": ""
5132           }
5133         ]
5134       }
5135     },
5136     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5137     "version": "0.0.0",
5138     "filename": "server/api/chatWebsite/index.js",
5139     "groupTitle": "Chat_Websites"
5140   },
5141   {
5142     "type": "post",
5143     "url": "/api/chat/websites/{id}/system_avatar",
5144     "title": "Add system avatar",
5145     "examples": [
5146       {
5147         "title": "Example usage:",
5148         "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",
5149         "type": "json"
5150       }
5151     ],
5152     "name": "addSystemAvatar",
5153     "group": "Chat_Websites",
5154     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5155     "version": "0.0.0",
5156     "filename": "server/api/chatWebsite/index.js",
5157     "groupTitle": "Chat_Websites"
5158   },
5159   {
5160     "type": "get",
5161     "url": "/api/chat/websites/{id}/canned_answers",
5162     "title": "Gets account canned answers",
5163     "examples": [
5164       {
5165         "title": "Example usage:",
5166         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5167         "type": "json"
5168       }
5169     ],
5170     "name": "getAnswers",
5171     "group": "Chat_Websites",
5172     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5173     "version": "0.0.0",
5174     "filename": "server/api/chatWebsite/index.js",
5175     "groupTitle": "Chat_Websites"
5176   },
5177   {
5178     "type": "get",
5179     "url": "/api/chat/websites/{id}/applications",
5180     "title": "Gets Website Applications",
5181     "examples": [
5182       {
5183         "title": "Example usage:",
5184         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5185         "type": "json"
5186       }
5187     ],
5188     "name": "getApplications",
5189     "group": "Chat_Websites",
5190     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5191     "version": "0.0.0",
5192     "filename": "server/api/chatWebsite/index.js",
5193     "groupTitle": "Chat_Websites"
5194   },
5195   {
5196     "type": "get",
5197     "url": "/api/chat/websites/{id}/avatar",
5198     "title": "Get avatar",
5199     "examples": [
5200       {
5201         "title": "Example usage:",
5202         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5203         "type": "json"
5204       }
5205     ],
5206     "name": "getAvatar",
5207     "group": "Chat_Websites",
5208     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5209     "version": "0.0.0",
5210     "filename": "server/api/chatWebsite/index.js",
5211     "groupTitle": "Chat_Websites"
5212   },
5213   {
5214     "type": "get",
5215     "url": "/api/chat/websites/{id}/customer_avatar",
5216     "title": "Get Customer Avatar",
5217     "examples": [
5218       {
5219         "title": "Example usage:",
5220         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5221         "type": "json"
5222       }
5223     ],
5224     "name": "getCustomerAvatar",
5225     "group": "Chat_Websites",
5226     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5227     "version": "0.0.0",
5228     "filename": "server/api/chatWebsite/index.js",
5229     "groupTitle": "Chat_Websites"
5230   },
5231   {
5232     "type": "get",
5233     "url": "/api/chat/websites/{id}/dispositions",
5234     "title": "Gets account dispositions",
5235     "examples": [
5236       {
5237         "title": "Example usage:",
5238         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5239         "type": "json"
5240       }
5241     ],
5242     "name": "getDispositions",
5243     "group": "Chat_Websites",
5244     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5245     "version": "0.0.0",
5246     "filename": "server/api/chatWebsite/index.js",
5247     "groupTitle": "Chat_Websites"
5248   },
5249   {
5250     "type": "get",
5251     "url": "/api/chat/websites/{id}/fields",
5252     "title": "Gets Website Fields",
5253     "examples": [
5254       {
5255         "title": "Example usage:",
5256         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5257         "type": "json"
5258       }
5259     ],
5260     "name": "getFields",
5261     "group": "Chat_Websites",
5262     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5263     "version": "0.0.0",
5264     "filename": "server/api/chatWebsite/index.js",
5265     "groupTitle": "Chat_Websites"
5266   },
5267   {
5268     "type": "get",
5269     "url": "/api/chat/websites/{id}/interactions",
5270     "title": "Gets Website Interactions",
5271     "examples": [
5272       {
5273         "title": "Example usage:",
5274         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5275         "type": "json"
5276       }
5277     ],
5278     "name": "getInteraction",
5279     "group": "Chat_Websites",
5280     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5281     "version": "0.0.0",
5282     "filename": "server/api/chatWebsite/index.js",
5283     "groupTitle": "Chat_Websites"
5284   },
5285   {
5286     "type": "get",
5287     "url": "/api/chat/websites/{id}/logo",
5288     "title": "Get logo",
5289     "examples": [
5290       {
5291         "title": "Example usage:",
5292         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5293         "type": "json"
5294       }
5295     ],
5296     "name": "getLogo",
5297     "group": "Chat_Websites",
5298     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5299     "version": "0.0.0",
5300     "filename": "server/api/chatWebsite/index.js",
5301     "groupTitle": "Chat_Websites"
5302   },
5303   {
5304     "type": "get",
5305     "url": "/api/chat/websites/{id}/offline_messages",
5306     "title": "Gets Website Offline Messages",
5307     "examples": [
5308       {
5309         "title": "Example usage:",
5310         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5311         "type": "json"
5312       }
5313     ],
5314     "name": "getOfflineMessages",
5315     "group": "Chat_Websites",
5316     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5317     "version": "0.0.0",
5318     "filename": "server/api/chatWebsite/index.js",
5319     "groupTitle": "Chat_Websites"
5320   },
5321   {
5322     "type": "get",
5323     "url": "/api/chat/websites/{id}/proactive_actions",
5324     "title": "Gets Website Proactive Actions",
5325     "examples": [
5326       {
5327         "title": "Example usage:",
5328         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5329         "type": "json"
5330       }
5331     ],
5332     "name": "getProactiveActions",
5333     "group": "Chat_Websites",
5334     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5335     "version": "0.0.0",
5336     "filename": "server/api/chatWebsite/index.js",
5337     "groupTitle": "Chat_Websites"
5338   },
5339   {
5340     "type": "get",
5341     "url": "/api/chat/websites/{id}/snippet",
5342     "title": "Gets Website Snippet",
5343     "examples": [
5344       {
5345         "title": "Example usage:",
5346         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5347         "type": "json"
5348       }
5349     ],
5350     "name": "getSnippet",
5351     "group": "Chat_Websites",
5352     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5353     "version": "0.0.0",
5354     "filename": "server/api/chatWebsite/index.js",
5355     "groupTitle": "Chat_Websites"
5356   },
5357   {
5358     "type": "get",
5359     "url": "/api/chat/websites/{id}/system_avatar",
5360     "title": "Get System Avatar",
5361     "examples": [
5362       {
5363         "title": "Example usage:",
5364         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5365         "type": "json"
5366       }
5367     ],
5368     "name": "getSystemAvatar",
5369     "group": "Chat_Websites",
5370     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5371     "version": "0.0.0",
5372     "filename": "server/api/chatWebsite/index.js",
5373     "groupTitle": "Chat_Websites"
5374   },
5375   {
5376     "type": "post",
5377     "url": "/api/chat/websites/{id}/notify",
5378     "title": "Notify new message",
5379     "examples": [
5380       {
5381         "title": "Example usage:",
5382         "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",
5383         "type": "json"
5384       }
5385     ],
5386     "name": "notify",
5387     "group": "Chat_Websites",
5388     "description": "<p>Motion 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>",
5389     "version": "0.0.0",
5390     "filename": "server/api/chatWebsite/index.js",
5391     "groupTitle": "Chat_Websites"
5392   },
5393   {
5394     "type": "post",
5395     "url": "/api/chat/websites/{id}/offline",
5396     "title": "Offline message",
5397     "examples": [
5398       {
5399         "title": "Example usage:",
5400         "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",
5401         "type": "json"
5402       }
5403     ],
5404     "name": "offline",
5405     "group": "Chat_Websites",
5406     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5407     "version": "0.0.0",
5408     "filename": "server/api/chatWebsite/index.js",
5409     "groupTitle": "Chat_Websites"
5410   },
5411   {
5412     "type": "put",
5413     "url": "/api/chat/messages/{id}/reject",
5414     "title": "Rejects message",
5415     "examples": [
5416       {
5417         "title": "Example usage:",
5418         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5419         "type": "json"
5420       }
5421     ],
5422     "name": "rejectMessage",
5423     "group": "Chat_Websites",
5424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5425     "version": "0.0.0",
5426     "filename": "server/api/chatMessage/index.js",
5427     "groupTitle": "Chat_Websites"
5428   },
5429   {
5430     "type": "put",
5431     "url": "/api/chat/websites/{id}",
5432     "title": "Update an existing Website",
5433     "examples": [
5434       {
5435         "title": "Example usage:",
5436         "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",
5437         "type": "json"
5438       }
5439     ],
5440     "name": "updateWebsites",
5441     "group": "Chat_Websites",
5442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5443     "version": "0.0.0",
5444     "filename": "server/api/chatWebsite/index.js",
5445     "groupTitle": "Chat_Websites"
5446   },
5447   {
5448     "type": "post",
5449     "url": "/api/cloudProviders",
5450     "title": "Creates a new CloudProvider",
5451     "examples": [
5452       {
5453         "title": "Example usage:",
5454         "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5455         "type": "json"
5456       }
5457     ],
5458     "name": "CreateCloudProviders",
5459     "group": "CloudProviders",
5460     "parameter": {
5461       "fields": {
5462         "Body": [
5463           {
5464             "group": "Body",
5465             "type": "String",
5466             "optional": false,
5467             "field": "name",
5468             "description": ""
5469           },
5470           {
5471             "group": "Body",
5472             "type": "String",
5473             "allowedValues": [
5474               "\"AmazonAWS\"",
5475               "\"Google\""
5476             ],
5477             "optional": false,
5478             "field": "service",
5479             "description": ""
5480           },
5481           {
5482             "group": "Body",
5483             "type": "String",
5484             "optional": true,
5485             "field": "data1",
5486             "description": ""
5487           },
5488           {
5489             "group": "Body",
5490             "type": "String",
5491             "optional": true,
5492             "field": "data2",
5493             "description": ""
5494           }
5495         ]
5496       }
5497     },
5498     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5499     "version": "0.0.0",
5500     "filename": "server/api/cloudProvider/index.js",
5501     "groupTitle": "CloudProviders"
5502   },
5503   {
5504     "type": "delete",
5505     "url": "/api/cloudProviders/{id}",
5506     "title": "Deletes a CloudProvider",
5507     "examples": [
5508       {
5509         "title": "Example usage:",
5510         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5511         "type": "json"
5512       }
5513     ],
5514     "name": "DeleteCloudProviders",
5515     "group": "CloudProviders",
5516     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5517     "version": "0.0.0",
5518     "filename": "server/api/cloudProvider/index.js",
5519     "groupTitle": "CloudProviders"
5520   },
5521   {
5522     "type": "get",
5523     "url": "/api/cloudProviders",
5524     "title": "Gets a list of CloudProviders",
5525     "examples": [
5526       {
5527         "title": "Example usage:",
5528         "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5529         "type": "json"
5530       }
5531     ],
5532     "name": "GetCloudProviders",
5533     "group": "CloudProviders",
5534     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5535     "version": "0.0.0",
5536     "filename": "server/api/cloudProvider/index.js",
5537     "groupTitle": "CloudProviders"
5538   },
5539   {
5540     "type": "get",
5541     "url": "/api/cloudProviders/{id}",
5542     "title": "Gets a single CloudProvider",
5543     "examples": [
5544       {
5545         "title": "Example usage:",
5546         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5547         "type": "json"
5548       }
5549     ],
5550     "name": "ShowCloudProviders",
5551     "group": "CloudProviders",
5552     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5553     "version": "0.0.0",
5554     "filename": "server/api/cloudProvider/index.js",
5555     "groupTitle": "CloudProviders"
5556   },
5557   {
5558     "type": "put",
5559     "url": "/api/cloudProviders/{id}",
5560     "title": "Update an existing CloudProvider",
5561     "examples": [
5562       {
5563         "title": "Example usage:",
5564         "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5565         "type": "json"
5566       }
5567     ],
5568     "name": "updateCloudProviders",
5569     "group": "CloudProviders",
5570     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5571     "version": "0.0.0",
5572     "filename": "server/api/cloudProvider/index.js",
5573     "groupTitle": "CloudProviders"
5574   },
5575   {
5576     "type": "post",
5577     "url": "/api/cm/companies",
5578     "title": "Creates a new Company",
5579     "examples": [
5580       {
5581         "title": "Example usage:",
5582         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5583         "type": "json"
5584       }
5585     ],
5586     "name": "CreateCompanies",
5587     "group": "Cm_Companies",
5588     "parameter": {
5589       "fields": {
5590         "Body": [
5591           {
5592             "group": "Body",
5593             "type": "String",
5594             "optional": false,
5595             "field": "name",
5596             "description": ""
5597           },
5598           {
5599             "group": "Body",
5600             "type": "String",
5601             "optional": true,
5602             "field": "vat",
5603             "description": ""
5604           },
5605           {
5606             "group": "Body",
5607             "type": "String",
5608             "optional": true,
5609             "field": "companyId",
5610             "description": ""
5611           },
5612           {
5613             "group": "Body",
5614             "type": "String",
5615             "optional": true,
5616             "field": "website",
5617             "description": ""
5618           },
5619           {
5620             "group": "Body",
5621             "type": "String",
5622             "optional": true,
5623             "field": "phone",
5624             "description": ""
5625           },
5626           {
5627             "group": "Body",
5628             "type": "String",
5629             "optional": true,
5630             "field": "fax",
5631             "description": ""
5632           },
5633           {
5634             "group": "Body",
5635             "type": "String",
5636             "optional": true,
5637             "field": "type",
5638             "description": ""
5639           },
5640           {
5641             "group": "Body",
5642             "type": "String",
5643             "optional": true,
5644             "field": "street",
5645             "description": ""
5646           },
5647           {
5648             "group": "Body",
5649             "type": "String",
5650             "optional": true,
5651             "field": "postalCode",
5652             "description": ""
5653           },
5654           {
5655             "group": "Body",
5656             "type": "String",
5657             "optional": true,
5658             "field": "city",
5659             "description": ""
5660           },
5661           {
5662             "group": "Body",
5663             "type": "String",
5664             "optional": true,
5665             "field": "country",
5666             "description": ""
5667           },
5668           {
5669             "group": "Body",
5670             "type": "String",
5671             "optional": true,
5672             "field": "email",
5673             "description": ""
5674           },
5675           {
5676             "group": "Body",
5677             "type": "String",
5678             "optional": true,
5679             "field": "emailDomain",
5680             "description": ""
5681           },
5682           {
5683             "group": "Body",
5684             "type": "String",
5685             "optional": true,
5686             "field": "sStreet",
5687             "description": ""
5688           },
5689           {
5690             "group": "Body",
5691             "type": "String",
5692             "optional": true,
5693             "field": "sPostalCode",
5694             "description": ""
5695           },
5696           {
5697             "group": "Body",
5698             "type": "String",
5699             "optional": true,
5700             "field": "sCity",
5701             "description": ""
5702           },
5703           {
5704             "group": "Body",
5705             "type": "String",
5706             "optional": true,
5707             "field": "sCountry",
5708             "description": ""
5709           },
5710           {
5711             "group": "Body",
5712             "type": "String",
5713             "optional": true,
5714             "field": "description",
5715             "description": ""
5716           }
5717         ]
5718       }
5719     },
5720     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5721     "version": "0.0.0",
5722     "filename": "server/api/cmCompany/index.js",
5723     "groupTitle": "Cm_Companies"
5724   },
5725   {
5726     "type": "delete",
5727     "url": "/api/cm/companies/{id}",
5728     "title": "Deletes a Company",
5729     "examples": [
5730       {
5731         "title": "Example usage:",
5732         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5733         "type": "json"
5734       }
5735     ],
5736     "name": "DeleteCompanies",
5737     "group": "Cm_Companies",
5738     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5739     "version": "0.0.0",
5740     "filename": "server/api/cmCompany/index.js",
5741     "groupTitle": "Cm_Companies"
5742   },
5743   {
5744     "type": "get",
5745     "url": "/api/cm/companies/describe",
5746     "title": "Gets table info about Companies",
5747     "examples": [
5748       {
5749         "title": "Example usage:",
5750         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5751         "type": "json"
5752       }
5753     ],
5754     "name": "DescribeCompanies",
5755     "group": "Cm_Companies",
5756     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5757     "version": "0.0.0",
5758     "filename": "server/api/cmCompany/index.js",
5759     "groupTitle": "Cm_Companies"
5760   },
5761   {
5762     "type": "get",
5763     "url": "/api/cm/companies",
5764     "title": "Gets a list of Companies",
5765     "examples": [
5766       {
5767         "title": "Example usage:",
5768         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5769         "type": "json"
5770       }
5771     ],
5772     "name": "GetCompanies",
5773     "group": "Cm_Companies",
5774     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5775     "version": "0.0.0",
5776     "filename": "server/api/cmCompany/index.js",
5777     "groupTitle": "Cm_Companies"
5778   },
5779   {
5780     "type": "get",
5781     "url": "/api/cm/companies/{id}",
5782     "title": "Gets a single Company",
5783     "examples": [
5784       {
5785         "title": "Example usage:",
5786         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5787         "type": "json"
5788       }
5789     ],
5790     "name": "ShowCompanies",
5791     "group": "Cm_Companies",
5792     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5793     "version": "0.0.0",
5794     "filename": "server/api/cmCompany/index.js",
5795     "groupTitle": "Cm_Companies"
5796   },
5797   {
5798     "type": "post",
5799     "url": "/api/cm/companies/{id}/contacts",
5800     "title": "Creates new contacts",
5801     "examples": [
5802       {
5803         "title": "Example usage:",
5804         "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",
5805         "type": "json"
5806       }
5807     ],
5808     "name": "addContacts",
5809     "group": "Cm_Companies",
5810     "parameter": {
5811       "fields": {
5812         "Body": [
5813           {
5814             "group": "Body",
5815             "type": "String",
5816             "optional": false,
5817             "field": "firstName",
5818             "description": ""
5819           },
5820           {
5821             "group": "Body",
5822             "type": "String",
5823             "optional": true,
5824             "field": "lastName",
5825             "description": ""
5826           },
5827           {
5828             "group": "Body",
5829             "type": "String",
5830             "optional": true,
5831             "field": "street",
5832             "description": ""
5833           },
5834           {
5835             "group": "Body",
5836             "type": "String",
5837             "optional": true,
5838             "field": "postalCode",
5839             "description": ""
5840           },
5841           {
5842             "group": "Body",
5843             "type": "String",
5844             "optional": true,
5845             "field": "city",
5846             "description": ""
5847           },
5848           {
5849             "group": "Body",
5850             "type": "String",
5851             "optional": true,
5852             "field": "country",
5853             "description": ""
5854           },
5855           {
5856             "group": "Body",
5857             "type": "String",
5858             "optional": true,
5859             "field": "dateOfBirth",
5860             "description": ""
5861           },
5862           {
5863             "group": "Body",
5864             "type": "Text",
5865             "optional": true,
5866             "field": "description",
5867             "description": ""
5868           },
5869           {
5870             "group": "Body",
5871             "type": "String",
5872             "optional": true,
5873             "field": "phone",
5874             "description": ""
5875           },
5876           {
5877             "group": "Body",
5878             "type": "String",
5879             "optional": true,
5880             "field": "mobile",
5881             "description": ""
5882           },
5883           {
5884             "group": "Body",
5885             "type": "String",
5886             "optional": true,
5887             "field": "fax",
5888             "description": ""
5889           },
5890           {
5891             "group": "Body",
5892             "type": "String",
5893             "optional": true,
5894             "field": "email",
5895             "description": ""
5896           },
5897           {
5898             "group": "Body",
5899             "type": "String",
5900             "optional": true,
5901             "field": "url",
5902             "description": ""
5903           },
5904           {
5905             "group": "Body",
5906             "type": "String",
5907             "optional": true,
5908             "field": "facebook",
5909             "description": ""
5910           },
5911           {
5912             "group": "Body",
5913             "type": "String",
5914             "optional": true,
5915             "field": "fb_data",
5916             "description": ""
5917           },
5918           {
5919             "group": "Body",
5920             "type": "String",
5921             "optional": true,
5922             "field": "twitter",
5923             "description": ""
5924           },
5925           {
5926             "group": "Body",
5927             "type": "String",
5928             "optional": true,
5929             "field": "skype",
5930             "description": ""
5931           },
5932           {
5933             "group": "Body",
5934             "type": "String",
5935             "optional": true,
5936             "field": "teams",
5937             "description": ""
5938           },
5939           {
5940             "group": "Body",
5941             "type": "String",
5942             "optional": true,
5943             "field": "viber",
5944             "description": ""
5945           },
5946           {
5947             "group": "Body",
5948             "type": "String",
5949             "optional": true,
5950             "field": "line",
5951             "description": ""
5952           },
5953           {
5954             "group": "Body",
5955             "type": "String",
5956             "optional": true,
5957             "field": "wechat",
5958             "description": ""
5959           },
5960           {
5961             "group": "Body",
5962             "type": "String",
5963             "optional": true,
5964             "field": "telegram",
5965             "description": ""
5966           },
5967           {
5968             "group": "Body",
5969             "type": "Integer",
5970             "optional": true,
5971             "field": "UserId",
5972             "description": ""
5973           },
5974           {
5975             "group": "Body",
5976             "type": "Integer",
5977             "optional": true,
5978             "field": "priority",
5979             "description": ""
5980           },
5981           {
5982             "group": "Body",
5983             "type": "String",
5984             "optional": true,
5985             "field": "scheduledat",
5986             "description": ""
5987           }
5988         ]
5989       }
5990     },
5991     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5992     "version": "0.0.0",
5993     "filename": "server/api/cmCompany/index.js",
5994     "groupTitle": "Cm_Companies"
5995   },
5996   {
5997     "type": "get",
5998     "url": "/api/cm/companies/{id}/contacts",
5999     "title": "Gets List Contacts",
6000     "examples": [
6001       {
6002         "title": "Example usage:",
6003         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
6004         "type": "json"
6005       }
6006     ],
6007     "name": "getContacts",
6008     "group": "Cm_Companies",
6009     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6010     "version": "0.0.0",
6011     "filename": "server/api/cmCompany/index.js",
6012     "groupTitle": "Cm_Companies"
6013   },
6014   {
6015     "type": "put",
6016     "url": "/api/cm/companies/{id}",
6017     "title": "Update an existing Company",
6018     "examples": [
6019       {
6020         "title": "Example usage:",
6021         "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",
6022         "type": "json"
6023       }
6024     ],
6025     "name": "updateCompanies",
6026     "group": "Cm_Companies",
6027     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6028     "version": "0.0.0",
6029     "filename": "server/api/cmCompany/index.js",
6030     "groupTitle": "Cm_Companies"
6031   },
6032   {
6033     "type": "delete",
6034     "url": "/api/cm/contacts/{id}",
6035     "title": "Deletes a Contact",
6036     "examples": [
6037       {
6038         "title": "Example usage:",
6039         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
6040         "type": "json"
6041       }
6042     ],
6043     "name": "DeleteContacts",
6044     "group": "Cm_Contacts",
6045     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6046     "version": "0.0.0",
6047     "filename": "server/api/cmContact/index.js",
6048     "groupTitle": "Cm_Contacts"
6049   },
6050   {
6051     "type": "get",
6052     "url": "/api/cm/contacts/describe",
6053     "title": "Gets table info about Contacts",
6054     "examples": [
6055       {
6056         "title": "Example usage:",
6057         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6058         "type": "json"
6059       }
6060     ],
6061     "name": "DescribeContacts",
6062     "group": "Cm_Contacts",
6063     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6064     "version": "0.0.0",
6065     "filename": "server/api/cmContact/index.js",
6066     "groupTitle": "Cm_Contacts"
6067   },
6068   {
6069     "type": "get",
6070     "url": "/api/cm/contacts",
6071     "title": "Gets a list of Contacts",
6072     "examples": [
6073       {
6074         "title": "Example usage:",
6075         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6076         "type": "json"
6077       }
6078     ],
6079     "name": "GetContacts",
6080     "group": "Cm_Contacts",
6081     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6082     "version": "0.0.0",
6083     "filename": "server/api/cmContact/index.js",
6084     "groupTitle": "Cm_Contacts"
6085   },
6086   {
6087     "type": "get",
6088     "url": "/api/cm/contacts/{id}/finals",
6089     "title": "Gets contact hopper finals",
6090     "examples": [
6091       {
6092         "title": "Example usage:",
6093         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
6094         "type": "json"
6095       }
6096     ],
6097     "name": "GetHopperFinals",
6098     "group": "Cm_Contacts",
6099     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6100     "version": "0.0.0",
6101     "filename": "server/api/cmContact/index.js",
6102     "groupTitle": "Cm_Contacts"
6103   },
6104   {
6105     "type": "get",
6106     "url": "/api/cm/contacts/{id}/hopper_histories",
6107     "title": "Gets contact hopper histories",
6108     "examples": [
6109       {
6110         "title": "Example usage:",
6111         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6112         "type": "json"
6113       }
6114     ],
6115     "name": "GetHopperHistories",
6116     "group": "Cm_Contacts",
6117     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6118     "version": "0.0.0",
6119     "filename": "server/api/cmContact/index.js",
6120     "groupTitle": "Cm_Contacts"
6121   },
6122   {
6123     "type": "get",
6124     "url": "/api/cm/contacts/{id}/hoppers",
6125     "title": "Gets contact hoppers",
6126     "examples": [
6127       {
6128         "title": "Example usage:",
6129         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6130         "type": "json"
6131       }
6132     ],
6133     "name": "GetHoppers",
6134     "group": "Cm_Contacts",
6135     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6136     "version": "0.0.0",
6137     "filename": "server/api/cmContact/index.js",
6138     "groupTitle": "Cm_Contacts"
6139   },
6140   {
6141     "type": "post",
6142     "url": "/api/cm/contacts/create_many",
6143     "title": "Create Contacts",
6144     "examples": [
6145       {
6146         "title": "Example usage:",
6147         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6148         "type": "json"
6149       }
6150     ],
6151     "name": "bulkCreate",
6152     "group": "Cm_Contacts",
6153     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6154     "version": "0.0.0",
6155     "filename": "server/api/cmContact/index.js",
6156     "groupTitle": "Cm_Contacts"
6157   },
6158   {
6159     "type": "post",
6160     "url": "/api/cm/contacts",
6161     "title": "Create Contact",
6162     "examples": [
6163       {
6164         "title": "Example usage:",
6165         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6166         "type": "json"
6167       }
6168     ],
6169     "name": "create",
6170     "group": "Cm_Contacts",
6171     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6172     "version": "0.0.0",
6173     "filename": "server/api/cmContact/index.js",
6174     "groupTitle": "Cm_Contacts"
6175   },
6176   {
6177     "type": "get",
6178     "url": "/api/cm/contacts/{id}/journey",
6179     "title": "Gets customer journey",
6180     "examples": [
6181       {
6182         "title": "Example usage:",
6183         "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password}  -X GET",
6184         "type": "json"
6185       }
6186     ],
6187     "name": "getJourney",
6188     "group": "Cm_Contacts",
6189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6190     "version": "0.0.0",
6191     "filename": "server/api/cmContact/index.js",
6192     "groupTitle": "Cm_Contacts"
6193   },
6194   {
6195     "type": "get",
6196     "url": "/api/cm/contacts/{id}/jscripty_sessions",
6197     "title": "Gets contact hopper blacks",
6198     "examples": [
6199       {
6200         "title": "Example usage:",
6201         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
6202         "type": "json"
6203       }
6204     ],
6205     "name": "getJscriptySessions",
6206     "group": "Cm_Contacts",
6207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6208     "version": "0.0.0",
6209     "filename": "server/api/cmContact/index.js",
6210     "groupTitle": "Cm_Contacts"
6211   },
6212   {
6213     "type": "get",
6214     "url": "/api/cm/contacts/{id}/tags",
6215     "title": "Gets configurations tags",
6216     "examples": [
6217       {
6218         "title": "Example usage:",
6219         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6220         "type": "json"
6221       }
6222     ],
6223     "name": "getTags",
6224     "group": "Cm_Contacts",
6225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6226     "version": "0.0.0",
6227     "filename": "server/api/cmContact/index.js",
6228     "groupTitle": "Cm_Contacts"
6229   },
6230   {
6231     "type": "post",
6232     "url": "/api/cm/contacts/merge",
6233     "title": "Merge Contact",
6234     "examples": [
6235       {
6236         "title": "Example usage:",
6237         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6238         "type": "json"
6239       }
6240     ],
6241     "name": "merge",
6242     "group": "Cm_Contacts",
6243     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6244     "version": "0.0.0",
6245     "filename": "server/api/cmContact/index.js",
6246     "groupTitle": "Cm_Contacts"
6247   },
6248   {
6249     "type": "post",
6250     "url": "/api/cm/contacts/{id}/tags",
6251     "title": "Sets new tags",
6252     "examples": [
6253       {
6254         "title": "Example usage:",
6255         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6256         "type": "json"
6257       }
6258     ],
6259     "name": "setTags",
6260     "group": "Cm_Contacts",
6261     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6262     "version": "0.0.0",
6263     "filename": "server/api/cmContact/index.js",
6264     "groupTitle": "Cm_Contacts"
6265   },
6266   {
6267     "type": "get",
6268     "url": "/api/cm/contacts/{id}",
6269     "title": "Gets a single Contact",
6270     "examples": [
6271       {
6272         "title": "Example usage:",
6273         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6274         "type": "json"
6275       }
6276     ],
6277     "name": "show",
6278     "group": "Cm_Contacts",
6279     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6280     "version": "0.0.0",
6281     "filename": "server/api/cmContact/index.js",
6282     "groupTitle": "Cm_Contacts"
6283   },
6284   {
6285     "type": "put",
6286     "url": "/api/cm/contacts/{id}",
6287     "title": "Update a single Contact",
6288     "examples": [
6289       {
6290         "title": "Example usage:",
6291         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6292         "type": "json"
6293       }
6294     ],
6295     "name": "update",
6296     "group": "Cm_Contacts",
6297     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6298     "version": "0.0.0",
6299     "filename": "server/api/cmContact/index.js",
6300     "groupTitle": "Cm_Contacts"
6301   },
6302   {
6303     "type": "delete",
6304     "url": "/api/cm/custom_fields/{id}",
6305     "title": "Deletes a Custom Field",
6306     "examples": [
6307       {
6308         "title": "Example usage:",
6309         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6310         "type": "json"
6311       }
6312     ],
6313     "name": "DeleteCustom_Fields",
6314     "group": "Cm_Custom_Fields",
6315     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6316     "version": "0.0.0",
6317     "filename": "server/api/cmCustomField/index.js",
6318     "groupTitle": "Cm_Custom_Fields"
6319   },
6320   {
6321     "type": "get",
6322     "url": "/api/cm/custom_fields",
6323     "title": "Gets a list of Custom Fields",
6324     "examples": [
6325       {
6326         "title": "Example usage:",
6327         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6328         "type": "json"
6329       }
6330     ],
6331     "name": "GetCustom_Fields",
6332     "group": "Cm_Custom_Fields",
6333     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6334     "version": "0.0.0",
6335     "filename": "server/api/cmCustomField/index.js",
6336     "groupTitle": "Cm_Custom_Fields"
6337   },
6338   {
6339     "type": "get",
6340     "url": "/api/cm/custom_fields/{id}",
6341     "title": "Gets a single Custom Field",
6342     "examples": [
6343       {
6344         "title": "Example usage:",
6345         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6346         "type": "json"
6347       }
6348     ],
6349     "name": "ShowCustom_Fields",
6350     "group": "Cm_Custom_Fields",
6351     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6352     "version": "0.0.0",
6353     "filename": "server/api/cmCustomField/index.js",
6354     "groupTitle": "Cm_Custom_Fields"
6355   },
6356   {
6357     "type": "put",
6358     "url": "/api/cm/custom_fields/{id}",
6359     "title": "Update an existing Custom Field",
6360     "examples": [
6361       {
6362         "title": "Example usage:",
6363         "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",
6364         "type": "json"
6365       }
6366     ],
6367     "name": "updateCustom_Fields",
6368     "group": "Cm_Custom_Fields",
6369     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6370     "version": "0.0.0",
6371     "filename": "server/api/cmCustomField/index.js",
6372     "groupTitle": "Cm_Custom_Fields"
6373   },
6374   {
6375     "type": "post",
6376     "url": "/api/cm/hopper",
6377     "title": "Creates a new Hopper",
6378     "examples": [
6379       {
6380         "title": "Example usage:",
6381         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6382         "type": "json"
6383       }
6384     ],
6385     "name": "CreateHopper",
6386     "group": "Cm_Hopper",
6387     "parameter": {
6388       "fields": {
6389         "Body": [
6390           {
6391             "group": "Body",
6392             "type": "String",
6393             "optional": false,
6394             "field": "phone",
6395             "description": ""
6396           },
6397           {
6398             "group": "Body",
6399             "type": "Boolean",
6400             "optional": true,
6401             "field": "active",
6402             "description": ""
6403           },
6404           {
6405             "group": "Body",
6406             "type": "String",
6407             "optional": true,
6408             "field": "scheduledat",
6409             "description": ""
6410           },
6411           {
6412             "group": "Body",
6413             "type": "Integer",
6414             "optional": true,
6415             "field": "countbusyretry",
6416             "description": ""
6417           },
6418           {
6419             "group": "Body",
6420             "type": "Integer",
6421             "optional": true,
6422             "field": "countcongestionretry",
6423             "description": ""
6424           },
6425           {
6426             "group": "Body",
6427             "type": "Integer",
6428             "optional": true,
6429             "field": "countnoanswerretry",
6430             "description": ""
6431           },
6432           {
6433             "group": "Body",
6434             "type": "Boolean",
6435             "optional": true,
6436             "field": "callback",
6437             "description": ""
6438           },
6439           {
6440             "group": "Body",
6441             "type": "String",
6442             "optional": true,
6443             "field": "callbackuniqueid",
6444             "description": ""
6445           },
6446           {
6447             "group": "Body",
6448             "type": "String",
6449             "optional": true,
6450             "field": "callbackat",
6451             "description": ""
6452           },
6453           {
6454             "group": "Body",
6455             "type": "Integer",
6456             "optional": true,
6457             "field": "priority",
6458             "description": ""
6459           },
6460           {
6461             "group": "Body",
6462             "type": "Boolean",
6463             "optional": true,
6464             "field": "recallme",
6465             "description": ""
6466           },
6467           {
6468             "group": "Body",
6469             "type": "Integer",
6470             "optional": true,
6471             "field": "ContactId",
6472             "description": ""
6473           },
6474           {
6475             "group": "Body",
6476             "type": "Integer",
6477             "optional": true,
6478             "field": "ListId",
6479             "description": ""
6480           },
6481           {
6482             "group": "Body",
6483             "type": "Integer",
6484             "optional": true,
6485             "field": "UserId",
6486             "description": ""
6487           },
6488           {
6489             "group": "Body",
6490             "type": "Integer",
6491             "optional": true,
6492             "field": "VoiceQueueId",
6493             "description": ""
6494           },
6495           {
6496             "group": "Body",
6497             "type": "Integer",
6498             "optional": true,
6499             "field": "CampaignId",
6500             "description": ""
6501           },
6502           {
6503             "group": "Body",
6504             "type": "Integer",
6505             "optional": true,
6506             "field": "countnosuchnumberretry",
6507             "description": ""
6508           },
6509           {
6510             "group": "Body",
6511             "type": "Integer",
6512             "optional": true,
6513             "field": "countdropretry",
6514             "description": ""
6515           },
6516           {
6517             "group": "Body",
6518             "type": "Integer",
6519             "optional": true,
6520             "field": "countabandonedretry",
6521             "description": ""
6522           },
6523           {
6524             "group": "Body",
6525             "type": "Integer",
6526             "optional": true,
6527             "field": "countmachineretry",
6528             "description": ""
6529           },
6530           {
6531             "group": "Body",
6532             "type": "Integer",
6533             "optional": true,
6534             "field": "countagentrejectretry",
6535             "description": ""
6536           }
6537         ]
6538       }
6539     },
6540     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6541     "version": "0.0.0",
6542     "filename": "server/api/cmHopper/index.js",
6543     "groupTitle": "Cm_Hopper"
6544   },
6545   {
6546     "type": "get",
6547     "url": "/api/cm/hopper/describe",
6548     "title": "Gets table info about Hopper",
6549     "examples": [
6550       {
6551         "title": "Example usage:",
6552         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6553         "type": "json"
6554       }
6555     ],
6556     "name": "DescribeHopper",
6557     "group": "Cm_Hopper",
6558     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6559     "version": "0.0.0",
6560     "filename": "server/api/cmHopper/index.js",
6561     "groupTitle": "Cm_Hopper"
6562   },
6563   {
6564     "type": "get",
6565     "url": "/api/cm/hopper",
6566     "title": "Gets a list of Hopper",
6567     "examples": [
6568       {
6569         "title": "Example usage:",
6570         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6571         "type": "json"
6572       }
6573     ],
6574     "name": "GetHopper",
6575     "group": "Cm_Hopper",
6576     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6577     "version": "0.0.0",
6578     "filename": "server/api/cmHopper/index.js",
6579     "groupTitle": "Cm_Hopper"
6580   },
6581   {
6582     "type": "get",
6583     "url": "/api/cm/hopper/{id}",
6584     "title": "Gets a single Hopper",
6585     "examples": [
6586       {
6587         "title": "Example usage:",
6588         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6589         "type": "json"
6590       }
6591     ],
6592     "name": "ShowHopper",
6593     "group": "Cm_Hopper",
6594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6595     "version": "0.0.0",
6596     "filename": "server/api/cmHopper/index.js",
6597     "groupTitle": "Cm_Hopper"
6598   },
6599   {
6600     "type": "delete",
6601     "url": "/api/cm/hopper_black/{id}",
6602     "title": "Deletes a Hopper Black",
6603     "examples": [
6604       {
6605         "title": "Example usage:",
6606         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6607         "type": "json"
6608       }
6609     ],
6610     "name": "DeleteHopper_Black",
6611     "group": "Cm_Hopper_Black",
6612     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6613     "version": "0.0.0",
6614     "filename": "server/api/cmHopperBlack/index.js",
6615     "groupTitle": "Cm_Hopper_Black"
6616   },
6617   {
6618     "type": "get",
6619     "url": "/api/cm/hopper_black/describe",
6620     "title": "Gets table info about Hopper Black",
6621     "examples": [
6622       {
6623         "title": "Example usage:",
6624         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6625         "type": "json"
6626       }
6627     ],
6628     "name": "DescribeHopper_Black",
6629     "group": "Cm_Hopper_Black",
6630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6631     "version": "0.0.0",
6632     "filename": "server/api/cmHopperBlack/index.js",
6633     "groupTitle": "Cm_Hopper_Black"
6634   },
6635   {
6636     "type": "get",
6637     "url": "/api/cm/hopper_black",
6638     "title": "Gets a list of Hopper Black",
6639     "examples": [
6640       {
6641         "title": "Example usage:",
6642         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6643         "type": "json"
6644       }
6645     ],
6646     "name": "GetHopper_Black",
6647     "group": "Cm_Hopper_Black",
6648     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6649     "version": "0.0.0",
6650     "filename": "server/api/cmHopperBlack/index.js",
6651     "groupTitle": "Cm_Hopper_Black"
6652   },
6653   {
6654     "type": "get",
6655     "url": "/api/cm/hopper_black/{id}",
6656     "title": "Gets a single Hopper Black",
6657     "examples": [
6658       {
6659         "title": "Example usage:",
6660         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6661         "type": "json"
6662       }
6663     ],
6664     "name": "ShowHopper_Black",
6665     "group": "Cm_Hopper_Black",
6666     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6667     "version": "0.0.0",
6668     "filename": "server/api/cmHopperBlack/index.js",
6669     "groupTitle": "Cm_Hopper_Black"
6670   },
6671   {
6672     "type": "put",
6673     "url": "/api/cm/hopper_black/{id}",
6674     "title": "Update an existing Hopper Black",
6675     "examples": [
6676       {
6677         "title": "Example usage:",
6678         "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",
6679         "type": "json"
6680       }
6681     ],
6682     "name": "updateHopper_Black",
6683     "group": "Cm_Hopper_Black",
6684     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6685     "version": "0.0.0",
6686     "filename": "server/api/cmHopperBlack/index.js",
6687     "groupTitle": "Cm_Hopper_Black"
6688   },
6689   {
6690     "type": "post",
6691     "url": "/api/cm/hopper_final/checkContactHopper",
6692     "title": "Check if contact is in hopper",
6693     "examples": [
6694       {
6695         "title": "Example usage:",
6696         "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",
6697         "type": "json"
6698       }
6699     ],
6700     "name": "/checkContactHopper",
6701     "group": "Cm_Hopper_Final",
6702     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6703     "version": "0.0.0",
6704     "filename": "server/api/cmHopperFinal/index.js",
6705     "groupTitle": "Cm_Hopper_Final"
6706   },
6707   {
6708     "type": "get",
6709     "url": "/api/cm/hopper_final/describe",
6710     "title": "Gets table info about HopperFinal",
6711     "examples": [
6712       {
6713         "title": "Example usage:",
6714         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6715         "type": "json"
6716       }
6717     ],
6718     "name": "DescribeHopperFinal",
6719     "group": "Cm_Hopper_Final",
6720     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6721     "version": "0.0.0",
6722     "filename": "server/api/cmHopperFinal/index.js",
6723     "groupTitle": "Cm_Hopper_Final"
6724   },
6725   {
6726     "type": "get",
6727     "url": "/api/cm/hopper_final",
6728     "title": "Gets a list of HopperFinal",
6729     "examples": [
6730       {
6731         "title": "Example usage:",
6732         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6733         "type": "json"
6734       }
6735     ],
6736     "name": "GetHopperFinal",
6737     "group": "Cm_Hopper_Final",
6738     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6739     "version": "0.0.0",
6740     "filename": "server/api/cmHopperFinal/index.js",
6741     "groupTitle": "Cm_Hopper_Final"
6742   },
6743   {
6744     "type": "get",
6745     "url": "/api/cm/hopper_final/{id}",
6746     "title": "Gets a single HopperFinal",
6747     "examples": [
6748       {
6749         "title": "Example usage:",
6750         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6751         "type": "json"
6752       }
6753     ],
6754     "name": "ShowHopperFinal",
6755     "group": "Cm_Hopper_Final",
6756     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6757     "version": "0.0.0",
6758     "filename": "server/api/cmHopperFinal/index.js",
6759     "groupTitle": "Cm_Hopper_Final"
6760   },
6761   {
6762     "type": "get",
6763     "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6764     "title": "Return number contacts for attributes",
6765     "examples": [
6766       {
6767         "title": "Example usage:",
6768         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6769         "type": "json"
6770       }
6771     ],
6772     "name": "countContactsIvrCampaignHopperFinal",
6773     "group": "Cm_Hopper_Final",
6774     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6775     "version": "0.0.0",
6776     "filename": "server/api/cmHopperFinal/index.js",
6777     "groupTitle": "Cm_Hopper_Final"
6778   },
6779   {
6780     "type": "get",
6781     "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6782     "title": "Return number contacts for attributes",
6783     "examples": [
6784       {
6785         "title": "Example usage:",
6786         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6787         "type": "json"
6788       }
6789     ],
6790     "name": "countContactsQueueCampaignHopperFinal",
6791     "group": "Cm_Hopper_Final",
6792     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6793     "version": "0.0.0",
6794     "filename": "server/api/cmHopperFinal/index.js",
6795     "groupTitle": "Cm_Hopper_Final"
6796   },
6797   {
6798     "type": "post",
6799     "url": "/api/cm/hopper_final/campaign/{id}",
6800     "title": "Move contacts in hopper",
6801     "examples": [
6802       {
6803         "title": "Example usage:",
6804         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6805         "type": "json"
6806       }
6807     ],
6808     "name": "moveContactsIvrCampaignHopperFinal",
6809     "group": "Cm_Hopper_Final",
6810     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6811     "version": "0.0.0",
6812     "filename": "server/api/cmHopperFinal/index.js",
6813     "groupTitle": "Cm_Hopper_Final"
6814   },
6815   {
6816     "type": "post",
6817     "url": "/api/cm/hopper_final/voice/queue/{id}",
6818     "title": "Move contacts in hopper",
6819     "examples": [
6820       {
6821         "title": "Example usage:",
6822         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6823         "type": "json"
6824       }
6825     ],
6826     "name": "moveContactsQueueCampaignHopperFinal",
6827     "group": "Cm_Hopper_Final",
6828     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6829     "version": "0.0.0",
6830     "filename": "server/api/cmHopperFinal/index.js",
6831     "groupTitle": "Cm_Hopper_Final"
6832   },
6833   {
6834     "type": "put",
6835     "url": "/api/cm/hopper_final/{id}",
6836     "title": "Update a single hopper final",
6837     "examples": [
6838       {
6839         "title": "Example usage:",
6840         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6841         "type": "json"
6842       }
6843     ],
6844     "name": "update",
6845     "group": "Cm_Hopper_Final",
6846     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6847     "version": "0.0.0",
6848     "filename": "server/api/cmHopperFinal/index.js",
6849     "groupTitle": "Cm_Hopper_Final"
6850   },
6851   {
6852     "type": "post",
6853     "url": "/api/cm/hopper_history",
6854     "title": "Creates a new HopperHistory",
6855     "examples": [
6856       {
6857         "title": "Example usage:",
6858         "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",
6859         "type": "json"
6860       }
6861     ],
6862     "name": "CreateHopperHistory",
6863     "group": "Cm_Hopper_History",
6864     "parameter": {
6865       "fields": {
6866         "Body": [
6867           {
6868             "group": "Body",
6869             "type": "Integer",
6870             "optional": true,
6871             "field": "state",
6872             "description": ""
6873           },
6874           {
6875             "group": "Body",
6876             "type": "String",
6877             "optional": true,
6878             "field": "statedesc",
6879             "description": ""
6880           },
6881           {
6882             "group": "Body",
6883             "type": "String",
6884             "optional": true,
6885             "field": "scheduledat",
6886             "description": ""
6887           },
6888           {
6889             "group": "Body",
6890             "type": "Integer",
6891             "optional": true,
6892             "field": "countbusyretry",
6893             "description": ""
6894           },
6895           {
6896             "group": "Body",
6897             "type": "Integer",
6898             "optional": true,
6899             "field": "countcongestionretry",
6900             "description": ""
6901           },
6902           {
6903             "group": "Body",
6904             "type": "Integer",
6905             "optional": true,
6906             "field": "countnoanswerretry",
6907             "description": ""
6908           },
6909           {
6910             "group": "Body",
6911             "type": "Integer",
6912             "optional": true,
6913             "field": "countglobal",
6914             "description": ""
6915           },
6916           {
6917             "group": "Body",
6918             "type": "String",
6919             "optional": true,
6920             "field": "uniqueid",
6921             "description": ""
6922           },
6923           {
6924             "group": "Body",
6925             "type": "String",
6926             "optional": true,
6927             "field": "originatecalleridnum",
6928             "description": ""
6929           },
6930           {
6931             "group": "Body",
6932             "type": "String",
6933             "optional": true,
6934             "field": "originatecalleridname",
6935             "description": ""
6936           },
6937           {
6938             "group": "Body",
6939             "type": "String",
6940             "optional": true,
6941             "field": "calleridnum",
6942             "description": ""
6943           },
6944           {
6945             "group": "Body",
6946             "type": "String",
6947             "optional": true,
6948             "field": "calleridname",
6949             "description": ""
6950           },
6951           {
6952             "group": "Body",
6953             "type": "String",
6954             "optional": true,
6955             "field": "starttime",
6956             "description": ""
6957           },
6958           {
6959             "group": "Body",
6960             "type": "String",
6961             "optional": true,
6962             "field": "responsetime",
6963             "description": ""
6964           },
6965           {
6966             "group": "Body",
6967             "type": "String",
6968             "optional": true,
6969             "field": "answertime",
6970             "description": ""
6971           },
6972           {
6973             "group": "Body",
6974             "type": "String",
6975             "optional": true,
6976             "field": "droptime",
6977             "description": ""
6978           },
6979           {
6980             "group": "Body",
6981             "type": "String",
6982             "optional": true,
6983             "field": "endtime",
6984             "description": ""
6985           },
6986           {
6987             "group": "Body",
6988             "type": "Integer",
6989             "optional": true,
6990             "field": "ringtime",
6991             "description": ""
6992           },
6993           {
6994             "group": "Body",
6995             "type": "Integer",
6996             "optional": true,
6997             "field": "holdtime",
6998             "description": ""
6999           },
7000           {
7001             "group": "Body",
7002             "type": "Integer",
7003             "optional": true,
7004             "field": "talktime",
7005             "description": ""
7006           },
7007           {
7008             "group": "Body",
7009             "type": "Integer",
7010             "optional": true,
7011             "field": "followuptime",
7012             "description": ""
7013           },
7014           {
7015             "group": "Body",
7016             "type": "String",
7017             "optional": true,
7018             "field": "dropreason",
7019             "description": ""
7020           },
7021           {
7022             "group": "Body",
7023             "type": "String",
7024             "optional": true,
7025             "field": "campaign",
7026             "description": ""
7027           },
7028           {
7029             "group": "Body",
7030             "type": "String",
7031             "optional": true,
7032             "field": "campaigntype",
7033             "description": ""
7034           },
7035           {
7036             "group": "Body",
7037             "type": "String",
7038             "optional": true,
7039             "field": "membername",
7040             "description": ""
7041           },
7042           {
7043             "group": "Body",
7044             "type": "String",
7045             "optional": true,
7046             "field": "reason",
7047             "description": ""
7048           },
7049           {
7050             "group": "Body",
7051             "type": "Boolean",
7052             "optional": true,
7053             "field": "amd",
7054             "description": ""
7055           },
7056           {
7057             "group": "Body",
7058             "type": "Boolean",
7059             "optional": true,
7060             "field": "fax",
7061             "description": ""
7062           },
7063           {
7064             "group": "Body",
7065             "type": "Boolean",
7066             "optional": true,
7067             "field": "callback",
7068             "description": ""
7069           },
7070           {
7071             "group": "Body",
7072             "type": "String",
7073             "optional": true,
7074             "field": "callbackuniqueid",
7075             "description": ""
7076           },
7077           {
7078             "group": "Body",
7079             "type": "String",
7080             "optional": true,
7081             "field": "callbackat",
7082             "description": ""
7083           },
7084           {
7085             "group": "Body",
7086             "type": "Boolean",
7087             "optional": true,
7088             "field": "recallme",
7089             "description": ""
7090           },
7091           {
7092             "group": "Body",
7093             "type": "String",
7094             "optional": true,
7095             "field": "editedat",
7096             "description": ""
7097           },
7098           {
7099             "group": "Body",
7100             "type": "Boolean",
7101             "optional": true,
7102             "field": "edited",
7103             "description": ""
7104           },
7105           {
7106             "group": "Body",
7107             "type": "Integer",
7108             "optional": true,
7109             "field": "countnosuchnumberretry",
7110             "description": ""
7111           },
7112           {
7113             "group": "Body",
7114             "type": "Integer",
7115             "optional": true,
7116             "field": "countdropretry",
7117             "description": ""
7118           },
7119           {
7120             "group": "Body",
7121             "type": "Integer",
7122             "optional": true,
7123             "field": "countabandonedretry",
7124             "description": ""
7125           },
7126           {
7127             "group": "Body",
7128             "type": "Integer",
7129             "optional": true,
7130             "field": "countmachineretry",
7131             "description": ""
7132           },
7133           {
7134             "group": "Body",
7135             "type": "Integer",
7136             "optional": true,
7137             "field": "countagentrejectretry",
7138             "description": ""
7139           }
7140         ]
7141       }
7142     },
7143     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7144     "version": "0.0.0",
7145     "filename": "server/api/cmHopperHistory/index.js",
7146     "groupTitle": "Cm_Hopper_History"
7147   },
7148   {
7149     "type": "get",
7150     "url": "/api/cm/hopper_history/describe",
7151     "title": "Gets table info about HopperHistory",
7152     "examples": [
7153       {
7154         "title": "Example usage:",
7155         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7156         "type": "json"
7157       }
7158     ],
7159     "name": "DescribeHopperHistory",
7160     "group": "Cm_Hopper_History",
7161     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7162     "version": "0.0.0",
7163     "filename": "server/api/cmHopperHistory/index.js",
7164     "groupTitle": "Cm_Hopper_History"
7165   },
7166   {
7167     "type": "get",
7168     "url": "/api/cm/hopper_history",
7169     "title": "Gets a list of HopperHistory",
7170     "examples": [
7171       {
7172         "title": "Example usage:",
7173         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7174         "type": "json"
7175       }
7176     ],
7177     "name": "GetHopperHistory",
7178     "group": "Cm_Hopper_History",
7179     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7180     "version": "0.0.0",
7181     "filename": "server/api/cmHopperHistory/index.js",
7182     "groupTitle": "Cm_Hopper_History"
7183   },
7184   {
7185     "type": "get",
7186     "url": "/api/cm/hopper_history/{id}",
7187     "title": "Gets a single HopperHistory",
7188     "examples": [
7189       {
7190         "title": "Example usage:",
7191         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7192         "type": "json"
7193       }
7194     ],
7195     "name": "ShowHopperHistory",
7196     "group": "Cm_Hopper_History",
7197     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7198     "version": "0.0.0",
7199     "filename": "server/api/cmHopperHistory/index.js",
7200     "groupTitle": "Cm_Hopper_History"
7201   },
7202   {
7203     "type": "put",
7204     "url": "/api/cm/hopper_history/{id}",
7205     "title": "Update a single hopper history",
7206     "examples": [
7207       {
7208         "title": "Example usage:",
7209         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7210         "type": "json"
7211       }
7212     ],
7213     "name": "update",
7214     "group": "Cm_Hopper_History",
7215     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7216     "version": "0.0.0",
7217     "filename": "server/api/cmHopperHistory/index.js",
7218     "groupTitle": "Cm_Hopper_History"
7219   },
7220   {
7221     "type": "delete",
7222     "url": "/api/cm/hopper/{id}",
7223     "title": "Delete Hopper",
7224     "examples": [
7225       {
7226         "title": "Example usage:",
7227         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7228         "type": "json"
7229       }
7230     ],
7231     "name": "destroy",
7232     "group": "Cm_Hopper",
7233     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7234     "version": "0.0.0",
7235     "filename": "server/api/cmHopper/index.js",
7236     "groupTitle": "Cm_Hopper"
7237   },
7238   {
7239     "type": "get",
7240     "url": "/api/cm/hopper/opencontacts",
7241     "title": "Gets Open Contacts",
7242     "examples": [
7243       {
7244         "title": "Example usage:",
7245         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7246         "type": "json"
7247       }
7248     ],
7249     "name": "getOpenContacts",
7250     "group": "Cm_Hopper",
7251     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7252     "version": "0.0.0",
7253     "filename": "server/api/cmHopper/index.js",
7254     "groupTitle": "Cm_Hopper"
7255   },
7256   {
7257     "type": "post",
7258     "url": "/api/cm/hopper/preview",
7259     "title": "Gets Preview Dialer Contacts",
7260     "examples": [
7261       {
7262         "title": "Example usage:",
7263         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7264         "type": "json"
7265       }
7266     ],
7267     "name": "getPreview",
7268     "group": "Cm_Hopper",
7269     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7270     "version": "0.0.0",
7271     "filename": "server/api/cmHopper/index.js",
7272     "groupTitle": "Cm_Hopper"
7273   },
7274   {
7275     "type": "put",
7276     "url": "/api/cm/hopper/{id}",
7277     "title": "Update an existing Hopper",
7278     "examples": [
7279       {
7280         "title": "Example usage:",
7281         "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",
7282         "type": "json"
7283       }
7284     ],
7285     "name": "updateHopper",
7286     "group": "Cm_Hopper",
7287     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7288     "version": "0.0.0",
7289     "filename": "server/api/cmHopper/index.js",
7290     "groupTitle": "Cm_Hopper"
7291   },
7292   {
7293     "type": "post",
7294     "url": "/api/cm/lists",
7295     "title": "Creates a new List",
7296     "examples": [
7297       {
7298         "title": "Example usage:",
7299         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7300         "type": "json"
7301       }
7302     ],
7303     "name": "CreateLists",
7304     "group": "Cm_Lists",
7305     "parameter": {
7306       "fields": {
7307         "Body": [
7308           {
7309             "group": "Body",
7310             "type": "String",
7311             "optional": false,
7312             "field": "name",
7313             "description": ""
7314           },
7315           {
7316             "group": "Body",
7317             "type": "String",
7318             "optional": true,
7319             "field": "description",
7320             "description": ""
7321           },
7322           {
7323             "group": "Body",
7324             "type": "String",
7325             "optional": true,
7326             "field": "dialPrefix",
7327             "description": ""
7328           }
7329         ]
7330       }
7331     },
7332     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7333     "version": "0.0.0",
7334     "filename": "server/api/cmList/index.js",
7335     "groupTitle": "Cm_Lists"
7336   },
7337   {
7338     "type": "delete",
7339     "url": "/api/cm/lists/{id}",
7340     "title": "Deletes a List",
7341     "examples": [
7342       {
7343         "title": "Example usage:",
7344         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7345         "type": "json"
7346       }
7347     ],
7348     "name": "DeleteLists",
7349     "group": "Cm_Lists",
7350     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7351     "version": "0.0.0",
7352     "filename": "server/api/cmList/index.js",
7353     "groupTitle": "Cm_Lists"
7354   },
7355   {
7356     "type": "get",
7357     "url": "/api/cm/lists/describe",
7358     "title": "Gets table info about Lists",
7359     "examples": [
7360       {
7361         "title": "Example usage:",
7362         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7363         "type": "json"
7364       }
7365     ],
7366     "name": "DescribeLists",
7367     "group": "Cm_Lists",
7368     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7369     "version": "0.0.0",
7370     "filename": "server/api/cmList/index.js",
7371     "groupTitle": "Cm_Lists"
7372   },
7373   {
7374     "type": "get",
7375     "url": "/api/cm/lists/{id}/users",
7376     "title": "Gets agents from list",
7377     "examples": [
7378       {
7379         "title": "Example usage:",
7380         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7381         "type": "json"
7382       }
7383     ],
7384     "name": "GetAgents",
7385     "group": "Cm_Lists",
7386     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7387     "version": "0.0.0",
7388     "filename": "server/api/cmList/index.js",
7389     "groupTitle": "Cm_Lists"
7390   },
7391   {
7392     "type": "get",
7393     "url": "/api/cm/lists",
7394     "title": "Gets a list of Lists",
7395     "examples": [
7396       {
7397         "title": "Example usage:",
7398         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7399         "type": "json"
7400       }
7401     ],
7402     "name": "GetLists",
7403     "group": "Cm_Lists",
7404     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7405     "version": "0.0.0",
7406     "filename": "server/api/cmList/index.js",
7407     "groupTitle": "Cm_Lists"
7408   },
7409   {
7410     "type": "delete",
7411     "url": "/api/cm/lists/{id}/users",
7412     "title": "Removes agents from a list",
7413     "examples": [
7414       {
7415         "title": "Example usage:",
7416         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7417         "type": "json"
7418       }
7419     ],
7420     "name": "RemoveAgents",
7421     "group": "Cm_Lists",
7422     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7423     "version": "0.0.0",
7424     "filename": "server/api/cmList/index.js",
7425     "groupTitle": "Cm_Lists"
7426   },
7427   {
7428     "type": "delete",
7429     "url": "/api/cm/lists/{id}/dispositions",
7430     "title": "Removes dispositions from account",
7431     "examples": [
7432       {
7433         "title": "Example usage:",
7434         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7435         "type": "json"
7436       }
7437     ],
7438     "name": "RemoveDispositions",
7439     "group": "Cm_Lists",
7440     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7441     "version": "0.0.0",
7442     "filename": "server/api/cmList/index.js",
7443     "groupTitle": "Cm_Lists"
7444   },
7445   {
7446     "type": "get",
7447     "url": "/api/cm/lists/{id}",
7448     "title": "Gets a single List",
7449     "examples": [
7450       {
7451         "title": "Example usage:",
7452         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7453         "type": "json"
7454       }
7455     ],
7456     "name": "ShowLists",
7457     "group": "Cm_Lists",
7458     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7459     "version": "0.0.0",
7460     "filename": "server/api/cmList/index.js",
7461     "groupTitle": "Cm_Lists"
7462   },
7463   {
7464     "type": "post",
7465     "url": "/api/cm/lists/{id}/users",
7466     "title": "Adds agents to a list",
7467     "examples": [
7468       {
7469         "title": "Example usage:",
7470         "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",
7471         "type": "json"
7472       }
7473     ],
7474     "name": "addAgents",
7475     "group": "Cm_Lists",
7476     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7477     "version": "0.0.0",
7478     "filename": "server/api/cmList/index.js",
7479     "groupTitle": "Cm_Lists"
7480   },
7481   {
7482     "type": "post",
7483     "url": "/api/cm/lists/{id}/contacts",
7484     "title": "Creates new contacts",
7485     "examples": [
7486       {
7487         "title": "Example usage:",
7488         "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",
7489         "type": "json"
7490       }
7491     ],
7492     "name": "addContacts",
7493     "group": "Cm_Lists",
7494     "parameter": {
7495       "fields": {
7496         "Body": [
7497           {
7498             "group": "Body",
7499             "type": "String",
7500             "optional": false,
7501             "field": "firstName",
7502             "description": ""
7503           },
7504           {
7505             "group": "Body",
7506             "type": "String",
7507             "optional": true,
7508             "field": "lastName",
7509             "description": ""
7510           },
7511           {
7512             "group": "Body",
7513             "type": "String",
7514             "optional": true,
7515             "field": "street",
7516             "description": ""
7517           },
7518           {
7519             "group": "Body",
7520             "type": "String",
7521             "optional": true,
7522             "field": "postalCode",
7523             "description": ""
7524           },
7525           {
7526             "group": "Body",
7527             "type": "String",
7528             "optional": true,
7529             "field": "city",
7530             "description": ""
7531           },
7532           {
7533             "group": "Body",
7534             "type": "String",
7535             "optional": true,
7536             "field": "country",
7537             "description": ""
7538           },
7539           {
7540             "group": "Body",
7541             "type": "String",
7542             "optional": true,
7543             "field": "dateOfBirth",
7544             "description": ""
7545           },
7546           {
7547             "group": "Body",
7548             "type": "Text",
7549             "optional": true,
7550             "field": "description",
7551             "description": ""
7552           },
7553           {
7554             "group": "Body",
7555             "type": "String",
7556             "optional": true,
7557             "field": "phone",
7558             "description": ""
7559           },
7560           {
7561             "group": "Body",
7562             "type": "String",
7563             "optional": true,
7564             "field": "mobile",
7565             "description": ""
7566           },
7567           {
7568             "group": "Body",
7569             "type": "String",
7570             "optional": true,
7571             "field": "fax",
7572             "description": ""
7573           },
7574           {
7575             "group": "Body",
7576             "type": "String",
7577             "optional": true,
7578             "field": "email",
7579             "description": ""
7580           },
7581           {
7582             "group": "Body",
7583             "type": "String",
7584             "optional": true,
7585             "field": "url",
7586             "description": ""
7587           },
7588           {
7589             "group": "Body",
7590             "type": "String",
7591             "optional": true,
7592             "field": "facebook",
7593             "description": ""
7594           },
7595           {
7596             "group": "Body",
7597             "type": "String",
7598             "optional": true,
7599             "field": "fb_data",
7600             "description": ""
7601           },
7602           {
7603             "group": "Body",
7604             "type": "String",
7605             "optional": true,
7606             "field": "twitter",
7607             "description": ""
7608           },
7609           {
7610             "group": "Body",
7611             "type": "String",
7612             "optional": true,
7613             "field": "skype",
7614             "description": ""
7615           },
7616           {
7617             "group": "Body",
7618             "type": "String",
7619             "optional": true,
7620             "field": "teams",
7621             "description": ""
7622           },
7623           {
7624             "group": "Body",
7625             "type": "String",
7626             "optional": true,
7627             "field": "viber",
7628             "description": ""
7629           },
7630           {
7631             "group": "Body",
7632             "type": "String",
7633             "optional": true,
7634             "field": "line",
7635             "description": ""
7636           },
7637           {
7638             "group": "Body",
7639             "type": "String",
7640             "optional": true,
7641             "field": "wechat",
7642             "description": ""
7643           },
7644           {
7645             "group": "Body",
7646             "type": "String",
7647             "optional": true,
7648             "field": "telegram",
7649             "description": ""
7650           },
7651           {
7652             "group": "Body",
7653             "type": "Integer",
7654             "optional": true,
7655             "field": "UserId",
7656             "description": ""
7657           },
7658           {
7659             "group": "Body",
7660             "type": "Integer",
7661             "optional": true,
7662             "field": "priority",
7663             "description": ""
7664           },
7665           {
7666             "group": "Body",
7667             "type": "String",
7668             "optional": true,
7669             "field": "scheduledat",
7670             "description": ""
7671           }
7672         ]
7673       }
7674     },
7675     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7676     "version": "0.0.0",
7677     "filename": "server/api/cmList/index.js",
7678     "groupTitle": "Cm_Lists"
7679   },
7680   {
7681     "type": "post",
7682     "url": "/api/cm/lists/{id}/fields",
7683     "title": "Creates a new custom field",
7684     "examples": [
7685       {
7686         "title": "Example usage:",
7687         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7688         "type": "json"
7689       }
7690     ],
7691     "name": "addCustomField",
7692     "group": "Cm_Lists",
7693     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7694     "version": "0.0.0",
7695     "filename": "server/api/cmList/index.js",
7696     "groupTitle": "Cm_Lists"
7697   },
7698   {
7699     "type": "post",
7700     "url": "/api/cm/lists/{id}/dispositions",
7701     "title": "Creates new disposition",
7702     "examples": [
7703       {
7704         "title": "Example usage:",
7705         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7706         "type": "json"
7707       }
7708     ],
7709     "name": "addDisposition",
7710     "group": "Cm_Lists",
7711     "parameter": {
7712       "fields": {
7713         "Body": [
7714           {
7715             "group": "Body",
7716             "type": "String",
7717             "optional": false,
7718             "field": "name",
7719             "description": ""
7720           },
7721           {
7722             "group": "Body",
7723             "type": "String",
7724             "allowedValues": [
7725               "\"first\"",
7726               "\"second\"",
7727               "\"third\""
7728             ],
7729             "optional": false,
7730             "field": "level",
7731             "description": ""
7732           },
7733           {
7734             "group": "Body",
7735             "type": "String",
7736             "optional": true,
7737             "field": "description",
7738             "description": ""
7739           }
7740         ]
7741       }
7742     },
7743     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7744     "version": "0.0.0",
7745     "filename": "server/api/cmList/index.js",
7746     "groupTitle": "Cm_Lists"
7747   },
7748   {
7749     "type": "get",
7750     "url": "/api/cm/lists/{id}/contacts",
7751     "title": "Gets List Contacts",
7752     "examples": [
7753       {
7754         "title": "Example usage:",
7755         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7756         "type": "json"
7757       }
7758     ],
7759     "name": "getContacts",
7760     "group": "Cm_Lists",
7761     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7762     "version": "0.0.0",
7763     "filename": "server/api/cmList/index.js",
7764     "groupTitle": "Cm_Lists"
7765   },
7766   {
7767     "type": "get",
7768     "url": "/api/cm/lists/{id}/fields",
7769     "title": "Gets Custom Fields",
7770     "examples": [
7771       {
7772         "title": "Example usage:",
7773         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7774         "type": "json"
7775       }
7776     ],
7777     "name": "getCustomFields",
7778     "group": "Cm_Lists",
7779     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7780     "version": "0.0.0",
7781     "filename": "server/api/cmList/index.js",
7782     "groupTitle": "Cm_Lists"
7783   },
7784   {
7785     "type": "get",
7786     "url": "/api/cm/lists/{id}/dispositions",
7787     "title": "Gets list dispositions",
7788     "examples": [
7789       {
7790         "title": "Example usage:",
7791         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7792         "type": "json"
7793       }
7794     ],
7795     "name": "getDispositions",
7796     "group": "Cm_Lists",
7797     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7798     "version": "0.0.0",
7799     "filename": "server/api/cmList/index.js",
7800     "groupTitle": "Cm_Lists"
7801   },
7802   {
7803     "type": "get",
7804     "url": "/api/cm/lists/{id}/contacts/csv",
7805     "title": "Gets CSV List Contacts",
7806     "examples": [
7807       {
7808         "title": "Example usage:",
7809         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7810         "type": "json"
7811       }
7812     ],
7813     "name": "grunt",
7814     "group": "Cm_Lists",
7815     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7816     "version": "0.0.0",
7817     "filename": "server/api/cmList/index.js",
7818     "groupTitle": "Cm_Lists"
7819   },
7820   {
7821     "type": "put",
7822     "url": "/api/cm/lists/{id}",
7823     "title": "Update an existing List",
7824     "examples": [
7825       {
7826         "title": "Example usage:",
7827         "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",
7828         "type": "json"
7829       }
7830     ],
7831     "name": "updateLists",
7832     "group": "Cm_Lists",
7833     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7834     "version": "0.0.0",
7835     "filename": "server/api/cmList/index.js",
7836     "groupTitle": "Cm_Lists"
7837   },
7838   {
7839     "type": "post",
7840     "url": "/api/cm/contacts/upload/:id",
7841     "title": "Import new contacts by csv",
7842     "examples": [
7843       {
7844         "title": "Example usage:",
7845         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7846         "type": "json"
7847       }
7848     ],
7849     "name": "import",
7850     "group": "Cm_contacts",
7851     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7852     "version": "0.0.0",
7853     "filename": "server/api/cmContact/index.js",
7854     "groupTitle": "Cm_contacts"
7855   },
7856   {
7857     "type": "post",
7858     "url": "/api/cm/contacts/upload",
7859     "title": "Upload csv",
7860     "examples": [
7861       {
7862         "title": "Example usage:",
7863         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7864         "type": "json"
7865       }
7866     ],
7867     "name": "upload",
7868     "group": "Cm_contacts",
7869     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7870     "version": "0.0.0",
7871     "filename": "server/api/cmContact/index.js",
7872     "groupTitle": "Cm_contacts"
7873   },
7874   {
7875     "type": "post",
7876     "url": "/api/cm/contacts/csv",
7877     "title": "Create new contacts by csv",
7878     "examples": [
7879       {
7880         "title": "Example usage:",
7881         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7882         "type": "json"
7883       }
7884     ],
7885     "name": "uploadCsv",
7886     "group": "Cm_contacts",
7887     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7888     "version": "0.0.0",
7889     "filename": "server/api/cmContact/index.js",
7890     "groupTitle": "Cm_contacts"
7891   },
7892   {
7893     "type": "delete",
7894     "url": "/api/conditions/{id}",
7895     "title": "Deletes a Condition",
7896     "examples": [
7897       {
7898         "title": "Example usage:",
7899         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7900         "type": "json"
7901       }
7902     ],
7903     "name": "DeleteConditions",
7904     "group": "Conditions",
7905     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7906     "version": "0.0.0",
7907     "filename": "server/api/condition/index.js",
7908     "groupTitle": "Conditions"
7909   },
7910   {
7911     "type": "put",
7912     "url": "/api/conditions/{id}",
7913     "title": "Update an existing Condition",
7914     "examples": [
7915       {
7916         "title": "Example usage:",
7917         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7918         "type": "json"
7919       }
7920     ],
7921     "name": "updateConditions",
7922     "group": "Conditions",
7923     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7924     "version": "0.0.0",
7925     "filename": "server/api/condition/index.js",
7926     "groupTitle": "Conditions"
7927   },
7928   {
7929     "type": "post",
7930     "url": "/api/cm/custom_field",
7931     "title": "Create a new custom field",
7932     "examples": [
7933       {
7934         "title": "Example usage:",
7935         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7936         "type": "json"
7937       }
7938     ],
7939     "name": "CreateCustomField",
7940     "group": "Custom_Fields",
7941     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7942     "version": "0.0.0",
7943     "filename": "server/api/cmCustomField/index.js",
7944     "groupTitle": "Custom_Fields"
7945   },
7946   {
7947     "type": "post",
7948     "url": "/api/dashboards/items",
7949     "title": "Create dasboard item",
7950     "examples": [
7951       {
7952         "title": "Example usage:",
7953         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7954         "type": "json"
7955       }
7956     ],
7957     "name": "Create",
7958     "group": "Dashboard_Items",
7959     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7960     "version": "0.0.0",
7961     "filename": "server/api/dashboardItem/index.js",
7962     "groupTitle": "Dashboard_Items"
7963   },
7964   {
7965     "type": "delete",
7966     "url": "/api/dashboards/items/{id}",
7967     "title": "Deletes a Dashboard Item",
7968     "examples": [
7969       {
7970         "title": "Example usage:",
7971         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7972         "type": "json"
7973       }
7974     ],
7975     "name": "DeleteDashboard_Items",
7976     "group": "Dashboard_Items",
7977     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7978     "version": "0.0.0",
7979     "filename": "server/api/dashboardItem/index.js",
7980     "groupTitle": "Dashboard_Items"
7981   },
7982   {
7983     "type": "get",
7984     "url": "/api/dashboards/items/{id}",
7985     "title": "Gets a single Dashboard Item",
7986     "examples": [
7987       {
7988         "title": "Example usage:",
7989         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7990         "type": "json"
7991       }
7992     ],
7993     "name": "ShowDashboard_Items",
7994     "group": "Dashboard_Items",
7995     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7996     "version": "0.0.0",
7997     "filename": "server/api/dashboardItem/index.js",
7998     "groupTitle": "Dashboard_Items"
7999   },
8000   {
8001     "type": "put",
8002     "url": "/api/dashboards/items/{id}",
8003     "title": "Update an existing item",
8004     "examples": [
8005       {
8006         "title": "Example usage:",
8007         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
8008         "type": "json"
8009       }
8010     ],
8011     "name": "Update",
8012     "group": "Dashboard_Items",
8013     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8014     "version": "0.0.0",
8015     "filename": "server/api/dashboardItem/index.js",
8016     "groupTitle": "Dashboard_Items"
8017   },
8018   {
8019     "type": "post",
8020     "url": "/api/dashboards/clone",
8021     "title": "Clone an existing Dashboard",
8022     "examples": [
8023       {
8024         "title": "Example usage:",
8025         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8026         "type": "json"
8027       }
8028     ],
8029     "name": "CloneDashboards",
8030     "group": "Dashboards",
8031     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8032     "version": "0.0.0",
8033     "filename": "server/api/dashboard/index.js",
8034     "groupTitle": "Dashboards"
8035   },
8036   {
8037     "type": "post",
8038     "url": "/api/dashboards",
8039     "title": "Creates a new Dashboard",
8040     "examples": [
8041       {
8042         "title": "Example usage:",
8043         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8044         "type": "json"
8045       }
8046     ],
8047     "name": "CreateDashboards",
8048     "group": "Dashboards",
8049     "parameter": {
8050       "fields": {
8051         "Body": [
8052           {
8053             "group": "Body",
8054             "type": "String",
8055             "optional": false,
8056             "field": "name",
8057             "description": ""
8058           },
8059           {
8060             "group": "Body",
8061             "type": "String",
8062             "optional": true,
8063             "field": "description",
8064             "description": ""
8065           }
8066         ]
8067       }
8068     },
8069     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8070     "version": "0.0.0",
8071     "filename": "server/api/dashboard/index.js",
8072     "groupTitle": "Dashboards"
8073   },
8074   {
8075     "type": "delete",
8076     "url": "/api/dashboards/{id}",
8077     "title": "Deletes a Dashboard",
8078     "examples": [
8079       {
8080         "title": "Example usage:",
8081         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8082         "type": "json"
8083       }
8084     ],
8085     "name": "DeleteDashboards",
8086     "group": "Dashboards",
8087     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8088     "version": "0.0.0",
8089     "filename": "server/api/dashboard/index.js",
8090     "groupTitle": "Dashboards"
8091   },
8092   {
8093     "type": "get",
8094     "url": "/api/dashboards",
8095     "title": "Gets a list of Dashboards",
8096     "examples": [
8097       {
8098         "title": "Example usage:",
8099         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8100         "type": "json"
8101       }
8102     ],
8103     "name": "GetDashboards",
8104     "group": "Dashboards",
8105     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8106     "version": "0.0.0",
8107     "filename": "server/api/dashboard/index.js",
8108     "groupTitle": "Dashboards"
8109   },
8110   {
8111     "type": "get",
8112     "url": "/api/dashboards/{id}",
8113     "title": "Gets a single Dashboard",
8114     "examples": [
8115       {
8116         "title": "Example usage:",
8117         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8118         "type": "json"
8119       }
8120     ],
8121     "name": "ShowDashboards",
8122     "group": "Dashboards",
8123     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8124     "version": "0.0.0",
8125     "filename": "server/api/dashboard/index.js",
8126     "groupTitle": "Dashboards"
8127   },
8128   {
8129     "type": "post",
8130     "url": "/api/dashboards/{id}/items",
8131     "title": "Creates new item",
8132     "examples": [
8133       {
8134         "title": "Example usage:",
8135         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8136         "type": "json"
8137       }
8138     ],
8139     "name": "addItem",
8140     "group": "Dashboards",
8141     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8142     "version": "0.0.0",
8143     "filename": "server/api/dashboard/index.js",
8144     "groupTitle": "Dashboards"
8145   },
8146   {
8147     "type": "get",
8148     "url": "/api/dashboards/{id}/items",
8149     "title": "Gets items",
8150     "examples": [
8151       {
8152         "title": "Example usage:",
8153         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8154         "type": "json"
8155       }
8156     ],
8157     "name": "getItems",
8158     "group": "Dashboards",
8159     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8160     "version": "0.0.0",
8161     "filename": "server/api/dashboard/index.js",
8162     "groupTitle": "Dashboards"
8163   },
8164   {
8165     "type": "put",
8166     "url": "/api/dashboards/{id}",
8167     "title": "Update an existing Dashboard",
8168     "examples": [
8169       {
8170         "title": "Example usage:",
8171         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8172         "type": "json"
8173       }
8174     ],
8175     "name": "updateDashboards",
8176     "group": "Dashboards",
8177     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8178     "version": "0.0.0",
8179     "filename": "server/api/dashboard/index.js",
8180     "groupTitle": "Dashboards"
8181   },
8182   {
8183     "type": "post",
8184     "url": "/api/integrations/desk/accounts",
8185     "title": "Creates a new Desk Account",
8186     "examples": [
8187       {
8188         "title": "Example usage:",
8189         "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",
8190         "type": "json"
8191       }
8192     ],
8193     "name": "CreateDesk_Accounts",
8194     "group": "Desk_Accounts",
8195     "parameter": {
8196       "fields": {
8197         "Body": [
8198           {
8199             "group": "Body",
8200             "type": "String",
8201             "optional": true,
8202             "field": "name",
8203             "description": ""
8204           },
8205           {
8206             "group": "Body",
8207             "type": "String",
8208             "optional": true,
8209             "field": "description",
8210             "description": ""
8211           },
8212           {
8213             "group": "Body",
8214             "type": "String",
8215             "optional": true,
8216             "field": "username",
8217             "description": ""
8218           },
8219           {
8220             "group": "Body",
8221             "type": "String",
8222             "optional": true,
8223             "field": "remoteUri",
8224             "description": ""
8225           },
8226           {
8227             "group": "Body",
8228             "type": "String",
8229             "allowedValues": [
8230               "\"basic\""
8231             ],
8232             "optional": true,
8233             "field": "authType",
8234             "description": ""
8235           },
8236           {
8237             "group": "Body",
8238             "type": "String",
8239             "optional": true,
8240             "field": "password",
8241             "description": ""
8242           },
8243           {
8244             "group": "Body",
8245             "type": "String",
8246             "optional": true,
8247             "field": "consumerKey",
8248             "description": ""
8249           },
8250           {
8251             "group": "Body",
8252             "type": "String",
8253             "optional": true,
8254             "field": "consumerSecret",
8255             "description": ""
8256           },
8257           {
8258             "group": "Body",
8259             "type": "String",
8260             "optional": true,
8261             "field": "token",
8262             "description": ""
8263           },
8264           {
8265             "group": "Body",
8266             "type": "String",
8267             "optional": true,
8268             "field": "tokenSecret",
8269             "description": ""
8270           },
8271           {
8272             "group": "Body",
8273             "type": "String",
8274             "optional": false,
8275             "field": "serverUrl",
8276             "description": ""
8277           },
8278           {
8279             "group": "Body",
8280             "type": "String",
8281             "allowedValues": [
8282               "\"integrationTab\"",
8283               "\"newTab\""
8284             ],
8285             "optional": true,
8286             "field": "type",
8287             "description": ""
8288           }
8289         ]
8290       }
8291     },
8292     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8293     "version": "0.0.0",
8294     "filename": "server/api/intDeskAccount/index.js",
8295     "groupTitle": "Desk_Accounts"
8296   },
8297   {
8298     "type": "delete",
8299     "url": "/api/integrations/desk/accounts/{id}",
8300     "title": "Deletes a Desk Account",
8301     "examples": [
8302       {
8303         "title": "Example usage:",
8304         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8305         "type": "json"
8306       }
8307     ],
8308     "name": "DeleteDesk_Accounts",
8309     "group": "Desk_Accounts",
8310     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8311     "version": "0.0.0",
8312     "filename": "server/api/intDeskAccount/index.js",
8313     "groupTitle": "Desk_Accounts"
8314   },
8315   {
8316     "type": "get",
8317     "url": "/api/integrations/desk/accounts",
8318     "title": "Gets a list of Desk Accounts",
8319     "examples": [
8320       {
8321         "title": "Example usage:",
8322         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8323         "type": "json"
8324       }
8325     ],
8326     "name": "GetDesk_Accounts",
8327     "group": "Desk_Accounts",
8328     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8329     "version": "0.0.0",
8330     "filename": "server/api/intDeskAccount/index.js",
8331     "groupTitle": "Desk_Accounts"
8332   },
8333   {
8334     "type": "get",
8335     "url": "/api/integrations/desk/accounts/{id}",
8336     "title": "Gets a single Desk Account",
8337     "examples": [
8338       {
8339         "title": "Example usage:",
8340         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8341         "type": "json"
8342       }
8343     ],
8344     "name": "ShowDesk_Accounts",
8345     "group": "Desk_Accounts",
8346     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8347     "version": "0.0.0",
8348     "filename": "server/api/intDeskAccount/index.js",
8349     "groupTitle": "Desk_Accounts"
8350   },
8351   {
8352     "type": "post",
8353     "url": "/api/integrations/desk/accounts/{id}/configurations",
8354     "title": "Creates new configuration",
8355     "examples": [
8356       {
8357         "title": "Example usage:",
8358         "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",
8359         "type": "json"
8360       }
8361     ],
8362     "name": "addConfiguration",
8363     "group": "Desk_Accounts",
8364     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8365     "version": "0.0.0",
8366     "filename": "server/api/intDeskAccount/index.js",
8367     "groupTitle": "Desk_Accounts"
8368   },
8369   {
8370     "type": "get",
8371     "url": "/api/integrations/desk/accounts/{id}/configurations",
8372     "title": "Gets account configurations",
8373     "examples": [
8374       {
8375         "title": "Example usage:",
8376         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8377         "type": "json"
8378       }
8379     ],
8380     "name": "getConfigurations",
8381     "group": "Desk_Accounts",
8382     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8383     "version": "0.0.0",
8384     "filename": "server/api/intDeskAccount/index.js",
8385     "groupTitle": "Desk_Accounts"
8386   },
8387   {
8388     "type": "get",
8389     "url": "/api/integrations/desk/accounts/{id}/fields",
8390     "title": "Gets account fields",
8391     "examples": [
8392       {
8393         "title": "Example usage:",
8394         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8395         "type": "json"
8396       }
8397     ],
8398     "name": "getFields",
8399     "group": "Desk_Accounts",
8400     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8401     "version": "0.0.0",
8402     "filename": "server/api/intDeskAccount/index.js",
8403     "groupTitle": "Desk_Accounts"
8404   },
8405   {
8406     "type": "put",
8407     "url": "/api/integrations/desk/accounts/{id}",
8408     "title": "Update an existing Desk Account",
8409     "examples": [
8410       {
8411         "title": "Example usage:",
8412         "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",
8413         "type": "json"
8414       }
8415     ],
8416     "name": "updateDesk_Accounts",
8417     "group": "Desk_Accounts",
8418     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8419     "version": "0.0.0",
8420     "filename": "server/api/intDeskAccount/index.js",
8421     "groupTitle": "Desk_Accounts"
8422   },
8423   {
8424     "type": "post",
8425     "url": "/api/integrations/desk/configurations",
8426     "title": "Creates a new Desk Configuration",
8427     "examples": [
8428       {
8429         "title": "Example usage:",
8430         "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",
8431         "type": "json"
8432       }
8433     ],
8434     "name": "CreateDesk_Configurations",
8435     "group": "Desk_Configurations",
8436     "parameter": {
8437       "fields": {
8438         "Body": [
8439           {
8440             "group": "Body",
8441             "type": "String",
8442             "optional": true,
8443             "field": "name",
8444             "description": ""
8445           },
8446           {
8447             "group": "Body",
8448             "type": "String",
8449             "optional": true,
8450             "field": "description",
8451             "description": ""
8452           }
8453         ]
8454       }
8455     },
8456     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8457     "version": "0.0.0",
8458     "filename": "server/api/intDeskConfiguration/index.js",
8459     "groupTitle": "Desk_Configurations"
8460   },
8461   {
8462     "type": "delete",
8463     "url": "/api/integrations/desk/configurations/{id}",
8464     "title": "Deletes a Desk Configuration",
8465     "examples": [
8466       {
8467         "title": "Example usage:",
8468         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8469         "type": "json"
8470       }
8471     ],
8472     "name": "DeleteDesk_Configurations",
8473     "group": "Desk_Configurations",
8474     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8475     "version": "0.0.0",
8476     "filename": "server/api/intDeskConfiguration/index.js",
8477     "groupTitle": "Desk_Configurations"
8478   },
8479   {
8480     "type": "get",
8481     "url": "/api/integrations/desk/configurations",
8482     "title": "Gets a list of Desk Configurations",
8483     "examples": [
8484       {
8485         "title": "Example usage:",
8486         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8487         "type": "json"
8488       }
8489     ],
8490     "name": "GetDesk_Configurations",
8491     "group": "Desk_Configurations",
8492     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8493     "version": "0.0.0",
8494     "filename": "server/api/intDeskConfiguration/index.js",
8495     "groupTitle": "Desk_Configurations"
8496   },
8497   {
8498     "type": "get",
8499     "url": "/api/integrations/desk/configurations/{id}",
8500     "title": "Gets a single Desk Configuration",
8501     "examples": [
8502       {
8503         "title": "Example usage:",
8504         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8505         "type": "json"
8506       }
8507     ],
8508     "name": "ShowDesk_Configurations",
8509     "group": "Desk_Configurations",
8510     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8511     "version": "0.0.0",
8512     "filename": "server/api/intDeskConfiguration/index.js",
8513     "groupTitle": "Desk_Configurations"
8514   },
8515   {
8516     "type": "get",
8517     "url": "/api/integrations/desk/configurations/{id}/descriptions",
8518     "title": "Gets configurations descriptions",
8519     "examples": [
8520       {
8521         "title": "Example usage:",
8522         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8523         "type": "json"
8524       }
8525     ],
8526     "name": "getDescriptions",
8527     "group": "Desk_Configurations",
8528     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8529     "version": "0.0.0",
8530     "filename": "server/api/intDeskConfiguration/index.js",
8531     "groupTitle": "Desk_Configurations"
8532   },
8533   {
8534     "type": "get",
8535     "url": "/api/integrations/desk/configurations/{id}/fields",
8536     "title": "Gets configurations fields",
8537     "examples": [
8538       {
8539         "title": "Example usage:",
8540         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8541         "type": "json"
8542       }
8543     ],
8544     "name": "getFields",
8545     "group": "Desk_Configurations",
8546     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8547     "version": "0.0.0",
8548     "filename": "server/api/intDeskConfiguration/index.js",
8549     "groupTitle": "Desk_Configurations"
8550   },
8551   {
8552     "type": "get",
8553     "url": "/api/integrations/desk/configurations/{id}/subjects",
8554     "title": "Gets configurations subjects",
8555     "examples": [
8556       {
8557         "title": "Example usage:",
8558         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8559         "type": "json"
8560       }
8561     ],
8562     "name": "getSubjects",
8563     "group": "Desk_Configurations",
8564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8565     "version": "0.0.0",
8566     "filename": "server/api/intDeskConfiguration/index.js",
8567     "groupTitle": "Desk_Configurations"
8568   },
8569   {
8570     "type": "get",
8571     "url": "/api/integrations/desk/configurations/{id}/tags",
8572     "title": "Gets configurations tags",
8573     "examples": [
8574       {
8575         "title": "Example usage:",
8576         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8577         "type": "json"
8578       }
8579     ],
8580     "name": "getTags",
8581     "group": "Desk_Configurations",
8582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8583     "version": "0.0.0",
8584     "filename": "server/api/intDeskConfiguration/index.js",
8585     "groupTitle": "Desk_Configurations"
8586   },
8587   {
8588     "type": "post",
8589     "url": "/api/integrations/desk/configurations/{id}/tags",
8590     "title": "Sets new tags",
8591     "examples": [
8592       {
8593         "title": "Example usage:",
8594         "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",
8595         "type": "json"
8596       }
8597     ],
8598     "name": "setTags",
8599     "group": "Desk_Configurations",
8600     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8601     "version": "0.0.0",
8602     "filename": "server/api/intDeskConfiguration/index.js",
8603     "groupTitle": "Desk_Configurations"
8604   },
8605   {
8606     "type": "put",
8607     "url": "/api/integrations/desk/configurations/{id}",
8608     "title": "Update an existing Desk Configuration",
8609     "examples": [
8610       {
8611         "title": "Example usage:",
8612         "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",
8613         "type": "json"
8614       }
8615     ],
8616     "name": "updateDesk_Configurations",
8617     "group": "Desk_Configurations",
8618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8619     "version": "0.0.0",
8620     "filename": "server/api/intDeskConfiguration/index.js",
8621     "groupTitle": "Desk_Configurations"
8622   },
8623   {
8624     "type": "post",
8625     "url": "/api/integrations/desk/fields",
8626     "title": "Creates a new Desk Field",
8627     "examples": [
8628       {
8629         "title": "Example usage:",
8630         "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",
8631         "type": "json"
8632       }
8633     ],
8634     "name": "CreateDesk_Fields",
8635     "group": "Desk_Fields",
8636     "parameter": {
8637       "fields": {
8638         "Body": [
8639           {
8640             "group": "Body",
8641             "type": "String",
8642             "allowedValues": [
8643               "\"string\"",
8644               "\"variable\"",
8645               "\"customVariable\"",
8646               "\"keyValue\"",
8647               "\"picklist\""
8648             ],
8649             "optional": true,
8650             "field": "type",
8651             "description": ""
8652           },
8653           {
8654             "group": "Body",
8655             "type": "String",
8656             "optional": true,
8657             "field": "content",
8658             "description": ""
8659           },
8660           {
8661             "group": "Body",
8662             "type": "String",
8663             "optional": true,
8664             "field": "key",
8665             "description": ""
8666           },
8667           {
8668             "group": "Body",
8669             "type": "String",
8670             "allowedValues": [
8671               "\"string\"",
8672               "\"variable\"",
8673               "\"customVariable\""
8674             ],
8675             "optional": true,
8676             "field": "keyType",
8677             "description": ""
8678           },
8679           {
8680             "group": "Body",
8681             "type": "String",
8682             "optional": true,
8683             "field": "keyContent",
8684             "description": ""
8685           },
8686           {
8687             "group": "Body",
8688             "type": "String",
8689             "optional": true,
8690             "field": "idField",
8691             "description": ""
8692           },
8693           {
8694             "group": "Body",
8695             "type": "String",
8696             "optional": true,
8697             "field": "nameField",
8698             "description": ""
8699           },
8700           {
8701             "group": "Body",
8702             "type": "Boolean",
8703             "optional": true,
8704             "field": "customField",
8705             "description": ""
8706           },
8707           {
8708             "group": "Body",
8709             "type": "String",
8710             "optional": true,
8711             "field": "variableName",
8712             "description": ""
8713           }
8714         ]
8715       }
8716     },
8717     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8718     "version": "0.0.0",
8719     "filename": "server/api/intDeskField/index.js",
8720     "groupTitle": "Desk_Fields"
8721   },
8722   {
8723     "type": "delete",
8724     "url": "/api/integrations/desk/fields/{id}",
8725     "title": "Deletes a Desk Field",
8726     "examples": [
8727       {
8728         "title": "Example usage:",
8729         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8730         "type": "json"
8731       }
8732     ],
8733     "name": "DeleteDesk_Fields",
8734     "group": "Desk_Fields",
8735     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8736     "version": "0.0.0",
8737     "filename": "server/api/intDeskField/index.js",
8738     "groupTitle": "Desk_Fields"
8739   },
8740   {
8741     "type": "get",
8742     "url": "/api/integrations/desk/fields",
8743     "title": "Gets a list of Desk Fields",
8744     "examples": [
8745       {
8746         "title": "Example usage:",
8747         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8748         "type": "json"
8749       }
8750     ],
8751     "name": "GetDesk_Fields",
8752     "group": "Desk_Fields",
8753     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8754     "version": "0.0.0",
8755     "filename": "server/api/intDeskField/index.js",
8756     "groupTitle": "Desk_Fields"
8757   },
8758   {
8759     "type": "get",
8760     "url": "/api/integrations/desk/fields/{id}",
8761     "title": "Gets a single Desk Field",
8762     "examples": [
8763       {
8764         "title": "Example usage:",
8765         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8766         "type": "json"
8767       }
8768     ],
8769     "name": "ShowDesk_Fields",
8770     "group": "Desk_Fields",
8771     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8772     "version": "0.0.0",
8773     "filename": "server/api/intDeskField/index.js",
8774     "groupTitle": "Desk_Fields"
8775   },
8776   {
8777     "type": "put",
8778     "url": "/api/integrations/desk/fields/{id}",
8779     "title": "Update an existing Desk Field",
8780     "examples": [
8781       {
8782         "title": "Example usage:",
8783         "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",
8784         "type": "json"
8785       }
8786     ],
8787     "name": "updateDesk_Fields",
8788     "group": "Desk_Fields",
8789     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8790     "version": "0.0.0",
8791     "filename": "server/api/intDeskField/index.js",
8792     "groupTitle": "Desk_Fields"
8793   },
8794   {
8795     "type": "post",
8796     "url": "/api/dispositions",
8797     "title": "Creates a new Disposition",
8798     "examples": [
8799       {
8800         "title": "Example usage:",
8801         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8802         "type": "json"
8803       }
8804     ],
8805     "name": "CreateDispositions",
8806     "group": "Dispositions",
8807     "parameter": {
8808       "fields": {
8809         "Body": [
8810           {
8811             "group": "Body",
8812             "type": "String",
8813             "optional": false,
8814             "field": "name",
8815             "description": ""
8816           },
8817           {
8818             "group": "Body",
8819             "type": "String",
8820             "allowedValues": [
8821               "\"first\"",
8822               "\"second\"",
8823               "\"third\""
8824             ],
8825             "optional": false,
8826             "field": "level",
8827             "description": ""
8828           },
8829           {
8830             "group": "Body",
8831             "type": "String",
8832             "optional": true,
8833             "field": "description",
8834             "description": ""
8835           }
8836         ]
8837       }
8838     },
8839     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8840     "version": "0.0.0",
8841     "filename": "server/api/disposition/index.js",
8842     "groupTitle": "Dispositions"
8843   },
8844   {
8845     "type": "delete",
8846     "url": "/api/dispositions/{id}",
8847     "title": "Deletes a Disposition",
8848     "examples": [
8849       {
8850         "title": "Example usage:",
8851         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8852         "type": "json"
8853       }
8854     ],
8855     "name": "DeleteDispositions",
8856     "group": "Dispositions",
8857     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8858     "version": "0.0.0",
8859     "filename": "server/api/disposition/index.js",
8860     "groupTitle": "Dispositions"
8861   },
8862   {
8863     "type": "get",
8864     "url": "/api/dispositions",
8865     "title": "Gets a list of Dispositions",
8866     "examples": [
8867       {
8868         "title": "Example usage:",
8869         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8870         "type": "json"
8871       }
8872     ],
8873     "name": "GetDispositions",
8874     "group": "Dispositions",
8875     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8876     "version": "0.0.0",
8877     "filename": "server/api/disposition/index.js",
8878     "groupTitle": "Dispositions"
8879   },
8880   {
8881     "type": "get",
8882     "url": "/api/dispositions/{id}",
8883     "title": "Gets a single Disposition",
8884     "examples": [
8885       {
8886         "title": "Example usage:",
8887         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8888         "type": "json"
8889       }
8890     ],
8891     "name": "ShowDispositions",
8892     "group": "Dispositions",
8893     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8894     "version": "0.0.0",
8895     "filename": "server/api/disposition/index.js",
8896     "groupTitle": "Dispositions"
8897   },
8898   {
8899     "type": "put",
8900     "url": "/api/dispositions/{id}",
8901     "title": "Update an existing Disposition",
8902     "examples": [
8903       {
8904         "title": "Example usage:",
8905         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8906         "type": "json"
8907       }
8908     ],
8909     "name": "updateDispositions",
8910     "group": "Dispositions",
8911     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8912     "version": "0.0.0",
8913     "filename": "server/api/disposition/index.js",
8914     "groupTitle": "Dispositions"
8915   },
8916   {
8917     "type": "post",
8918     "url": "/api/integrations/dynamics365/accounts",
8919     "title": "Creates a new Dynamics365 Account",
8920     "examples": [
8921       {
8922         "title": "Example usage:",
8923         "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",
8924         "type": "json"
8925       }
8926     ],
8927     "name": "CreateDynamics365_Accounts",
8928     "group": "Dynamics365_Accounts",
8929     "parameter": {
8930       "fields": {
8931         "Body": [
8932           {
8933             "group": "Body",
8934             "type": "String",
8935             "optional": true,
8936             "field": "name",
8937             "description": ""
8938           },
8939           {
8940             "group": "Body",
8941             "type": "String",
8942             "optional": true,
8943             "field": "username",
8944             "description": ""
8945           },
8946           {
8947             "group": "Body",
8948             "type": "String",
8949             "optional": true,
8950             "field": "password",
8951             "description": ""
8952           },
8953           {
8954             "group": "Body",
8955             "type": "String",
8956             "optional": true,
8957             "field": "remoteUri",
8958             "description": ""
8959           },
8960           {
8961             "group": "Body",
8962             "type": "String",
8963             "optional": true,
8964             "field": "tenantId",
8965             "description": ""
8966           },
8967           {
8968             "group": "Body",
8969             "type": "String",
8970             "optional": true,
8971             "field": "clientId",
8972             "description": ""
8973           },
8974           {
8975             "group": "Body",
8976             "type": "String",
8977             "optional": true,
8978             "field": "clientSecret",
8979             "description": ""
8980           },
8981           {
8982             "group": "Body",
8983             "type": "String",
8984             "optional": false,
8985             "field": "serverUrl",
8986             "description": ""
8987           },
8988           {
8989             "group": "Body",
8990             "type": "String",
8991             "optional": true,
8992             "field": "description",
8993             "description": ""
8994           }
8995         ]
8996       }
8997     },
8998     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8999     "version": "0.0.0",
9000     "filename": "server/api/intDynamics365Account/index.js",
9001     "groupTitle": "Dynamics365_Accounts"
9002   },
9003   {
9004     "type": "delete",
9005     "url": "/api/integrations/dynamics365/accounts/{id}",
9006     "title": "Deletes a Dynamics365 Account",
9007     "examples": [
9008       {
9009         "title": "Example usage:",
9010         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
9011         "type": "json"
9012       }
9013     ],
9014     "name": "DeleteDynamics365_Accounts",
9015     "group": "Dynamics365_Accounts",
9016     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9017     "version": "0.0.0",
9018     "filename": "server/api/intDynamics365Account/index.js",
9019     "groupTitle": "Dynamics365_Accounts"
9020   },
9021   {
9022     "type": "get",
9023     "url": "/api/integrations/dynamics365/accounts",
9024     "title": "Gets a list of Dynamics365 Accounts",
9025     "examples": [
9026       {
9027         "title": "Example usage:",
9028         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
9029         "type": "json"
9030       }
9031     ],
9032     "name": "GetDynamics365_Accounts",
9033     "group": "Dynamics365_Accounts",
9034     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9035     "version": "0.0.0",
9036     "filename": "server/api/intDynamics365Account/index.js",
9037     "groupTitle": "Dynamics365_Accounts"
9038   },
9039   {
9040     "type": "get",
9041     "url": "/api/integrations/dynamics365/accounts/{id}",
9042     "title": "Gets a single Dynamics365 Account",
9043     "examples": [
9044       {
9045         "title": "Example usage:",
9046         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9047         "type": "json"
9048       }
9049     ],
9050     "name": "ShowDynamics365_Accounts",
9051     "group": "Dynamics365_Accounts",
9052     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9053     "version": "0.0.0",
9054     "filename": "server/api/intDynamics365Account/index.js",
9055     "groupTitle": "Dynamics365_Accounts"
9056   },
9057   {
9058     "type": "post",
9059     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9060     "title": "Creates new configuration",
9061     "examples": [
9062       {
9063         "title": "Example usage:",
9064         "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",
9065         "type": "json"
9066       }
9067     ],
9068     "name": "addConfiguration",
9069     "group": "Dynamics365_Accounts",
9070     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9071     "version": "0.0.0",
9072     "filename": "server/api/intDynamics365Account/index.js",
9073     "groupTitle": "Dynamics365_Accounts"
9074   },
9075   {
9076     "type": "get",
9077     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9078     "title": "Gets account configurations",
9079     "examples": [
9080       {
9081         "title": "Example usage:",
9082         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9083         "type": "json"
9084       }
9085     ],
9086     "name": "getConfigurations",
9087     "group": "Dynamics365_Accounts",
9088     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9089     "version": "0.0.0",
9090     "filename": "server/api/intDynamics365Account/index.js",
9091     "groupTitle": "Dynamics365_Accounts"
9092   },
9093   {
9094     "type": "get",
9095     "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9096     "title": "Gets account fields",
9097     "examples": [
9098       {
9099         "title": "Example usage:",
9100         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9101         "type": "json"
9102       }
9103     ],
9104     "name": "getFields",
9105     "group": "Dynamics365_Accounts",
9106     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9107     "version": "0.0.0",
9108     "filename": "server/api/intDynamics365Account/index.js",
9109     "groupTitle": "Dynamics365_Accounts"
9110   },
9111   {
9112     "type": "put",
9113     "url": "/api/integrations/dynamics365/accounts/{id}",
9114     "title": "Update an existing Dynamics365 Account",
9115     "examples": [
9116       {
9117         "title": "Example usage:",
9118         "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",
9119         "type": "json"
9120       }
9121     ],
9122     "name": "updateDynamics365_Accounts",
9123     "group": "Dynamics365_Accounts",
9124     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9125     "version": "0.0.0",
9126     "filename": "server/api/intDynamics365Account/index.js",
9127     "groupTitle": "Dynamics365_Accounts"
9128   },
9129   {
9130     "type": "post",
9131     "url": "/api/integrations/dynamics365/configurations",
9132     "title": "Creates a new Dynamics365 Configuration",
9133     "examples": [
9134       {
9135         "title": "Example usage:",
9136         "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",
9137         "type": "json"
9138       }
9139     ],
9140     "name": "CreateDynamics365_Configurations",
9141     "group": "Dynamics365_Configurations",
9142     "parameter": {
9143       "fields": {
9144         "Body": [
9145           {
9146             "group": "Body",
9147             "type": "String",
9148             "optional": true,
9149             "field": "name",
9150             "description": ""
9151           },
9152           {
9153             "group": "Body",
9154             "type": "String",
9155             "optional": true,
9156             "field": "description",
9157             "description": ""
9158           },
9159           {
9160             "group": "Body",
9161             "type": "String",
9162             "allowedValues": [
9163               "\"incident\"",
9164               "\"phonecall\""
9165             ],
9166             "optional": true,
9167             "field": "ticketType",
9168             "description": ""
9169           }
9170         ]
9171       }
9172     },
9173     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9174     "version": "0.0.0",
9175     "filename": "server/api/intDynamics365Configuration/index.js",
9176     "groupTitle": "Dynamics365_Configurations"
9177   },
9178   {
9179     "type": "delete",
9180     "url": "/api/integrations/dynamics365/configurations/{id}",
9181     "title": "Deletes a Dynamics365 Configuration",
9182     "examples": [
9183       {
9184         "title": "Example usage:",
9185         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9186         "type": "json"
9187       }
9188     ],
9189     "name": "DeleteDynamics365_Configurations",
9190     "group": "Dynamics365_Configurations",
9191     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9192     "version": "0.0.0",
9193     "filename": "server/api/intDynamics365Configuration/index.js",
9194     "groupTitle": "Dynamics365_Configurations"
9195   },
9196   {
9197     "type": "get",
9198     "url": "/api/integrations/dynamics365/configurations",
9199     "title": "Gets a list of Dynamics365 Configurations",
9200     "examples": [
9201       {
9202         "title": "Example usage:",
9203         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9204         "type": "json"
9205       }
9206     ],
9207     "name": "GetDynamics365_Configurations",
9208     "group": "Dynamics365_Configurations",
9209     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9210     "version": "0.0.0",
9211     "filename": "server/api/intDynamics365Configuration/index.js",
9212     "groupTitle": "Dynamics365_Configurations"
9213   },
9214   {
9215     "type": "get",
9216     "url": "/api/integrations/dynamics365/configurations/{id}",
9217     "title": "Gets a single Dynamics365 Configuration",
9218     "examples": [
9219       {
9220         "title": "Example usage:",
9221         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9222         "type": "json"
9223       }
9224     ],
9225     "name": "ShowDynamics365_Configurations",
9226     "group": "Dynamics365_Configurations",
9227     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9228     "version": "0.0.0",
9229     "filename": "server/api/intDynamics365Configuration/index.js",
9230     "groupTitle": "Dynamics365_Configurations"
9231   },
9232   {
9233     "type": "get",
9234     "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9235     "title": "Gets configurations descriptions",
9236     "examples": [
9237       {
9238         "title": "Example usage:",
9239         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9240         "type": "json"
9241       }
9242     ],
9243     "name": "getDescriptions",
9244     "group": "Dynamics365_Configurations",
9245     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9246     "version": "0.0.0",
9247     "filename": "server/api/intDynamics365Configuration/index.js",
9248     "groupTitle": "Dynamics365_Configurations"
9249   },
9250   {
9251     "type": "get",
9252     "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9253     "title": "Gets configurations fields",
9254     "examples": [
9255       {
9256         "title": "Example usage:",
9257         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9258         "type": "json"
9259       }
9260     ],
9261     "name": "getFields",
9262     "group": "Dynamics365_Configurations",
9263     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9264     "version": "0.0.0",
9265     "filename": "server/api/intDynamics365Configuration/index.js",
9266     "groupTitle": "Dynamics365_Configurations"
9267   },
9268   {
9269     "type": "get",
9270     "url": "/api/integrations/zoho/configurations/{id}/subjects",
9271     "title": "Gets configurations subjects",
9272     "examples": [
9273       {
9274         "title": "Example usage:",
9275         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9276         "type": "json"
9277       }
9278     ],
9279     "name": "getSubjects",
9280     "group": "Dynamics365_Configurations",
9281     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9282     "version": "0.0.0",
9283     "filename": "server/api/intDynamics365Configuration/index.js",
9284     "groupTitle": "Dynamics365_Configurations"
9285   },
9286   {
9287     "type": "put",
9288     "url": "/api/integrations/dynamics365/configurations/{id}",
9289     "title": "Update an existing Dynamics365 Configuration",
9290     "examples": [
9291       {
9292         "title": "Example usage:",
9293         "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",
9294         "type": "json"
9295       }
9296     ],
9297     "name": "updateDynamics365_Configurations",
9298     "group": "Dynamics365_Configurations",
9299     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9300     "version": "0.0.0",
9301     "filename": "server/api/intDynamics365Configuration/index.js",
9302     "groupTitle": "Dynamics365_Configurations"
9303   },
9304   {
9305     "type": "post",
9306     "url": "/api/integrations/dynamics365/fields",
9307     "title": "Creates a new Dynamics365 Field",
9308     "examples": [
9309       {
9310         "title": "Example usage:",
9311         "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",
9312         "type": "json"
9313       }
9314     ],
9315     "name": "CreateDynamics365_Fields",
9316     "group": "Dynamics365_Fields",
9317     "parameter": {
9318       "fields": {
9319         "Body": [
9320           {
9321             "group": "Body",
9322             "type": "String",
9323             "allowedValues": [
9324               "\"string\"",
9325               "\"variable\"",
9326               "\"customVariable\"",
9327               "\"keyValue\"",
9328               "\"picklist\""
9329             ],
9330             "optional": true,
9331             "field": "type",
9332             "description": ""
9333           },
9334           {
9335             "group": "Body",
9336             "type": "String",
9337             "optional": true,
9338             "field": "content",
9339             "description": ""
9340           },
9341           {
9342             "group": "Body",
9343             "type": "String",
9344             "optional": true,
9345             "field": "key",
9346             "description": ""
9347           },
9348           {
9349             "group": "Body",
9350             "type": "String",
9351             "allowedValues": [
9352               "\"string\"",
9353               "\"variable\"",
9354               "\"customVariable\""
9355             ],
9356             "optional": true,
9357             "field": "keyType",
9358             "description": ""
9359           },
9360           {
9361             "group": "Body",
9362             "type": "String",
9363             "optional": true,
9364             "field": "keyContent",
9365             "description": ""
9366           },
9367           {
9368             "group": "Body",
9369             "type": "String",
9370             "optional": true,
9371             "field": "idField",
9372             "description": ""
9373           },
9374           {
9375             "group": "Body",
9376             "type": "String",
9377             "optional": true,
9378             "field": "nameField",
9379             "description": ""
9380           },
9381           {
9382             "group": "Body",
9383             "type": "Boolean",
9384             "optional": true,
9385             "field": "customField",
9386             "description": ""
9387           },
9388           {
9389             "group": "Body",
9390             "type": "String",
9391             "optional": true,
9392             "field": "variableName",
9393             "description": ""
9394           }
9395         ]
9396       }
9397     },
9398     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9399     "version": "0.0.0",
9400     "filename": "server/api/intDynamics365Field/index.js",
9401     "groupTitle": "Dynamics365_Fields"
9402   },
9403   {
9404     "type": "delete",
9405     "url": "/api/integrations/dynamics365/fields/{id}",
9406     "title": "Deletes a Dynamics365 Field",
9407     "examples": [
9408       {
9409         "title": "Example usage:",
9410         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9411         "type": "json"
9412       }
9413     ],
9414     "name": "DeleteDynamics365_Fields",
9415     "group": "Dynamics365_Fields",
9416     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9417     "version": "0.0.0",
9418     "filename": "server/api/intDynamics365Field/index.js",
9419     "groupTitle": "Dynamics365_Fields"
9420   },
9421   {
9422     "type": "get",
9423     "url": "/api/integrations/dynamics365/fields",
9424     "title": "Gets a list of Dynamics365 Fields",
9425     "examples": [
9426       {
9427         "title": "Example usage:",
9428         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9429         "type": "json"
9430       }
9431     ],
9432     "name": "GetDynamics365_Fields",
9433     "group": "Dynamics365_Fields",
9434     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9435     "version": "0.0.0",
9436     "filename": "server/api/intDynamics365Field/index.js",
9437     "groupTitle": "Dynamics365_Fields"
9438   },
9439   {
9440     "type": "get",
9441     "url": "/api/integrations/dynamics365/fields/{id}",
9442     "title": "Gets a single Dynamics365 Field",
9443     "examples": [
9444       {
9445         "title": "Example usage:",
9446         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9447         "type": "json"
9448       }
9449     ],
9450     "name": "ShowDynamics365_Fields",
9451     "group": "Dynamics365_Fields",
9452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9453     "version": "0.0.0",
9454     "filename": "server/api/intDynamics365Field/index.js",
9455     "groupTitle": "Dynamics365_Fields"
9456   },
9457   {
9458     "type": "put",
9459     "url": "/api/integrations/dynamics365/fields/{id}",
9460     "title": "Update an existing Dynamics365 Field",
9461     "examples": [
9462       {
9463         "title": "Example usage:",
9464         "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",
9465         "type": "json"
9466       }
9467     ],
9468     "name": "updateDynamics365_Fields",
9469     "group": "Dynamics365_Fields",
9470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9471     "version": "0.0.0",
9472     "filename": "server/api/intDynamics365Field/index.js",
9473     "groupTitle": "Dynamics365_Fields"
9474   },
9475   {
9476     "type": "post",
9477     "url": "/api/fax/accounts/{id}/users",
9478     "title": "Add agents to a fax account",
9479     "examples": [
9480       {
9481         "title": "Example usage:",
9482         "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",
9483         "type": "json"
9484       }
9485     ],
9486     "name": "AddAgents",
9487     "group": "Fax_Accounts",
9488     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9489     "version": "0.0.0",
9490     "filename": "server/api/faxAccount/index.js",
9491     "groupTitle": "Fax_Accounts"
9492   },
9493   {
9494     "type": "post",
9495     "url": "/api/fax/accounts",
9496     "title": "Creates a new Account",
9497     "examples": [
9498       {
9499         "title": "Example usage:",
9500         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9501         "type": "json"
9502       }
9503     ],
9504     "name": "CreateAccounts",
9505     "group": "Fax_Accounts",
9506     "parameter": {
9507       "fields": {
9508         "Body": [
9509           {
9510             "group": "Body",
9511             "type": "String",
9512             "optional": false,
9513             "field": "name",
9514             "description": ""
9515           },
9516           {
9517             "group": "Body",
9518             "type": "String",
9519             "optional": true,
9520             "field": "description",
9521             "description": ""
9522           },
9523           {
9524             "group": "Body",
9525             "type": "String",
9526             "allowedValues": [
9527               "\"yes\"",
9528               "\"no\""
9529             ],
9530             "optional": true,
9531             "field": "ecm",
9532             "description": ""
9533           },
9534           {
9535             "group": "Body",
9536             "type": "String",
9537             "optional": true,
9538             "field": "headerinfo",
9539             "description": ""
9540           },
9541           {
9542             "group": "Body",
9543             "type": "String",
9544             "optional": true,
9545             "field": "localstationid",
9546             "description": ""
9547           },
9548           {
9549             "group": "Body",
9550             "type": "String",
9551             "allowedValues": [
9552               "\"2400\"",
9553               "\"4800\"",
9554               "\"7200\"",
9555               "\"9600\"",
9556               "\"12000\"",
9557               "\"14400\""
9558             ],
9559             "optional": true,
9560             "field": "minrate",
9561             "description": ""
9562           },
9563           {
9564             "group": "Body",
9565             "type": "String",
9566             "allowedValues": [
9567               "\"2400\"",
9568               "\"4800\"",
9569               "\"7200\"",
9570               "\"9600\"",
9571               "\"12000\"",
9572               "\"14400\""
9573             ],
9574             "optional": true,
9575             "field": "maxrate",
9576             "description": ""
9577           },
9578           {
9579             "group": "Body",
9580             "type": "String",
9581             "optional": true,
9582             "field": "modem",
9583             "description": ""
9584           },
9585           {
9586             "group": "Body",
9587             "type": "String",
9588             "optional": true,
9589             "field": "gateway",
9590             "description": ""
9591           },
9592           {
9593             "group": "Body",
9594             "type": "String",
9595             "optional": true,
9596             "field": "faxdetect",
9597             "description": ""
9598           },
9599           {
9600             "group": "Body",
9601             "type": "Integer",
9602             "optional": true,
9603             "field": "t38timeout",
9604             "description": ""
9605           },
9606           {
9607             "group": "Body",
9608             "type": "String",
9609             "allowedValues": [
9610               "\"SIP\"",
9611               "\"IAX\"",
9612               "\"DADHI\"",
9613               "\"KHOMP\""
9614             ],
9615             "optional": true,
9616             "field": "tech",
9617             "description": ""
9618           },
9619           {
9620             "group": "Body",
9621             "type": "String",
9622             "optional": false,
9623             "field": "key",
9624             "description": ""
9625           },
9626           {
9627             "group": "Body",
9628             "type": "Text",
9629             "optional": true,
9630             "field": "notificationTemplate",
9631             "description": ""
9632           },
9633           {
9634             "group": "Body",
9635             "type": "Boolean",
9636             "optional": true,
9637             "field": "notificationSound",
9638             "description": ""
9639           },
9640           {
9641             "group": "Body",
9642             "type": "Boolean",
9643             "optional": true,
9644             "field": "notificationShake",
9645             "description": ""
9646           },
9647           {
9648             "group": "Body",
9649             "type": "Integer",
9650             "optional": true,
9651             "field": "waitForTheAssignedAgent",
9652             "description": ""
9653           },
9654           {
9655             "group": "Body",
9656             "type": "Boolean",
9657             "optional": true,
9658             "field": "queueTransfer",
9659             "description": ""
9660           },
9661           {
9662             "group": "Body",
9663             "type": "Integer",
9664             "optional": true,
9665             "field": "queueTransferTimeout",
9666             "description": ""
9667           },
9668           {
9669             "group": "Body",
9670             "type": "Boolean",
9671             "optional": true,
9672             "field": "agentTransfer",
9673             "description": ""
9674           },
9675           {
9676             "group": "Body",
9677             "type": "Integer",
9678             "optional": true,
9679             "field": "agentTransferTimeout",
9680             "description": ""
9681           },
9682           {
9683             "group": "Body",
9684             "type": "Integer",
9685             "optional": true,
9686             "field": "mandatoryDispositionPauseId",
9687             "description": "<p>Status to put when mandatory disposition is enabled</p>"
9688           },
9689           {
9690             "group": "Body",
9691             "type": "Boolean",
9692             "optional": true,
9693             "field": "mandatoryDisposition",
9694             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9695           }
9696         ]
9697       }
9698     },
9699     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9700     "version": "0.0.0",
9701     "filename": "server/api/faxAccount/index.js",
9702     "groupTitle": "Fax_Accounts"
9703   },
9704   {
9705     "type": "delete",
9706     "url": "/api/fax/accounts/{id}",
9707     "title": "Deletes a Account",
9708     "examples": [
9709       {
9710         "title": "Example usage:",
9711         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9712         "type": "json"
9713       }
9714     ],
9715     "name": "DeleteAccounts",
9716     "group": "Fax_Accounts",
9717     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9718     "version": "0.0.0",
9719     "filename": "server/api/faxAccount/index.js",
9720     "groupTitle": "Fax_Accounts"
9721   },
9722   {
9723     "type": "get",
9724     "url": "/api/fax/accounts/describe",
9725     "title": "Gets table info about Accounts",
9726     "examples": [
9727       {
9728         "title": "Example usage:",
9729         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9730         "type": "json"
9731       }
9732     ],
9733     "name": "DescribeAccounts",
9734     "group": "Fax_Accounts",
9735     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9736     "version": "0.0.0",
9737     "filename": "server/api/faxAccount/index.js",
9738     "groupTitle": "Fax_Accounts"
9739   },
9740   {
9741     "type": "get",
9742     "url": "/api/fax/accounts",
9743     "title": "Gets a list of Accounts",
9744     "examples": [
9745       {
9746         "title": "Example usage:",
9747         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9748         "type": "json"
9749       }
9750     ],
9751     "name": "GetAccounts",
9752     "group": "Fax_Accounts",
9753     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9754     "version": "0.0.0",
9755     "filename": "server/api/faxAccount/index.js",
9756     "groupTitle": "Fax_Accounts"
9757   },
9758   {
9759     "type": "get",
9760     "url": "/api/fax/accounts/{id}/users",
9761     "title": "Gets agents from fax account",
9762     "examples": [
9763       {
9764         "title": "Example usage:",
9765         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9766         "type": "json"
9767       }
9768     ],
9769     "name": "GetAgents",
9770     "group": "Fax_Accounts",
9771     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9772     "version": "0.0.0",
9773     "filename": "server/api/faxAccount/index.js",
9774     "groupTitle": "Fax_Accounts"
9775   },
9776   {
9777     "type": "delete",
9778     "url": "/api/fax/accounts/{id}/users",
9779     "title": "Removes agents from a fax account",
9780     "examples": [
9781       {
9782         "title": "Example usage:",
9783         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9784         "type": "json"
9785       }
9786     ],
9787     "name": "RemoveAgents",
9788     "group": "Fax_Accounts",
9789     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9790     "version": "0.0.0",
9791     "filename": "server/api/faxAccount/index.js",
9792     "groupTitle": "Fax_Accounts"
9793   },
9794   {
9795     "type": "delete",
9796     "url": "/api/fax/accounts/{id}/canned_answers",
9797     "title": "Removes canned answers from account",
9798     "examples": [
9799       {
9800         "title": "Example usage:",
9801         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9802         "type": "json"
9803       }
9804     ],
9805     "name": "RemoveAnswers",
9806     "group": "Fax_Accounts",
9807     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9808     "version": "0.0.0",
9809     "filename": "server/api/faxAccount/index.js",
9810     "groupTitle": "Fax_Accounts"
9811   },
9812   {
9813     "type": "delete",
9814     "url": "/api/fax/accounts/{id}/dispositions",
9815     "title": "Removes dispositions from account",
9816     "examples": [
9817       {
9818         "title": "Example usage:",
9819         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9820         "type": "json"
9821       }
9822     ],
9823     "name": "RemoveDispositions",
9824     "group": "Fax_Accounts",
9825     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9826     "version": "0.0.0",
9827     "filename": "server/api/faxAccount/index.js",
9828     "groupTitle": "Fax_Accounts"
9829   },
9830   {
9831     "type": "get",
9832     "url": "/api/fax/accounts/{id}",
9833     "title": "Gets a single Account",
9834     "examples": [
9835       {
9836         "title": "Example usage:",
9837         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9838         "type": "json"
9839       }
9840     ],
9841     "name": "ShowAccounts",
9842     "group": "Fax_Accounts",
9843     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9844     "version": "0.0.0",
9845     "filename": "server/api/faxAccount/index.js",
9846     "groupTitle": "Fax_Accounts"
9847   },
9848   {
9849     "type": "post",
9850     "url": "/api/fax/accounts/{id}/canned_answers",
9851     "title": "Creates new canned answer",
9852     "examples": [
9853       {
9854         "title": "Example usage:",
9855         "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",
9856         "type": "json"
9857       }
9858     ],
9859     "name": "addAnswer",
9860     "group": "Fax_Accounts",
9861     "parameter": {
9862       "fields": {
9863         "Body": [
9864           {
9865             "group": "Body",
9866             "type": "String",
9867             "optional": false,
9868             "field": "key",
9869             "description": ""
9870           },
9871           {
9872             "group": "Body",
9873             "type": "Text",
9874             "optional": false,
9875             "field": "value",
9876             "description": ""
9877           },
9878           {
9879             "group": "Body",
9880             "type": "String",
9881             "optional": true,
9882             "field": "description",
9883             "description": ""
9884           },
9885           {
9886             "group": "Body",
9887             "type": "Virtual",
9888             "optional": true,
9889             "field": "name",
9890             "description": ""
9891           }
9892         ]
9893       }
9894     },
9895     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9896     "version": "0.0.0",
9897     "filename": "server/api/faxAccount/index.js",
9898     "groupTitle": "Fax_Accounts"
9899   },
9900   {
9901     "type": "post",
9902     "url": "/api/fax/accounts/{id}/applications",
9903     "title": "Creates new applications",
9904     "examples": [
9905       {
9906         "title": "Example usage:",
9907         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9908         "type": "json"
9909       }
9910     ],
9911     "name": "addApplications",
9912     "group": "Fax_Accounts",
9913     "parameter": {
9914       "fields": {
9915         "Body": [
9916           {
9917             "group": "Body",
9918             "type": "Integer",
9919             "optional": false,
9920             "field": "priority",
9921             "description": ""
9922           },
9923           {
9924             "group": "Body",
9925             "type": "String",
9926             "optional": false,
9927             "field": "app",
9928             "description": ""
9929           },
9930           {
9931             "group": "Body",
9932             "type": "Text",
9933             "optional": true,
9934             "field": "appdata",
9935             "description": ""
9936           },
9937           {
9938             "group": "Body",
9939             "type": "String",
9940             "optional": true,
9941             "field": "description",
9942             "description": ""
9943           },
9944           {
9945             "group": "Body",
9946             "type": "String",
9947             "optional": true,
9948             "field": "interval",
9949             "description": ""
9950           }
9951         ]
9952       }
9953     },
9954     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9955     "version": "0.0.0",
9956     "filename": "server/api/faxAccount/index.js",
9957     "groupTitle": "Fax_Accounts"
9958   },
9959   {
9960     "type": "post",
9961     "url": "/api/fax/accounts/addaccountapplications",
9962     "title": "Creates new account and applications",
9963     "examples": [
9964       {
9965         "title": "Example usage:",
9966         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9967         "type": "json"
9968       }
9969     ],
9970     "name": "addApplications",
9971     "group": "Fax_Accounts",
9972     "parameter": {
9973       "fields": {
9974         "Body": [
9975           {
9976             "group": "Body",
9977             "type": "Integer",
9978             "optional": false,
9979             "field": "priority",
9980             "description": ""
9981           },
9982           {
9983             "group": "Body",
9984             "type": "String",
9985             "optional": false,
9986             "field": "app",
9987             "description": ""
9988           },
9989           {
9990             "group": "Body",
9991             "type": "Text",
9992             "optional": true,
9993             "field": "appdata",
9994             "description": ""
9995           },
9996           {
9997             "group": "Body",
9998             "type": "String",
9999             "optional": true,
10000             "field": "description",
10001             "description": ""
10002           },
10003           {
10004             "group": "Body",
10005             "type": "String",
10006             "optional": true,
10007             "field": "interval",
10008             "description": ""
10009           }
10010         ]
10011       }
10012     },
10013     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10014     "version": "0.0.0",
10015     "filename": "server/api/faxAccount/index.js",
10016     "groupTitle": "Fax_Accounts"
10017   },
10018   {
10019     "type": "post",
10020     "url": "/api/fax/accounts/{id}/dispositions",
10021     "title": "Creates new disposition",
10022     "examples": [
10023       {
10024         "title": "Example usage:",
10025         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10026         "type": "json"
10027       }
10028     ],
10029     "name": "addDisposition",
10030     "group": "Fax_Accounts",
10031     "parameter": {
10032       "fields": {
10033         "Body": [
10034           {
10035             "group": "Body",
10036             "type": "String",
10037             "optional": false,
10038             "field": "name",
10039             "description": ""
10040           },
10041           {
10042             "group": "Body",
10043             "type": "String",
10044             "allowedValues": [
10045               "\"first\"",
10046               "\"second\"",
10047               "\"third\""
10048             ],
10049             "optional": false,
10050             "field": "level",
10051             "description": ""
10052           },
10053           {
10054             "group": "Body",
10055             "type": "String",
10056             "optional": true,
10057             "field": "description",
10058             "description": ""
10059           }
10060         ]
10061       }
10062     },
10063     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10064     "version": "0.0.0",
10065     "filename": "server/api/faxAccount/index.js",
10066     "groupTitle": "Fax_Accounts"
10067   },
10068   {
10069     "type": "post",
10070     "url": "/api/fax/accounts/{id}/interactions",
10071     "title": "Creates new interactions",
10072     "examples": [
10073       {
10074         "title": "Example usage:",
10075         "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",
10076         "type": "json"
10077       }
10078     ],
10079     "name": "addInteraction",
10080     "group": "Fax_Accounts",
10081     "parameter": {
10082       "fields": {
10083         "Body": [
10084           {
10085             "group": "Body",
10086             "type": "Boolean",
10087             "optional": true,
10088             "field": "closed",
10089             "description": ""
10090           },
10091           {
10092             "group": "Body",
10093             "type": "String",
10094             "optional": true,
10095             "field": "closedAt",
10096             "description": ""
10097           },
10098           {
10099             "group": "Body",
10100             "type": "String",
10101             "optional": true,
10102             "field": "disposition",
10103             "description": ""
10104           },
10105           {
10106             "group": "Body",
10107             "type": "String",
10108             "optional": true,
10109             "field": "secondDisposition",
10110             "description": ""
10111           },
10112           {
10113             "group": "Body",
10114             "type": "String",
10115             "optional": true,
10116             "field": "thirdDisposition",
10117             "description": ""
10118           },
10119           {
10120             "group": "Body",
10121             "type": "String",
10122             "optional": true,
10123             "field": "note",
10124             "description": ""
10125           },
10126           {
10127             "group": "Body",
10128             "type": "String",
10129             "optional": true,
10130             "field": "read1stAt",
10131             "description": ""
10132           },
10133           {
10134             "group": "Body",
10135             "type": "String",
10136             "optional": true,
10137             "field": "fax",
10138             "description": ""
10139           },
10140           {
10141             "group": "Body",
10142             "type": "String",
10143             "allowedValues": [
10144               "\"in\"",
10145               "\"out\""
10146             ],
10147             "optional": false,
10148             "field": "firstMsgDirection",
10149             "description": ""
10150           },
10151           {
10152             "group": "Body",
10153             "type": "String",
10154             "optional": true,
10155             "field": "lastMsgAt",
10156             "description": ""
10157           },
10158           {
10159             "group": "Body",
10160             "type": "String",
10161             "allowedValues": [
10162               "\"in\"",
10163               "\"out\""
10164             ],
10165             "optional": false,
10166             "field": "lastMsgDirection",
10167             "description": ""
10168           }
10169         ]
10170       }
10171     },
10172     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10173     "version": "0.0.0",
10174     "filename": "server/api/faxAccount/index.js",
10175     "groupTitle": "Fax_Accounts"
10176   },
10177   {
10178     "type": "get",
10179     "url": "/api/fax/accounts/{id}/canned_answers",
10180     "title": "Gets account canned answers",
10181     "examples": [
10182       {
10183         "title": "Example usage:",
10184         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10185         "type": "json"
10186       }
10187     ],
10188     "name": "getAnswers",
10189     "group": "Fax_Accounts",
10190     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10191     "version": "0.0.0",
10192     "filename": "server/api/faxAccount/index.js",
10193     "groupTitle": "Fax_Accounts"
10194   },
10195   {
10196     "type": "get",
10197     "url": "/api/fax/accounts/{id}/applications",
10198     "title": "Gets account pplications",
10199     "examples": [
10200       {
10201         "title": "Example usage:",
10202         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10203         "type": "json"
10204       }
10205     ],
10206     "name": "getApplications",
10207     "group": "Fax_Accounts",
10208     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10209     "version": "0.0.0",
10210     "filename": "server/api/faxAccount/index.js",
10211     "groupTitle": "Fax_Accounts"
10212   },
10213   {
10214     "type": "get",
10215     "url": "/api/fax/accounts/{id}/dispositions",
10216     "title": "Gets account dispositions",
10217     "examples": [
10218       {
10219         "title": "Example usage:",
10220         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10221         "type": "json"
10222       }
10223     ],
10224     "name": "getDispositions",
10225     "group": "Fax_Accounts",
10226     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10227     "version": "0.0.0",
10228     "filename": "server/api/faxAccount/index.js",
10229     "groupTitle": "Fax_Accounts"
10230   },
10231   {
10232     "type": "get",
10233     "url": "/api/fax/accounts/{id}/interactions",
10234     "title": "Gets account interactions",
10235     "examples": [
10236       {
10237         "title": "Example usage:",
10238         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10239         "type": "json"
10240       }
10241     ],
10242     "name": "getInteraction",
10243     "group": "Fax_Accounts",
10244     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10245     "version": "0.0.0",
10246     "filename": "server/api/faxAccount/index.js",
10247     "groupTitle": "Fax_Accounts"
10248   },
10249   {
10250     "type": "get",
10251     "url": "/api/fax/accounts/{id}/messages",
10252     "title": "Gets account messages",
10253     "examples": [
10254       {
10255         "title": "Example usage:",
10256         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10257         "type": "json"
10258       }
10259     ],
10260     "name": "getMessages",
10261     "group": "Fax_Accounts",
10262     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10263     "version": "0.0.0",
10264     "filename": "server/api/faxAccount/index.js",
10265     "groupTitle": "Fax_Accounts"
10266   },
10267   {
10268     "type": "post",
10269     "url": "/api/fax/accounts/{id}/send",
10270     "title": "Send new fax",
10271     "examples": [
10272       {
10273         "title": "Example usage:",
10274         "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",
10275         "type": "json"
10276       }
10277     ],
10278     "name": "sendFax",
10279     "group": "Fax_Accounts",
10280     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10281     "version": "0.0.0",
10282     "filename": "server/api/faxAccount/index.js",
10283     "groupTitle": "Fax_Accounts"
10284   },
10285   {
10286     "type": "put",
10287     "url": "/api/fax/accounts/{id}",
10288     "title": "Update an existing Account",
10289     "examples": [
10290       {
10291         "title": "Example usage:",
10292         "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",
10293         "type": "json"
10294       }
10295     ],
10296     "name": "updateAccounts",
10297     "group": "Fax_Accounts",
10298     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10299     "version": "0.0.0",
10300     "filename": "server/api/faxAccount/index.js",
10301     "groupTitle": "Fax_Accounts"
10302   },
10303   {
10304     "type": "post",
10305     "url": "/api/fax/accounts/updateaccountapplications",
10306     "title": "Update account and applications",
10307     "examples": [
10308       {
10309         "title": "Example usage:",
10310         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10311         "type": "json"
10312       }
10313     ],
10314     "name": "updateApplications",
10315     "group": "Fax_Accounts",
10316     "parameter": {
10317       "fields": {
10318         "Body": [
10319           {
10320             "group": "Body",
10321             "type": "Integer",
10322             "optional": false,
10323             "field": "priority",
10324             "description": ""
10325           },
10326           {
10327             "group": "Body",
10328             "type": "String",
10329             "optional": false,
10330             "field": "app",
10331             "description": ""
10332           },
10333           {
10334             "group": "Body",
10335             "type": "Text",
10336             "optional": true,
10337             "field": "appdata",
10338             "description": ""
10339           },
10340           {
10341             "group": "Body",
10342             "type": "String",
10343             "optional": true,
10344             "field": "description",
10345             "description": ""
10346           },
10347           {
10348             "group": "Body",
10349             "type": "String",
10350             "optional": true,
10351             "field": "interval",
10352             "description": ""
10353           }
10354         ]
10355       }
10356     },
10357     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10358     "version": "0.0.0",
10359     "filename": "server/api/faxAccount/index.js",
10360     "groupTitle": "Fax_Accounts"
10361   },
10362   {
10363     "type": "post",
10364     "url": "/api/fax/applications",
10365     "title": "Creates a new Application",
10366     "examples": [
10367       {
10368         "title": "Example usage:",
10369         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10370         "type": "json"
10371       }
10372     ],
10373     "name": "CreateApplications",
10374     "group": "Fax_Applications",
10375     "parameter": {
10376       "fields": {
10377         "Body": [
10378           {
10379             "group": "Body",
10380             "type": "Integer",
10381             "optional": false,
10382             "field": "priority",
10383             "description": ""
10384           },
10385           {
10386             "group": "Body",
10387             "type": "String",
10388             "optional": false,
10389             "field": "app",
10390             "description": ""
10391           },
10392           {
10393             "group": "Body",
10394             "type": "Text",
10395             "optional": true,
10396             "field": "appdata",
10397             "description": ""
10398           },
10399           {
10400             "group": "Body",
10401             "type": "String",
10402             "optional": true,
10403             "field": "description",
10404             "description": ""
10405           },
10406           {
10407             "group": "Body",
10408             "type": "String",
10409             "optional": true,
10410             "field": "interval",
10411             "description": ""
10412           }
10413         ]
10414       }
10415     },
10416     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10417     "version": "0.0.0",
10418     "filename": "server/api/faxApplication/index.js",
10419     "groupTitle": "Fax_Applications"
10420   },
10421   {
10422     "type": "delete",
10423     "url": "/api/fax/applications/{id}",
10424     "title": "Deletes a Application",
10425     "examples": [
10426       {
10427         "title": "Example usage:",
10428         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10429         "type": "json"
10430       }
10431     ],
10432     "name": "DeleteApplications",
10433     "group": "Fax_Applications",
10434     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10435     "version": "0.0.0",
10436     "filename": "server/api/faxApplication/index.js",
10437     "groupTitle": "Fax_Applications"
10438   },
10439   {
10440     "type": "get",
10441     "url": "/api/fax/applications",
10442     "title": "Gets a list of Applications",
10443     "examples": [
10444       {
10445         "title": "Example usage:",
10446         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10447         "type": "json"
10448       }
10449     ],
10450     "name": "GetApplications",
10451     "group": "Fax_Applications",
10452     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10453     "version": "0.0.0",
10454     "filename": "server/api/faxApplication/index.js",
10455     "groupTitle": "Fax_Applications"
10456   },
10457   {
10458     "type": "get",
10459     "url": "/api/fax/applications/{id}",
10460     "title": "Gets a single Application",
10461     "examples": [
10462       {
10463         "title": "Example usage:",
10464         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10465         "type": "json"
10466       }
10467     ],
10468     "name": "ShowApplications",
10469     "group": "Fax_Applications",
10470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10471     "version": "0.0.0",
10472     "filename": "server/api/faxApplication/index.js",
10473     "groupTitle": "Fax_Applications"
10474   },
10475   {
10476     "type": "put",
10477     "url": "/api/fax/applications/{id}",
10478     "title": "Update an existing Application",
10479     "examples": [
10480       {
10481         "title": "Example usage:",
10482         "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",
10483         "type": "json"
10484       }
10485     ],
10486     "name": "updateApplications",
10487     "group": "Fax_Applications",
10488     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10489     "version": "0.0.0",
10490     "filename": "server/api/faxApplication/index.js",
10491     "groupTitle": "Fax_Applications"
10492   },
10493   {
10494     "type": "post",
10495     "url": "/api/fax/interactions/{id}/tags",
10496     "title": "Add tags to the interaction",
10497     "examples": [
10498       {
10499         "title": "Example usage:",
10500         "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",
10501         "type": "json"
10502       }
10503     ],
10504     "name": "AddTags",
10505     "group": "Fax_Interactions",
10506     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10507     "version": "0.0.0",
10508     "filename": "server/api/faxInteraction/index.js",
10509     "groupTitle": "Fax_Interactions"
10510   },
10511   {
10512     "type": "post",
10513     "url": "/api/fax/interactions",
10514     "title": "Creates a new Interaction",
10515     "examples": [
10516       {
10517         "title": "Example usage:",
10518         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10519         "type": "json"
10520       }
10521     ],
10522     "name": "CreateInteractions",
10523     "group": "Fax_Interactions",
10524     "parameter": {
10525       "fields": {
10526         "Body": [
10527           {
10528             "group": "Body",
10529             "type": "Boolean",
10530             "optional": true,
10531             "field": "closed",
10532             "description": ""
10533           },
10534           {
10535             "group": "Body",
10536             "type": "String",
10537             "optional": true,
10538             "field": "closedAt",
10539             "description": ""
10540           },
10541           {
10542             "group": "Body",
10543             "type": "String",
10544             "optional": true,
10545             "field": "disposition",
10546             "description": ""
10547           },
10548           {
10549             "group": "Body",
10550             "type": "String",
10551             "optional": true,
10552             "field": "secondDisposition",
10553             "description": ""
10554           },
10555           {
10556             "group": "Body",
10557             "type": "String",
10558             "optional": true,
10559             "field": "thirdDisposition",
10560             "description": ""
10561           },
10562           {
10563             "group": "Body",
10564             "type": "String",
10565             "optional": true,
10566             "field": "note",
10567             "description": ""
10568           },
10569           {
10570             "group": "Body",
10571             "type": "String",
10572             "optional": true,
10573             "field": "read1stAt",
10574             "description": ""
10575           },
10576           {
10577             "group": "Body",
10578             "type": "String",
10579             "optional": true,
10580             "field": "fax",
10581             "description": ""
10582           },
10583           {
10584             "group": "Body",
10585             "type": "String",
10586             "allowedValues": [
10587               "\"in\"",
10588               "\"out\""
10589             ],
10590             "optional": false,
10591             "field": "firstMsgDirection",
10592             "description": ""
10593           },
10594           {
10595             "group": "Body",
10596             "type": "String",
10597             "optional": true,
10598             "field": "lastMsgAt",
10599             "description": ""
10600           },
10601           {
10602             "group": "Body",
10603             "type": "String",
10604             "allowedValues": [
10605               "\"in\"",
10606               "\"out\""
10607             ],
10608             "optional": false,
10609             "field": "lastMsgDirection",
10610             "description": ""
10611           }
10612         ]
10613       }
10614     },
10615     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10616     "version": "0.0.0",
10617     "filename": "server/api/faxInteraction/index.js",
10618     "groupTitle": "Fax_Interactions"
10619   },
10620   {
10621     "type": "delete",
10622     "url": "/api/fax/interactions/{id}",
10623     "title": "Deletes a Interaction",
10624     "examples": [
10625       {
10626         "title": "Example usage:",
10627         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10628         "type": "json"
10629       }
10630     ],
10631     "name": "DeleteInteractions",
10632     "group": "Fax_Interactions",
10633     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10634     "version": "0.0.0",
10635     "filename": "server/api/faxInteraction/index.js",
10636     "groupTitle": "Fax_Interactions"
10637   },
10638   {
10639     "type": "get",
10640     "url": "/api/fax/interactions/describe",
10641     "title": "Gets table info about Interactions",
10642     "examples": [
10643       {
10644         "title": "Example usage:",
10645         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10646         "type": "json"
10647       }
10648     ],
10649     "name": "DescribeInteractions",
10650     "group": "Fax_Interactions",
10651     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10652     "version": "0.0.0",
10653     "filename": "server/api/faxInteraction/index.js",
10654     "groupTitle": "Fax_Interactions"
10655   },
10656   {
10657     "type": "get",
10658     "url": "/api/fax/interactions",
10659     "title": "Gets a list of Interactions",
10660     "examples": [
10661       {
10662         "title": "Example usage:",
10663         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10664         "type": "json"
10665       }
10666     ],
10667     "name": "GetInteractions",
10668     "group": "Fax_Interactions",
10669     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10670     "version": "0.0.0",
10671     "filename": "server/api/faxInteraction/index.js",
10672     "groupTitle": "Fax_Interactions"
10673   },
10674   {
10675     "type": "delete",
10676     "url": "/api/fax/interactions/{id}/tags",
10677     "title": "Removes tags from interaction",
10678     "examples": [
10679       {
10680         "title": "Example usage:",
10681         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10682         "type": "json"
10683       }
10684     ],
10685     "name": "RemoveTags",
10686     "group": "Fax_Interactions",
10687     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10688     "version": "0.0.0",
10689     "filename": "server/api/faxInteraction/index.js",
10690     "groupTitle": "Fax_Interactions"
10691   },
10692   {
10693     "type": "get",
10694     "url": "/api/fax/interactions/{id}",
10695     "title": "Gets a single Interaction",
10696     "examples": [
10697       {
10698         "title": "Example usage:",
10699         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10700         "type": "json"
10701       }
10702     ],
10703     "name": "ShowInteractions",
10704     "group": "Fax_Interactions",
10705     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10706     "version": "0.0.0",
10707     "filename": "server/api/faxInteraction/index.js",
10708     "groupTitle": "Fax_Interactions"
10709   },
10710   {
10711     "type": "post",
10712     "url": "/api/fax/interactions/{id}/messages",
10713     "title": "Creates new messages",
10714     "examples": [
10715       {
10716         "title": "Example usage:",
10717         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10718         "type": "json"
10719       }
10720     ],
10721     "name": "addMessage",
10722     "group": "Fax_Interactions",
10723     "parameter": {
10724       "fields": {
10725         "Body": [
10726           {
10727             "group": "Body",
10728             "type": "Text",
10729             "optional": false,
10730             "field": "body",
10731             "description": ""
10732           },
10733           {
10734             "group": "Body",
10735             "type": "Boolean",
10736             "optional": true,
10737             "field": "read",
10738             "description": ""
10739           },
10740           {
10741             "group": "Body",
10742             "type": "String",
10743             "allowedValues": [
10744               "\"in\"",
10745               "\"out\""
10746             ],
10747             "optional": false,
10748             "field": "direction",
10749             "description": ""
10750           },
10751           {
10752             "group": "Body",
10753             "type": "Text",
10754             "optional": true,
10755             "field": "failMessage",
10756             "description": ""
10757           },
10758           {
10759             "group": "Body",
10760             "type": "String",
10761             "optional": true,
10762             "field": "readAt",
10763             "description": ""
10764           }
10765         ]
10766       }
10767     },
10768     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10769     "version": "0.0.0",
10770     "filename": "server/api/faxInteraction/index.js",
10771     "groupTitle": "Fax_Interactions"
10772   },
10773   {
10774     "type": "get",
10775     "url": "/api/fax/interactions/{id}/download",
10776     "title": "Get interactions",
10777     "examples": [
10778       {
10779         "title": "Example usage:",
10780         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10781         "type": "json"
10782       }
10783     ],
10784     "name": "download",
10785     "group": "Fax_Interactions",
10786     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10787     "version": "0.0.0",
10788     "filename": "server/api/faxInteraction/index.js",
10789     "groupTitle": "Fax_Interactions"
10790   },
10791   {
10792     "type": "get",
10793     "url": "/api/fax/interactions/{id}/messages",
10794     "title": "Gets interaction messages",
10795     "examples": [
10796       {
10797         "title": "Example usage:",
10798         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10799         "type": "json"
10800       }
10801     ],
10802     "name": "getMessages",
10803     "group": "Fax_Interactions",
10804     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10805     "version": "0.0.0",
10806     "filename": "server/api/faxInteraction/index.js",
10807     "groupTitle": "Fax_Interactions"
10808   },
10809   {
10810     "type": "put",
10811     "url": "/api/fax/interactions/{id}",
10812     "title": "Update an existing Interaction",
10813     "examples": [
10814       {
10815         "title": "Example usage:",
10816         "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",
10817         "type": "json"
10818       }
10819     ],
10820     "name": "updateInteractions",
10821     "group": "Fax_Interactions",
10822     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10823     "version": "0.0.0",
10824     "filename": "server/api/faxInteraction/index.js",
10825     "groupTitle": "Fax_Interactions"
10826   },
10827   {
10828     "type": "get",
10829     "url": "/api/fax/messages/{id}/download",
10830     "title": "Get message",
10831     "examples": [
10832       {
10833         "title": "Example usage:",
10834         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10835         "type": "json"
10836       }
10837     ],
10838     "name": "download",
10839     "group": "Fax_Message",
10840     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10841     "version": "0.0.0",
10842     "filename": "server/api/faxMessage/index.js",
10843     "groupTitle": "Fax_Message"
10844   },
10845   {
10846     "type": "delete",
10847     "url": "/api/fax/messages/{id}",
10848     "title": "Deletes a Message",
10849     "examples": [
10850       {
10851         "title": "Example usage:",
10852         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10853         "type": "json"
10854       }
10855     ],
10856     "name": "DeleteMessages",
10857     "group": "Fax_Messages",
10858     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10859     "version": "0.0.0",
10860     "filename": "server/api/faxMessage/index.js",
10861     "groupTitle": "Fax_Messages"
10862   },
10863   {
10864     "type": "get",
10865     "url": "/api/fax/messages/describe",
10866     "title": "Gets table info about Messages",
10867     "examples": [
10868       {
10869         "title": "Example usage:",
10870         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10871         "type": "json"
10872       }
10873     ],
10874     "name": "DescribeMessages",
10875     "group": "Fax_Messages",
10876     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10877     "version": "0.0.0",
10878     "filename": "server/api/faxMessage/index.js",
10879     "groupTitle": "Fax_Messages"
10880   },
10881   {
10882     "type": "get",
10883     "url": "/api/fax/messages",
10884     "title": "Gets a list of Messages",
10885     "examples": [
10886       {
10887         "title": "Example usage:",
10888         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10889         "type": "json"
10890       }
10891     ],
10892     "name": "GetMessages",
10893     "group": "Fax_Messages",
10894     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10895     "version": "0.0.0",
10896     "filename": "server/api/faxMessage/index.js",
10897     "groupTitle": "Fax_Messages"
10898   },
10899   {
10900     "type": "get",
10901     "url": "/api/fax/messages/{id}",
10902     "title": "Gets a single Message",
10903     "examples": [
10904       {
10905         "title": "Example usage:",
10906         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10907         "type": "json"
10908       }
10909     ],
10910     "name": "ShowMessages",
10911     "group": "Fax_Messages",
10912     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10913     "version": "0.0.0",
10914     "filename": "server/api/faxMessage/index.js",
10915     "groupTitle": "Fax_Messages"
10916   },
10917   {
10918     "type": "put",
10919     "url": "/api/fax/messages/{id}/accept",
10920     "title": "Accepts message",
10921     "examples": [
10922       {
10923         "title": "Example usage:",
10924         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10925         "type": "json"
10926       }
10927     ],
10928     "name": "acceptMessage",
10929     "group": "Fax_Messages",
10930     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10931     "version": "0.0.0",
10932     "filename": "server/api/faxMessage/index.js",
10933     "groupTitle": "Fax_Messages"
10934   },
10935   {
10936     "type": "put",
10937     "url": "/api/fax/messages/{id}/reject",
10938     "title": "Rejects message",
10939     "examples": [
10940       {
10941         "title": "Example usage:",
10942         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10943         "type": "json"
10944       }
10945     ],
10946     "name": "rejectMessage",
10947     "group": "Fax_Messages",
10948     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10949     "version": "0.0.0",
10950     "filename": "server/api/faxMessage/index.js",
10951     "groupTitle": "Fax_Messages"
10952   },
10953   {
10954     "type": "post",
10955     "url": "/api/fax/messages",
10956     "title": "Create message and send Fax",
10957     "examples": [
10958       {
10959         "title": "Example usage:",
10960         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10961         "type": "json"
10962       }
10963     ],
10964     "name": "rejectMessage",
10965     "group": "Fax_Messages",
10966     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10967     "version": "0.0.0",
10968     "filename": "server/api/faxMessage/index.js",
10969     "groupTitle": "Fax_Messages"
10970   },
10971   {
10972     "type": "put",
10973     "url": "/api/fax/messages/{id}",
10974     "title": "Update an existing Message",
10975     "examples": [
10976       {
10977         "title": "Example usage:",
10978         "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",
10979         "type": "json"
10980       }
10981     ],
10982     "name": "updateMessages",
10983     "group": "Fax_Messages",
10984     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10985     "version": "0.0.0",
10986     "filename": "server/api/faxMessage/index.js",
10987     "groupTitle": "Fax_Messages"
10988   },
10989   {
10990     "type": "post",
10991     "url": "/api/fax/reports/queue",
10992     "title": "Creates a new Fax Queue Report",
10993     "examples": [
10994       {
10995         "title": "Example usage:",
10996         "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",
10997         "type": "json"
10998       }
10999     ],
11000     "name": "CreateFax_Queue_Reports",
11001     "group": "Fax_Queue_Reports",
11002     "parameter": {
11003       "fields": {
11004         "Body": [
11005           {
11006             "group": "Body",
11007             "type": "String",
11008             "optional": false,
11009             "field": "uniqueid",
11010             "description": ""
11011           },
11012           {
11013             "group": "Body",
11014             "type": "String",
11015             "optional": true,
11016             "field": "from",
11017             "description": ""
11018           },
11019           {
11020             "group": "Body",
11021             "type": "String",
11022             "optional": true,
11023             "field": "joinAt",
11024             "description": ""
11025           },
11026           {
11027             "group": "Body",
11028             "type": "String",
11029             "optional": true,
11030             "field": "leaveAt",
11031             "description": ""
11032           },
11033           {
11034             "group": "Body",
11035             "type": "String",
11036             "optional": true,
11037             "field": "acceptAt",
11038             "description": ""
11039           },
11040           {
11041             "group": "Body",
11042             "type": "String",
11043             "optional": true,
11044             "field": "exitAt",
11045             "description": ""
11046           },
11047           {
11048             "group": "Body",
11049             "type": "String",
11050             "optional": true,
11051             "field": "reason",
11052             "description": ""
11053           }
11054         ]
11055       }
11056     },
11057     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11058     "version": "0.0.0",
11059     "filename": "server/api/faxQueueReport/index.js",
11060     "groupTitle": "Fax_Queue_Reports"
11061   },
11062   {
11063     "type": "delete",
11064     "url": "/api/fax/reports/queue/{id}",
11065     "title": "Deletes a Fax Queue Report",
11066     "examples": [
11067       {
11068         "title": "Example usage:",
11069         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11070         "type": "json"
11071       }
11072     ],
11073     "name": "DeleteFax_Queue_Reports",
11074     "group": "Fax_Queue_Reports",
11075     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11076     "version": "0.0.0",
11077     "filename": "server/api/faxQueueReport/index.js",
11078     "groupTitle": "Fax_Queue_Reports"
11079   },
11080   {
11081     "type": "get",
11082     "url": "/api/fax/reports/queue/describe",
11083     "title": "Gets table info about Fax Queue Reports",
11084     "examples": [
11085       {
11086         "title": "Example usage:",
11087         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11088         "type": "json"
11089       }
11090     ],
11091     "name": "DescribeFax_Queue_Reports",
11092     "group": "Fax_Queue_Reports",
11093     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11094     "version": "0.0.0",
11095     "filename": "server/api/faxQueueReport/index.js",
11096     "groupTitle": "Fax_Queue_Reports"
11097   },
11098   {
11099     "type": "get",
11100     "url": "/api/fax/reports/queue",
11101     "title": "Gets a list of Fax Queue Reports",
11102     "examples": [
11103       {
11104         "title": "Example usage:",
11105         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11106         "type": "json"
11107       }
11108     ],
11109     "name": "GetFax_Queue_Reports",
11110     "group": "Fax_Queue_Reports",
11111     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11112     "version": "0.0.0",
11113     "filename": "server/api/faxQueueReport/index.js",
11114     "groupTitle": "Fax_Queue_Reports"
11115   },
11116   {
11117     "type": "get",
11118     "url": "/api/fax/reports/queue/{id}",
11119     "title": "Gets a single Fax Queue Report",
11120     "examples": [
11121       {
11122         "title": "Example usage:",
11123         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11124         "type": "json"
11125       }
11126     ],
11127     "name": "ShowFax_Queue_Reports",
11128     "group": "Fax_Queue_Reports",
11129     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11130     "version": "0.0.0",
11131     "filename": "server/api/faxQueueReport/index.js",
11132     "groupTitle": "Fax_Queue_Reports"
11133   },
11134   {
11135     "type": "put",
11136     "url": "/api/fax/reports/queue/{id}",
11137     "title": "Update an existing Fax Queue Report",
11138     "examples": [
11139       {
11140         "title": "Example usage:",
11141         "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",
11142         "type": "json"
11143       }
11144     ],
11145     "name": "updateFax_Queue_Reports",
11146     "group": "Fax_Queue_Reports",
11147     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11148     "version": "0.0.0",
11149     "filename": "server/api/faxQueueReport/index.js",
11150     "groupTitle": "Fax_Queue_Reports"
11151   },
11152   {
11153     "type": "post",
11154     "url": "/api/fax/queues/{id}/users",
11155     "title": "Add agents to a queue",
11156     "examples": [
11157       {
11158         "title": "Example usage:",
11159         "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",
11160         "type": "json"
11161       }
11162     ],
11163     "name": "AddAgents",
11164     "group": "Fax_Queues",
11165     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11166     "version": "0.0.0",
11167     "filename": "server/api/faxQueue/index.js",
11168     "groupTitle": "Fax_Queues"
11169   },
11170   {
11171     "type": "post",
11172     "url": "/api/fax/queues/{id}/teams",
11173     "title": "Add teams to a queue",
11174     "examples": [
11175       {
11176         "title": "Example usage:",
11177         "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",
11178         "type": "json"
11179       }
11180     ],
11181     "name": "AddTeams",
11182     "group": "Fax_Queues",
11183     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11184     "version": "0.0.0",
11185     "filename": "server/api/faxQueue/index.js",
11186     "groupTitle": "Fax_Queues"
11187   },
11188   {
11189     "type": "post",
11190     "url": "/api/fax/queues",
11191     "title": "Creates a new Queue",
11192     "examples": [
11193       {
11194         "title": "Example usage:",
11195         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11196         "type": "json"
11197       }
11198     ],
11199     "name": "CreateQueues",
11200     "group": "Fax_Queues",
11201     "parameter": {
11202       "fields": {
11203         "Body": [
11204           {
11205             "group": "Body",
11206             "type": "String",
11207             "optional": false,
11208             "field": "name",
11209             "description": ""
11210           },
11211           {
11212             "group": "Body",
11213             "type": "String",
11214             "optional": true,
11215             "field": "description",
11216             "description": ""
11217           },
11218           {
11219             "group": "Body",
11220             "type": "Integer",
11221             "optional": false,
11222             "field": "timeout",
11223             "description": ""
11224           },
11225           {
11226             "group": "Body",
11227             "type": "String",
11228             "allowedValues": [
11229               "\"rrmemory\"",
11230               "\"beepall\"",
11231               "\"roundrobin\""
11232             ],
11233             "optional": false,
11234             "field": "strategy",
11235             "description": ""
11236           },
11237           {
11238             "group": "Body",
11239             "type": "Integer",
11240             "optional": true,
11241             "field": "lastAgent",
11242             "description": ""
11243           }
11244         ]
11245       }
11246     },
11247     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11248     "version": "0.0.0",
11249     "filename": "server/api/faxQueue/index.js",
11250     "groupTitle": "Fax_Queues"
11251   },
11252   {
11253     "type": "delete",
11254     "url": "/api/fax/queues/{id}",
11255     "title": "Deletes a Queue",
11256     "examples": [
11257       {
11258         "title": "Example usage:",
11259         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11260         "type": "json"
11261       }
11262     ],
11263     "name": "DeleteQueues",
11264     "group": "Fax_Queues",
11265     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11266     "version": "0.0.0",
11267     "filename": "server/api/faxQueue/index.js",
11268     "groupTitle": "Fax_Queues"
11269   },
11270   {
11271     "type": "get",
11272     "url": "/api/fax/queues/describe",
11273     "title": "Gets table info about Queues",
11274     "examples": [
11275       {
11276         "title": "Example usage:",
11277         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11278         "type": "json"
11279       }
11280     ],
11281     "name": "DescribeQueues",
11282     "group": "Fax_Queues",
11283     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11284     "version": "0.0.0",
11285     "filename": "server/api/faxQueue/index.js",
11286     "groupTitle": "Fax_Queues"
11287   },
11288   {
11289     "type": "get",
11290     "url": "/api/fax/queues/{id}/users",
11291     "title": "Gets queue agents",
11292     "examples": [
11293       {
11294         "title": "Example usage:",
11295         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11296         "type": "json"
11297       }
11298     ],
11299     "name": "GetAgents",
11300     "group": "Fax_Queues",
11301     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11302     "version": "0.0.0",
11303     "filename": "server/api/faxQueue/index.js",
11304     "groupTitle": "Fax_Queues"
11305   },
11306   {
11307     "type": "get",
11308     "url": "/api/fax/queues/{id}/members",
11309     "title": "GetMembers",
11310     "examples": [
11311       {
11312         "title": "Example usage:",
11313         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
11314         "type": "json"
11315       }
11316     ],
11317     "name": "GetMembers",
11318     "group": "Fax_Queues",
11319     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11320     "version": "0.0.0",
11321     "filename": "server/api/faxQueue/index.js",
11322     "groupTitle": "Fax_Queues"
11323   },
11324   {
11325     "type": "get",
11326     "url": "/api/fax/queues",
11327     "title": "Gets a list of Queues",
11328     "examples": [
11329       {
11330         "title": "Example usage:",
11331         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11332         "type": "json"
11333       }
11334     ],
11335     "name": "GetQueues",
11336     "group": "Fax_Queues",
11337     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11338     "version": "0.0.0",
11339     "filename": "server/api/faxQueue/index.js",
11340     "groupTitle": "Fax_Queues"
11341   },
11342   {
11343     "type": "get",
11344     "url": "/api/fax/queues/{id}/teams",
11345     "title": "Gets queues list",
11346     "examples": [
11347       {
11348         "title": "Example usage:",
11349         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11350         "type": "json"
11351       }
11352     ],
11353     "name": "GetTeams",
11354     "group": "Fax_Queues",
11355     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11356     "version": "0.0.0",
11357     "filename": "server/api/faxQueue/index.js",
11358     "groupTitle": "Fax_Queues"
11359   },
11360   {
11361     "type": "delete",
11362     "url": "/api/fax/queues/{id}/users",
11363     "title": "Removes agents from a queue",
11364     "examples": [
11365       {
11366         "title": "Example usage:",
11367         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11368         "type": "json"
11369       }
11370     ],
11371     "name": "RemoveAgents",
11372     "group": "Fax_Queues",
11373     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11374     "version": "0.0.0",
11375     "filename": "server/api/faxQueue/index.js",
11376     "groupTitle": "Fax_Queues"
11377   },
11378   {
11379     "type": "get",
11380     "url": "/api/fax/queues/{id}",
11381     "title": "Gets a single Queue",
11382     "examples": [
11383       {
11384         "title": "Example usage:",
11385         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11386         "type": "json"
11387       }
11388     ],
11389     "name": "ShowQueues",
11390     "group": "Fax_Queues",
11391     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11392     "version": "0.0.0",
11393     "filename": "server/api/faxQueue/index.js",
11394     "groupTitle": "Fax_Queues"
11395   },
11396   {
11397     "type": "put",
11398     "url": "/api/fax/queues/{id}",
11399     "title": "Update an existing Queue",
11400     "examples": [
11401       {
11402         "title": "Example usage:",
11403         "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",
11404         "type": "json"
11405       }
11406     ],
11407     "name": "updateQueues",
11408     "group": "Fax_Queues",
11409     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11410     "version": "0.0.0",
11411     "filename": "server/api/faxQueue/index.js",
11412     "groupTitle": "Fax_Queues"
11413   },
11414   {
11415     "type": "post",
11416     "url": "/api/fax/reports/transfer",
11417     "title": "Creates a new Fax Transfer Report",
11418     "examples": [
11419       {
11420         "title": "Example usage:",
11421         "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",
11422         "type": "json"
11423       }
11424     ],
11425     "name": "CreateFax_Transfer_Reports",
11426     "group": "Fax_Transfer_Reports",
11427     "parameter": {
11428       "fields": {
11429         "Body": [
11430           {
11431             "group": "Body",
11432             "type": "String",
11433             "optional": false,
11434             "field": "uniqueid",
11435             "description": ""
11436           },
11437           {
11438             "group": "Body",
11439             "type": "String",
11440             "allowedValues": [
11441               "\"account\"",
11442               "\"agent\"",
11443               "\"queue\""
11444             ],
11445             "optional": false,
11446             "field": "type",
11447             "description": ""
11448           },
11449           {
11450             "group": "Body",
11451             "type": "String",
11452             "optional": false,
11453             "field": "transferredAt",
11454             "description": ""
11455           }
11456         ]
11457       }
11458     },
11459     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11460     "version": "0.0.0",
11461     "filename": "server/api/faxTransferReport/index.js",
11462     "groupTitle": "Fax_Transfer_Reports"
11463   },
11464   {
11465     "type": "delete",
11466     "url": "/api/fax/reports/transfer/{id}",
11467     "title": "Deletes a Fax Transfer Report",
11468     "examples": [
11469       {
11470         "title": "Example usage:",
11471         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11472         "type": "json"
11473       }
11474     ],
11475     "name": "DeleteFax_Transfer_Reports",
11476     "group": "Fax_Transfer_Reports",
11477     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11478     "version": "0.0.0",
11479     "filename": "server/api/faxTransferReport/index.js",
11480     "groupTitle": "Fax_Transfer_Reports"
11481   },
11482   {
11483     "type": "get",
11484     "url": "/api/fax/reports/transfer/describe",
11485     "title": "Gets table info about Fax Transfer Reports",
11486     "examples": [
11487       {
11488         "title": "Example usage:",
11489         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11490         "type": "json"
11491       }
11492     ],
11493     "name": "DescribeFax_Transfer_Reports",
11494     "group": "Fax_Transfer_Reports",
11495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11496     "version": "0.0.0",
11497     "filename": "server/api/faxTransferReport/index.js",
11498     "groupTitle": "Fax_Transfer_Reports"
11499   },
11500   {
11501     "type": "get",
11502     "url": "/api/fax/reports/transfer",
11503     "title": "Gets a list of Fax Transfer Reports",
11504     "examples": [
11505       {
11506         "title": "Example usage:",
11507         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11508         "type": "json"
11509       }
11510     ],
11511     "name": "GetFax_Transfer_Reports",
11512     "group": "Fax_Transfer_Reports",
11513     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11514     "version": "0.0.0",
11515     "filename": "server/api/faxTransferReport/index.js",
11516     "groupTitle": "Fax_Transfer_Reports"
11517   },
11518   {
11519     "type": "get",
11520     "url": "/api/fax/reports/transfer/{id}",
11521     "title": "Gets a single Fax Transfer Report",
11522     "examples": [
11523       {
11524         "title": "Example usage:",
11525         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11526         "type": "json"
11527       }
11528     ],
11529     "name": "ShowFax_Transfer_Reports",
11530     "group": "Fax_Transfer_Reports",
11531     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11532     "version": "0.0.0",
11533     "filename": "server/api/faxTransferReport/index.js",
11534     "groupTitle": "Fax_Transfer_Reports"
11535   },
11536   {
11537     "type": "put",
11538     "url": "/api/fax/reports/transfer/{id}",
11539     "title": "Update an existing Fax Transfer Report",
11540     "examples": [
11541       {
11542         "title": "Example usage:",
11543         "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",
11544         "type": "json"
11545       }
11546     ],
11547     "name": "updateFax_Transfer_Reports",
11548     "group": "Fax_Transfer_Reports",
11549     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11550     "version": "0.0.0",
11551     "filename": "server/api/faxTransferReport/index.js",
11552     "groupTitle": "Fax_Transfer_Reports"
11553   },
11554   {
11555     "type": "post",
11556     "url": "/api/integrations/freshdesk/accounts",
11557     "title": "Creates a new Freshdesk Account",
11558     "examples": [
11559       {
11560         "title": "Example usage:",
11561         "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",
11562         "type": "json"
11563       }
11564     ],
11565     "name": "CreateFreshdesk_Accounts",
11566     "group": "Freshdesk_Accounts",
11567     "parameter": {
11568       "fields": {
11569         "Body": [
11570           {
11571             "group": "Body",
11572             "type": "String",
11573             "optional": true,
11574             "field": "name",
11575             "description": ""
11576           },
11577           {
11578             "group": "Body",
11579             "type": "String",
11580             "optional": true,
11581             "field": "description",
11582             "description": ""
11583           },
11584           {
11585             "group": "Body",
11586             "type": "String",
11587             "optional": true,
11588             "field": "username",
11589             "description": ""
11590           },
11591           {
11592             "group": "Body",
11593             "type": "String",
11594             "optional": true,
11595             "field": "apiKey",
11596             "description": ""
11597           },
11598           {
11599             "group": "Body",
11600             "type": "String",
11601             "optional": true,
11602             "field": "remoteUri",
11603             "description": ""
11604           },
11605           {
11606             "group": "Body",
11607             "type": "String",
11608             "optional": false,
11609             "field": "serverUrl",
11610             "description": ""
11611           }
11612         ]
11613       }
11614     },
11615     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11616     "version": "0.0.0",
11617     "filename": "server/api/intFreshdeskAccount/index.js",
11618     "groupTitle": "Freshdesk_Accounts"
11619   },
11620   {
11621     "type": "delete",
11622     "url": "/api/integrations/freshdesk/accounts/{id}",
11623     "title": "Deletes a Freshdesk Account",
11624     "examples": [
11625       {
11626         "title": "Example usage:",
11627         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11628         "type": "json"
11629       }
11630     ],
11631     "name": "DeleteFreshdesk_Accounts",
11632     "group": "Freshdesk_Accounts",
11633     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11634     "version": "0.0.0",
11635     "filename": "server/api/intFreshdeskAccount/index.js",
11636     "groupTitle": "Freshdesk_Accounts"
11637   },
11638   {
11639     "type": "get",
11640     "url": "/api/integrations/freshdesk/accounts",
11641     "title": "Gets a list of Freshdesk Accounts",
11642     "examples": [
11643       {
11644         "title": "Example usage:",
11645         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11646         "type": "json"
11647       }
11648     ],
11649     "name": "GetFreshdesk_Accounts",
11650     "group": "Freshdesk_Accounts",
11651     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11652     "version": "0.0.0",
11653     "filename": "server/api/intFreshdeskAccount/index.js",
11654     "groupTitle": "Freshdesk_Accounts"
11655   },
11656   {
11657     "type": "get",
11658     "url": "/api/integrations/freshdesk/accounts/{id}",
11659     "title": "Gets a single Freshdesk Account",
11660     "examples": [
11661       {
11662         "title": "Example usage:",
11663         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11664         "type": "json"
11665       }
11666     ],
11667     "name": "ShowFreshdesk_Accounts",
11668     "group": "Freshdesk_Accounts",
11669     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11670     "version": "0.0.0",
11671     "filename": "server/api/intFreshdeskAccount/index.js",
11672     "groupTitle": "Freshdesk_Accounts"
11673   },
11674   {
11675     "type": "post",
11676     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11677     "title": "Creates new configuration",
11678     "examples": [
11679       {
11680         "title": "Example usage:",
11681         "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",
11682         "type": "json"
11683       }
11684     ],
11685     "name": "addConfiguration",
11686     "group": "Freshdesk_Accounts",
11687     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11688     "version": "0.0.0",
11689     "filename": "server/api/intFreshdeskAccount/index.js",
11690     "groupTitle": "Freshdesk_Accounts"
11691   },
11692   {
11693     "type": "get",
11694     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11695     "title": "Gets account configurations",
11696     "examples": [
11697       {
11698         "title": "Example usage:",
11699         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11700         "type": "json"
11701       }
11702     ],
11703     "name": "getConfigurations",
11704     "group": "Freshdesk_Accounts",
11705     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11706     "version": "0.0.0",
11707     "filename": "server/api/intFreshdeskAccount/index.js",
11708     "groupTitle": "Freshdesk_Accounts"
11709   },
11710   {
11711     "type": "get",
11712     "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11713     "title": "Gets account fields",
11714     "examples": [
11715       {
11716         "title": "Example usage:",
11717         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11718         "type": "json"
11719       }
11720     ],
11721     "name": "getFields",
11722     "group": "Freshdesk_Accounts",
11723     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11724     "version": "0.0.0",
11725     "filename": "server/api/intFreshdeskAccount/index.js",
11726     "groupTitle": "Freshdesk_Accounts"
11727   },
11728   {
11729     "type": "put",
11730     "url": "/api/integrations/freshdesk/accounts/{id}",
11731     "title": "Update an existing Freshdesk Account",
11732     "examples": [
11733       {
11734         "title": "Example usage:",
11735         "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",
11736         "type": "json"
11737       }
11738     ],
11739     "name": "updateFreshdesk_Accounts",
11740     "group": "Freshdesk_Accounts",
11741     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11742     "version": "0.0.0",
11743     "filename": "server/api/intFreshdeskAccount/index.js",
11744     "groupTitle": "Freshdesk_Accounts"
11745   },
11746   {
11747     "type": "post",
11748     "url": "/api/integrations/freshdesk/configurations",
11749     "title": "Creates a new Freshdesk Configuration",
11750     "examples": [
11751       {
11752         "title": "Example usage:",
11753         "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",
11754         "type": "json"
11755       }
11756     ],
11757     "name": "CreateFreshdesk_Configurations",
11758     "group": "Freshdesk_Configurations",
11759     "parameter": {
11760       "fields": {
11761         "Body": [
11762           {
11763             "group": "Body",
11764             "type": "String",
11765             "optional": true,
11766             "field": "name",
11767             "description": ""
11768           },
11769           {
11770             "group": "Body",
11771             "type": "String",
11772             "optional": true,
11773             "field": "description",
11774             "description": ""
11775           }
11776         ]
11777       }
11778     },
11779     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11780     "version": "0.0.0",
11781     "filename": "server/api/intFreshdeskConfiguration/index.js",
11782     "groupTitle": "Freshdesk_Configurations"
11783   },
11784   {
11785     "type": "delete",
11786     "url": "/api/integrations/freshdesk/configurations/{id}",
11787     "title": "Deletes a Freshdesk Configuration",
11788     "examples": [
11789       {
11790         "title": "Example usage:",
11791         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11792         "type": "json"
11793       }
11794     ],
11795     "name": "DeleteFreshdesk_Configurations",
11796     "group": "Freshdesk_Configurations",
11797     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11798     "version": "0.0.0",
11799     "filename": "server/api/intFreshdeskConfiguration/index.js",
11800     "groupTitle": "Freshdesk_Configurations"
11801   },
11802   {
11803     "type": "get",
11804     "url": "/api/integrations/freshdesk/configurations",
11805     "title": "Gets a list of Freshdesk Configurations",
11806     "examples": [
11807       {
11808         "title": "Example usage:",
11809         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11810         "type": "json"
11811       }
11812     ],
11813     "name": "GetFreshdesk_Configurations",
11814     "group": "Freshdesk_Configurations",
11815     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11816     "version": "0.0.0",
11817     "filename": "server/api/intFreshdeskConfiguration/index.js",
11818     "groupTitle": "Freshdesk_Configurations"
11819   },
11820   {
11821     "type": "get",
11822     "url": "/api/integrations/freshdesk/configurations/{id}",
11823     "title": "Gets a single Freshdesk Configuration",
11824     "examples": [
11825       {
11826         "title": "Example usage:",
11827         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11828         "type": "json"
11829       }
11830     ],
11831     "name": "ShowFreshdesk_Configurations",
11832     "group": "Freshdesk_Configurations",
11833     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11834     "version": "0.0.0",
11835     "filename": "server/api/intFreshdeskConfiguration/index.js",
11836     "groupTitle": "Freshdesk_Configurations"
11837   },
11838   {
11839     "type": "get",
11840     "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11841     "title": "Gets configurations descriptions",
11842     "examples": [
11843       {
11844         "title": "Example usage:",
11845         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11846         "type": "json"
11847       }
11848     ],
11849     "name": "getDescriptions",
11850     "group": "Freshdesk_Configurations",
11851     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11852     "version": "0.0.0",
11853     "filename": "server/api/intFreshdeskConfiguration/index.js",
11854     "groupTitle": "Freshdesk_Configurations"
11855   },
11856   {
11857     "type": "get",
11858     "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11859     "title": "Gets configurations fields",
11860     "examples": [
11861       {
11862         "title": "Example usage:",
11863         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11864         "type": "json"
11865       }
11866     ],
11867     "name": "getFields",
11868     "group": "Freshdesk_Configurations",
11869     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11870     "version": "0.0.0",
11871     "filename": "server/api/intFreshdeskConfiguration/index.js",
11872     "groupTitle": "Freshdesk_Configurations"
11873   },
11874   {
11875     "type": "get",
11876     "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11877     "title": "Gets configurations subjects",
11878     "examples": [
11879       {
11880         "title": "Example usage:",
11881         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11882         "type": "json"
11883       }
11884     ],
11885     "name": "getSubjects",
11886     "group": "Freshdesk_Configurations",
11887     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11888     "version": "0.0.0",
11889     "filename": "server/api/intFreshdeskConfiguration/index.js",
11890     "groupTitle": "Freshdesk_Configurations"
11891   },
11892   {
11893     "type": "get",
11894     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11895     "title": "Gets configurations tags",
11896     "examples": [
11897       {
11898         "title": "Example usage:",
11899         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11900         "type": "json"
11901       }
11902     ],
11903     "name": "getTags",
11904     "group": "Freshdesk_Configurations",
11905     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11906     "version": "0.0.0",
11907     "filename": "server/api/intFreshdeskConfiguration/index.js",
11908     "groupTitle": "Freshdesk_Configurations"
11909   },
11910   {
11911     "type": "post",
11912     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11913     "title": "Sets new tags",
11914     "examples": [
11915       {
11916         "title": "Example usage:",
11917         "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",
11918         "type": "json"
11919       }
11920     ],
11921     "name": "setTags",
11922     "group": "Freshdesk_Configurations",
11923     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11924     "version": "0.0.0",
11925     "filename": "server/api/intFreshdeskConfiguration/index.js",
11926     "groupTitle": "Freshdesk_Configurations"
11927   },
11928   {
11929     "type": "put",
11930     "url": "/api/integrations/freshdesk/configurations/{id}",
11931     "title": "Update an existing Freshdesk Configuration",
11932     "examples": [
11933       {
11934         "title": "Example usage:",
11935         "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",
11936         "type": "json"
11937       }
11938     ],
11939     "name": "updateFreshdesk_Configurations",
11940     "group": "Freshdesk_Configurations",
11941     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11942     "version": "0.0.0",
11943     "filename": "server/api/intFreshdeskConfiguration/index.js",
11944     "groupTitle": "Freshdesk_Configurations"
11945   },
11946   {
11947     "type": "post",
11948     "url": "/api/integrations/freshdesk/fields",
11949     "title": "Creates a new Freshdesk Field",
11950     "examples": [
11951       {
11952         "title": "Example usage:",
11953         "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",
11954         "type": "json"
11955       }
11956     ],
11957     "name": "CreateFreshdesk_Fields",
11958     "group": "Freshdesk_Fields",
11959     "parameter": {
11960       "fields": {
11961         "Body": [
11962           {
11963             "group": "Body",
11964             "type": "String",
11965             "allowedValues": [
11966               "\"string\"",
11967               "\"variable\"",
11968               "\"customVariable\"",
11969               "\"keyValue\"",
11970               "\"picklist\""
11971             ],
11972             "optional": true,
11973             "field": "type",
11974             "description": ""
11975           },
11976           {
11977             "group": "Body",
11978             "type": "String",
11979             "optional": true,
11980             "field": "content",
11981             "description": ""
11982           },
11983           {
11984             "group": "Body",
11985             "type": "String",
11986             "optional": true,
11987             "field": "key",
11988             "description": ""
11989           },
11990           {
11991             "group": "Body",
11992             "type": "String",
11993             "allowedValues": [
11994               "\"string\"",
11995               "\"variable\"",
11996               "\"customVariable\""
11997             ],
11998             "optional": true,
11999             "field": "keyType",
12000             "description": ""
12001           },
12002           {
12003             "group": "Body",
12004             "type": "String",
12005             "optional": true,
12006             "field": "keyContent",
12007             "description": ""
12008           },
12009           {
12010             "group": "Body",
12011             "type": "String",
12012             "optional": true,
12013             "field": "idField",
12014             "description": ""
12015           },
12016           {
12017             "group": "Body",
12018             "type": "String",
12019             "optional": true,
12020             "field": "nameField",
12021             "description": ""
12022           },
12023           {
12024             "group": "Body",
12025             "type": "Boolean",
12026             "optional": true,
12027             "field": "customField",
12028             "description": ""
12029           },
12030           {
12031             "group": "Body",
12032             "type": "String",
12033             "optional": true,
12034             "field": "variableName",
12035             "description": ""
12036           }
12037         ]
12038       }
12039     },
12040     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12041     "version": "0.0.0",
12042     "filename": "server/api/intFreshdeskField/index.js",
12043     "groupTitle": "Freshdesk_Fields"
12044   },
12045   {
12046     "type": "delete",
12047     "url": "/api/integrations/freshdesk/fields/{id}",
12048     "title": "Deletes a Freshdesk Field",
12049     "examples": [
12050       {
12051         "title": "Example usage:",
12052         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
12053         "type": "json"
12054       }
12055     ],
12056     "name": "DeleteFreshdesk_Fields",
12057     "group": "Freshdesk_Fields",
12058     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12059     "version": "0.0.0",
12060     "filename": "server/api/intFreshdeskField/index.js",
12061     "groupTitle": "Freshdesk_Fields"
12062   },
12063   {
12064     "type": "get",
12065     "url": "/api/integrations/freshdesk/fields",
12066     "title": "Gets a list of Freshdesk Fields",
12067     "examples": [
12068       {
12069         "title": "Example usage:",
12070         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12071         "type": "json"
12072       }
12073     ],
12074     "name": "GetFreshdesk_Fields",
12075     "group": "Freshdesk_Fields",
12076     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12077     "version": "0.0.0",
12078     "filename": "server/api/intFreshdeskField/index.js",
12079     "groupTitle": "Freshdesk_Fields"
12080   },
12081   {
12082     "type": "get",
12083     "url": "/api/integrations/freshdesk/fields/{id}",
12084     "title": "Gets a single Freshdesk Field",
12085     "examples": [
12086       {
12087         "title": "Example usage:",
12088         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12089         "type": "json"
12090       }
12091     ],
12092     "name": "ShowFreshdesk_Fields",
12093     "group": "Freshdesk_Fields",
12094     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12095     "version": "0.0.0",
12096     "filename": "server/api/intFreshdeskField/index.js",
12097     "groupTitle": "Freshdesk_Fields"
12098   },
12099   {
12100     "type": "put",
12101     "url": "/api/integrations/freshdesk/fields/{id}",
12102     "title": "Update an existing Freshdesk Field",
12103     "examples": [
12104       {
12105         "title": "Example usage:",
12106         "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",
12107         "type": "json"
12108       }
12109     ],
12110     "name": "updateFreshdesk_Fields",
12111     "group": "Freshdesk_Fields",
12112     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12113     "version": "0.0.0",
12114     "filename": "server/api/intFreshdeskField/index.js",
12115     "groupTitle": "Freshdesk_Fields"
12116   },
12117   {
12118     "type": "post",
12119     "url": "/api/integrations/freshsales/accounts",
12120     "title": "Creates a new Freshsales Account",
12121     "examples": [
12122       {
12123         "title": "Example usage:",
12124         "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",
12125         "type": "json"
12126       }
12127     ],
12128     "name": "CreateFreshsales_Accounts",
12129     "group": "Freshsales_Accounts",
12130     "parameter": {
12131       "fields": {
12132         "Body": [
12133           {
12134             "group": "Body",
12135             "type": "String",
12136             "optional": true,
12137             "field": "name",
12138             "description": ""
12139           },
12140           {
12141             "group": "Body",
12142             "type": "String",
12143             "optional": true,
12144             "field": "description",
12145             "description": ""
12146           },
12147           {
12148             "group": "Body",
12149             "type": "String",
12150             "optional": true,
12151             "field": "username",
12152             "description": ""
12153           },
12154           {
12155             "group": "Body",
12156             "type": "String",
12157             "optional": true,
12158             "field": "apiKey",
12159             "description": ""
12160           },
12161           {
12162             "group": "Body",
12163             "type": "String",
12164             "optional": true,
12165             "field": "remoteUri",
12166             "description": ""
12167           },
12168           {
12169             "group": "Body",
12170             "type": "String",
12171             "optional": false,
12172             "field": "serverUrl",
12173             "description": ""
12174           }
12175         ]
12176       }
12177     },
12178     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12179     "version": "0.0.0",
12180     "filename": "server/api/intFreshsalesAccount/index.js",
12181     "groupTitle": "Freshsales_Accounts"
12182   },
12183   {
12184     "type": "delete",
12185     "url": "/api/integrations/freshsales/accounts/{id}",
12186     "title": "Deletes a Freshsales Account",
12187     "examples": [
12188       {
12189         "title": "Example usage:",
12190         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12191         "type": "json"
12192       }
12193     ],
12194     "name": "DeleteFreshsales_Accounts",
12195     "group": "Freshsales_Accounts",
12196     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12197     "version": "0.0.0",
12198     "filename": "server/api/intFreshsalesAccount/index.js",
12199     "groupTitle": "Freshsales_Accounts"
12200   },
12201   {
12202     "type": "get",
12203     "url": "/api/integrations/freshsales/accounts",
12204     "title": "Gets a list of Freshsales Accounts",
12205     "examples": [
12206       {
12207         "title": "Example usage:",
12208         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12209         "type": "json"
12210       }
12211     ],
12212     "name": "GetFreshsales_Accounts",
12213     "group": "Freshsales_Accounts",
12214     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12215     "version": "0.0.0",
12216     "filename": "server/api/intFreshsalesAccount/index.js",
12217     "groupTitle": "Freshsales_Accounts"
12218   },
12219   {
12220     "type": "get",
12221     "url": "/api/integrations/freshsales/accounts/{id}",
12222     "title": "Gets a single Freshsales Account",
12223     "examples": [
12224       {
12225         "title": "Example usage:",
12226         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12227         "type": "json"
12228       }
12229     ],
12230     "name": "ShowFreshsales_Accounts",
12231     "group": "Freshsales_Accounts",
12232     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12233     "version": "0.0.0",
12234     "filename": "server/api/intFreshsalesAccount/index.js",
12235     "groupTitle": "Freshsales_Accounts"
12236   },
12237   {
12238     "type": "post",
12239     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12240     "title": "Creates new configuration",
12241     "examples": [
12242       {
12243         "title": "Example usage:",
12244         "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",
12245         "type": "json"
12246       }
12247     ],
12248     "name": "addConfiguration",
12249     "group": "Freshsales_Accounts",
12250     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12251     "version": "0.0.0",
12252     "filename": "server/api/intFreshsalesAccount/index.js",
12253     "groupTitle": "Freshsales_Accounts"
12254   },
12255   {
12256     "type": "get",
12257     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12258     "title": "Gets account configurations",
12259     "examples": [
12260       {
12261         "title": "Example usage:",
12262         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12263         "type": "json"
12264       }
12265     ],
12266     "name": "getConfigurations",
12267     "group": "Freshsales_Accounts",
12268     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12269     "version": "0.0.0",
12270     "filename": "server/api/intFreshsalesAccount/index.js",
12271     "groupTitle": "Freshsales_Accounts"
12272   },
12273   {
12274     "type": "get",
12275     "url": "/api/integrations/freshsales/accounts/{id}/fields",
12276     "title": "Gets account fields",
12277     "examples": [
12278       {
12279         "title": "Example usage:",
12280         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12281         "type": "json"
12282       }
12283     ],
12284     "name": "getFields",
12285     "group": "Freshsales_Accounts",
12286     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12287     "version": "0.0.0",
12288     "filename": "server/api/intFreshsalesAccount/index.js",
12289     "groupTitle": "Freshsales_Accounts"
12290   },
12291   {
12292     "type": "put",
12293     "url": "/api/integrations/freshsales/accounts/{id}",
12294     "title": "Update an existing Freshsales Account",
12295     "examples": [
12296       {
12297         "title": "Example usage:",
12298         "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",
12299         "type": "json"
12300       }
12301     ],
12302     "name": "updateFreshsales_Accounts",
12303     "group": "Freshsales_Accounts",
12304     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12305     "version": "0.0.0",
12306     "filename": "server/api/intFreshsalesAccount/index.js",
12307     "groupTitle": "Freshsales_Accounts"
12308   },
12309   {
12310     "type": "post",
12311     "url": "/api/integrations/freshsales/configurations",
12312     "title": "Creates a new Freshsales Configuration",
12313     "examples": [
12314       {
12315         "title": "Example usage:",
12316         "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",
12317         "type": "json"
12318       }
12319     ],
12320     "name": "CreateFreshsales_Configurations",
12321     "group": "Freshsales_Configurations",
12322     "parameter": {
12323       "fields": {
12324         "Body": [
12325           {
12326             "group": "Body",
12327             "type": "String",
12328             "optional": true,
12329             "field": "name",
12330             "description": ""
12331           },
12332           {
12333             "group": "Body",
12334             "type": "String",
12335             "optional": true,
12336             "field": "description",
12337             "description": ""
12338           }
12339         ]
12340       }
12341     },
12342     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12343     "version": "0.0.0",
12344     "filename": "server/api/intFreshsalesConfiguration/index.js",
12345     "groupTitle": "Freshsales_Configurations"
12346   },
12347   {
12348     "type": "delete",
12349     "url": "/api/integrations/freshsales/configurations/{id}",
12350     "title": "Deletes a Freshsales Configuration",
12351     "examples": [
12352       {
12353         "title": "Example usage:",
12354         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12355         "type": "json"
12356       }
12357     ],
12358     "name": "DeleteFreshsales_Configurations",
12359     "group": "Freshsales_Configurations",
12360     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12361     "version": "0.0.0",
12362     "filename": "server/api/intFreshsalesConfiguration/index.js",
12363     "groupTitle": "Freshsales_Configurations"
12364   },
12365   {
12366     "type": "get",
12367     "url": "/api/integrations/freshsales/configurations",
12368     "title": "Gets a list of Freshsales Configurations",
12369     "examples": [
12370       {
12371         "title": "Example usage:",
12372         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12373         "type": "json"
12374       }
12375     ],
12376     "name": "GetFreshsales_Configurations",
12377     "group": "Freshsales_Configurations",
12378     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12379     "version": "0.0.0",
12380     "filename": "server/api/intFreshsalesConfiguration/index.js",
12381     "groupTitle": "Freshsales_Configurations"
12382   },
12383   {
12384     "type": "get",
12385     "url": "/api/integrations/freshsales/configurations/{id}",
12386     "title": "Gets a single Freshsales Configuration",
12387     "examples": [
12388       {
12389         "title": "Example usage:",
12390         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12391         "type": "json"
12392       }
12393     ],
12394     "name": "ShowFreshsales_Configurations",
12395     "group": "Freshsales_Configurations",
12396     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12397     "version": "0.0.0",
12398     "filename": "server/api/intFreshsalesConfiguration/index.js",
12399     "groupTitle": "Freshsales_Configurations"
12400   },
12401   {
12402     "type": "get",
12403     "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12404     "title": "Gets configurations descriptions",
12405     "examples": [
12406       {
12407         "title": "Example usage:",
12408         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12409         "type": "json"
12410       }
12411     ],
12412     "name": "getDescriptions",
12413     "group": "Freshsales_Configurations",
12414     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12415     "version": "0.0.0",
12416     "filename": "server/api/intFreshsalesConfiguration/index.js",
12417     "groupTitle": "Freshsales_Configurations"
12418   },
12419   {
12420     "type": "get",
12421     "url": "/api/integrations/freshsales/configurations/{id}/fields",
12422     "title": "Gets configurations fields",
12423     "examples": [
12424       {
12425         "title": "Example usage:",
12426         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12427         "type": "json"
12428       }
12429     ],
12430     "name": "getFields",
12431     "group": "Freshsales_Configurations",
12432     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12433     "version": "0.0.0",
12434     "filename": "server/api/intFreshsalesConfiguration/index.js",
12435     "groupTitle": "Freshsales_Configurations"
12436   },
12437   {
12438     "type": "get",
12439     "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12440     "title": "Gets configurations subjects",
12441     "examples": [
12442       {
12443         "title": "Example usage:",
12444         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12445         "type": "json"
12446       }
12447     ],
12448     "name": "getSubjects",
12449     "group": "Freshsales_Configurations",
12450     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12451     "version": "0.0.0",
12452     "filename": "server/api/intFreshsalesConfiguration/index.js",
12453     "groupTitle": "Freshsales_Configurations"
12454   },
12455   {
12456     "type": "put",
12457     "url": "/api/integrations/freshsales/configurations/{id}",
12458     "title": "Update an existing Freshsales Configuration",
12459     "examples": [
12460       {
12461         "title": "Example usage:",
12462         "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",
12463         "type": "json"
12464       }
12465     ],
12466     "name": "updateFreshsales_Configurations",
12467     "group": "Freshsales_Configurations",
12468     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12469     "version": "0.0.0",
12470     "filename": "server/api/intFreshsalesConfiguration/index.js",
12471     "groupTitle": "Freshsales_Configurations"
12472   },
12473   {
12474     "type": "post",
12475     "url": "/api/integrations/freshsales/fields",
12476     "title": "Creates a new Freshsales Field",
12477     "examples": [
12478       {
12479         "title": "Example usage:",
12480         "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",
12481         "type": "json"
12482       }
12483     ],
12484     "name": "CreateFreshsales_Fields",
12485     "group": "Freshsales_Fields",
12486     "parameter": {
12487       "fields": {
12488         "Body": [
12489           {
12490             "group": "Body",
12491             "type": "String",
12492             "allowedValues": [
12493               "\"string\"",
12494               "\"variable\"",
12495               "\"customVariable\"",
12496               "\"keyValue\"",
12497               "\"picklist\""
12498             ],
12499             "optional": true,
12500             "field": "type",
12501             "description": ""
12502           },
12503           {
12504             "group": "Body",
12505             "type": "String",
12506             "optional": true,
12507             "field": "content",
12508             "description": ""
12509           },
12510           {
12511             "group": "Body",
12512             "type": "String",
12513             "optional": true,
12514             "field": "key",
12515             "description": ""
12516           },
12517           {
12518             "group": "Body",
12519             "type": "String",
12520             "allowedValues": [
12521               "\"string\"",
12522               "\"variable\"",
12523               "\"customVariable\""
12524             ],
12525             "optional": true,
12526             "field": "keyType",
12527             "description": ""
12528           },
12529           {
12530             "group": "Body",
12531             "type": "String",
12532             "optional": true,
12533             "field": "keyContent",
12534             "description": ""
12535           },
12536           {
12537             "group": "Body",
12538             "type": "String",
12539             "optional": true,
12540             "field": "idField",
12541             "description": ""
12542           },
12543           {
12544             "group": "Body",
12545             "type": "String",
12546             "optional": true,
12547             "field": "nameField",
12548             "description": ""
12549           },
12550           {
12551             "group": "Body",
12552             "type": "Boolean",
12553             "optional": true,
12554             "field": "customField",
12555             "description": ""
12556           },
12557           {
12558             "group": "Body",
12559             "type": "String",
12560             "optional": true,
12561             "field": "variableName",
12562             "description": ""
12563           }
12564         ]
12565       }
12566     },
12567     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12568     "version": "0.0.0",
12569     "filename": "server/api/intFreshsalesField/index.js",
12570     "groupTitle": "Freshsales_Fields"
12571   },
12572   {
12573     "type": "delete",
12574     "url": "/api/integrations/freshsales/fields/{id}",
12575     "title": "Deletes a Freshsales Field",
12576     "examples": [
12577       {
12578         "title": "Example usage:",
12579         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12580         "type": "json"
12581       }
12582     ],
12583     "name": "DeleteFreshsales_Fields",
12584     "group": "Freshsales_Fields",
12585     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12586     "version": "0.0.0",
12587     "filename": "server/api/intFreshsalesField/index.js",
12588     "groupTitle": "Freshsales_Fields"
12589   },
12590   {
12591     "type": "get",
12592     "url": "/api/integrations/freshsales/fields",
12593     "title": "Gets a list of Freshsales Fields",
12594     "examples": [
12595       {
12596         "title": "Example usage:",
12597         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12598         "type": "json"
12599       }
12600     ],
12601     "name": "GetFreshsales_Fields",
12602     "group": "Freshsales_Fields",
12603     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12604     "version": "0.0.0",
12605     "filename": "server/api/intFreshsalesField/index.js",
12606     "groupTitle": "Freshsales_Fields"
12607   },
12608   {
12609     "type": "get",
12610     "url": "/api/integrations/freshsales/fields/{id}",
12611     "title": "Gets a single Freshsales Field",
12612     "examples": [
12613       {
12614         "title": "Example usage:",
12615         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12616         "type": "json"
12617       }
12618     ],
12619     "name": "ShowFreshsales_Fields",
12620     "group": "Freshsales_Fields",
12621     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12622     "version": "0.0.0",
12623     "filename": "server/api/intFreshsalesField/index.js",
12624     "groupTitle": "Freshsales_Fields"
12625   },
12626   {
12627     "type": "put",
12628     "url": "/api/integrations/freshsales/fields/{id}",
12629     "title": "Update an existing Freshsales Field",
12630     "examples": [
12631       {
12632         "title": "Example usage:",
12633         "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",
12634         "type": "json"
12635       }
12636     ],
12637     "name": "updateFreshsales_Fields",
12638     "group": "Freshsales_Fields",
12639     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12640     "version": "0.0.0",
12641     "filename": "server/api/intFreshsalesField/index.js",
12642     "groupTitle": "Freshsales_Fields"
12643   },
12644   {
12645     "type": "post",
12646     "url": "/api/campaigns/{id}/blacklists",
12647     "title": "Add blacklists to an IVR campaign",
12648     "examples": [
12649       {
12650         "title": "Example usage:",
12651         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12652         "type": "json"
12653       }
12654     ],
12655     "name": "AddBlackLists",
12656     "group": "IVR_Campaigns",
12657     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12658     "version": "0.0.0",
12659     "filename": "server/api/campaign/index.js",
12660     "groupTitle": "IVR_Campaigns"
12661   },
12662   {
12663     "type": "post",
12664     "url": "/api/campaigns/{id}/lists",
12665     "title": "Add lists to an IVR campaign",
12666     "examples": [
12667       {
12668         "title": "Example usage:",
12669         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12670         "type": "json"
12671       }
12672     ],
12673     "name": "AddLists",
12674     "group": "IVR_Campaigns",
12675     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12676     "version": "0.0.0",
12677     "filename": "server/api/campaign/index.js",
12678     "groupTitle": "IVR_Campaigns"
12679   },
12680   {
12681     "type": "post",
12682     "url": "/api/campaigns/clone",
12683     "title": "Clone an existing IVR Campaign",
12684     "examples": [
12685       {
12686         "title": "Example usage:",
12687         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12688         "type": "json"
12689       }
12690     ],
12691     "name": "CloneIVR_Campaigns",
12692     "group": "IVR_Campaigns",
12693     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12694     "version": "0.0.0",
12695     "filename": "server/api/campaign/index.js",
12696     "groupTitle": "IVR_Campaigns"
12697   },
12698   {
12699     "type": "post",
12700     "url": "/api/campaigns",
12701     "title": "Creates a new IVR Campaign",
12702     "examples": [
12703       {
12704         "title": "Example usage:",
12705         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12706         "type": "json"
12707       }
12708     ],
12709     "name": "CreateIVR_Campaigns",
12710     "group": "IVR_Campaigns",
12711     "parameter": {
12712       "fields": {
12713         "Body": [
12714           {
12715             "group": "Body",
12716             "type": "String",
12717             "optional": false,
12718             "field": "name",
12719             "description": ""
12720           },
12721           {
12722             "group": "Body",
12723             "type": "String",
12724             "allowedValues": [
12725               "\"ivr\""
12726             ],
12727             "optional": false,
12728             "field": "type",
12729             "description": ""
12730           },
12731           {
12732             "group": "Body",
12733             "type": "String",
12734             "optional": true,
12735             "field": "description",
12736             "description": ""
12737           },
12738           {
12739             "group": "Body",
12740             "type": "Boolean",
12741             "optional": true,
12742             "field": "active",
12743             "description": "<p>Active/Disactive Campaign</p>"
12744           },
12745           {
12746             "group": "Body",
12747             "type": "Integer",
12748             "optional": true,
12749             "field": "limitCalls",
12750             "description": "<p>Max 200 calls.</p>"
12751           },
12752           {
12753             "group": "Body",
12754             "type": "String",
12755             "optional": true,
12756             "field": "dialOriginateCallerIdName",
12757             "description": ""
12758           },
12759           {
12760             "group": "Body",
12761             "type": "String",
12762             "optional": true,
12763             "field": "dialOriginateCallerIdNumber",
12764             "description": ""
12765           },
12766           {
12767             "group": "Body",
12768             "type": "Integer",
12769             "optional": true,
12770             "field": "dialOriginateTimeout",
12771             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12772           },
12773           {
12774             "group": "Body",
12775             "type": "Integer",
12776             "optional": true,
12777             "field": "dialCongestionMaxRetry",
12778             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12779           },
12780           {
12781             "group": "Body",
12782             "type": "Integer",
12783             "optional": true,
12784             "field": "dialCongestionRetryFrequency",
12785             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12786           },
12787           {
12788             "group": "Body",
12789             "type": "Integer",
12790             "optional": true,
12791             "field": "dialBusyMaxRetry",
12792             "description": "<p>#Busy Retry (min:1, max:999)</p>"
12793           },
12794           {
12795             "group": "Body",
12796             "type": "Integer",
12797             "optional": true,
12798             "field": "dialBusyRetryFrequency",
12799             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12800           },
12801           {
12802             "group": "Body",
12803             "type": "Integer",
12804             "optional": true,
12805             "field": "dialNoAnswerMaxRetry",
12806             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12807           },
12808           {
12809             "group": "Body",
12810             "type": "Integer",
12811             "optional": true,
12812             "field": "dialNoAnswerRetryFrequency",
12813             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12814           },
12815           {
12816             "group": "Body",
12817             "type": "Integer",
12818             "optional": true,
12819             "field": "dialGlobalMaxRetry",
12820             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12821           },
12822           {
12823             "group": "Body",
12824             "type": "String",
12825             "optional": true,
12826             "field": "dialTimezone",
12827             "description": ""
12828           },
12829           {
12830             "group": "Body",
12831             "type": "String",
12832             "optional": true,
12833             "field": "dialGlobalInterval",
12834             "description": ""
12835           },
12836           {
12837             "group": "Body",
12838             "type": "String",
12839             "allowedValues": [
12840               "\"always\"",
12841               "\"never\"",
12842               "\"onlyIfOpen\""
12843             ],
12844             "optional": true,
12845             "field": "dialCheckDuplicateType",
12846             "description": ""
12847           },
12848           {
12849             "group": "Body",
12850             "type": "Boolean",
12851             "optional": true,
12852             "field": "dialAMDActive",
12853             "description": "<p>Active/Disactive AMD</p>"
12854           },
12855           {
12856             "group": "Body",
12857             "type": "Integer",
12858             "optional": true,
12859             "field": "dialAMDInitialSilence",
12860             "description": "<p>#AMD Initial Silence</p>"
12861           },
12862           {
12863             "group": "Body",
12864             "type": "Integer",
12865             "optional": true,
12866             "field": "dialAMDGreeting",
12867             "description": "<p>#AMD Greeting</p>"
12868           },
12869           {
12870             "group": "Body",
12871             "type": "Integer",
12872             "optional": true,
12873             "field": "dialAMDAfterGreetingSilence",
12874             "description": "<p>#AMD After Greeting Silence</p>"
12875           },
12876           {
12877             "group": "Body",
12878             "type": "Integer",
12879             "optional": true,
12880             "field": "dialAMDTotalAnalysisTime",
12881             "description": "<p>#AMD Total Analysis Time</p>"
12882           },
12883           {
12884             "group": "Body",
12885             "type": "Integer",
12886             "optional": true,
12887             "field": "dialAMDMinWordLength",
12888             "description": "<p>#AMD Min Word Length</p>"
12889           },
12890           {
12891             "group": "Body",
12892             "type": "Integer",
12893             "optional": true,
12894             "field": "dialAMDBetweenWordsSilence",
12895             "description": "<p>#AMD Between Words Silence</p>"
12896           },
12897           {
12898             "group": "Body",
12899             "type": "Integer",
12900             "optional": true,
12901             "field": "dialAMDMaximumNumberOfWords",
12902             "description": "<p>#AMD Maximum Number Of Words</p>"
12903           },
12904           {
12905             "group": "Body",
12906             "type": "Integer",
12907             "optional": true,
12908             "field": "dialAMDSilenceThreshold",
12909             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12910           },
12911           {
12912             "group": "Body",
12913             "type": "Integer",
12914             "optional": true,
12915             "field": "dialAMDMaximumWordLength",
12916             "description": "<p>#AMD Maximum Word Length</p>"
12917           },
12918           {
12919             "group": "Body",
12920             "type": "String",
12921             "allowedValues": [
12922               "\"DESC\"",
12923               "\"ASC\""
12924             ],
12925             "optional": true,
12926             "field": "dialOrderByScheduledAt",
12927             "description": ""
12928           },
12929           {
12930             "group": "Body",
12931             "type": "String",
12932             "optional": true,
12933             "field": "dialPrefix",
12934             "description": ""
12935           },
12936           {
12937             "group": "Body",
12938             "type": "Integer",
12939             "optional": true,
12940             "field": "dialRandomLastDigitCallerIdNumber",
12941             "description": "<p>Random Last Digit (min:1, max:15)</p>"
12942           },
12943           {
12944             "group": "Body",
12945             "type": "Integer",
12946             "optional": true,
12947             "field": "dialCutDigit",
12948             "description": "<p>Cut Digit (min:1, max:15)</p>"
12949           },
12950           {
12951             "group": "Body",
12952             "type": "Integer",
12953             "optional": true,
12954             "field": "dialNoSuchNumberMaxRetry",
12955             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12956           },
12957           {
12958             "group": "Body",
12959             "type": "Integer",
12960             "optional": true,
12961             "field": "dialNoSuchNumberRetryFrequency",
12962             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12963           },
12964           {
12965             "group": "Body",
12966             "type": "Integer",
12967             "optional": true,
12968             "field": "dialDropMaxRetry",
12969             "description": "<p>#Drop Retry (min:1, max:999)</p>"
12970           },
12971           {
12972             "group": "Body",
12973             "type": "Integer",
12974             "optional": true,
12975             "field": "dialDropRetryFrequency",
12976             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12977           },
12978           {
12979             "group": "Body",
12980             "type": "Integer",
12981             "optional": true,
12982             "field": "dialAbandonedMaxRetry",
12983             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12984           },
12985           {
12986             "group": "Body",
12987             "type": "Integer",
12988             "optional": true,
12989             "field": "dialAbandonedRetryFrequency",
12990             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12991           },
12992           {
12993             "group": "Body",
12994             "type": "Integer",
12995             "optional": true,
12996             "field": "dialMachineMaxRetry",
12997             "description": "<p>#Machine Retry (min:1, max:999)</p>"
12998           },
12999           {
13000             "group": "Body",
13001             "type": "Integer",
13002             "optional": true,
13003             "field": "dialMachineRetryFrequency",
13004             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
13005           },
13006           {
13007             "group": "Body",
13008             "type": "Integer",
13009             "optional": true,
13010             "field": "dialAgentRejectMaxRetry",
13011             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
13012           },
13013           {
13014             "group": "Body",
13015             "type": "Integer",
13016             "optional": true,
13017             "field": "dialAgentRejectRetryFrequency",
13018             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
13019           }
13020         ]
13021       }
13022     },
13023     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13024     "version": "0.0.0",
13025     "filename": "server/api/campaign/index.js",
13026     "groupTitle": "IVR_Campaigns"
13027   },
13028   {
13029     "type": "delete",
13030     "url": "/api/campaigns/{id}",
13031     "title": "Deletes a IVR Campaign",
13032     "examples": [
13033       {
13034         "title": "Example usage:",
13035         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
13036         "type": "json"
13037       }
13038     ],
13039     "name": "DeleteIVR_Campaigns",
13040     "group": "IVR_Campaigns",
13041     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13042     "version": "0.0.0",
13043     "filename": "server/api/campaign/index.js",
13044     "groupTitle": "IVR_Campaigns"
13045   },
13046   {
13047     "type": "get",
13048     "url": "/api/campaigns/{id}/blacklists",
13049     "title": "Get IVR campaign blacklists",
13050     "examples": [
13051       {
13052         "title": "Example usage:",
13053         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
13054         "type": "json"
13055       }
13056     ],
13057     "name": "GetBlackLists",
13058     "group": "IVR_Campaigns",
13059     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13060     "version": "0.0.0",
13061     "filename": "server/api/campaign/index.js",
13062     "groupTitle": "IVR_Campaigns"
13063   },
13064   {
13065     "type": "get",
13066     "url": "/api/campaigns/{id}/finals",
13067     "title": "Gets IVR campaign hopper finals",
13068     "examples": [
13069       {
13070         "title": "Example usage:",
13071         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
13072         "type": "json"
13073       }
13074     ],
13075     "name": "GetHopperFinals",
13076     "group": "IVR_Campaigns",
13077     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13078     "version": "0.0.0",
13079     "filename": "server/api/campaign/index.js",
13080     "groupTitle": "IVR_Campaigns"
13081   },
13082   {
13083     "type": "get",
13084     "url": "/api/campaigns/{id}/hopper_histories",
13085     "title": "Gets IVR campaign hopper histories",
13086     "examples": [
13087       {
13088         "title": "Example usage:",
13089         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13090         "type": "json"
13091       }
13092     ],
13093     "name": "GetHopperHistories",
13094     "group": "IVR_Campaigns",
13095     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13096     "version": "0.0.0",
13097     "filename": "server/api/campaign/index.js",
13098     "groupTitle": "IVR_Campaigns"
13099   },
13100   {
13101     "type": "get",
13102     "url": "/api/campaigns/{id}/hoppers",
13103     "title": "Gets IVR campaign hoppers",
13104     "examples": [
13105       {
13106         "title": "Example usage:",
13107         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13108         "type": "json"
13109       }
13110     ],
13111     "name": "GetHoppers",
13112     "group": "IVR_Campaigns",
13113     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13114     "version": "0.0.0",
13115     "filename": "server/api/campaign/index.js",
13116     "groupTitle": "IVR_Campaigns"
13117   },
13118   {
13119     "type": "get",
13120     "url": "/api/campaigns",
13121     "title": "Gets a list of IVR Campaigns",
13122     "examples": [
13123       {
13124         "title": "Example usage:",
13125         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13126         "type": "json"
13127       }
13128     ],
13129     "name": "GetIVR_Campaigns",
13130     "group": "IVR_Campaigns",
13131     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13132     "version": "0.0.0",
13133     "filename": "server/api/campaign/index.js",
13134     "groupTitle": "IVR_Campaigns"
13135   },
13136   {
13137     "type": "get",
13138     "url": "/api/campaigns/{id}/lists",
13139     "title": "Get IVR campaign lists",
13140     "examples": [
13141       {
13142         "title": "Example usage:",
13143         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13144         "type": "json"
13145       }
13146     ],
13147     "name": "GetLists",
13148     "group": "IVR_Campaigns",
13149     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13150     "version": "0.0.0",
13151     "filename": "server/api/campaign/index.js",
13152     "groupTitle": "IVR_Campaigns"
13153   },
13154   {
13155     "type": "delete",
13156     "url": "/api/campaigns/{id}/blacklists",
13157     "title": "Remove blacklists from an IVR Campaign",
13158     "examples": [
13159       {
13160         "title": "Example usage:",
13161         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13162         "type": "json"
13163       }
13164     ],
13165     "name": "RemoveBlackLists",
13166     "group": "IVR_Campaigns",
13167     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13168     "version": "0.0.0",
13169     "filename": "server/api/campaign/index.js",
13170     "groupTitle": "IVR_Campaigns"
13171   },
13172   {
13173     "type": "delete",
13174     "url": "/api/campaigns/{id}/lists",
13175     "title": "Remove lists from an IVR Campaign",
13176     "examples": [
13177       {
13178         "title": "Example usage:",
13179         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13180         "type": "json"
13181       }
13182     ],
13183     "name": "RemoveLists",
13184     "group": "IVR_Campaigns",
13185     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13186     "version": "0.0.0",
13187     "filename": "server/api/campaign/index.js",
13188     "groupTitle": "IVR_Campaigns"
13189   },
13190   {
13191     "type": "get",
13192     "url": "/api/campaigns/{id}",
13193     "title": "Gets a single IVR Campaign",
13194     "examples": [
13195       {
13196         "title": "Example usage:",
13197         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13198         "type": "json"
13199       }
13200     ],
13201     "name": "ShowIVR_Campaigns",
13202     "group": "IVR_Campaigns",
13203     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13204     "version": "0.0.0",
13205     "filename": "server/api/campaign/index.js",
13206     "groupTitle": "IVR_Campaigns"
13207   },
13208   {
13209     "type": "get",
13210     "url": "/api/campaigns/{id}/blacks",
13211     "title": "Gets IVR campaign hopper blacks",
13212     "examples": [
13213       {
13214         "title": "Example usage:",
13215         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
13216         "type": "json"
13217       }
13218     ],
13219     "name": "getHopperBlacks",
13220     "group": "IVR_Campaigns",
13221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13222     "version": "0.0.0",
13223     "filename": "server/api/campaign/index.js",
13224     "groupTitle": "IVR_Campaigns"
13225   },
13226   {
13227     "type": "put",
13228     "url": "/api/campaigns/{id}",
13229     "title": "Update an existing IVR Campaign",
13230     "examples": [
13231       {
13232         "title": "Example usage:",
13233         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13234         "type": "json"
13235       }
13236     ],
13237     "name": "updateIVR_Campaigns",
13238     "group": "IVR_Campaigns",
13239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13240     "version": "0.0.0",
13241     "filename": "server/api/campaign/index.js",
13242     "groupTitle": "IVR_Campaigns"
13243   },
13244   {
13245     "type": "post",
13246     "url": "/api/integrations/reports",
13247     "title": "Creates a new Integration Report",
13248     "examples": [
13249       {
13250         "title": "Example usage:",
13251         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13252         "type": "json"
13253       }
13254     ],
13255     "name": "CreateIntegration_Reports",
13256     "group": "Integration_Reports",
13257     "parameter": {
13258       "fields": {
13259         "Body": [
13260           {
13261             "group": "Body",
13262             "type": "String",
13263             "optional": true,
13264             "field": "integration",
13265             "description": ""
13266           },
13267           {
13268             "group": "Body",
13269             "type": "String",
13270             "optional": true,
13271             "field": "eventChannel",
13272             "description": ""
13273           },
13274           {
13275             "group": "Body",
13276             "type": "String",
13277             "optional": true,
13278             "field": "exitStatus",
13279             "description": ""
13280           },
13281           {
13282             "group": "Body",
13283             "type": "String",
13284             "optional": true,
13285             "field": "ticketId",
13286             "description": ""
13287           },
13288           {
13289             "group": "Body",
13290             "type": "Integer",
13291             "optional": true,
13292             "field": "integrationId",
13293             "description": ""
13294           },
13295           {
13296             "group": "Body",
13297             "type": "String",
13298             "optional": true,
13299             "field": "contacts",
13300             "description": ""
13301           },
13302           {
13303             "group": "Body",
13304             "type": "String",
13305             "optional": true,
13306             "field": "uniqueid",
13307             "description": ""
13308           },
13309           {
13310             "group": "Body",
13311             "type": "String",
13312             "optional": true,
13313             "field": "calleridnum",
13314             "description": ""
13315           },
13316           {
13317             "group": "Body",
13318             "type": "String",
13319             "optional": true,
13320             "field": "calleridname",
13321             "description": ""
13322           },
13323           {
13324             "group": "Body",
13325             "type": "String",
13326             "optional": true,
13327             "field": "queue",
13328             "description": ""
13329           },
13330           {
13331             "group": "Body",
13332             "type": "String",
13333             "optional": true,
13334             "field": "interface",
13335             "description": ""
13336           },
13337           {
13338             "group": "Body",
13339             "type": "String",
13340             "optional": true,
13341             "field": "membername",
13342             "description": ""
13343           },
13344           {
13345             "group": "Body",
13346             "type": "String",
13347             "optional": true,
13348             "field": "agentcalledAt",
13349             "description": ""
13350           },
13351           {
13352             "group": "Body",
13353             "type": "String",
13354             "optional": true,
13355             "field": "agentconnectAt",
13356             "description": ""
13357           },
13358           {
13359             "group": "Body",
13360             "type": "Integer",
13361             "optional": true,
13362             "field": "holdtime",
13363             "description": ""
13364           },
13365           {
13366             "group": "Body",
13367             "type": "Boolean",
13368             "optional": true,
13369             "field": "agentcomplete",
13370             "description": ""
13371           },
13372           {
13373             "group": "Body",
13374             "type": "String",
13375             "optional": true,
13376             "field": "agentcompleteAt",
13377             "description": ""
13378           },
13379           {
13380             "group": "Body",
13381             "type": "Integer",
13382             "optional": true,
13383             "field": "talktime",
13384             "description": ""
13385           },
13386           {
13387             "group": "Body",
13388             "type": "Boolean",
13389             "optional": true,
13390             "field": "agentacw",
13391             "description": ""
13392           },
13393           {
13394             "group": "Body",
13395             "type": "Integer",
13396             "optional": true,
13397             "field": "acwtime",
13398             "description": ""
13399           },
13400           {
13401             "group": "Body",
13402             "type": "String",
13403             "optional": true,
13404             "field": "reason",
13405             "description": ""
13406           },
13407           {
13408             "group": "Body",
13409             "type": "Boolean",
13410             "optional": true,
13411             "field": "agentringnoanswer",
13412             "description": ""
13413           },
13414           {
13415             "group": "Body",
13416             "type": "String",
13417             "optional": true,
13418             "field": "agentringnoanswerAt",
13419             "description": ""
13420           },
13421           {
13422             "group": "Body",
13423             "type": "Boolean",
13424             "optional": true,
13425             "field": "agentdump",
13426             "description": ""
13427           },
13428           {
13429             "group": "Body",
13430             "type": "String",
13431             "optional": true,
13432             "field": "agentdumpAt",
13433             "description": ""
13434           },
13435           {
13436             "group": "Body",
13437             "type": "String",
13438             "optional": true,
13439             "field": "lastevent",
13440             "description": ""
13441           },
13442           {
13443             "group": "Body",
13444             "type": "String",
13445             "optional": true,
13446             "field": "channel",
13447             "description": ""
13448           },
13449           {
13450             "group": "Body",
13451             "type": "Integer",
13452             "optional": true,
13453             "field": "channelstate",
13454             "description": ""
13455           },
13456           {
13457             "group": "Body",
13458             "type": "String",
13459             "optional": true,
13460             "field": "channelstatedesc",
13461             "description": ""
13462           },
13463           {
13464             "group": "Body",
13465             "type": "String",
13466             "optional": true,
13467             "field": "connectedlinenum",
13468             "description": ""
13469           },
13470           {
13471             "group": "Body",
13472             "type": "String",
13473             "optional": true,
13474             "field": "connectedlinename",
13475             "description": ""
13476           },
13477           {
13478             "group": "Body",
13479             "type": "String",
13480             "optional": true,
13481             "field": "language",
13482             "description": ""
13483           },
13484           {
13485             "group": "Body",
13486             "type": "String",
13487             "optional": true,
13488             "field": "accountcode",
13489             "description": ""
13490           },
13491           {
13492             "group": "Body",
13493             "type": "String",
13494             "optional": true,
13495             "field": "context",
13496             "description": ""
13497           },
13498           {
13499             "group": "Body",
13500             "type": "String",
13501             "optional": true,
13502             "field": "exten",
13503             "description": ""
13504           },
13505           {
13506             "group": "Body",
13507             "type": "String",
13508             "optional": true,
13509             "field": "priority",
13510             "description": ""
13511           },
13512           {
13513             "group": "Body",
13514             "type": "String",
13515             "optional": true,
13516             "field": "destchannel",
13517             "description": ""
13518           },
13519           {
13520             "group": "Body",
13521             "type": "Integer",
13522             "optional": true,
13523             "field": "destchannelstate",
13524             "description": ""
13525           },
13526           {
13527             "group": "Body",
13528             "type": "String",
13529             "optional": true,
13530             "field": "destchannelstatedesc",
13531             "description": ""
13532           },
13533           {
13534             "group": "Body",
13535             "type": "String",
13536             "optional": true,
13537             "field": "destcalleridnum",
13538             "description": ""
13539           },
13540           {
13541             "group": "Body",
13542             "type": "String",
13543             "optional": true,
13544             "field": "destcalleridname",
13545             "description": ""
13546           },
13547           {
13548             "group": "Body",
13549             "type": "String",
13550             "optional": true,
13551             "field": "destconnectedlinenum",
13552             "description": ""
13553           },
13554           {
13555             "group": "Body",
13556             "type": "String",
13557             "optional": true,
13558             "field": "destconnectedlinename",
13559             "description": ""
13560           },
13561           {
13562             "group": "Body",
13563             "type": "String",
13564             "optional": true,
13565             "field": "destlanguage",
13566             "description": ""
13567           },
13568           {
13569             "group": "Body",
13570             "type": "String",
13571             "optional": true,
13572             "field": "destaccountcode",
13573             "description": ""
13574           },
13575           {
13576             "group": "Body",
13577             "type": "String",
13578             "optional": true,
13579             "field": "destcontext",
13580             "description": ""
13581           },
13582           {
13583             "group": "Body",
13584             "type": "String",
13585             "optional": true,
13586             "field": "destexten",
13587             "description": ""
13588           },
13589           {
13590             "group": "Body",
13591             "type": "String",
13592             "optional": true,
13593             "field": "destpriority",
13594             "description": ""
13595           },
13596           {
13597             "group": "Body",
13598             "type": "String",
13599             "optional": true,
13600             "field": "destuniqueid",
13601             "description": ""
13602           },
13603           {
13604             "group": "Body",
13605             "type": "String",
13606             "optional": true,
13607             "field": "messageId",
13608             "description": ""
13609           },
13610           {
13611             "group": "Body",
13612             "type": "String",
13613             "optional": true,
13614             "field": "inReplyTo",
13615             "description": ""
13616           },
13617           {
13618             "group": "Body",
13619             "type": "String",
13620             "optional": true,
13621             "field": "subject",
13622             "description": ""
13623           },
13624           {
13625             "group": "Body",
13626             "type": "String",
13627             "optional": true,
13628             "field": "from",
13629             "description": ""
13630           },
13631           {
13632             "group": "Body",
13633             "type": "String",
13634             "optional": true,
13635             "field": "to",
13636             "description": ""
13637           },
13638           {
13639             "group": "Body",
13640             "type": "String",
13641             "optional": true,
13642             "field": "cc",
13643             "description": ""
13644           },
13645           {
13646             "group": "Body",
13647             "type": "Text",
13648             "optional": true,
13649             "field": "attachment",
13650             "description": ""
13651           },
13652           {
13653             "group": "Body",
13654             "type": "Text",
13655             "optional": true,
13656             "field": "html",
13657             "description": ""
13658           },
13659           {
13660             "group": "Body",
13661             "type": "Text",
13662             "optional": true,
13663             "field": "text",
13664             "description": ""
13665           },
13666           {
13667             "group": "Body",
13668             "type": "String",
13669             "allowedValues": [
13670               "\"SENT\"",
13671               "\"SENDING\"",
13672               "\"RECEIVED\"",
13673               "\"FAILED\""
13674             ],
13675             "optional": true,
13676             "field": "status",
13677             "description": ""
13678           },
13679           {
13680             "group": "Body",
13681             "type": "String",
13682             "optional": true,
13683             "field": "url",
13684             "description": ""
13685           },
13686           {
13687             "group": "Body",
13688             "type": "String",
13689             "optional": true,
13690             "field": "app",
13691             "description": ""
13692           },
13693           {
13694             "group": "Body",
13695             "type": "String",
13696             "optional": true,
13697             "field": "appdata",
13698             "description": ""
13699           },
13700           {
13701             "group": "Body",
13702             "type": "Integer",
13703             "optional": true,
13704             "field": "projectId",
13705             "description": ""
13706           }
13707         ]
13708       }
13709     },
13710     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13711     "version": "0.0.0",
13712     "filename": "server/api/integrationReport/index.js",
13713     "groupTitle": "Integration_Reports"
13714   },
13715   {
13716     "type": "delete",
13717     "url": "/api/integrations/reports/{id}",
13718     "title": "Deletes a Integration Report",
13719     "examples": [
13720       {
13721         "title": "Example usage:",
13722         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13723         "type": "json"
13724       }
13725     ],
13726     "name": "DeleteIntegration_Reports",
13727     "group": "Integration_Reports",
13728     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13729     "version": "0.0.0",
13730     "filename": "server/api/integrationReport/index.js",
13731     "groupTitle": "Integration_Reports"
13732   },
13733   {
13734     "type": "get",
13735     "url": "/api/integrations/reports/describe",
13736     "title": "Gets table info about Integration Reports",
13737     "examples": [
13738       {
13739         "title": "Example usage:",
13740         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13741         "type": "json"
13742       }
13743     ],
13744     "name": "DescribeIntegration_Reports",
13745     "group": "Integration_Reports",
13746     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13747     "version": "0.0.0",
13748     "filename": "server/api/integrationReport/index.js",
13749     "groupTitle": "Integration_Reports"
13750   },
13751   {
13752     "type": "get",
13753     "url": "/api/integrations/reports",
13754     "title": "Gets a list of Integration Reports",
13755     "examples": [
13756       {
13757         "title": "Example usage:",
13758         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13759         "type": "json"
13760       }
13761     ],
13762     "name": "GetIntegration_Reports",
13763     "group": "Integration_Reports",
13764     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13765     "version": "0.0.0",
13766     "filename": "server/api/integrationReport/index.js",
13767     "groupTitle": "Integration_Reports"
13768   },
13769   {
13770     "type": "get",
13771     "url": "/api/integrations/reports/{id}",
13772     "title": "Gets a single Integration Report",
13773     "examples": [
13774       {
13775         "title": "Example usage:",
13776         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13777         "type": "json"
13778       }
13779     ],
13780     "name": "ShowIntegration_Reports",
13781     "group": "Integration_Reports",
13782     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13783     "version": "0.0.0",
13784     "filename": "server/api/integrationReport/index.js",
13785     "groupTitle": "Integration_Reports"
13786   },
13787   {
13788     "type": "put",
13789     "url": "/api/integrations/reports/{id}",
13790     "title": "Update an existing Integration Report",
13791     "examples": [
13792       {
13793         "title": "Example usage:",
13794         "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",
13795         "type": "json"
13796       }
13797     ],
13798     "name": "updateIntegration_Reports",
13799     "group": "Integration_Reports",
13800     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13801     "version": "0.0.0",
13802     "filename": "server/api/integrationReport/index.js",
13803     "groupTitle": "Integration_Reports"
13804   },
13805   {
13806     "type": "post",
13807     "url": "/api/intervals",
13808     "title": "Creates a new Interval",
13809     "examples": [
13810       {
13811         "title": "Example usage:",
13812         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13813         "type": "json"
13814       }
13815     ],
13816     "name": "CreateIntervals",
13817     "group": "Intervals",
13818     "parameter": {
13819       "fields": {
13820         "Body": [
13821           {
13822             "group": "Body",
13823             "type": "String",
13824             "optional": true,
13825             "field": "name",
13826             "description": ""
13827           },
13828           {
13829             "group": "Body",
13830             "type": "String",
13831             "optional": true,
13832             "field": "description",
13833             "description": ""
13834           },
13835           {
13836             "group": "Body",
13837             "type": "String",
13838             "optional": true,
13839             "field": "interval",
13840             "description": ""
13841           }
13842         ]
13843       }
13844     },
13845     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13846     "version": "0.0.0",
13847     "filename": "server/api/interval/index.js",
13848     "groupTitle": "Intervals"
13849   },
13850   {
13851     "type": "delete",
13852     "url": "/api/intervals/{id}",
13853     "title": "Deletes a Interval",
13854     "examples": [
13855       {
13856         "title": "Example usage:",
13857         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13858         "type": "json"
13859       }
13860     ],
13861     "name": "DeleteIntervals",
13862     "group": "Intervals",
13863     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13864     "version": "0.0.0",
13865     "filename": "server/api/interval/index.js",
13866     "groupTitle": "Intervals"
13867   },
13868   {
13869     "type": "get",
13870     "url": "/api/intervals",
13871     "title": "Gets a list of Intervals",
13872     "examples": [
13873       {
13874         "title": "Example usage:",
13875         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13876         "type": "json"
13877       }
13878     ],
13879     "name": "GetIntervals",
13880     "group": "Intervals",
13881     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13882     "version": "0.0.0",
13883     "filename": "server/api/interval/index.js",
13884     "groupTitle": "Intervals"
13885   },
13886   {
13887     "type": "get",
13888     "url": "/api/intervals/{id}",
13889     "title": "Gets a single Interval",
13890     "examples": [
13891       {
13892         "title": "Example usage:",
13893         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13894         "type": "json"
13895       }
13896     ],
13897     "name": "ShowIntervals",
13898     "group": "Intervals",
13899     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13900     "version": "0.0.0",
13901     "filename": "server/api/interval/index.js",
13902     "groupTitle": "Intervals"
13903   },
13904   {
13905     "type": "post",
13906     "url": "/api/intervals/{id}/sub_intervals",
13907     "title": "Creates a new sub interval",
13908     "examples": [
13909       {
13910         "title": "Example usage:",
13911         "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",
13912         "type": "json"
13913       }
13914     ],
13915     "name": "addInterval",
13916     "group": "Intervals",
13917     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13918     "version": "0.0.0",
13919     "filename": "server/api/interval/index.js",
13920     "groupTitle": "Intervals"
13921   },
13922   {
13923     "type": "post",
13924     "url": "/api/intervals/{id}/sub_intervals/create_many",
13925     "title": "Create new sub intervals set",
13926     "examples": [
13927       {
13928         "title": "Example usage:",
13929         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13930         "type": "json"
13931       }
13932     ],
13933     "name": "addIntervals",
13934     "group": "Intervals",
13935     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13936     "version": "0.0.0",
13937     "filename": "server/api/interval/index.js",
13938     "groupTitle": "Intervals"
13939   },
13940   {
13941     "type": "get",
13942     "url": "/api/intervals/{id}/sub_intervals",
13943     "title": "Get sub intervals set",
13944     "examples": [
13945       {
13946         "title": "Example usage:",
13947         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13948         "type": "json"
13949       }
13950     ],
13951     "name": "getIntervals",
13952     "group": "Intervals",
13953     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13954     "version": "0.0.0",
13955     "filename": "server/api/interval/index.js",
13956     "groupTitle": "Intervals"
13957   },
13958   {
13959     "type": "put",
13960     "url": "/api/intervals/{id}",
13961     "title": "Update an existing Interval",
13962     "examples": [
13963       {
13964         "title": "Example usage:",
13965         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13966         "type": "json"
13967       }
13968     ],
13969     "name": "updateIntervals",
13970     "group": "Intervals",
13971     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13972     "version": "0.0.0",
13973     "filename": "server/api/interval/index.js",
13974     "groupTitle": "Intervals"
13975   },
13976   {
13977     "type": "post",
13978     "url": "/api/jira",
13979     "title": "Creates a new issue",
13980     "examples": [
13981       {
13982         "title": "Example usage:",
13983         "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}",
13984         "type": "json"
13985       }
13986     ],
13987     "name": "Creates_Issue",
13988     "group": "Issue",
13989     "parameter": {
13990       "fields": {
13991         "Body": [
13992           {
13993             "group": "Body",
13994             "type": "String",
13995             "allowedValues": [
13996               "\"Bug\""
13997             ],
13998             "optional": true,
13999             "field": "issuetype",
14000             "description": ""
14001           },
14002           {
14003             "group": "Body",
14004             "type": "String",
14005             "optional": false,
14006             "field": "summary",
14007             "description": ""
14008           },
14009           {
14010             "group": "Body",
14011             "type": "String",
14012             "optional": false,
14013             "field": "description",
14014             "description": ""
14015           }
14016         ]
14017       }
14018     },
14019     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14020     "version": "0.0.0",
14021     "filename": "server/api/jira/index.js",
14022     "groupTitle": "Issue"
14023   },
14024   {
14025     "type": "post",
14026     "url": "/api/jscripty/answers/reports",
14027     "title": "Creates a new Report",
14028     "examples": [
14029       {
14030         "title": "Example usage:",
14031         "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",
14032         "type": "json"
14033       }
14034     ],
14035     "name": "CreateReports",
14036     "group": "JscriptyAnswerReport",
14037     "parameter": {
14038       "fields": {
14039         "Body": [
14040           {
14041             "group": "Body",
14042             "type": "Text",
14043             "optional": true,
14044             "field": "question",
14045             "description": ""
14046           },
14047           {
14048             "group": "Body",
14049             "type": "Text",
14050             "optional": true,
14051             "field": "answer",
14052             "description": ""
14053           },
14054           {
14055             "group": "Body",
14056             "type": "String",
14057             "optional": true,
14058             "field": "membername",
14059             "description": ""
14060           },
14061           {
14062             "group": "Body",
14063             "type": "String",
14064             "optional": true,
14065             "field": "projectname",
14066             "description": ""
14067           },
14068           {
14069             "group": "Body",
14070             "type": "String",
14071             "optional": true,
14072             "field": "queue",
14073             "description": ""
14074           },
14075           {
14076             "group": "Body",
14077             "type": "String",
14078             "optional": true,
14079             "field": "uniqueid",
14080             "description": ""
14081           },
14082           {
14083             "group": "Body",
14084             "type": "String",
14085             "optional": true,
14086             "field": "calleridname",
14087             "description": ""
14088           },
14089           {
14090             "group": "Body",
14091             "type": "String",
14092             "optional": true,
14093             "field": "calleridnum",
14094             "description": ""
14095           },
14096           {
14097             "group": "Body",
14098             "type": "String",
14099             "optional": true,
14100             "field": "questionId",
14101             "description": ""
14102           }
14103         ]
14104       }
14105     },
14106     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14107     "version": "0.0.0",
14108     "filename": "server/api/jscriptyAnswerReport/index.js",
14109     "groupTitle": "JscriptyAnswerReport"
14110   },
14111   {
14112     "type": "delete",
14113     "url": "/api/jscripty/answers/reports/{id}",
14114     "title": "Deletes a Report",
14115     "examples": [
14116       {
14117         "title": "Example usage:",
14118         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14119         "type": "json"
14120       }
14121     ],
14122     "name": "DeleteReports",
14123     "group": "JscriptyAnswerReport",
14124     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14125     "version": "0.0.0",
14126     "filename": "server/api/jscriptyAnswerReport/index.js",
14127     "groupTitle": "JscriptyAnswerReport"
14128   },
14129   {
14130     "type": "get",
14131     "url": "/api/jscripty/answers/reports/describe",
14132     "title": "Gets table info about Reports",
14133     "examples": [
14134       {
14135         "title": "Example usage:",
14136         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14137         "type": "json"
14138       }
14139     ],
14140     "name": "DescribeReports",
14141     "group": "JscriptyAnswerReport",
14142     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14143     "version": "0.0.0",
14144     "filename": "server/api/jscriptyAnswerReport/index.js",
14145     "groupTitle": "JscriptyAnswerReport"
14146   },
14147   {
14148     "type": "get",
14149     "url": "/api/jscripty/answers/reports",
14150     "title": "Gets a list of Reports",
14151     "examples": [
14152       {
14153         "title": "Example usage:",
14154         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14155         "type": "json"
14156       }
14157     ],
14158     "name": "GetReports",
14159     "group": "JscriptyAnswerReport",
14160     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14161     "version": "0.0.0",
14162     "filename": "server/api/jscriptyAnswerReport/index.js",
14163     "groupTitle": "JscriptyAnswerReport"
14164   },
14165   {
14166     "type": "get",
14167     "url": "/api/jscripty/answers/reports/{id}",
14168     "title": "Gets a single Report",
14169     "examples": [
14170       {
14171         "title": "Example usage:",
14172         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14173         "type": "json"
14174       }
14175     ],
14176     "name": "ShowReports",
14177     "group": "JscriptyAnswerReport",
14178     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14179     "version": "0.0.0",
14180     "filename": "server/api/jscriptyAnswerReport/index.js",
14181     "groupTitle": "JscriptyAnswerReport"
14182   },
14183   {
14184     "type": "put",
14185     "url": "/api/jscripty/answers/reports/{id}",
14186     "title": "Update an existing Report",
14187     "examples": [
14188       {
14189         "title": "Example usage:",
14190         "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",
14191         "type": "json"
14192       }
14193     ],
14194     "name": "updateReports",
14195     "group": "JscriptyAnswerReport",
14196     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14197     "version": "0.0.0",
14198     "filename": "server/api/jscriptyAnswerReport/index.js",
14199     "groupTitle": "JscriptyAnswerReport"
14200   },
14201   {
14202     "type": "post",
14203     "url": "/api/jscripty/questions/reports",
14204     "title": "Creates a new Report",
14205     "examples": [
14206       {
14207         "title": "Example usage:",
14208         "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",
14209         "type": "json"
14210       }
14211     ],
14212     "name": "CreateReports",
14213     "group": "JscriptyQuestionReport",
14214     "parameter": {
14215       "fields": {
14216         "Body": [
14217           {
14218             "group": "Body",
14219             "type": "Text",
14220             "optional": true,
14221             "field": "question",
14222             "description": ""
14223           },
14224           {
14225             "group": "Body",
14226             "type": "Text",
14227             "optional": true,
14228             "field": "answer",
14229             "description": ""
14230           },
14231           {
14232             "group": "Body",
14233             "type": "String",
14234             "optional": true,
14235             "field": "membername",
14236             "description": ""
14237           },
14238           {
14239             "group": "Body",
14240             "type": "String",
14241             "optional": true,
14242             "field": "projectname",
14243             "description": ""
14244           },
14245           {
14246             "group": "Body",
14247             "type": "String",
14248             "optional": true,
14249             "field": "queue",
14250             "description": ""
14251           },
14252           {
14253             "group": "Body",
14254             "type": "String",
14255             "optional": true,
14256             "field": "uniqueid",
14257             "description": ""
14258           },
14259           {
14260             "group": "Body",
14261             "type": "String",
14262             "optional": true,
14263             "field": "calleridname",
14264             "description": ""
14265           },
14266           {
14267             "group": "Body",
14268             "type": "String",
14269             "optional": true,
14270             "field": "calleridnum",
14271             "description": ""
14272           },
14273           {
14274             "group": "Body",
14275             "type": "String",
14276             "optional": true,
14277             "field": "questionId",
14278             "description": ""
14279           }
14280         ]
14281       }
14282     },
14283     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14284     "version": "0.0.0",
14285     "filename": "server/api/jscriptyQuestionReport/index.js",
14286     "groupTitle": "JscriptyQuestionReport"
14287   },
14288   {
14289     "type": "delete",
14290     "url": "/api/jscripty/questions/reports/{id}",
14291     "title": "Deletes a Report",
14292     "examples": [
14293       {
14294         "title": "Example usage:",
14295         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14296         "type": "json"
14297       }
14298     ],
14299     "name": "DeleteReports",
14300     "group": "JscriptyQuestionReport",
14301     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14302     "version": "0.0.0",
14303     "filename": "server/api/jscriptyQuestionReport/index.js",
14304     "groupTitle": "JscriptyQuestionReport"
14305   },
14306   {
14307     "type": "get",
14308     "url": "/api/jscripty/questions/reports/describe",
14309     "title": "Gets table info about Reports",
14310     "examples": [
14311       {
14312         "title": "Example usage:",
14313         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14314         "type": "json"
14315       }
14316     ],
14317     "name": "DescribeReports",
14318     "group": "JscriptyQuestionReport",
14319     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14320     "version": "0.0.0",
14321     "filename": "server/api/jscriptyQuestionReport/index.js",
14322     "groupTitle": "JscriptyQuestionReport"
14323   },
14324   {
14325     "type": "get",
14326     "url": "/api/jscripty/questions/reports",
14327     "title": "Gets a list of Reports",
14328     "examples": [
14329       {
14330         "title": "Example usage:",
14331         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14332         "type": "json"
14333       }
14334     ],
14335     "name": "GetReports",
14336     "group": "JscriptyQuestionReport",
14337     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14338     "version": "0.0.0",
14339     "filename": "server/api/jscriptyQuestionReport/index.js",
14340     "groupTitle": "JscriptyQuestionReport"
14341   },
14342   {
14343     "type": "get",
14344     "url": "/api/jscripty/questions/reports/{id}",
14345     "title": "Gets a single Report",
14346     "examples": [
14347       {
14348         "title": "Example usage:",
14349         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14350         "type": "json"
14351       }
14352     ],
14353     "name": "ShowReports",
14354     "group": "JscriptyQuestionReport",
14355     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14356     "version": "0.0.0",
14357     "filename": "server/api/jscriptyQuestionReport/index.js",
14358     "groupTitle": "JscriptyQuestionReport"
14359   },
14360   {
14361     "type": "put",
14362     "url": "/api/jscripty/questions/reports/{id}",
14363     "title": "Update an existing Report",
14364     "examples": [
14365       {
14366         "title": "Example usage:",
14367         "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",
14368         "type": "json"
14369       }
14370     ],
14371     "name": "updateReports",
14372     "group": "JscriptyQuestionReport",
14373     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14374     "version": "0.0.0",
14375     "filename": "server/api/jscriptyQuestionReport/index.js",
14376     "groupTitle": "JscriptyQuestionReport"
14377   },
14378   {
14379     "type": "post",
14380     "url": "/api/jscripty/sessions/reports",
14381     "title": "Creates a new Report",
14382     "examples": [
14383       {
14384         "title": "Example usage:",
14385         "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",
14386         "type": "json"
14387       }
14388     ],
14389     "name": "CreateReports",
14390     "group": "JscriptySessionReport",
14391     "parameter": {
14392       "fields": {
14393         "Body": [
14394           {
14395             "group": "Body",
14396             "type": "String",
14397             "optional": true,
14398             "field": "starttime",
14399             "description": ""
14400           },
14401           {
14402             "group": "Body",
14403             "type": "String",
14404             "optional": true,
14405             "field": "endtime",
14406             "description": ""
14407           },
14408           {
14409             "group": "Body",
14410             "type": "String",
14411             "optional": true,
14412             "field": "membername",
14413             "description": ""
14414           },
14415           {
14416             "group": "Body",
14417             "type": "String",
14418             "optional": true,
14419             "field": "projectname",
14420             "description": ""
14421           },
14422           {
14423             "group": "Body",
14424             "type": "String",
14425             "optional": true,
14426             "field": "queue",
14427             "description": ""
14428           },
14429           {
14430             "group": "Body",
14431             "type": "String",
14432             "optional": true,
14433             "field": "uniqueid",
14434             "description": ""
14435           },
14436           {
14437             "group": "Body",
14438             "type": "String",
14439             "optional": true,
14440             "field": "calleridname",
14441             "description": ""
14442           },
14443           {
14444             "group": "Body",
14445             "type": "String",
14446             "optional": true,
14447             "field": "calleridnum",
14448             "description": ""
14449           },
14450           {
14451             "group": "Body",
14452             "type": "Boolean",
14453             "optional": true,
14454             "field": "completed",
14455             "description": ""
14456           }
14457         ]
14458       }
14459     },
14460     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14461     "version": "0.0.0",
14462     "filename": "server/api/jscriptySessionReport/index.js",
14463     "groupTitle": "JscriptySessionReport"
14464   },
14465   {
14466     "type": "delete",
14467     "url": "/api/jscripty/sessions/reports/{id}",
14468     "title": "Deletes a Report",
14469     "examples": [
14470       {
14471         "title": "Example usage:",
14472         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14473         "type": "json"
14474       }
14475     ],
14476     "name": "DeleteReports",
14477     "group": "JscriptySessionReport",
14478     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14479     "version": "0.0.0",
14480     "filename": "server/api/jscriptySessionReport/index.js",
14481     "groupTitle": "JscriptySessionReport"
14482   },
14483   {
14484     "type": "get",
14485     "url": "/api/jscripty/sessions/reports/describe",
14486     "title": "Gets table info about Reports",
14487     "examples": [
14488       {
14489         "title": "Example usage:",
14490         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14491         "type": "json"
14492       }
14493     ],
14494     "name": "DescribeReports",
14495     "group": "JscriptySessionReport",
14496     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14497     "version": "0.0.0",
14498     "filename": "server/api/jscriptySessionReport/index.js",
14499     "groupTitle": "JscriptySessionReport"
14500   },
14501   {
14502     "type": "get",
14503     "url": "/api/jscripty/sessions/reports",
14504     "title": "Gets a list of Reports",
14505     "examples": [
14506       {
14507         "title": "Example usage:",
14508         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14509         "type": "json"
14510       }
14511     ],
14512     "name": "GetReports",
14513     "group": "JscriptySessionReport",
14514     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14515     "version": "0.0.0",
14516     "filename": "server/api/jscriptySessionReport/index.js",
14517     "groupTitle": "JscriptySessionReport"
14518   },
14519   {
14520     "type": "get",
14521     "url": "/api/jscripty/sessions/reports/{id}",
14522     "title": "Gets a single Report",
14523     "examples": [
14524       {
14525         "title": "Example usage:",
14526         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14527         "type": "json"
14528       }
14529     ],
14530     "name": "ShowReports",
14531     "group": "JscriptySessionReport",
14532     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14533     "version": "0.0.0",
14534     "filename": "server/api/jscriptySessionReport/index.js",
14535     "groupTitle": "JscriptySessionReport"
14536   },
14537   {
14538     "type": "get",
14539     "url": "/api/jscripty/sessions/reports/{id}/questions",
14540     "title": "Gets Jscripty Session questions",
14541     "examples": [
14542       {
14543         "title": "Example usage:",
14544         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
14545         "type": "json"
14546       }
14547     ],
14548     "name": "getQuestions",
14549     "group": "JscriptySessionReport",
14550     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14551     "version": "0.0.0",
14552     "filename": "server/api/jscriptySessionReport/index.js",
14553     "groupTitle": "JscriptySessionReport"
14554   },
14555   {
14556     "type": "put",
14557     "url": "/api/jscripty/sessions/reports/{id}",
14558     "title": "Update an existing Report",
14559     "examples": [
14560       {
14561         "title": "Example usage:",
14562         "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",
14563         "type": "json"
14564       }
14565     ],
14566     "name": "updateReports",
14567     "group": "JscriptySessionReport",
14568     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14569     "version": "0.0.0",
14570     "filename": "server/api/jscriptySessionReport/index.js",
14571     "groupTitle": "JscriptySessionReport"
14572   },
14573   {
14574     "type": "post",
14575     "url": "/api/jscripty/projects/clone",
14576     "title": "Clone an existing Project",
14577     "examples": [
14578       {
14579         "title": "Example usage:",
14580         "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",
14581         "type": "json"
14582       }
14583     ],
14584     "name": "CloneProjects",
14585     "group": "Jscripty_Projects",
14586     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14587     "version": "0.0.0",
14588     "filename": "server/api/jscriptyProject/index.js",
14589     "groupTitle": "Jscripty_Projects"
14590   },
14591   {
14592     "type": "post",
14593     "url": "/api/jscripty/projects",
14594     "title": "Creates a new Project",
14595     "examples": [
14596       {
14597         "title": "Example usage:",
14598         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14599         "type": "json"
14600       }
14601     ],
14602     "name": "CreateProjects",
14603     "group": "Jscripty_Projects",
14604     "parameter": {
14605       "fields": {
14606         "Body": [
14607           {
14608             "group": "Body",
14609             "type": "String",
14610             "optional": true,
14611             "field": "name",
14612             "description": ""
14613           },
14614           {
14615             "group": "Body",
14616             "type": "String",
14617             "optional": true,
14618             "field": "description",
14619             "description": ""
14620           },
14621           {
14622             "group": "Body",
14623             "type": "Text",
14624             "optional": true,
14625             "field": "formData",
14626             "description": ""
14627           },
14628           {
14629             "group": "Body",
14630             "type": "Boolean",
14631             "optional": true,
14632             "field": "enableUncompleteSave",
14633             "description": ""
14634           },
14635           {
14636             "group": "Body",
14637             "type": "Boolean",
14638             "optional": true,
14639             "field": "sendUnpauseOnSubmit",
14640             "description": ""
14641           }
14642         ]
14643       }
14644     },
14645     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14646     "version": "0.0.0",
14647     "filename": "server/api/jscriptyProject/index.js",
14648     "groupTitle": "Jscripty_Projects"
14649   },
14650   {
14651     "type": "delete",
14652     "url": "/api/jscripty/projects/{id}",
14653     "title": "Deletes a Project",
14654     "examples": [
14655       {
14656         "title": "Example usage:",
14657         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14658         "type": "json"
14659       }
14660     ],
14661     "name": "DeleteProjects",
14662     "group": "Jscripty_Projects",
14663     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14664     "version": "0.0.0",
14665     "filename": "server/api/jscriptyProject/index.js",
14666     "groupTitle": "Jscripty_Projects"
14667   },
14668   {
14669     "type": "get",
14670     "url": "/api/jscripty/projects",
14671     "title": "Gets a list of Projects",
14672     "examples": [
14673       {
14674         "title": "Example usage:",
14675         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14676         "type": "json"
14677       }
14678     ],
14679     "name": "GetProjects",
14680     "group": "Jscripty_Projects",
14681     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14682     "version": "0.0.0",
14683     "filename": "server/api/jscriptyProject/index.js",
14684     "groupTitle": "Jscripty_Projects"
14685   },
14686   {
14687     "type": "get",
14688     "url": "/api/jscripty/projects/{id}",
14689     "title": "Gets a single Project",
14690     "examples": [
14691       {
14692         "title": "Example usage:",
14693         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14694         "type": "json"
14695       }
14696     ],
14697     "name": "ShowProjects",
14698     "group": "Jscripty_Projects",
14699     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14700     "version": "0.0.0",
14701     "filename": "server/api/jscriptyProject/index.js",
14702     "groupTitle": "Jscripty_Projects"
14703   },
14704   {
14705     "type": "get",
14706     "url": "/api/jscripty/projects/{id}/answers",
14707     "title": "Gets jscripty project answers",
14708     "examples": [
14709       {
14710         "title": "Example usage:",
14711         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
14712         "type": "json"
14713       }
14714     ],
14715     "name": "getAnswers",
14716     "group": "Jscripty_Projects",
14717     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14718     "version": "0.0.0",
14719     "filename": "server/api/jscriptyProject/index.js",
14720     "groupTitle": "Jscripty_Projects"
14721   },
14722   {
14723     "type": "get",
14724     "url": "/api/jscripty/projects/{id}/sessions",
14725     "title": "Gets jscripty project sessions",
14726     "examples": [
14727       {
14728         "title": "Example usage:",
14729         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
14730         "type": "json"
14731       }
14732     ],
14733     "name": "getSessions",
14734     "group": "Jscripty_Projects",
14735     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14736     "version": "0.0.0",
14737     "filename": "server/api/jscriptyProject/index.js",
14738     "groupTitle": "Jscripty_Projects"
14739   },
14740   {
14741     "type": "get",
14742     "url": "/api/jscripty/projects/{id}/summary",
14743     "title": "Gets jscripty project summary",
14744     "examples": [
14745       {
14746         "title": "Example usage:",
14747         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
14748         "type": "json"
14749       }
14750     ],
14751     "name": "getSummary",
14752     "group": "Jscripty_Projects",
14753     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14754     "version": "0.0.0",
14755     "filename": "server/api/jscriptyProject/index.js",
14756     "groupTitle": "Jscripty_Projects"
14757   },
14758   {
14759     "type": "put",
14760     "url": "/api/jscripty/projects/{id}",
14761     "title": "Update an existing Project",
14762     "examples": [
14763       {
14764         "title": "Example usage:",
14765         "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",
14766         "type": "json"
14767       }
14768     ],
14769     "name": "updateProjects",
14770     "group": "Jscripty_Projects",
14771     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14772     "version": "0.0.0",
14773     "filename": "server/api/jscriptyProject/index.js",
14774     "groupTitle": "Jscripty_Projects"
14775   },
14776   {
14777     "type": "get",
14778     "url": "/api/license",
14779     "title": "Gets License Info",
14780     "examples": [
14781       {
14782         "title": "Example usage:",
14783         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14784         "type": "json"
14785       }
14786     ],
14787     "name": "index",
14788     "group": "License",
14789     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14790     "version": "0.0.0",
14791     "filename": "server/api/license/index.js",
14792     "groupTitle": "License"
14793   },
14794   {
14795     "type": "put",
14796     "url": "/api/license/{id}",
14797     "title": "Update License Info",
14798     "examples": [
14799       {
14800         "title": "Example usage:",
14801         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14802         "type": "json"
14803       }
14804     ],
14805     "name": "update",
14806     "group": "License",
14807     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14808     "version": "0.0.0",
14809     "filename": "server/api/license/index.js",
14810     "groupTitle": "License"
14811   },
14812   {
14813     "type": "post",
14814     "url": "/api/mail/accounts/{id}/users",
14815     "title": "Add agents to a mail account",
14816     "examples": [
14817       {
14818         "title": "Example usage:",
14819         "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",
14820         "type": "json"
14821       }
14822     ],
14823     "name": "AddAgents",
14824     "group": "Mail_Accounts",
14825     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14826     "version": "0.0.0",
14827     "filename": "server/api/mailAccount/index.js",
14828     "groupTitle": "Mail_Accounts"
14829   },
14830   {
14831     "type": "post",
14832     "url": "/api/mail/accounts/{id}/in_servers",
14833     "title": "Creates a new IMAP server",
14834     "examples": [
14835       {
14836         "title": "Example usage:",
14837         "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",
14838         "type": "json"
14839       }
14840     ],
14841     "name": "AddImap",
14842     "group": "Mail_Accounts",
14843     "parameter": {
14844       "fields": {
14845         "Body": [
14846           {
14847             "group": "Body",
14848             "type": "String",
14849             "optional": true,
14850             "field": "description",
14851             "description": ""
14852           },
14853           {
14854             "group": "Body",
14855             "type": "String",
14856             "optional": true,
14857             "field": "host",
14858             "description": ""
14859           },
14860           {
14861             "group": "Body",
14862             "type": "Boolean",
14863             "optional": true,
14864             "field": "authentication",
14865             "description": ""
14866           },
14867           {
14868             "group": "Body",
14869             "type": "String",
14870             "optional": true,
14871             "field": "user",
14872             "description": ""
14873           },
14874           {
14875             "group": "Body",
14876             "type": "String",
14877             "optional": true,
14878             "field": "password",
14879             "description": ""
14880           },
14881           {
14882             "group": "Body",
14883             "type": "Integer",
14884             "optional": true,
14885             "field": "port",
14886             "description": ""
14887           },
14888           {
14889             "group": "Body",
14890             "type": "Boolean",
14891             "optional": true,
14892             "field": "tls",
14893             "description": ""
14894           },
14895           {
14896             "group": "Body",
14897             "type": "String",
14898             "optional": true,
14899             "field": "mailbox",
14900             "description": ""
14901           },
14902           {
14903             "group": "Body",
14904             "type": "Integer",
14905             "optional": true,
14906             "field": "connTimeout",
14907             "description": ""
14908           },
14909           {
14910             "group": "Body",
14911             "type": "Integer",
14912             "optional": true,
14913             "field": "authTimeout",
14914             "description": ""
14915           },
14916           {
14917             "group": "Body",
14918             "type": "String",
14919             "optional": true,
14920             "field": "service",
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": "post",
14933     "url": "/api/mail/accounts/{id}/out_servers",
14934     "title": "Creates a new SMTP server",
14935     "examples": [
14936       {
14937         "title": "Example usage:",
14938         "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",
14939         "type": "json"
14940       }
14941     ],
14942     "name": "AddSmtp",
14943     "group": "Mail_Accounts",
14944     "parameter": {
14945       "fields": {
14946         "Body": [
14947           {
14948             "group": "Body",
14949             "type": "String",
14950             "optional": true,
14951             "field": "description",
14952             "description": ""
14953           },
14954           {
14955             "group": "Body",
14956             "type": "String",
14957             "optional": true,
14958             "field": "host",
14959             "description": ""
14960           },
14961           {
14962             "group": "Body",
14963             "type": "String",
14964             "optional": true,
14965             "field": "user",
14966             "description": ""
14967           },
14968           {
14969             "group": "Body",
14970             "type": "String",
14971             "optional": true,
14972             "field": "pass",
14973             "description": ""
14974           },
14975           {
14976             "group": "Body",
14977             "type": "Integer",
14978             "optional": true,
14979             "field": "port",
14980             "description": ""
14981           },
14982           {
14983             "group": "Body",
14984             "type": "Boolean",
14985             "optional": true,
14986             "field": "secure",
14987             "description": ""
14988           },
14989           {
14990             "group": "Body",
14991             "type": "String",
14992             "optional": true,
14993             "field": "service",
14994             "description": ""
14995           },
14996           {
14997             "group": "Body",
14998             "type": "Boolean",
14999             "optional": true,
15000             "field": "authentication",
15001             "description": ""
15002           }
15003         ]
15004       }
15005     },
15006     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15007     "version": "0.0.0",
15008     "filename": "server/api/mailAccount/index.js",
15009     "groupTitle": "Mail_Accounts"
15010   },
15011   {
15012     "type": "delete",
15013     "url": "/api/mail/accounts/{id}",
15014     "title": "Deletes a mail account",
15015     "examples": [
15016       {
15017         "title": "Example usage:",
15018         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
15019         "type": "json"
15020       }
15021     ],
15022     "name": "DeleteMailAccounts",
15023     "group": "Mail_Accounts",
15024     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15025     "version": "0.0.0",
15026     "filename": "server/api/mailAccount/index.js",
15027     "groupTitle": "Mail_Accounts"
15028   },
15029   {
15030     "type": "get",
15031     "url": "/api/mail/accounts/describe",
15032     "title": "Gets table info about Accounts",
15033     "examples": [
15034       {
15035         "title": "Example usage:",
15036         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
15037         "type": "json"
15038       }
15039     ],
15040     "name": "DescribeAccounts",
15041     "group": "Mail_Accounts",
15042     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15043     "version": "0.0.0",
15044     "filename": "server/api/mailAccount/index.js",
15045     "groupTitle": "Mail_Accounts"
15046   },
15047   {
15048     "type": "get",
15049     "url": "/api/mail/accounts",
15050     "title": "Gets a list of Accounts",
15051     "examples": [
15052       {
15053         "title": "Example usage:",
15054         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
15055         "type": "json"
15056       }
15057     ],
15058     "name": "GetAccounts",
15059     "group": "Mail_Accounts",
15060     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15061     "version": "0.0.0",
15062     "filename": "server/api/mailAccount/index.js",
15063     "groupTitle": "Mail_Accounts"
15064   },
15065   {
15066     "type": "get",
15067     "url": "/api/mail/accounts/{id}/users",
15068     "title": "Gets agents from mail account",
15069     "examples": [
15070       {
15071         "title": "Example usage:",
15072         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15073         "type": "json"
15074       }
15075     ],
15076     "name": "GetAgents",
15077     "group": "Mail_Accounts",
15078     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15079     "version": "0.0.0",
15080     "filename": "server/api/mailAccount/index.js",
15081     "groupTitle": "Mail_Accounts"
15082   },
15083   {
15084     "type": "get",
15085     "url": "/api/mail/accounts/{id}/in_servers",
15086     "title": "Gets account IMAP server",
15087     "examples": [
15088       {
15089         "title": "Example usage:",
15090         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15091         "type": "json"
15092       }
15093     ],
15094     "name": "GetImap",
15095     "group": "Mail_Accounts",
15096     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15097     "version": "0.0.0",
15098     "filename": "server/api/mailAccount/index.js",
15099     "groupTitle": "Mail_Accounts"
15100   },
15101   {
15102     "type": "get",
15103     "url": "/api/mail/accounts/{id}/out_servers",
15104     "title": "Gets account SMTP server",
15105     "examples": [
15106       {
15107         "title": "Example usage:",
15108         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15109         "type": "json"
15110       }
15111     ],
15112     "name": "GetSmtp",
15113     "group": "Mail_Accounts",
15114     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15115     "version": "0.0.0",
15116     "filename": "server/api/mailAccount/index.js",
15117     "groupTitle": "Mail_Accounts"
15118   },
15119   {
15120     "type": "delete",
15121     "url": "/api/mail/accounts/{id}/users",
15122     "title": "Removes agents from a mail account",
15123     "examples": [
15124       {
15125         "title": "Example usage:",
15126         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15127         "type": "json"
15128       }
15129     ],
15130     "name": "RemoveAgents",
15131     "group": "Mail_Accounts",
15132     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15133     "version": "0.0.0",
15134     "filename": "server/api/mailAccount/index.js",
15135     "groupTitle": "Mail_Accounts"
15136   },
15137   {
15138     "type": "delete",
15139     "url": "/api/mail/accounts/{id}/canned_answers",
15140     "title": "Removes canned answers from account",
15141     "examples": [
15142       {
15143         "title": "Example usage:",
15144         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15145         "type": "json"
15146       }
15147     ],
15148     "name": "RemoveAnswers",
15149     "group": "Mail_Accounts",
15150     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15151     "version": "0.0.0",
15152     "filename": "server/api/mailAccount/index.js",
15153     "groupTitle": "Mail_Accounts"
15154   },
15155   {
15156     "type": "delete",
15157     "url": "/api/mail/accounts/{id}/dispositions",
15158     "title": "Removes dispositions from account",
15159     "examples": [
15160       {
15161         "title": "Example usage:",
15162         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15163         "type": "json"
15164       }
15165     ],
15166     "name": "RemoveDispositions",
15167     "group": "Mail_Accounts",
15168     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15169     "version": "0.0.0",
15170     "filename": "server/api/mailAccount/index.js",
15171     "groupTitle": "Mail_Accounts"
15172   },
15173   {
15174     "type": "delete",
15175     "url": "/api/mail/accounts/{id}/in_servers",
15176     "title": "Removes IMAP server from an account",
15177     "examples": [
15178       {
15179         "title": "Example usage:",
15180         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15181         "type": "json"
15182       }
15183     ],
15184     "name": "RemoveImmap",
15185     "group": "Mail_Accounts",
15186     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15187     "version": "0.0.0",
15188     "filename": "server/api/mailAccount/index.js",
15189     "groupTitle": "Mail_Accounts"
15190   },
15191   {
15192     "type": "delete",
15193     "url": "/api/mail/accounts/{id}/out_servers",
15194     "title": "Removes SMTP server from an account",
15195     "examples": [
15196       {
15197         "title": "Example usage:",
15198         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15199         "type": "json"
15200       }
15201     ],
15202     "name": "RemoveSmtp",
15203     "group": "Mail_Accounts",
15204     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15205     "version": "0.0.0",
15206     "filename": "server/api/mailAccount/index.js",
15207     "groupTitle": "Mail_Accounts"
15208   },
15209   {
15210     "type": "get",
15211     "url": "/api/mail/accounts/{id}",
15212     "title": "Gets a single Account",
15213     "examples": [
15214       {
15215         "title": "Example usage:",
15216         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15217         "type": "json"
15218       }
15219     ],
15220     "name": "ShowAccounts",
15221     "group": "Mail_Accounts",
15222     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15223     "version": "0.0.0",
15224     "filename": "server/api/mailAccount/index.js",
15225     "groupTitle": "Mail_Accounts"
15226   },
15227   {
15228     "type": "post",
15229     "url": "/api/mail/accounts/{id}/canned_answers",
15230     "title": "Creates new canned answer",
15231     "examples": [
15232       {
15233         "title": "Example usage:",
15234         "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",
15235         "type": "json"
15236       }
15237     ],
15238     "name": "addAnswer",
15239     "group": "Mail_Accounts",
15240     "parameter": {
15241       "fields": {
15242         "Body": [
15243           {
15244             "group": "Body",
15245             "type": "String",
15246             "optional": false,
15247             "field": "key",
15248             "description": ""
15249           },
15250           {
15251             "group": "Body",
15252             "type": "Text",
15253             "optional": false,
15254             "field": "value",
15255             "description": ""
15256           },
15257           {
15258             "group": "Body",
15259             "type": "String",
15260             "optional": true,
15261             "field": "description",
15262             "description": ""
15263           },
15264           {
15265             "group": "Body",
15266             "type": "Virtual",
15267             "optional": true,
15268             "field": "name",
15269             "description": ""
15270           }
15271         ]
15272       }
15273     },
15274     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15275     "version": "0.0.0",
15276     "filename": "server/api/mailAccount/index.js",
15277     "groupTitle": "Mail_Accounts"
15278   },
15279   {
15280     "type": "post",
15281     "url": "/api/mail/accounts/{id}/applications",
15282     "title": "Creates new applications",
15283     "examples": [
15284       {
15285         "title": "Example usage:",
15286         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15287         "type": "json"
15288       }
15289     ],
15290     "name": "addApplications",
15291     "group": "Mail_Accounts",
15292     "parameter": {
15293       "fields": {
15294         "Body": [
15295           {
15296             "group": "Body",
15297             "type": "Integer",
15298             "optional": false,
15299             "field": "priority",
15300             "description": ""
15301           },
15302           {
15303             "group": "Body",
15304             "type": "String",
15305             "optional": false,
15306             "field": "app",
15307             "description": ""
15308           },
15309           {
15310             "group": "Body",
15311             "type": "Text",
15312             "optional": true,
15313             "field": "appdata",
15314             "description": ""
15315           },
15316           {
15317             "group": "Body",
15318             "type": "String",
15319             "optional": true,
15320             "field": "description",
15321             "description": ""
15322           },
15323           {
15324             "group": "Body",
15325             "type": "String",
15326             "optional": true,
15327             "field": "interval",
15328             "description": ""
15329           }
15330         ]
15331       }
15332     },
15333     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15334     "version": "0.0.0",
15335     "filename": "server/api/mailAccount/index.js",
15336     "groupTitle": "Mail_Accounts"
15337   },
15338   {
15339     "type": "post",
15340     "url": "/api/mail/accounts/{id}/dispositions",
15341     "title": "Creates new disposition",
15342     "examples": [
15343       {
15344         "title": "Example usage:",
15345         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15346         "type": "json"
15347       }
15348     ],
15349     "name": "addDisposition",
15350     "group": "Mail_Accounts",
15351     "parameter": {
15352       "fields": {
15353         "Body": [
15354           {
15355             "group": "Body",
15356             "type": "String",
15357             "optional": false,
15358             "field": "name",
15359             "description": ""
15360           },
15361           {
15362             "group": "Body",
15363             "type": "String",
15364             "allowedValues": [
15365               "\"first\"",
15366               "\"second\"",
15367               "\"third\""
15368             ],
15369             "optional": false,
15370             "field": "level",
15371             "description": ""
15372           },
15373           {
15374             "group": "Body",
15375             "type": "String",
15376             "optional": true,
15377             "field": "description",
15378             "description": ""
15379           }
15380         ]
15381       }
15382     },
15383     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15384     "version": "0.0.0",
15385     "filename": "server/api/mailAccount/index.js",
15386     "groupTitle": "Mail_Accounts"
15387   },
15388   {
15389     "type": "post",
15390     "url": "/api/mail/accounts/{id}/interactions",
15391     "title": "Creates new interactions",
15392     "examples": [
15393       {
15394         "title": "Example usage:",
15395         "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",
15396         "type": "json"
15397       }
15398     ],
15399     "name": "addInteraction",
15400     "group": "Mail_Accounts",
15401     "parameter": {
15402       "fields": {
15403         "Body": [
15404           {
15405             "group": "Body",
15406             "type": "Boolean",
15407             "optional": true,
15408             "field": "closed",
15409             "description": ""
15410           },
15411           {
15412             "group": "Body",
15413             "type": "String",
15414             "optional": true,
15415             "field": "closedAt",
15416             "description": ""
15417           },
15418           {
15419             "group": "Body",
15420             "type": "String",
15421             "optional": true,
15422             "field": "disposition",
15423             "description": ""
15424           },
15425           {
15426             "group": "Body",
15427             "type": "String",
15428             "optional": true,
15429             "field": "secondDisposition",
15430             "description": ""
15431           },
15432           {
15433             "group": "Body",
15434             "type": "String",
15435             "optional": true,
15436             "field": "thirdDisposition",
15437             "description": ""
15438           },
15439           {
15440             "group": "Body",
15441             "type": "String",
15442             "optional": true,
15443             "field": "note",
15444             "description": ""
15445           },
15446           {
15447             "group": "Body",
15448             "type": "String",
15449             "optional": true,
15450             "field": "inReplyTo",
15451             "description": ""
15452           },
15453           {
15454             "group": "Body",
15455             "type": "String",
15456             "optional": true,
15457             "field": "to",
15458             "description": ""
15459           },
15460           {
15461             "group": "Body",
15462             "type": "Text",
15463             "optional": true,
15464             "field": "cc",
15465             "description": ""
15466           },
15467           {
15468             "group": "Body",
15469             "type": "Text",
15470             "optional": true,
15471             "field": "subject",
15472             "description": ""
15473           },
15474           {
15475             "group": "Body",
15476             "type": "Boolean",
15477             "optional": true,
15478             "field": "attach",
15479             "description": ""
15480           },
15481           {
15482             "group": "Body",
15483             "type": "String",
15484             "optional": true,
15485             "field": "read1stAt",
15486             "description": ""
15487           },
15488           {
15489             "group": "Body",
15490             "type": "String",
15491             "optional": true,
15492             "field": "substatus",
15493             "description": ""
15494           },
15495           {
15496             "group": "Body",
15497             "type": "String",
15498             "optional": true,
15499             "field": "substatusAt",
15500             "description": ""
15501           },
15502           {
15503             "group": "Body",
15504             "type": "String",
15505             "allowedValues": [
15506               "\"in\"",
15507               "\"out\""
15508             ],
15509             "optional": false,
15510             "field": "firstMsgDirection",
15511             "description": ""
15512           },
15513           {
15514             "group": "Body",
15515             "type": "String",
15516             "optional": true,
15517             "field": "lastMsgAt",
15518             "description": ""
15519           },
15520           {
15521             "group": "Body",
15522             "type": "String",
15523             "allowedValues": [
15524               "\"in\"",
15525               "\"out\""
15526             ],
15527             "optional": false,
15528             "field": "lastMsgDirection",
15529             "description": ""
15530           },
15531           {
15532             "group": "Body",
15533             "type": "Boolean",
15534             "optional": true,
15535             "field": "autoreplyExecuted",
15536             "description": ""
15537           }
15538         ]
15539       }
15540     },
15541     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15542     "version": "0.0.0",
15543     "filename": "server/api/mailAccount/index.js",
15544     "groupTitle": "Mail_Accounts"
15545   },
15546   {
15547     "type": "post",
15548     "url": "/api/mail/accounts",
15549     "title": "Create a mail account",
15550     "examples": [
15551       {
15552         "title": "Example usage:",
15553         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15554         "type": "json"
15555       }
15556     ],
15557     "name": "create",
15558     "group": "Mail_Accounts",
15559     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15560     "version": "0.0.0",
15561     "filename": "server/api/mailAccount/index.js",
15562     "groupTitle": "Mail_Accounts"
15563   },
15564   {
15565     "type": "get",
15566     "url": "/api/mail/accounts/{id}/canned_answers",
15567     "title": "Gets account canned answers",
15568     "examples": [
15569       {
15570         "title": "Example usage:",
15571         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15572         "type": "json"
15573       }
15574     ],
15575     "name": "getAnswers",
15576     "group": "Mail_Accounts",
15577     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15578     "version": "0.0.0",
15579     "filename": "server/api/mailAccount/index.js",
15580     "groupTitle": "Mail_Accounts"
15581   },
15582   {
15583     "type": "get",
15584     "url": "/api/mail/accounts/{id}/applications",
15585     "title": "Gets account applications",
15586     "examples": [
15587       {
15588         "title": "Example usage:",
15589         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15590         "type": "json"
15591       }
15592     ],
15593     "name": "getApplications",
15594     "group": "Mail_Accounts",
15595     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15596     "version": "0.0.0",
15597     "filename": "server/api/mailAccount/index.js",
15598     "groupTitle": "Mail_Accounts"
15599   },
15600   {
15601     "type": "get",
15602     "url": "/api/mail/accounts/{id}/dispositions",
15603     "title": "Gets account dispositions",
15604     "examples": [
15605       {
15606         "title": "Example usage:",
15607         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15608         "type": "json"
15609       }
15610     ],
15611     "name": "getDispositions",
15612     "group": "Mail_Accounts",
15613     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15614     "version": "0.0.0",
15615     "filename": "server/api/mailAccount/index.js",
15616     "groupTitle": "Mail_Accounts"
15617   },
15618   {
15619     "type": "get",
15620     "url": "/api/mail/accounts/{id}/interactions",
15621     "title": "Gets account interactions",
15622     "examples": [
15623       {
15624         "title": "Example usage:",
15625         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15626         "type": "json"
15627       }
15628     ],
15629     "name": "getInteraction",
15630     "group": "Mail_Accounts",
15631     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15632     "version": "0.0.0",
15633     "filename": "server/api/mailAccount/index.js",
15634     "groupTitle": "Mail_Accounts"
15635   },
15636   {
15637     "type": "get",
15638     "url": "/api/mail/accounts/{id}/messages",
15639     "title": "Gets account messages",
15640     "examples": [
15641       {
15642         "title": "Example usage:",
15643         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15644         "type": "json"
15645       }
15646     ],
15647     "name": "getMessages",
15648     "group": "Mail_Accounts",
15649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15650     "version": "0.0.0",
15651     "filename": "server/api/mailAccount/index.js",
15652     "groupTitle": "Mail_Accounts"
15653   },
15654   {
15655     "type": "post",
15656     "url": "/api/mail/accounts/{id}/send",
15657     "title": "Send new mail",
15658     "examples": [
15659       {
15660         "title": "Example usage:",
15661         "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",
15662         "type": "json"
15663       }
15664     ],
15665     "name": "sendMail",
15666     "group": "Mail_Accounts",
15667     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15668     "version": "0.0.0",
15669     "filename": "server/api/mailAccount/index.js",
15670     "groupTitle": "Mail_Accounts"
15671   },
15672   {
15673     "type": "put",
15674     "url": "/api/mail/accounts/{id}",
15675     "title": "Update an existing Account",
15676     "examples": [
15677       {
15678         "title": "Example usage:",
15679         "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",
15680         "type": "json"
15681       }
15682     ],
15683     "name": "updateAccounts",
15684     "group": "Mail_Accounts",
15685     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15686     "version": "0.0.0",
15687     "filename": "server/api/mailAccount/index.js",
15688     "groupTitle": "Mail_Accounts"
15689   },
15690   {
15691     "type": "get",
15692     "url": "/api/mail/accounts/{id}/verify",
15693     "title": "Verify mail account",
15694     "examples": [
15695       {
15696         "title": "Example usage:",
15697         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15698         "type": "json"
15699       }
15700     ],
15701     "name": "verifySmtp",
15702     "group": "Mail_Accounts",
15703     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15704     "version": "0.0.0",
15705     "filename": "server/api/mailAccount/index.js",
15706     "groupTitle": "Mail_Accounts"
15707   },
15708   {
15709     "type": "delete",
15710     "url": "/api/mail/applications/{id}",
15711     "title": "Deletes a Application",
15712     "examples": [
15713       {
15714         "title": "Example usage:",
15715         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15716         "type": "json"
15717       }
15718     ],
15719     "name": "DeleteApplications",
15720     "group": "Mail_Applications",
15721     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15722     "version": "0.0.0",
15723     "filename": "server/api/mailApplication/index.js",
15724     "groupTitle": "Mail_Applications"
15725   },
15726   {
15727     "type": "get",
15728     "url": "/api/mail/applications/{id}",
15729     "title": "Gets a single Application",
15730     "examples": [
15731       {
15732         "title": "Example usage:",
15733         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15734         "type": "json"
15735       }
15736     ],
15737     "name": "ShowApplications",
15738     "group": "Mail_Applications",
15739     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15740     "version": "0.0.0",
15741     "filename": "server/api/mailApplication/index.js",
15742     "groupTitle": "Mail_Applications"
15743   },
15744   {
15745     "type": "put",
15746     "url": "/api/mail/applications/{id}",
15747     "title": "Update an existing Application",
15748     "examples": [
15749       {
15750         "title": "Example usage:",
15751         "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",
15752         "type": "json"
15753       }
15754     ],
15755     "name": "updateApplications",
15756     "group": "Mail_Applications",
15757     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15758     "version": "0.0.0",
15759     "filename": "server/api/mailApplication/index.js",
15760     "groupTitle": "Mail_Applications"
15761   },
15762   {
15763     "type": "post",
15764     "url": "/api/mail/interactions/{id}/tags",
15765     "title": "Add tags to the interaction",
15766     "examples": [
15767       {
15768         "title": "Example usage:",
15769         "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",
15770         "type": "json"
15771       }
15772     ],
15773     "name": "AddTags",
15774     "group": "Mail_Interactions",
15775     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15776     "version": "0.0.0",
15777     "filename": "server/api/mailInteraction/index.js",
15778     "groupTitle": "Mail_Interactions"
15779   },
15780   {
15781     "type": "post",
15782     "url": "/api/mail/interactions",
15783     "title": "Creates a new Interaction",
15784     "examples": [
15785       {
15786         "title": "Example usage:",
15787         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15788         "type": "json"
15789       }
15790     ],
15791     "name": "CreateInteractions",
15792     "group": "Mail_Interactions",
15793     "parameter": {
15794       "fields": {
15795         "Body": [
15796           {
15797             "group": "Body",
15798             "type": "Boolean",
15799             "optional": true,
15800             "field": "closed",
15801             "description": ""
15802           },
15803           {
15804             "group": "Body",
15805             "type": "String",
15806             "optional": true,
15807             "field": "closedAt",
15808             "description": ""
15809           },
15810           {
15811             "group": "Body",
15812             "type": "String",
15813             "optional": true,
15814             "field": "disposition",
15815             "description": ""
15816           },
15817           {
15818             "group": "Body",
15819             "type": "String",
15820             "optional": true,
15821             "field": "secondDisposition",
15822             "description": ""
15823           },
15824           {
15825             "group": "Body",
15826             "type": "String",
15827             "optional": true,
15828             "field": "thirdDisposition",
15829             "description": ""
15830           },
15831           {
15832             "group": "Body",
15833             "type": "String",
15834             "optional": true,
15835             "field": "note",
15836             "description": ""
15837           },
15838           {
15839             "group": "Body",
15840             "type": "String",
15841             "optional": true,
15842             "field": "inReplyTo",
15843             "description": ""
15844           },
15845           {
15846             "group": "Body",
15847             "type": "String",
15848             "optional": true,
15849             "field": "to",
15850             "description": ""
15851           },
15852           {
15853             "group": "Body",
15854             "type": "Text",
15855             "optional": true,
15856             "field": "cc",
15857             "description": ""
15858           },
15859           {
15860             "group": "Body",
15861             "type": "Text",
15862             "optional": true,
15863             "field": "subject",
15864             "description": ""
15865           },
15866           {
15867             "group": "Body",
15868             "type": "Boolean",
15869             "optional": true,
15870             "field": "attach",
15871             "description": ""
15872           },
15873           {
15874             "group": "Body",
15875             "type": "String",
15876             "optional": true,
15877             "field": "read1stAt",
15878             "description": ""
15879           },
15880           {
15881             "group": "Body",
15882             "type": "String",
15883             "optional": true,
15884             "field": "substatus",
15885             "description": ""
15886           },
15887           {
15888             "group": "Body",
15889             "type": "String",
15890             "optional": true,
15891             "field": "substatusAt",
15892             "description": ""
15893           },
15894           {
15895             "group": "Body",
15896             "type": "String",
15897             "allowedValues": [
15898               "\"in\"",
15899               "\"out\""
15900             ],
15901             "optional": false,
15902             "field": "firstMsgDirection",
15903             "description": ""
15904           },
15905           {
15906             "group": "Body",
15907             "type": "String",
15908             "optional": true,
15909             "field": "lastMsgAt",
15910             "description": ""
15911           },
15912           {
15913             "group": "Body",
15914             "type": "String",
15915             "allowedValues": [
15916               "\"in\"",
15917               "\"out\""
15918             ],
15919             "optional": false,
15920             "field": "lastMsgDirection",
15921             "description": ""
15922           },
15923           {
15924             "group": "Body",
15925             "type": "Boolean",
15926             "optional": true,
15927             "field": "autoreplyExecuted",
15928             "description": ""
15929           }
15930         ]
15931       }
15932     },
15933     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15934     "version": "0.0.0",
15935     "filename": "server/api/mailInteraction/index.js",
15936     "groupTitle": "Mail_Interactions"
15937   },
15938   {
15939     "type": "delete",
15940     "url": "/api/mail/interactions/{id}",
15941     "title": "Deletes a Interaction",
15942     "examples": [
15943       {
15944         "title": "Example usage:",
15945         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15946         "type": "json"
15947       }
15948     ],
15949     "name": "DeleteInteractions",
15950     "group": "Mail_Interactions",
15951     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15952     "version": "0.0.0",
15953     "filename": "server/api/mailInteraction/index.js",
15954     "groupTitle": "Mail_Interactions"
15955   },
15956   {
15957     "type": "get",
15958     "url": "/api/mail/interactions/describe",
15959     "title": "Gets table info about Interactions",
15960     "examples": [
15961       {
15962         "title": "Example usage:",
15963         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15964         "type": "json"
15965       }
15966     ],
15967     "name": "DescribeInteractions",
15968     "group": "Mail_Interactions",
15969     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15970     "version": "0.0.0",
15971     "filename": "server/api/mailInteraction/index.js",
15972     "groupTitle": "Mail_Interactions"
15973   },
15974   {
15975     "type": "get",
15976     "url": "/api/mail/interactions",
15977     "title": "Gets a list of Interactions",
15978     "examples": [
15979       {
15980         "title": "Example usage:",
15981         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15982         "type": "json"
15983       }
15984     ],
15985     "name": "GetInteractions",
15986     "group": "Mail_Interactions",
15987     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15988     "version": "0.0.0",
15989     "filename": "server/api/mailInteraction/index.js",
15990     "groupTitle": "Mail_Interactions"
15991   },
15992   {
15993     "type": "delete",
15994     "url": "/api/mail/interactions/{id}/tags",
15995     "title": "Removes tags from interaction",
15996     "examples": [
15997       {
15998         "title": "Example usage:",
15999         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16000         "type": "json"
16001       }
16002     ],
16003     "name": "RemoveTags",
16004     "group": "Mail_Interactions",
16005     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16006     "version": "0.0.0",
16007     "filename": "server/api/mailInteraction/index.js",
16008     "groupTitle": "Mail_Interactions"
16009   },
16010   {
16011     "type": "get",
16012     "url": "/api/mail/interactions/{id}",
16013     "title": "Gets a single Interaction",
16014     "examples": [
16015       {
16016         "title": "Example usage:",
16017         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
16018         "type": "json"
16019       }
16020     ],
16021     "name": "ShowInteractions",
16022     "group": "Mail_Interactions",
16023     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16024     "version": "0.0.0",
16025     "filename": "server/api/mailInteraction/index.js",
16026     "groupTitle": "Mail_Interactions"
16027   },
16028   {
16029     "type": "post",
16030     "url": "/api/mail/interactions/{id}/messages",
16031     "title": "Creates new message",
16032     "examples": [
16033       {
16034         "title": "Example usage:",
16035         "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",
16036         "type": "json"
16037       }
16038     ],
16039     "name": "addMessage",
16040     "group": "Mail_Interactions",
16041     "parameter": {
16042       "fields": {
16043         "Body": [
16044           {
16045             "group": "Body",
16046             "type": "Text",
16047             "optional": false,
16048             "field": "body",
16049             "description": ""
16050           },
16051           {
16052             "group": "Body",
16053             "type": "Text",
16054             "optional": true,
16055             "field": "plainBody",
16056             "description": ""
16057           },
16058           {
16059             "group": "Body",
16060             "type": "Boolean",
16061             "optional": true,
16062             "field": "read",
16063             "description": ""
16064           },
16065           {
16066             "group": "Body",
16067             "type": "String",
16068             "allowedValues": [
16069               "\"in\"",
16070               "\"out\""
16071             ],
16072             "optional": false,
16073             "field": "direction",
16074             "description": ""
16075           },
16076           {
16077             "group": "Body",
16078             "type": "String",
16079             "optional": true,
16080             "field": "messageId",
16081             "description": ""
16082           },
16083           {
16084             "group": "Body",
16085             "type": "String",
16086             "optional": true,
16087             "field": "from",
16088             "description": ""
16089           },
16090           {
16091             "group": "Body",
16092             "type": "Text",
16093             "optional": true,
16094             "field": "to",
16095             "description": ""
16096           },
16097           {
16098             "group": "Body",
16099             "type": "Text",
16100             "optional": true,
16101             "field": "cc",
16102             "description": ""
16103           },
16104           {
16105             "group": "Body",
16106             "type": "Text",
16107             "optional": true,
16108             "field": "bcc",
16109             "description": ""
16110           },
16111           {
16112             "group": "Body",
16113             "type": "Text",
16114             "optional": true,
16115             "field": "subject",
16116             "description": ""
16117           },
16118           {
16119             "group": "Body",
16120             "type": "String",
16121             "optional": true,
16122             "field": "sentAt",
16123             "description": ""
16124           },
16125           {
16126             "group": "Body",
16127             "type": "Integer",
16128             "optional": true,
16129             "field": "attach",
16130             "description": ""
16131           },
16132           {
16133             "group": "Body",
16134             "type": "Boolean",
16135             "optional": true,
16136             "field": "secret",
16137             "description": ""
16138           },
16139           {
16140             "group": "Body",
16141             "type": "String",
16142             "optional": true,
16143             "field": "readAt",
16144             "description": ""
16145           },
16146           {
16147             "group": "Body",
16148             "type": "Text",
16149             "optional": true,
16150             "field": "originTo",
16151             "description": ""
16152           },
16153           {
16154             "group": "Body",
16155             "type": "Text",
16156             "optional": true,
16157             "field": "originCc",
16158             "description": ""
16159           },
16160           {
16161             "group": "Body",
16162             "type": "String",
16163             "allowedValues": [
16164               "\"Email\"",
16165               "\"Chat\""
16166             ],
16167             "optional": false,
16168             "field": "originChannel",
16169             "description": ""
16170           }
16171         ]
16172       }
16173     },
16174     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16175     "version": "0.0.0",
16176     "filename": "server/api/mailInteraction/index.js",
16177     "groupTitle": "Mail_Interactions"
16178   },
16179   {
16180     "type": "get",
16181     "url": "/api/mail/interactions/{id}/download",
16182     "title": "Gets interaction",
16183     "examples": [
16184       {
16185         "title": "Example usage:",
16186         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16187         "type": "json"
16188       }
16189     ],
16190     "name": "download",
16191     "group": "Mail_Interactions",
16192     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16193     "version": "0.0.0",
16194     "filename": "server/api/mailInteraction/index.js",
16195     "groupTitle": "Mail_Interactions"
16196   },
16197   {
16198     "type": "get",
16199     "url": "/api/mail/interactions/{id}/messages",
16200     "title": "Gets interaction messages",
16201     "examples": [
16202       {
16203         "title": "Example usage:",
16204         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16205         "type": "json"
16206       }
16207     ],
16208     "name": "getMessages",
16209     "group": "Mail_Interactions",
16210     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16211     "version": "0.0.0",
16212     "filename": "server/api/mailInteraction/index.js",
16213     "groupTitle": "Mail_Interactions"
16214   },
16215   {
16216     "type": "put",
16217     "url": "/api/mail/interactions/{id}",
16218     "title": "Update an existing Interaction",
16219     "examples": [
16220       {
16221         "title": "Example usage:",
16222         "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",
16223         "type": "json"
16224       }
16225     ],
16226     "name": "updateInteractions",
16227     "group": "Mail_Interactions",
16228     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16229     "version": "0.0.0",
16230     "filename": "server/api/mailInteraction/index.js",
16231     "groupTitle": "Mail_Interactions"
16232   },
16233   {
16234     "type": "delete",
16235     "url": "/api/mail/messages/{id}",
16236     "title": "Deletes a Message",
16237     "examples": [
16238       {
16239         "title": "Example usage:",
16240         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16241         "type": "json"
16242       }
16243     ],
16244     "name": "DeleteMessages",
16245     "group": "Mail_Messages",
16246     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16247     "version": "0.0.0",
16248     "filename": "server/api/mailMessage/index.js",
16249     "groupTitle": "Mail_Messages"
16250   },
16251   {
16252     "type": "get",
16253     "url": "/api/mail/messages/describe",
16254     "title": "Gets table info about Messages",
16255     "examples": [
16256       {
16257         "title": "Example usage:",
16258         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16259         "type": "json"
16260       }
16261     ],
16262     "name": "DescribeMessages",
16263     "group": "Mail_Messages",
16264     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16265     "version": "0.0.0",
16266     "filename": "server/api/mailMessage/index.js",
16267     "groupTitle": "Mail_Messages"
16268   },
16269   {
16270     "type": "get",
16271     "url": "/api/mail/messages",
16272     "title": "Gets a list of Messages",
16273     "examples": [
16274       {
16275         "title": "Example usage:",
16276         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16277         "type": "json"
16278       }
16279     ],
16280     "name": "GetMessages",
16281     "group": "Mail_Messages",
16282     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16283     "version": "0.0.0",
16284     "filename": "server/api/mailMessage/index.js",
16285     "groupTitle": "Mail_Messages"
16286   },
16287   {
16288     "type": "get",
16289     "url": "/api/mail/messages/{id}",
16290     "title": "Gets a single Message",
16291     "examples": [
16292       {
16293         "title": "Example usage:",
16294         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16295         "type": "json"
16296       }
16297     ],
16298     "name": "ShowMessages",
16299     "group": "Mail_Messages",
16300     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16301     "version": "0.0.0",
16302     "filename": "server/api/mailMessage/index.js",
16303     "groupTitle": "Mail_Messages"
16304   },
16305   {
16306     "type": "put",
16307     "url": "/api/mail/messages/{id}/accept",
16308     "title": "Accepts message",
16309     "examples": [
16310       {
16311         "title": "Example usage:",
16312         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16313         "type": "json"
16314       }
16315     ],
16316     "name": "acceptMessage",
16317     "group": "Mail_Messages",
16318     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16319     "version": "0.0.0",
16320     "filename": "server/api/mailMessage/index.js",
16321     "groupTitle": "Mail_Messages"
16322   },
16323   {
16324     "type": "post",
16325     "url": "/api/mail/messages",
16326     "title": "Create a message",
16327     "examples": [
16328       {
16329         "title": "Example usage:",
16330         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16331         "type": "json"
16332       }
16333     ],
16334     "name": "createMessage",
16335     "group": "Mail_Messages",
16336     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16337     "version": "0.0.0",
16338     "filename": "server/api/mailMessage/index.js",
16339     "groupTitle": "Mail_Messages"
16340   },
16341   {
16342     "type": "get",
16343     "url": "/api/mail/messages/{id}/download",
16344     "title": "Gets message",
16345     "examples": [
16346       {
16347         "title": "Example usage:",
16348         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16349         "type": "json"
16350       }
16351     ],
16352     "name": "download",
16353     "group": "Mail_Messages",
16354     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16355     "version": "0.0.0",
16356     "filename": "server/api/mailMessage/index.js",
16357     "groupTitle": "Mail_Messages"
16358   },
16359   {
16360     "type": "put",
16361     "url": "/api/mail/messages/{id}/reject",
16362     "title": "Rejects message",
16363     "examples": [
16364       {
16365         "title": "Example usage:",
16366         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16367         "type": "json"
16368       }
16369     ],
16370     "name": "rejectMessage",
16371     "group": "Mail_Messages",
16372     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16373     "version": "0.0.0",
16374     "filename": "server/api/mailMessage/index.js",
16375     "groupTitle": "Mail_Messages"
16376   },
16377   {
16378     "type": "put",
16379     "url": "/api/mail/messages/{id}",
16380     "title": "Update an existing Message",
16381     "examples": [
16382       {
16383         "title": "Example usage:",
16384         "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",
16385         "type": "json"
16386       }
16387     ],
16388     "name": "updateMessages",
16389     "group": "Mail_Messages",
16390     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16391     "version": "0.0.0",
16392     "filename": "server/api/mailMessage/index.js",
16393     "groupTitle": "Mail_Messages"
16394   },
16395   {
16396     "type": "post",
16397     "url": "/api/mail/reports/queue",
16398     "title": "Creates a new Mail Queue Report",
16399     "examples": [
16400       {
16401         "title": "Example usage:",
16402         "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",
16403         "type": "json"
16404       }
16405     ],
16406     "name": "CreateMail_Queue_Reports",
16407     "group": "Mail_Queue_Reports",
16408     "parameter": {
16409       "fields": {
16410         "Body": [
16411           {
16412             "group": "Body",
16413             "type": "String",
16414             "optional": false,
16415             "field": "uniqueid",
16416             "description": ""
16417           },
16418           {
16419             "group": "Body",
16420             "type": "String",
16421             "optional": true,
16422             "field": "from",
16423             "description": ""
16424           },
16425           {
16426             "group": "Body",
16427             "type": "String",
16428             "optional": true,
16429             "field": "joinAt",
16430             "description": ""
16431           },
16432           {
16433             "group": "Body",
16434             "type": "String",
16435             "optional": true,
16436             "field": "leaveAt",
16437             "description": ""
16438           },
16439           {
16440             "group": "Body",
16441             "type": "String",
16442             "optional": true,
16443             "field": "acceptAt",
16444             "description": ""
16445           },
16446           {
16447             "group": "Body",
16448             "type": "String",
16449             "optional": true,
16450             "field": "exitAt",
16451             "description": ""
16452           },
16453           {
16454             "group": "Body",
16455             "type": "String",
16456             "optional": true,
16457             "field": "reason",
16458             "description": ""
16459           }
16460         ]
16461       }
16462     },
16463     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16464     "version": "0.0.0",
16465     "filename": "server/api/mailQueueReport/index.js",
16466     "groupTitle": "Mail_Queue_Reports"
16467   },
16468   {
16469     "type": "delete",
16470     "url": "/api/mail/reports/queue/{id}",
16471     "title": "Deletes a Mail Queue Report",
16472     "examples": [
16473       {
16474         "title": "Example usage:",
16475         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16476         "type": "json"
16477       }
16478     ],
16479     "name": "DeleteMail_Queue_Reports",
16480     "group": "Mail_Queue_Reports",
16481     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16482     "version": "0.0.0",
16483     "filename": "server/api/mailQueueReport/index.js",
16484     "groupTitle": "Mail_Queue_Reports"
16485   },
16486   {
16487     "type": "get",
16488     "url": "/api/mail/reports/queue/describe",
16489     "title": "Gets table info about Mail Queue Reports",
16490     "examples": [
16491       {
16492         "title": "Example usage:",
16493         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16494         "type": "json"
16495       }
16496     ],
16497     "name": "DescribeMail_Queue_Reports",
16498     "group": "Mail_Queue_Reports",
16499     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16500     "version": "0.0.0",
16501     "filename": "server/api/mailQueueReport/index.js",
16502     "groupTitle": "Mail_Queue_Reports"
16503   },
16504   {
16505     "type": "get",
16506     "url": "/api/mail/reports/queue",
16507     "title": "Gets a list of Mail Queue Reports",
16508     "examples": [
16509       {
16510         "title": "Example usage:",
16511         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16512         "type": "json"
16513       }
16514     ],
16515     "name": "GetMail_Queue_Reports",
16516     "group": "Mail_Queue_Reports",
16517     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16518     "version": "0.0.0",
16519     "filename": "server/api/mailQueueReport/index.js",
16520     "groupTitle": "Mail_Queue_Reports"
16521   },
16522   {
16523     "type": "get",
16524     "url": "/api/mail/reports/queue/{id}",
16525     "title": "Gets a single Mail Queue Report",
16526     "examples": [
16527       {
16528         "title": "Example usage:",
16529         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16530         "type": "json"
16531       }
16532     ],
16533     "name": "ShowMail_Queue_Reports",
16534     "group": "Mail_Queue_Reports",
16535     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16536     "version": "0.0.0",
16537     "filename": "server/api/mailQueueReport/index.js",
16538     "groupTitle": "Mail_Queue_Reports"
16539   },
16540   {
16541     "type": "put",
16542     "url": "/api/mail/reports/queue/{id}",
16543     "title": "Update an existing Mail Queue Report",
16544     "examples": [
16545       {
16546         "title": "Example usage:",
16547         "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",
16548         "type": "json"
16549       }
16550     ],
16551     "name": "updateMail_Queue_Reports",
16552     "group": "Mail_Queue_Reports",
16553     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16554     "version": "0.0.0",
16555     "filename": "server/api/mailQueueReport/index.js",
16556     "groupTitle": "Mail_Queue_Reports"
16557   },
16558   {
16559     "type": "post",
16560     "url": "/api/mail/queues/{id}/users",
16561     "title": "Add agents to a queue",
16562     "examples": [
16563       {
16564         "title": "Example usage:",
16565         "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",
16566         "type": "json"
16567       }
16568     ],
16569     "name": "AddAgents",
16570     "group": "Mail_Queues",
16571     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16572     "version": "0.0.0",
16573     "filename": "server/api/mailQueue/index.js",
16574     "groupTitle": "Mail_Queues"
16575   },
16576   {
16577     "type": "post",
16578     "url": "/api/mail/queues/{id}/teams",
16579     "title": "Add teams to a queue",
16580     "examples": [
16581       {
16582         "title": "Example usage:",
16583         "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",
16584         "type": "json"
16585       }
16586     ],
16587     "name": "AddTeams",
16588     "group": "Mail_Queues",
16589     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16590     "version": "0.0.0",
16591     "filename": "server/api/mailQueue/index.js",
16592     "groupTitle": "Mail_Queues"
16593   },
16594   {
16595     "type": "post",
16596     "url": "/api/mail/queues",
16597     "title": "Creates a new Queue",
16598     "examples": [
16599       {
16600         "title": "Example usage:",
16601         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16602         "type": "json"
16603       }
16604     ],
16605     "name": "CreateQueues",
16606     "group": "Mail_Queues",
16607     "parameter": {
16608       "fields": {
16609         "Body": [
16610           {
16611             "group": "Body",
16612             "type": "String",
16613             "optional": true,
16614             "field": "name",
16615             "description": ""
16616           },
16617           {
16618             "group": "Body",
16619             "type": "String",
16620             "optional": true,
16621             "field": "description",
16622             "description": ""
16623           },
16624           {
16625             "group": "Body",
16626             "type": "Integer",
16627             "optional": true,
16628             "field": "timeout",
16629             "description": ""
16630           },
16631           {
16632             "group": "Body",
16633             "type": "String",
16634             "allowedValues": [
16635               "\"rrmemory\"",
16636               "\"beepall\"",
16637               "\"roundrobin\""
16638             ],
16639             "optional": true,
16640             "field": "strategy",
16641             "description": ""
16642           }
16643         ]
16644       }
16645     },
16646     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16647     "version": "0.0.0",
16648     "filename": "server/api/mailQueue/index.js",
16649     "groupTitle": "Mail_Queues"
16650   },
16651   {
16652     "type": "delete",
16653     "url": "/api/mail/queues/{id}",
16654     "title": "Deletes a Queue",
16655     "examples": [
16656       {
16657         "title": "Example usage:",
16658         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16659         "type": "json"
16660       }
16661     ],
16662     "name": "DeleteQueues",
16663     "group": "Mail_Queues",
16664     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16665     "version": "0.0.0",
16666     "filename": "server/api/mailQueue/index.js",
16667     "groupTitle": "Mail_Queues"
16668   },
16669   {
16670     "type": "get",
16671     "url": "/api/mail/queues/describe",
16672     "title": "Gets table info about Queues",
16673     "examples": [
16674       {
16675         "title": "Example usage:",
16676         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16677         "type": "json"
16678       }
16679     ],
16680     "name": "DescribeQueues",
16681     "group": "Mail_Queues",
16682     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16683     "version": "0.0.0",
16684     "filename": "server/api/mailQueue/index.js",
16685     "groupTitle": "Mail_Queues"
16686   },
16687   {
16688     "type": "get",
16689     "url": "/api/mail/queues/{id}/users",
16690     "title": "Gets queue agents",
16691     "examples": [
16692       {
16693         "title": "Example usage:",
16694         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16695         "type": "json"
16696       }
16697     ],
16698     "name": "GetAgents",
16699     "group": "Mail_Queues",
16700     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16701     "version": "0.0.0",
16702     "filename": "server/api/mailQueue/index.js",
16703     "groupTitle": "Mail_Queues"
16704   },
16705   {
16706     "type": "get",
16707     "url": "/api/mail/queues/{id}/members",
16708     "title": "GetMembers",
16709     "examples": [
16710       {
16711         "title": "Example usage:",
16712         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
16713         "type": "json"
16714       }
16715     ],
16716     "name": "GetMembers",
16717     "group": "Mail_Queues",
16718     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16719     "version": "0.0.0",
16720     "filename": "server/api/mailQueue/index.js",
16721     "groupTitle": "Mail_Queues"
16722   },
16723   {
16724     "type": "get",
16725     "url": "/api/mail/queues",
16726     "title": "Gets a list of Queues",
16727     "examples": [
16728       {
16729         "title": "Example usage:",
16730         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16731         "type": "json"
16732       }
16733     ],
16734     "name": "GetQueues",
16735     "group": "Mail_Queues",
16736     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16737     "version": "0.0.0",
16738     "filename": "server/api/mailQueue/index.js",
16739     "groupTitle": "Mail_Queues"
16740   },
16741   {
16742     "type": "get",
16743     "url": "/api/mail/queues/{id}/teams",
16744     "title": "Gets queues list",
16745     "examples": [
16746       {
16747         "title": "Example usage:",
16748         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16749         "type": "json"
16750       }
16751     ],
16752     "name": "GetTeams",
16753     "group": "Mail_Queues",
16754     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16755     "version": "0.0.0",
16756     "filename": "server/api/mailQueue/index.js",
16757     "groupTitle": "Mail_Queues"
16758   },
16759   {
16760     "type": "delete",
16761     "url": "/api/mail/queues/{id}/users",
16762     "title": "Removes agents from a queue",
16763     "examples": [
16764       {
16765         "title": "Example usage:",
16766         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16767         "type": "json"
16768       }
16769     ],
16770     "name": "RemoveAgents",
16771     "group": "Mail_Queues",
16772     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16773     "version": "0.0.0",
16774     "filename": "server/api/mailQueue/index.js",
16775     "groupTitle": "Mail_Queues"
16776   },
16777   {
16778     "type": "get",
16779     "url": "/api/mail/queues/{id}",
16780     "title": "Gets a single Queue",
16781     "examples": [
16782       {
16783         "title": "Example usage:",
16784         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16785         "type": "json"
16786       }
16787     ],
16788     "name": "ShowQueues",
16789     "group": "Mail_Queues",
16790     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16791     "version": "0.0.0",
16792     "filename": "server/api/mailQueue/index.js",
16793     "groupTitle": "Mail_Queues"
16794   },
16795   {
16796     "type": "put",
16797     "url": "/api/mail/queues/{id}",
16798     "title": "Update an existing Queue",
16799     "examples": [
16800       {
16801         "title": "Example usage:",
16802         "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",
16803         "type": "json"
16804       }
16805     ],
16806     "name": "updateQueues",
16807     "group": "Mail_Queues",
16808     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16809     "version": "0.0.0",
16810     "filename": "server/api/mailQueue/index.js",
16811     "groupTitle": "Mail_Queues"
16812   },
16813   {
16814     "type": "post",
16815     "url": "/api/mail/out_servers",
16816     "title": "Creates a new SMTP",
16817     "examples": [
16818       {
16819         "title": "Example usage:",
16820         "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",
16821         "type": "json"
16822       }
16823     ],
16824     "name": "CreateSMTPs",
16825     "group": "Mail_SMTP",
16826     "parameter": {
16827       "fields": {
16828         "Body": [
16829           {
16830             "group": "Body",
16831             "type": "String",
16832             "optional": true,
16833             "field": "description",
16834             "description": ""
16835           },
16836           {
16837             "group": "Body",
16838             "type": "String",
16839             "optional": true,
16840             "field": "host",
16841             "description": ""
16842           },
16843           {
16844             "group": "Body",
16845             "type": "String",
16846             "optional": true,
16847             "field": "user",
16848             "description": ""
16849           },
16850           {
16851             "group": "Body",
16852             "type": "String",
16853             "optional": true,
16854             "field": "pass",
16855             "description": ""
16856           },
16857           {
16858             "group": "Body",
16859             "type": "Integer",
16860             "optional": true,
16861             "field": "port",
16862             "description": ""
16863           },
16864           {
16865             "group": "Body",
16866             "type": "Boolean",
16867             "optional": true,
16868             "field": "secure",
16869             "description": ""
16870           },
16871           {
16872             "group": "Body",
16873             "type": "String",
16874             "optional": true,
16875             "field": "service",
16876             "description": ""
16877           },
16878           {
16879             "group": "Body",
16880             "type": "Boolean",
16881             "optional": true,
16882             "field": "authentication",
16883             "description": ""
16884           }
16885         ]
16886       }
16887     },
16888     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16889     "version": "0.0.0",
16890     "filename": "server/api/mailServerOut/index.js",
16891     "groupTitle": "Mail_SMTP"
16892   },
16893   {
16894     "type": "delete",
16895     "url": "/api/mail/out_servers/{id}",
16896     "title": "Deletes a SMTP",
16897     "examples": [
16898       {
16899         "title": "Example usage:",
16900         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16901         "type": "json"
16902       }
16903     ],
16904     "name": "DeleteSMTPs",
16905     "group": "Mail_SMTP",
16906     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16907     "version": "0.0.0",
16908     "filename": "server/api/mailServerOut/index.js",
16909     "groupTitle": "Mail_SMTP"
16910   },
16911   {
16912     "type": "get",
16913     "url": "/api/mail/out_servers",
16914     "title": "Gets a list of SMTPs",
16915     "examples": [
16916       {
16917         "title": "Example usage:",
16918         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16919         "type": "json"
16920       }
16921     ],
16922     "name": "GetSMTPs",
16923     "group": "Mail_SMTP",
16924     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16925     "version": "0.0.0",
16926     "filename": "server/api/mailServerOut/index.js",
16927     "groupTitle": "Mail_SMTP"
16928   },
16929   {
16930     "type": "get",
16931     "url": "/api/mail/out_servers/{id}",
16932     "title": "Gets a single SMTP",
16933     "examples": [
16934       {
16935         "title": "Example usage:",
16936         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16937         "type": "json"
16938       }
16939     ],
16940     "name": "ShowSMTPs",
16941     "group": "Mail_SMTP",
16942     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16943     "version": "0.0.0",
16944     "filename": "server/api/mailServerOut/index.js",
16945     "groupTitle": "Mail_SMTP"
16946   },
16947   {
16948     "type": "put",
16949     "url": "/api/mail/out_servers/{id}",
16950     "title": "Update an existing SMTP",
16951     "examples": [
16952       {
16953         "title": "Example usage:",
16954         "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",
16955         "type": "json"
16956       }
16957     ],
16958     "name": "updateSMTPs",
16959     "group": "Mail_SMTP",
16960     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16961     "version": "0.0.0",
16962     "filename": "server/api/mailServerOut/index.js",
16963     "groupTitle": "Mail_SMTP"
16964   },
16965   {
16966     "type": "post",
16967     "url": "/api/mail/substatuses",
16968     "title": "Creates a new Queue",
16969     "examples": [
16970       {
16971         "title": "Example usage:",
16972         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16973         "type": "json"
16974       }
16975     ],
16976     "name": "CreateSubstatuses",
16977     "group": "Mail_Substatuses",
16978     "parameter": {
16979       "fields": {
16980         "Body": [
16981           {
16982             "group": "Body",
16983             "type": "String",
16984             "optional": false,
16985             "field": "name",
16986             "description": ""
16987           },
16988           {
16989             "group": "Body",
16990             "type": "String",
16991             "optional": true,
16992             "field": "description",
16993             "description": ""
16994           }
16995         ]
16996       }
16997     },
16998     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16999     "version": "0.0.0",
17000     "filename": "server/api/mailSubstatus/index.js",
17001     "groupTitle": "Mail_Substatuses"
17002   },
17003   {
17004     "type": "delete",
17005     "url": "/api/mail/substatuses/{id}",
17006     "title": "Deletes a Queue",
17007     "examples": [
17008       {
17009         "title": "Example usage:",
17010         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
17011         "type": "json"
17012       }
17013     ],
17014     "name": "DeleteSubstatuses",
17015     "group": "Mail_Substatuses",
17016     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17017     "version": "0.0.0",
17018     "filename": "server/api/mailSubstatus/index.js",
17019     "groupTitle": "Mail_Substatuses"
17020   },
17021   {
17022     "type": "get",
17023     "url": "/api/mail/substatuses/describe",
17024     "title": "Gets table info about Substatuses",
17025     "examples": [
17026       {
17027         "title": "Example usage:",
17028         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
17029         "type": "json"
17030       }
17031     ],
17032     "name": "DescribeSubstatuses",
17033     "group": "Mail_Substatuses",
17034     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17035     "version": "0.0.0",
17036     "filename": "server/api/mailSubstatus/index.js",
17037     "groupTitle": "Mail_Substatuses"
17038   },
17039   {
17040     "type": "get",
17041     "url": "/api/mail/substatuses",
17042     "title": "Gets a list of Substatuses",
17043     "examples": [
17044       {
17045         "title": "Example usage:",
17046         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
17047         "type": "json"
17048       }
17049     ],
17050     "name": "GetSubstatuses",
17051     "group": "Mail_Substatuses",
17052     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17053     "version": "0.0.0",
17054     "filename": "server/api/mailSubstatus/index.js",
17055     "groupTitle": "Mail_Substatuses"
17056   },
17057   {
17058     "type": "get",
17059     "url": "/api/mail/substatuses/{id}",
17060     "title": "Gets a single Queue",
17061     "examples": [
17062       {
17063         "title": "Example usage:",
17064         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
17065         "type": "json"
17066       }
17067     ],
17068     "name": "ShowSubstatuses",
17069     "group": "Mail_Substatuses",
17070     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17071     "version": "0.0.0",
17072     "filename": "server/api/mailSubstatus/index.js",
17073     "groupTitle": "Mail_Substatuses"
17074   },
17075   {
17076     "type": "put",
17077     "url": "/api/mail/substatuses/{id}",
17078     "title": "Update an existing Queue",
17079     "examples": [
17080       {
17081         "title": "Example usage:",
17082         "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",
17083         "type": "json"
17084       }
17085     ],
17086     "name": "updateSubstatuses",
17087     "group": "Mail_Substatuses",
17088     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17089     "version": "0.0.0",
17090     "filename": "server/api/mailSubstatus/index.js",
17091     "groupTitle": "Mail_Substatuses"
17092   },
17093   {
17094     "type": "post",
17095     "url": "/api/mail/reports/transfer",
17096     "title": "Creates a new Mail Transfer Report",
17097     "examples": [
17098       {
17099         "title": "Example usage:",
17100         "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",
17101         "type": "json"
17102       }
17103     ],
17104     "name": "CreateMail_Transfer_Reports",
17105     "group": "Mail_Transfer_Reports",
17106     "parameter": {
17107       "fields": {
17108         "Body": [
17109           {
17110             "group": "Body",
17111             "type": "String",
17112             "optional": false,
17113             "field": "uniqueid",
17114             "description": ""
17115           },
17116           {
17117             "group": "Body",
17118             "type": "String",
17119             "allowedValues": [
17120               "\"account\"",
17121               "\"agent\"",
17122               "\"queue\""
17123             ],
17124             "optional": false,
17125             "field": "type",
17126             "description": ""
17127           },
17128           {
17129             "group": "Body",
17130             "type": "String",
17131             "optional": false,
17132             "field": "transferredAt",
17133             "description": ""
17134           }
17135         ]
17136       }
17137     },
17138     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17139     "version": "0.0.0",
17140     "filename": "server/api/mailTransferReport/index.js",
17141     "groupTitle": "Mail_Transfer_Reports"
17142   },
17143   {
17144     "type": "delete",
17145     "url": "/api/mail/reports/transfer/{id}",
17146     "title": "Deletes a Mail Transfer Report",
17147     "examples": [
17148       {
17149         "title": "Example usage:",
17150         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17151         "type": "json"
17152       }
17153     ],
17154     "name": "DeleteMail_Transfer_Reports",
17155     "group": "Mail_Transfer_Reports",
17156     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17157     "version": "0.0.0",
17158     "filename": "server/api/mailTransferReport/index.js",
17159     "groupTitle": "Mail_Transfer_Reports"
17160   },
17161   {
17162     "type": "get",
17163     "url": "/api/mail/reports/transfer/describe",
17164     "title": "Gets table info about Mail Transfer Reports",
17165     "examples": [
17166       {
17167         "title": "Example usage:",
17168         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17169         "type": "json"
17170       }
17171     ],
17172     "name": "DescribeMail_Transfer_Reports",
17173     "group": "Mail_Transfer_Reports",
17174     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17175     "version": "0.0.0",
17176     "filename": "server/api/mailTransferReport/index.js",
17177     "groupTitle": "Mail_Transfer_Reports"
17178   },
17179   {
17180     "type": "get",
17181     "url": "/api/mail/reports/transfer",
17182     "title": "Gets a list of Mail Transfer Reports",
17183     "examples": [
17184       {
17185         "title": "Example usage:",
17186         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17187         "type": "json"
17188       }
17189     ],
17190     "name": "GetMail_Transfer_Reports",
17191     "group": "Mail_Transfer_Reports",
17192     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17193     "version": "0.0.0",
17194     "filename": "server/api/mailTransferReport/index.js",
17195     "groupTitle": "Mail_Transfer_Reports"
17196   },
17197   {
17198     "type": "get",
17199     "url": "/api/mail/reports/transfer/{id}",
17200     "title": "Gets a single Mail Transfer Report",
17201     "examples": [
17202       {
17203         "title": "Example usage:",
17204         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17205         "type": "json"
17206       }
17207     ],
17208     "name": "ShowMail_Transfer_Reports",
17209     "group": "Mail_Transfer_Reports",
17210     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17211     "version": "0.0.0",
17212     "filename": "server/api/mailTransferReport/index.js",
17213     "groupTitle": "Mail_Transfer_Reports"
17214   },
17215   {
17216     "type": "put",
17217     "url": "/api/mail/reports/transfer/{id}",
17218     "title": "Update an existing Mail Transfer Report",
17219     "examples": [
17220       {
17221         "title": "Example usage:",
17222         "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",
17223         "type": "json"
17224       }
17225     ],
17226     "name": "updateMail_Transfer_Reports",
17227     "group": "Mail_Transfer_Reports",
17228     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17229     "version": "0.0.0",
17230     "filename": "server/api/mailTransferReport/index.js",
17231     "groupTitle": "Mail_Transfer_Reports"
17232   },
17233   {
17234     "type": "get",
17235     "url": "/api/members/reports/describe",
17236     "title": "Gets table info about Member Reports",
17237     "examples": [
17238       {
17239         "title": "Example usage:",
17240         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17241         "type": "json"
17242       }
17243     ],
17244     "name": "DescribeMember_Reports",
17245     "group": "Member_Reports",
17246     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17247     "version": "0.0.0",
17248     "filename": "server/api/memberReport/index.js",
17249     "groupTitle": "Member_Reports"
17250   },
17251   {
17252     "type": "get",
17253     "url": "/api/members/reports",
17254     "title": "Gets a list of Member Reports",
17255     "examples": [
17256       {
17257         "title": "Example usage:",
17258         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17259         "type": "json"
17260       }
17261     ],
17262     "name": "GetMember_Reports",
17263     "group": "Member_Reports",
17264     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17265     "version": "0.0.0",
17266     "filename": "server/api/memberReport/index.js",
17267     "groupTitle": "Member_Reports"
17268   },
17269   {
17270     "type": "get",
17271     "url": "/api/members/reports/{id}",
17272     "title": "Gets a single Member Report",
17273     "examples": [
17274       {
17275         "title": "Example usage:",
17276         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17277         "type": "json"
17278       }
17279     ],
17280     "name": "ShowMember_Reports",
17281     "group": "Member_Reports",
17282     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17283     "version": "0.0.0",
17284     "filename": "server/api/memberReport/index.js",
17285     "groupTitle": "Member_Reports"
17286   },
17287   {
17288     "type": "get",
17289     "url": "/api/migrations",
17290     "title": "Gets a list of Migrations",
17291     "examples": [
17292       {
17293         "title": "Example usage:",
17294         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17295         "type": "json"
17296       }
17297     ],
17298     "name": "GetMigrations",
17299     "group": "Migrations",
17300     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17301     "version": "0.0.0",
17302     "filename": "server/api/migration/index.js",
17303     "groupTitle": "Migrations"
17304   },
17305   {
17306     "type": "post",
17307     "url": "/api/voice/networks",
17308     "title": "Create a new network",
17309     "examples": [
17310       {
17311         "title": "Example usage:",
17312         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17313         "type": "json"
17314       }
17315     ],
17316     "name": "Create",
17317     "group": "Networks",
17318     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17319     "version": "0.0.0",
17320     "filename": "server/api/network/index.js",
17321     "groupTitle": "Networks"
17322   },
17323   {
17324     "type": "delete",
17325     "url": "/api/voice/networks/{id}",
17326     "title": "Deletes a network",
17327     "examples": [
17328       {
17329         "title": "Example usage:",
17330         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17331         "type": "json"
17332       }
17333     ],
17334     "name": "Delete",
17335     "group": "Networks",
17336     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17337     "version": "0.0.0",
17338     "filename": "server/api/network/index.js",
17339     "groupTitle": "Networks"
17340   },
17341   {
17342     "type": "get",
17343     "url": "/api/networks",
17344     "title": "Gets a list of Networks",
17345     "examples": [
17346       {
17347         "title": "Example usage:",
17348         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17349         "type": "json"
17350       }
17351     ],
17352     "name": "GetNetworks",
17353     "group": "Networks",
17354     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17355     "version": "0.0.0",
17356     "filename": "server/api/network/index.js",
17357     "groupTitle": "Networks"
17358   },
17359   {
17360     "type": "get",
17361     "url": "/api/networks/{id}",
17362     "title": "Gets a single Network",
17363     "examples": [
17364       {
17365         "title": "Example usage:",
17366         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17367         "type": "json"
17368       }
17369     ],
17370     "name": "ShowNetworks",
17371     "group": "Networks",
17372     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17373     "version": "0.0.0",
17374     "filename": "server/api/network/index.js",
17375     "groupTitle": "Networks"
17376   },
17377   {
17378     "type": "put",
17379     "url": "/api/voice/networks/{id}",
17380     "title": "Update an existing network",
17381     "examples": [
17382       {
17383         "title": "Example usage:",
17384         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17385         "type": "json"
17386       }
17387     ],
17388     "name": "Update",
17389     "group": "Networks",
17390     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17391     "version": "0.0.0",
17392     "filename": "server/api/network/index.js",
17393     "groupTitle": "Networks"
17394   },
17395   {
17396     "type": "post",
17397     "url": "/api/openchannel/accounts/{id}/users",
17398     "title": "Add agents to a openchannel account",
17399     "examples": [
17400       {
17401         "title": "Example usage:",
17402         "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",
17403         "type": "json"
17404       }
17405     ],
17406     "name": "AddAgents",
17407     "group": "Openchannel_Accounts",
17408     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17409     "version": "0.0.0",
17410     "filename": "server/api/openchannelAccount/index.js",
17411     "groupTitle": "Openchannel_Accounts"
17412   },
17413   {
17414     "type": "post",
17415     "url": "/api/openchannel/accounts",
17416     "title": "Creates a new Account",
17417     "examples": [
17418       {
17419         "title": "Example usage:",
17420         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17421         "type": "json"
17422       }
17423     ],
17424     "name": "CreateAccounts",
17425     "group": "Openchannel_Accounts",
17426     "parameter": {
17427       "fields": {
17428         "Body": [
17429           {
17430             "group": "Body",
17431             "type": "String",
17432             "optional": false,
17433             "field": "name",
17434             "description": ""
17435           },
17436           {
17437             "group": "Body",
17438             "type": "String",
17439             "optional": true,
17440             "field": "description",
17441             "description": ""
17442           },
17443           {
17444             "group": "Body",
17445             "type": "String",
17446             "optional": true,
17447             "field": "token",
17448             "description": ""
17449           },
17450           {
17451             "group": "Body",
17452             "type": "String",
17453             "optional": true,
17454             "field": "replyUri",
17455             "description": ""
17456           },
17457           {
17458             "group": "Body",
17459             "type": "String",
17460             "optional": false,
17461             "field": "key",
17462             "description": ""
17463           },
17464           {
17465             "group": "Body",
17466             "type": "Text",
17467             "optional": true,
17468             "field": "notificationTemplate",
17469             "description": ""
17470           },
17471           {
17472             "group": "Body",
17473             "type": "Boolean",
17474             "optional": true,
17475             "field": "notificationSound",
17476             "description": ""
17477           },
17478           {
17479             "group": "Body",
17480             "type": "Boolean",
17481             "optional": true,
17482             "field": "notificationShake",
17483             "description": ""
17484           },
17485           {
17486             "group": "Body",
17487             "type": "Integer",
17488             "optional": true,
17489             "field": "waitForTheAssignedAgent",
17490             "description": ""
17491           },
17492           {
17493             "group": "Body",
17494             "type": "String",
17495             "optional": true,
17496             "field": "mapKey",
17497             "description": ""
17498           },
17499           {
17500             "group": "Body",
17501             "type": "Boolean",
17502             "optional": true,
17503             "field": "queueTransfer",
17504             "description": ""
17505           },
17506           {
17507             "group": "Body",
17508             "type": "Integer",
17509             "optional": true,
17510             "field": "queueTransferTimeout",
17511             "description": ""
17512           },
17513           {
17514             "group": "Body",
17515             "type": "Boolean",
17516             "optional": true,
17517             "field": "agentTransfer",
17518             "description": ""
17519           },
17520           {
17521             "group": "Body",
17522             "type": "Integer",
17523             "optional": true,
17524             "field": "agentTransferTimeout",
17525             "description": ""
17526           },
17527           {
17528             "group": "Body",
17529             "type": "Integer",
17530             "optional": true,
17531             "field": "mandatoryDispositionPauseId",
17532             "description": "<p>Status to put when mandatory disposition is enabled</p>"
17533           },
17534           {
17535             "group": "Body",
17536             "type": "Boolean",
17537             "optional": true,
17538             "field": "mandatoryDisposition",
17539             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17540           }
17541         ]
17542       }
17543     },
17544     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17545     "version": "0.0.0",
17546     "filename": "server/api/openchannelAccount/index.js",
17547     "groupTitle": "Openchannel_Accounts"
17548   },
17549   {
17550     "type": "delete",
17551     "url": "/api/openchannel/accounts/{id}",
17552     "title": "Deletes a Account",
17553     "examples": [
17554       {
17555         "title": "Example usage:",
17556         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17557         "type": "json"
17558       }
17559     ],
17560     "name": "DeleteAccounts",
17561     "group": "Openchannel_Accounts",
17562     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17563     "version": "0.0.0",
17564     "filename": "server/api/openchannelAccount/index.js",
17565     "groupTitle": "Openchannel_Accounts"
17566   },
17567   {
17568     "type": "get",
17569     "url": "/api/openchannel/accounts/describe",
17570     "title": "Gets table info about Accounts",
17571     "examples": [
17572       {
17573         "title": "Example usage:",
17574         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17575         "type": "json"
17576       }
17577     ],
17578     "name": "DescribeAccounts",
17579     "group": "Openchannel_Accounts",
17580     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17581     "version": "0.0.0",
17582     "filename": "server/api/openchannelAccount/index.js",
17583     "groupTitle": "Openchannel_Accounts"
17584   },
17585   {
17586     "type": "get",
17587     "url": "/api/openchannel/accounts",
17588     "title": "Gets a list of Accounts",
17589     "examples": [
17590       {
17591         "title": "Example usage:",
17592         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17593         "type": "json"
17594       }
17595     ],
17596     "name": "GetAccounts",
17597     "group": "Openchannel_Accounts",
17598     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17599     "version": "0.0.0",
17600     "filename": "server/api/openchannelAccount/index.js",
17601     "groupTitle": "Openchannel_Accounts"
17602   },
17603   {
17604     "type": "get",
17605     "url": "/api/openchannel/accounts/{id}/users",
17606     "title": "Gets agents from openchannel account",
17607     "examples": [
17608       {
17609         "title": "Example usage:",
17610         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17611         "type": "json"
17612       }
17613     ],
17614     "name": "GetAgents",
17615     "group": "Openchannel_Accounts",
17616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17617     "version": "0.0.0",
17618     "filename": "server/api/openchannelAccount/index.js",
17619     "groupTitle": "Openchannel_Accounts"
17620   },
17621   {
17622     "type": "delete",
17623     "url": "/api/openchannel/accounts/{id}/users",
17624     "title": "Removes agents from a openchannel account",
17625     "examples": [
17626       {
17627         "title": "Example usage:",
17628         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17629         "type": "json"
17630       }
17631     ],
17632     "name": "RemoveAgents",
17633     "group": "Openchannel_Accounts",
17634     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17635     "version": "0.0.0",
17636     "filename": "server/api/openchannelAccount/index.js",
17637     "groupTitle": "Openchannel_Accounts"
17638   },
17639   {
17640     "type": "delete",
17641     "url": "/api/openchannel/accounts/{id}/canned_answers",
17642     "title": "Removes canned answers from account",
17643     "examples": [
17644       {
17645         "title": "Example usage:",
17646         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17647         "type": "json"
17648       }
17649     ],
17650     "name": "RemoveAnswers",
17651     "group": "Openchannel_Accounts",
17652     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17653     "version": "0.0.0",
17654     "filename": "server/api/openchannelAccount/index.js",
17655     "groupTitle": "Openchannel_Accounts"
17656   },
17657   {
17658     "type": "delete",
17659     "url": "/api/openchannel/accounts/{id}/dispositions",
17660     "title": "Removes dispositions from account",
17661     "examples": [
17662       {
17663         "title": "Example usage:",
17664         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17665         "type": "json"
17666       }
17667     ],
17668     "name": "RemoveDispositions",
17669     "group": "Openchannel_Accounts",
17670     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17671     "version": "0.0.0",
17672     "filename": "server/api/openchannelAccount/index.js",
17673     "groupTitle": "Openchannel_Accounts"
17674   },
17675   {
17676     "type": "get",
17677     "url": "/api/openchannel/accounts/{id}",
17678     "title": "Gets a single Account",
17679     "examples": [
17680       {
17681         "title": "Example usage:",
17682         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17683         "type": "json"
17684       }
17685     ],
17686     "name": "ShowAccounts",
17687     "group": "Openchannel_Accounts",
17688     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17689     "version": "0.0.0",
17690     "filename": "server/api/openchannelAccount/index.js",
17691     "groupTitle": "Openchannel_Accounts"
17692   },
17693   {
17694     "type": "post",
17695     "url": "/api/openchannel/accounts/{id}/canned_answers",
17696     "title": "Creates new canned answer",
17697     "examples": [
17698       {
17699         "title": "Example usage:",
17700         "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",
17701         "type": "json"
17702       }
17703     ],
17704     "name": "addAnswer",
17705     "group": "Openchannel_Accounts",
17706     "parameter": {
17707       "fields": {
17708         "Body": [
17709           {
17710             "group": "Body",
17711             "type": "String",
17712             "optional": false,
17713             "field": "key",
17714             "description": ""
17715           },
17716           {
17717             "group": "Body",
17718             "type": "Text",
17719             "optional": false,
17720             "field": "value",
17721             "description": ""
17722           },
17723           {
17724             "group": "Body",
17725             "type": "String",
17726             "optional": true,
17727             "field": "description",
17728             "description": ""
17729           },
17730           {
17731             "group": "Body",
17732             "type": "Virtual",
17733             "optional": true,
17734             "field": "name",
17735             "description": ""
17736           }
17737         ]
17738       }
17739     },
17740     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17741     "version": "0.0.0",
17742     "filename": "server/api/openchannelAccount/index.js",
17743     "groupTitle": "Openchannel_Accounts"
17744   },
17745   {
17746     "type": "post",
17747     "url": "/api/openchannel/accounts/{id}/applications",
17748     "title": "Creates new applications",
17749     "examples": [
17750       {
17751         "title": "Example usage:",
17752         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17753         "type": "json"
17754       }
17755     ],
17756     "name": "addApplications",
17757     "group": "Openchannel_Accounts",
17758     "parameter": {
17759       "fields": {
17760         "Body": [
17761           {
17762             "group": "Body",
17763             "type": "Integer",
17764             "optional": false,
17765             "field": "priority",
17766             "description": ""
17767           },
17768           {
17769             "group": "Body",
17770             "type": "String",
17771             "optional": false,
17772             "field": "app",
17773             "description": ""
17774           },
17775           {
17776             "group": "Body",
17777             "type": "Text",
17778             "optional": true,
17779             "field": "appdata",
17780             "description": ""
17781           },
17782           {
17783             "group": "Body",
17784             "type": "String",
17785             "optional": true,
17786             "field": "description",
17787             "description": ""
17788           },
17789           {
17790             "group": "Body",
17791             "type": "String",
17792             "optional": true,
17793             "field": "interval",
17794             "description": ""
17795           }
17796         ]
17797       }
17798     },
17799     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17800     "version": "0.0.0",
17801     "filename": "server/api/openchannelAccount/index.js",
17802     "groupTitle": "Openchannel_Accounts"
17803   },
17804   {
17805     "type": "post",
17806     "url": "/api/openchannel/accounts/{id}/dispositions",
17807     "title": "Creates new disposition",
17808     "examples": [
17809       {
17810         "title": "Example usage:",
17811         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17812         "type": "json"
17813       }
17814     ],
17815     "name": "addDisposition",
17816     "group": "Openchannel_Accounts",
17817     "parameter": {
17818       "fields": {
17819         "Body": [
17820           {
17821             "group": "Body",
17822             "type": "String",
17823             "optional": false,
17824             "field": "name",
17825             "description": ""
17826           },
17827           {
17828             "group": "Body",
17829             "type": "String",
17830             "allowedValues": [
17831               "\"first\"",
17832               "\"second\"",
17833               "\"third\""
17834             ],
17835             "optional": false,
17836             "field": "level",
17837             "description": ""
17838           },
17839           {
17840             "group": "Body",
17841             "type": "String",
17842             "optional": true,
17843             "field": "description",
17844             "description": ""
17845           }
17846         ]
17847       }
17848     },
17849     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17850     "version": "0.0.0",
17851     "filename": "server/api/openchannelAccount/index.js",
17852     "groupTitle": "Openchannel_Accounts"
17853   },
17854   {
17855     "type": "get",
17856     "url": "/api/openchannel/accounts/{id}/canned_answers",
17857     "title": "Gets account canned answers",
17858     "examples": [
17859       {
17860         "title": "Example usage:",
17861         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17862         "type": "json"
17863       }
17864     ],
17865     "name": "getAnswers",
17866     "group": "Openchannel_Accounts",
17867     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17868     "version": "0.0.0",
17869     "filename": "server/api/openchannelAccount/index.js",
17870     "groupTitle": "Openchannel_Accounts"
17871   },
17872   {
17873     "type": "get",
17874     "url": "/api/openchannel/accounts/{id}/applications",
17875     "title": "Gets account applications",
17876     "examples": [
17877       {
17878         "title": "Example usage:",
17879         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17880         "type": "json"
17881       }
17882     ],
17883     "name": "getApplications",
17884     "group": "Openchannel_Accounts",
17885     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17886     "version": "0.0.0",
17887     "filename": "server/api/openchannelAccount/index.js",
17888     "groupTitle": "Openchannel_Accounts"
17889   },
17890   {
17891     "type": "get",
17892     "url": "/api/openchannel/accounts/{id}/dispositions",
17893     "title": "Gets account dispositions",
17894     "examples": [
17895       {
17896         "title": "Example usage:",
17897         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17898         "type": "json"
17899       }
17900     ],
17901     "name": "getDispositions",
17902     "group": "Openchannel_Accounts",
17903     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17904     "version": "0.0.0",
17905     "filename": "server/api/openchannelAccount/index.js",
17906     "groupTitle": "Openchannel_Accounts"
17907   },
17908   {
17909     "type": "get",
17910     "url": "/api/openchannel/accounts/{id}/interactions",
17911     "title": "Gets Openchannel Account Interactions",
17912     "examples": [
17913       {
17914         "title": "Example usage:",
17915         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17916         "type": "json"
17917       }
17918     ],
17919     "name": "getInteractions",
17920     "group": "Openchannel_Accounts",
17921     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17922     "version": "0.0.0",
17923     "filename": "server/api/openchannelAccount/index.js",
17924     "groupTitle": "Openchannel_Accounts"
17925   },
17926   {
17927     "type": "post",
17928     "url": "/api/openchannel/accounts/{id}/notify",
17929     "title": "Notify new message",
17930     "examples": [
17931       {
17932         "title": "Example usage:",
17933         "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",
17934         "type": "json"
17935       }
17936     ],
17937     "name": "notify",
17938     "group": "Openchannel_Accounts",
17939     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <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>",
17940     "version": "0.0.0",
17941     "filename": "server/api/openchannelAccount/index.js",
17942     "groupTitle": "Openchannel_Accounts"
17943   },
17944   {
17945     "type": "post",
17946     "url": "/api/openchannel/accounts/{id}/send",
17947     "title": "Send new openchannel message",
17948     "examples": [
17949       {
17950         "title": "Example usage:",
17951         "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",
17952         "type": "json"
17953       }
17954     ],
17955     "name": "sendOpenchannel",
17956     "group": "Openchannel_Accounts",
17957     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17958     "version": "0.0.0",
17959     "filename": "server/api/openchannelAccount/index.js",
17960     "groupTitle": "Openchannel_Accounts"
17961   },
17962   {
17963     "type": "put",
17964     "url": "/api/openchannel/accounts/{id}",
17965     "title": "Update an existing Account",
17966     "examples": [
17967       {
17968         "title": "Example usage:",
17969         "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",
17970         "type": "json"
17971       }
17972     ],
17973     "name": "updateAccounts",
17974     "group": "Openchannel_Accounts",
17975     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17976     "version": "0.0.0",
17977     "filename": "server/api/openchannelAccount/index.js",
17978     "groupTitle": "Openchannel_Accounts"
17979   },
17980   {
17981     "type": "post",
17982     "url": "/api/openchannel/applications",
17983     "title": "Creates a new Application",
17984     "examples": [
17985       {
17986         "title": "Example usage:",
17987         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17988         "type": "json"
17989       }
17990     ],
17991     "name": "CreateApplications",
17992     "group": "Openchannel_Applications",
17993     "parameter": {
17994       "fields": {
17995         "Body": [
17996           {
17997             "group": "Body",
17998             "type": "Integer",
17999             "optional": false,
18000             "field": "priority",
18001             "description": ""
18002           },
18003           {
18004             "group": "Body",
18005             "type": "String",
18006             "optional": false,
18007             "field": "app",
18008             "description": ""
18009           },
18010           {
18011             "group": "Body",
18012             "type": "Text",
18013             "optional": true,
18014             "field": "appdata",
18015             "description": ""
18016           },
18017           {
18018             "group": "Body",
18019             "type": "String",
18020             "optional": true,
18021             "field": "description",
18022             "description": ""
18023           },
18024           {
18025             "group": "Body",
18026             "type": "String",
18027             "optional": true,
18028             "field": "interval",
18029             "description": ""
18030           }
18031         ]
18032       }
18033     },
18034     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18035     "version": "0.0.0",
18036     "filename": "server/api/openchannelApplication/index.js",
18037     "groupTitle": "Openchannel_Applications"
18038   },
18039   {
18040     "type": "delete",
18041     "url": "/api/openchannel/applications/{id}",
18042     "title": "Deletes a Application",
18043     "examples": [
18044       {
18045         "title": "Example usage:",
18046         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
18047         "type": "json"
18048       }
18049     ],
18050     "name": "DeleteApplications",
18051     "group": "Openchannel_Applications",
18052     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18053     "version": "0.0.0",
18054     "filename": "server/api/openchannelApplication/index.js",
18055     "groupTitle": "Openchannel_Applications"
18056   },
18057   {
18058     "type": "get",
18059     "url": "/api/openchannel/applications",
18060     "title": "Gets a list of Applications",
18061     "examples": [
18062       {
18063         "title": "Example usage:",
18064         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
18065         "type": "json"
18066       }
18067     ],
18068     "name": "GetApplications",
18069     "group": "Openchannel_Applications",
18070     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18071     "version": "0.0.0",
18072     "filename": "server/api/openchannelApplication/index.js",
18073     "groupTitle": "Openchannel_Applications"
18074   },
18075   {
18076     "type": "get",
18077     "url": "/api/openchannel/applications/{id}",
18078     "title": "Gets a single Application",
18079     "examples": [
18080       {
18081         "title": "Example usage:",
18082         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18083         "type": "json"
18084       }
18085     ],
18086     "name": "ShowApplications",
18087     "group": "Openchannel_Applications",
18088     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18089     "version": "0.0.0",
18090     "filename": "server/api/openchannelApplication/index.js",
18091     "groupTitle": "Openchannel_Applications"
18092   },
18093   {
18094     "type": "put",
18095     "url": "/api/openchannel/applications/{id}",
18096     "title": "Update an existing Application",
18097     "examples": [
18098       {
18099         "title": "Example usage:",
18100         "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",
18101         "type": "json"
18102       }
18103     ],
18104     "name": "updateApplications",
18105     "group": "Openchannel_Applications",
18106     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18107     "version": "0.0.0",
18108     "filename": "server/api/openchannelApplication/index.js",
18109     "groupTitle": "Openchannel_Applications"
18110   },
18111   {
18112     "type": "post",
18113     "url": "/api/openchannel/interactions/{id}/tags",
18114     "title": "Add tags to the interaction",
18115     "examples": [
18116       {
18117         "title": "Example usage:",
18118         "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",
18119         "type": "json"
18120       }
18121     ],
18122     "name": "AddTags",
18123     "group": "Openchannel_Interactions",
18124     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18125     "version": "0.0.0",
18126     "filename": "server/api/openchannelInteraction/index.js",
18127     "groupTitle": "Openchannel_Interactions"
18128   },
18129   {
18130     "type": "post",
18131     "url": "/api/openchannel/interactions",
18132     "title": "Creates a new Interaction",
18133     "examples": [
18134       {
18135         "title": "Example usage:",
18136         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18137         "type": "json"
18138       }
18139     ],
18140     "name": "CreateInteractions",
18141     "group": "Openchannel_Interactions",
18142     "parameter": {
18143       "fields": {
18144         "Body": [
18145           {
18146             "group": "Body",
18147             "type": "Boolean",
18148             "optional": true,
18149             "field": "closed",
18150             "description": ""
18151           },
18152           {
18153             "group": "Body",
18154             "type": "String",
18155             "optional": true,
18156             "field": "closedAt",
18157             "description": ""
18158           },
18159           {
18160             "group": "Body",
18161             "type": "String",
18162             "optional": true,
18163             "field": "disposition",
18164             "description": ""
18165           },
18166           {
18167             "group": "Body",
18168             "type": "String",
18169             "optional": true,
18170             "field": "secondDisposition",
18171             "description": ""
18172           },
18173           {
18174             "group": "Body",
18175             "type": "String",
18176             "optional": true,
18177             "field": "thirdDisposition",
18178             "description": ""
18179           },
18180           {
18181             "group": "Body",
18182             "type": "String",
18183             "optional": true,
18184             "field": "note",
18185             "description": ""
18186           },
18187           {
18188             "group": "Body",
18189             "type": "String",
18190             "optional": true,
18191             "field": "read1stAt",
18192             "description": ""
18193           },
18194           {
18195             "group": "Body",
18196             "type": "String",
18197             "optional": true,
18198             "field": "threadId",
18199             "description": ""
18200           },
18201           {
18202             "group": "Body",
18203             "type": "String",
18204             "optional": true,
18205             "field": "externalUrl",
18206             "description": ""
18207           },
18208           {
18209             "group": "Body",
18210             "type": "String",
18211             "optional": true,
18212             "field": "lastMsgAt",
18213             "description": ""
18214           },
18215           {
18216             "group": "Body",
18217             "type": "String",
18218             "allowedValues": [
18219               "\"in\"",
18220               "\"out\""
18221             ],
18222             "optional": false,
18223             "field": "lastMsgDirection",
18224             "description": ""
18225           },
18226           {
18227             "group": "Body",
18228             "type": "String",
18229             "optional": true,
18230             "field": "from",
18231             "description": ""
18232           },
18233           {
18234             "group": "Body",
18235             "type": "Boolean",
18236             "optional": true,
18237             "field": "autoreplyExecuted",
18238             "description": ""
18239           }
18240         ]
18241       }
18242     },
18243     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18244     "version": "0.0.0",
18245     "filename": "server/api/openchannelInteraction/index.js",
18246     "groupTitle": "Openchannel_Interactions"
18247   },
18248   {
18249     "type": "delete",
18250     "url": "/api/openchannel/interactions/{id}",
18251     "title": "Deletes a Interaction",
18252     "examples": [
18253       {
18254         "title": "Example usage:",
18255         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18256         "type": "json"
18257       }
18258     ],
18259     "name": "DeleteInteractions",
18260     "group": "Openchannel_Interactions",
18261     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18262     "version": "0.0.0",
18263     "filename": "server/api/openchannelInteraction/index.js",
18264     "groupTitle": "Openchannel_Interactions"
18265   },
18266   {
18267     "type": "get",
18268     "url": "/api/openchannel/interactions/describe",
18269     "title": "Gets table info about Interactions",
18270     "examples": [
18271       {
18272         "title": "Example usage:",
18273         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18274         "type": "json"
18275       }
18276     ],
18277     "name": "DescribeInteractions",
18278     "group": "Openchannel_Interactions",
18279     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18280     "version": "0.0.0",
18281     "filename": "server/api/openchannelInteraction/index.js",
18282     "groupTitle": "Openchannel_Interactions"
18283   },
18284   {
18285     "type": "get",
18286     "url": "/api/openchannel/interactions",
18287     "title": "Gets a list of Interactions",
18288     "examples": [
18289       {
18290         "title": "Example usage:",
18291         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18292         "type": "json"
18293       }
18294     ],
18295     "name": "GetInteractions",
18296     "group": "Openchannel_Interactions",
18297     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18298     "version": "0.0.0",
18299     "filename": "server/api/openchannelInteraction/index.js",
18300     "groupTitle": "Openchannel_Interactions"
18301   },
18302   {
18303     "type": "delete",
18304     "url": "/api/openchannel/interactions/{id}/tags",
18305     "title": "Removes tags from interaction",
18306     "examples": [
18307       {
18308         "title": "Example usage:",
18309         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18310         "type": "json"
18311       }
18312     ],
18313     "name": "RemoveTags",
18314     "group": "Openchannel_Interactions",
18315     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18316     "version": "0.0.0",
18317     "filename": "server/api/openchannelInteraction/index.js",
18318     "groupTitle": "Openchannel_Interactions"
18319   },
18320   {
18321     "type": "get",
18322     "url": "/api/openchannel/interactions/{id}",
18323     "title": "Gets a single Interaction",
18324     "examples": [
18325       {
18326         "title": "Example usage:",
18327         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18328         "type": "json"
18329       }
18330     ],
18331     "name": "ShowInteractions",
18332     "group": "Openchannel_Interactions",
18333     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18334     "version": "0.0.0",
18335     "filename": "server/api/openchannelInteraction/index.js",
18336     "groupTitle": "Openchannel_Interactions"
18337   },
18338   {
18339     "type": "post",
18340     "url": "/api/openchannel/interactions/{id}/messages",
18341     "title": "Creates new messages",
18342     "examples": [
18343       {
18344         "title": "Example usage:",
18345         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18346         "type": "json"
18347       }
18348     ],
18349     "name": "addMessage",
18350     "group": "Openchannel_Interactions",
18351     "parameter": {
18352       "fields": {
18353         "Body": [
18354           {
18355             "group": "Body",
18356             "type": "Text",
18357             "optional": false,
18358             "field": "body",
18359             "description": ""
18360           },
18361           {
18362             "group": "Body",
18363             "type": "Boolean",
18364             "optional": true,
18365             "field": "read",
18366             "description": ""
18367           },
18368           {
18369             "group": "Body",
18370             "type": "Boolean",
18371             "optional": true,
18372             "field": "secret",
18373             "description": ""
18374           },
18375           {
18376             "group": "Body",
18377             "type": "String",
18378             "allowedValues": [
18379               "\"in\"",
18380               "\"out\""
18381             ],
18382             "optional": false,
18383             "field": "direction",
18384             "description": ""
18385           },
18386           {
18387             "group": "Body",
18388             "type": "String",
18389             "optional": true,
18390             "field": "readAt",
18391             "description": ""
18392           },
18393           {
18394             "group": "Body",
18395             "type": "String",
18396             "optional": true,
18397             "field": "providerName",
18398             "description": ""
18399           },
18400           {
18401             "group": "Body",
18402             "type": "Text",
18403             "optional": true,
18404             "field": "providerResponse",
18405             "description": ""
18406           }
18407         ]
18408       }
18409     },
18410     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18411     "version": "0.0.0",
18412     "filename": "server/api/openchannelInteraction/index.js",
18413     "groupTitle": "Openchannel_Interactions"
18414   },
18415   {
18416     "type": "get",
18417     "url": "/api/openchannel/interactions/{id}/download",
18418     "title": "Gets interaction",
18419     "examples": [
18420       {
18421         "title": "Example usage:",
18422         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18423         "type": "json"
18424       }
18425     ],
18426     "name": "download",
18427     "group": "Openchannel_Interactions",
18428     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18429     "version": "0.0.0",
18430     "filename": "server/api/openchannelInteraction/index.js",
18431     "groupTitle": "Openchannel_Interactions"
18432   },
18433   {
18434     "type": "get",
18435     "url": "/api/openchannel/interactions/{id}/messages",
18436     "title": "Gets interaction messages",
18437     "examples": [
18438       {
18439         "title": "Example usage:",
18440         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18441         "type": "json"
18442       }
18443     ],
18444     "name": "getMessages",
18445     "group": "Openchannel_Interactions",
18446     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18447     "version": "0.0.0",
18448     "filename": "server/api/openchannelInteraction/index.js",
18449     "groupTitle": "Openchannel_Interactions"
18450   },
18451   {
18452     "type": "put",
18453     "url": "/api/openchannel/interactions/{id}",
18454     "title": "Update an existing Interaction",
18455     "examples": [
18456       {
18457         "title": "Example usage:",
18458         "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",
18459         "type": "json"
18460       }
18461     ],
18462     "name": "updateInteractions",
18463     "group": "Openchannel_Interactions",
18464     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18465     "version": "0.0.0",
18466     "filename": "server/api/openchannelInteraction/index.js",
18467     "groupTitle": "Openchannel_Interactions"
18468   },
18469   {
18470     "type": "post",
18471     "url": "/api/openchannel/messages",
18472     "title": "Creates a new Message",
18473     "examples": [
18474       {
18475         "title": "Example usage:",
18476         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18477         "type": "json"
18478       }
18479     ],
18480     "name": "CreateMessages",
18481     "group": "Openchannel_Messages",
18482     "parameter": {
18483       "fields": {
18484         "Body": [
18485           {
18486             "group": "Body",
18487             "type": "Text",
18488             "optional": false,
18489             "field": "body",
18490             "description": ""
18491           },
18492           {
18493             "group": "Body",
18494             "type": "Boolean",
18495             "optional": true,
18496             "field": "read",
18497             "description": ""
18498           },
18499           {
18500             "group": "Body",
18501             "type": "Boolean",
18502             "optional": true,
18503             "field": "secret",
18504             "description": ""
18505           },
18506           {
18507             "group": "Body",
18508             "type": "String",
18509             "allowedValues": [
18510               "\"in\"",
18511               "\"out\""
18512             ],
18513             "optional": false,
18514             "field": "direction",
18515             "description": ""
18516           },
18517           {
18518             "group": "Body",
18519             "type": "String",
18520             "optional": true,
18521             "field": "readAt",
18522             "description": ""
18523           },
18524           {
18525             "group": "Body",
18526             "type": "String",
18527             "optional": true,
18528             "field": "providerName",
18529             "description": ""
18530           },
18531           {
18532             "group": "Body",
18533             "type": "Text",
18534             "optional": true,
18535             "field": "providerResponse",
18536             "description": ""
18537           }
18538         ]
18539       }
18540     },
18541     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18542     "version": "0.0.0",
18543     "filename": "server/api/openchannelMessage/index.js",
18544     "groupTitle": "Openchannel_Messages"
18545   },
18546   {
18547     "type": "delete",
18548     "url": "/api/openchannel/messages/{id}",
18549     "title": "Deletes a Message",
18550     "examples": [
18551       {
18552         "title": "Example usage:",
18553         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18554         "type": "json"
18555       }
18556     ],
18557     "name": "DeleteMessages",
18558     "group": "Openchannel_Messages",
18559     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18560     "version": "0.0.0",
18561     "filename": "server/api/openchannelMessage/index.js",
18562     "groupTitle": "Openchannel_Messages"
18563   },
18564   {
18565     "type": "get",
18566     "url": "/api/openchannel/messages/describe",
18567     "title": "Gets table info about Messages",
18568     "examples": [
18569       {
18570         "title": "Example usage:",
18571         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18572         "type": "json"
18573       }
18574     ],
18575     "name": "DescribeMessages",
18576     "group": "Openchannel_Messages",
18577     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18578     "version": "0.0.0",
18579     "filename": "server/api/openchannelMessage/index.js",
18580     "groupTitle": "Openchannel_Messages"
18581   },
18582   {
18583     "type": "get",
18584     "url": "/api/openchannel/messages",
18585     "title": "Gets a list of Messages",
18586     "examples": [
18587       {
18588         "title": "Example usage:",
18589         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18590         "type": "json"
18591       }
18592     ],
18593     "name": "GetMessages",
18594     "group": "Openchannel_Messages",
18595     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18596     "version": "0.0.0",
18597     "filename": "server/api/openchannelMessage/index.js",
18598     "groupTitle": "Openchannel_Messages"
18599   },
18600   {
18601     "type": "get",
18602     "url": "/api/openchannel/messages/{id}",
18603     "title": "Gets a single Message",
18604     "examples": [
18605       {
18606         "title": "Example usage:",
18607         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18608         "type": "json"
18609       }
18610     ],
18611     "name": "ShowMessages",
18612     "group": "Openchannel_Messages",
18613     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18614     "version": "0.0.0",
18615     "filename": "server/api/openchannelMessage/index.js",
18616     "groupTitle": "Openchannel_Messages"
18617   },
18618   {
18619     "type": "put",
18620     "url": "/api/openchannel/messages/{id}/accept",
18621     "title": "Accepts message",
18622     "examples": [
18623       {
18624         "title": "Example usage:",
18625         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18626         "type": "json"
18627       }
18628     ],
18629     "name": "acceptMessage",
18630     "group": "Openchannel_Messages",
18631     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18632     "version": "0.0.0",
18633     "filename": "server/api/openchannelMessage/index.js",
18634     "groupTitle": "Openchannel_Messages"
18635   },
18636   {
18637     "type": "put",
18638     "url": "/api/openchannel/messages/{id}/reject",
18639     "title": "Rejects message",
18640     "examples": [
18641       {
18642         "title": "Example usage:",
18643         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18644         "type": "json"
18645       }
18646     ],
18647     "name": "rejectMessage",
18648     "group": "Openchannel_Messages",
18649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18650     "version": "0.0.0",
18651     "filename": "server/api/openchannelMessage/index.js",
18652     "groupTitle": "Openchannel_Messages"
18653   },
18654   {
18655     "type": "put",
18656     "url": "/api/openchannel/messages/{id}",
18657     "title": "Update an existing Message",
18658     "examples": [
18659       {
18660         "title": "Example usage:",
18661         "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",
18662         "type": "json"
18663       }
18664     ],
18665     "name": "updateMessages",
18666     "group": "Openchannel_Messages",
18667     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18668     "version": "0.0.0",
18669     "filename": "server/api/openchannelMessage/index.js",
18670     "groupTitle": "Openchannel_Messages"
18671   },
18672   {
18673     "type": "post",
18674     "url": "/api/openchannel/reports/queue",
18675     "title": "Creates a new Openchannel Queue Report",
18676     "examples": [
18677       {
18678         "title": "Example usage:",
18679         "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",
18680         "type": "json"
18681       }
18682     ],
18683     "name": "CreateOpenchannel_Queue_Reports",
18684     "group": "Openchannel_Queue_Reports",
18685     "parameter": {
18686       "fields": {
18687         "Body": [
18688           {
18689             "group": "Body",
18690             "type": "String",
18691             "optional": false,
18692             "field": "uniqueid",
18693             "description": ""
18694           },
18695           {
18696             "group": "Body",
18697             "type": "String",
18698             "optional": true,
18699             "field": "from",
18700             "description": ""
18701           },
18702           {
18703             "group": "Body",
18704             "type": "String",
18705             "optional": true,
18706             "field": "joinAt",
18707             "description": ""
18708           },
18709           {
18710             "group": "Body",
18711             "type": "String",
18712             "optional": true,
18713             "field": "leaveAt",
18714             "description": ""
18715           },
18716           {
18717             "group": "Body",
18718             "type": "String",
18719             "optional": true,
18720             "field": "acceptAt",
18721             "description": ""
18722           },
18723           {
18724             "group": "Body",
18725             "type": "String",
18726             "optional": true,
18727             "field": "exitAt",
18728             "description": ""
18729           },
18730           {
18731             "group": "Body",
18732             "type": "String",
18733             "optional": true,
18734             "field": "reason",
18735             "description": ""
18736           }
18737         ]
18738       }
18739     },
18740     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18741     "version": "0.0.0",
18742     "filename": "server/api/openchannelQueueReport/index.js",
18743     "groupTitle": "Openchannel_Queue_Reports"
18744   },
18745   {
18746     "type": "delete",
18747     "url": "/api/openchannel/reports/queue/{id}",
18748     "title": "Deletes a Openchannel Queue Report",
18749     "examples": [
18750       {
18751         "title": "Example usage:",
18752         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18753         "type": "json"
18754       }
18755     ],
18756     "name": "DeleteOpenchannel_Queue_Reports",
18757     "group": "Openchannel_Queue_Reports",
18758     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18759     "version": "0.0.0",
18760     "filename": "server/api/openchannelQueueReport/index.js",
18761     "groupTitle": "Openchannel_Queue_Reports"
18762   },
18763   {
18764     "type": "get",
18765     "url": "/api/openchannel/reports/queue/describe",
18766     "title": "Gets table info about Openchannel Queue Reports",
18767     "examples": [
18768       {
18769         "title": "Example usage:",
18770         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18771         "type": "json"
18772       }
18773     ],
18774     "name": "DescribeOpenchannel_Queue_Reports",
18775     "group": "Openchannel_Queue_Reports",
18776     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18777     "version": "0.0.0",
18778     "filename": "server/api/openchannelQueueReport/index.js",
18779     "groupTitle": "Openchannel_Queue_Reports"
18780   },
18781   {
18782     "type": "get",
18783     "url": "/api/openchannel/reports/queue",
18784     "title": "Gets a list of Openchannel Queue Reports",
18785     "examples": [
18786       {
18787         "title": "Example usage:",
18788         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18789         "type": "json"
18790       }
18791     ],
18792     "name": "GetOpenchannel_Queue_Reports",
18793     "group": "Openchannel_Queue_Reports",
18794     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18795     "version": "0.0.0",
18796     "filename": "server/api/openchannelQueueReport/index.js",
18797     "groupTitle": "Openchannel_Queue_Reports"
18798   },
18799   {
18800     "type": "get",
18801     "url": "/api/openchannel/reports/queue/{id}",
18802     "title": "Gets a single Openchannel Queue Report",
18803     "examples": [
18804       {
18805         "title": "Example usage:",
18806         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18807         "type": "json"
18808       }
18809     ],
18810     "name": "ShowOpenchannel_Queue_Reports",
18811     "group": "Openchannel_Queue_Reports",
18812     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18813     "version": "0.0.0",
18814     "filename": "server/api/openchannelQueueReport/index.js",
18815     "groupTitle": "Openchannel_Queue_Reports"
18816   },
18817   {
18818     "type": "put",
18819     "url": "/api/openchannel/reports/queue/{id}",
18820     "title": "Update an existing Openchannel Queue Report",
18821     "examples": [
18822       {
18823         "title": "Example usage:",
18824         "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",
18825         "type": "json"
18826       }
18827     ],
18828     "name": "updateOpenchannel_Queue_Reports",
18829     "group": "Openchannel_Queue_Reports",
18830     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18831     "version": "0.0.0",
18832     "filename": "server/api/openchannelQueueReport/index.js",
18833     "groupTitle": "Openchannel_Queue_Reports"
18834   },
18835   {
18836     "type": "post",
18837     "url": "/api/openchannel/queues/{id}/users",
18838     "title": "Add agents to a queue",
18839     "examples": [
18840       {
18841         "title": "Example usage:",
18842         "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",
18843         "type": "json"
18844       }
18845     ],
18846     "name": "AddAgents",
18847     "group": "Openchannel_Queues",
18848     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18849     "version": "0.0.0",
18850     "filename": "server/api/openchannelQueue/index.js",
18851     "groupTitle": "Openchannel_Queues"
18852   },
18853   {
18854     "type": "post",
18855     "url": "/api/openchannel/queues/{id}/teams",
18856     "title": "Add teams to a queue",
18857     "examples": [
18858       {
18859         "title": "Example usage:",
18860         "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",
18861         "type": "json"
18862       }
18863     ],
18864     "name": "AddTeams",
18865     "group": "Openchannel_Queues",
18866     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18867     "version": "0.0.0",
18868     "filename": "server/api/openchannelQueue/index.js",
18869     "groupTitle": "Openchannel_Queues"
18870   },
18871   {
18872     "type": "post",
18873     "url": "/api/openchannel/queues",
18874     "title": "Creates a new Queue",
18875     "examples": [
18876       {
18877         "title": "Example usage:",
18878         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18879         "type": "json"
18880       }
18881     ],
18882     "name": "CreateQueues",
18883     "group": "Openchannel_Queues",
18884     "parameter": {
18885       "fields": {
18886         "Body": [
18887           {
18888             "group": "Body",
18889             "type": "String",
18890             "optional": true,
18891             "field": "name",
18892             "description": ""
18893           },
18894           {
18895             "group": "Body",
18896             "type": "String",
18897             "optional": true,
18898             "field": "description",
18899             "description": ""
18900           },
18901           {
18902             "group": "Body",
18903             "type": "Integer",
18904             "optional": true,
18905             "field": "timeout",
18906             "description": ""
18907           },
18908           {
18909             "group": "Body",
18910             "type": "String",
18911             "allowedValues": [
18912               "\"rrmemory\"",
18913               "\"beepall\"",
18914               "\"roundrobin\""
18915             ],
18916             "optional": true,
18917             "field": "strategy",
18918             "description": ""
18919           }
18920         ]
18921       }
18922     },
18923     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18924     "version": "0.0.0",
18925     "filename": "server/api/openchannelQueue/index.js",
18926     "groupTitle": "Openchannel_Queues"
18927   },
18928   {
18929     "type": "delete",
18930     "url": "/api/openchannel/queues/{id}",
18931     "title": "Deletes a Queue",
18932     "examples": [
18933       {
18934         "title": "Example usage:",
18935         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18936         "type": "json"
18937       }
18938     ],
18939     "name": "DeleteQueues",
18940     "group": "Openchannel_Queues",
18941     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18942     "version": "0.0.0",
18943     "filename": "server/api/openchannelQueue/index.js",
18944     "groupTitle": "Openchannel_Queues"
18945   },
18946   {
18947     "type": "get",
18948     "url": "/api/openchannel/queues/describe",
18949     "title": "Gets table info about Queues",
18950     "examples": [
18951       {
18952         "title": "Example usage:",
18953         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18954         "type": "json"
18955       }
18956     ],
18957     "name": "DescribeQueues",
18958     "group": "Openchannel_Queues",
18959     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18960     "version": "0.0.0",
18961     "filename": "server/api/openchannelQueue/index.js",
18962     "groupTitle": "Openchannel_Queues"
18963   },
18964   {
18965     "type": "get",
18966     "url": "/api/openchannel/queues/{id}/users",
18967     "title": "Gets queue agents",
18968     "examples": [
18969       {
18970         "title": "Example usage:",
18971         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18972         "type": "json"
18973       }
18974     ],
18975     "name": "GetAgents",
18976     "group": "Openchannel_Queues",
18977     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18978     "version": "0.0.0",
18979     "filename": "server/api/openchannelQueue/index.js",
18980     "groupTitle": "Openchannel_Queues"
18981   },
18982   {
18983     "type": "get",
18984     "url": "/api/openchannel/queues/{id}/members",
18985     "title": "GetMembers",
18986     "examples": [
18987       {
18988         "title": "Example usage:",
18989         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
18990         "type": "json"
18991       }
18992     ],
18993     "name": "GetMembers",
18994     "group": "Openchannel_Queues",
18995     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18996     "version": "0.0.0",
18997     "filename": "server/api/openchannelQueue/index.js",
18998     "groupTitle": "Openchannel_Queues"
18999   },
19000   {
19001     "type": "get",
19002     "url": "/api/openchannel/queues",
19003     "title": "Gets a list of Queues",
19004     "examples": [
19005       {
19006         "title": "Example usage:",
19007         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
19008         "type": "json"
19009       }
19010     ],
19011     "name": "GetQueues",
19012     "group": "Openchannel_Queues",
19013     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19014     "version": "0.0.0",
19015     "filename": "server/api/openchannelQueue/index.js",
19016     "groupTitle": "Openchannel_Queues"
19017   },
19018   {
19019     "type": "get",
19020     "url": "/api/openchannel/queues/{id}/teams",
19021     "title": "Gets queues list",
19022     "examples": [
19023       {
19024         "title": "Example usage:",
19025         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
19026         "type": "json"
19027       }
19028     ],
19029     "name": "GetTeams",
19030     "group": "Openchannel_Queues",
19031     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19032     "version": "0.0.0",
19033     "filename": "server/api/openchannelQueue/index.js",
19034     "groupTitle": "Openchannel_Queues"
19035   },
19036   {
19037     "type": "delete",
19038     "url": "/api/openchannel/queues/{id}/users",
19039     "title": "Removes agents from a queue",
19040     "examples": [
19041       {
19042         "title": "Example usage:",
19043         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19044         "type": "json"
19045       }
19046     ],
19047     "name": "RemoveAgents",
19048     "group": "Openchannel_Queues",
19049     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19050     "version": "0.0.0",
19051     "filename": "server/api/openchannelQueue/index.js",
19052     "groupTitle": "Openchannel_Queues"
19053   },
19054   {
19055     "type": "get",
19056     "url": "/api/openchannel/queues/{id}",
19057     "title": "Gets a single Queue",
19058     "examples": [
19059       {
19060         "title": "Example usage:",
19061         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
19062         "type": "json"
19063       }
19064     ],
19065     "name": "ShowQueues",
19066     "group": "Openchannel_Queues",
19067     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19068     "version": "0.0.0",
19069     "filename": "server/api/openchannelQueue/index.js",
19070     "groupTitle": "Openchannel_Queues"
19071   },
19072   {
19073     "type": "put",
19074     "url": "/api/openchannel/queues/{id}",
19075     "title": "Update an existing Queue",
19076     "examples": [
19077       {
19078         "title": "Example usage:",
19079         "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",
19080         "type": "json"
19081       }
19082     ],
19083     "name": "updateQueues",
19084     "group": "Openchannel_Queues",
19085     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19086     "version": "0.0.0",
19087     "filename": "server/api/openchannelQueue/index.js",
19088     "groupTitle": "Openchannel_Queues"
19089   },
19090   {
19091     "type": "post",
19092     "url": "/api/openchannel/reports/transfer",
19093     "title": "Creates a new Openchannel Transfer Report",
19094     "examples": [
19095       {
19096         "title": "Example usage:",
19097         "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",
19098         "type": "json"
19099       }
19100     ],
19101     "name": "CreateOpenchannel_Transfer_Reports",
19102     "group": "Openchannel_Transfer_Reports",
19103     "parameter": {
19104       "fields": {
19105         "Body": [
19106           {
19107             "group": "Body",
19108             "type": "String",
19109             "optional": false,
19110             "field": "uniqueid",
19111             "description": ""
19112           },
19113           {
19114             "group": "Body",
19115             "type": "String",
19116             "allowedValues": [
19117               "\"account\"",
19118               "\"agent\"",
19119               "\"queue\""
19120             ],
19121             "optional": false,
19122             "field": "type",
19123             "description": ""
19124           },
19125           {
19126             "group": "Body",
19127             "type": "String",
19128             "optional": false,
19129             "field": "transferredAt",
19130             "description": ""
19131           }
19132         ]
19133       }
19134     },
19135     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19136     "version": "0.0.0",
19137     "filename": "server/api/openchannelTransferReport/index.js",
19138     "groupTitle": "Openchannel_Transfer_Reports"
19139   },
19140   {
19141     "type": "delete",
19142     "url": "/api/openchannel/reports/transfer/{id}",
19143     "title": "Deletes a Openchannel Transfer Report",
19144     "examples": [
19145       {
19146         "title": "Example usage:",
19147         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19148         "type": "json"
19149       }
19150     ],
19151     "name": "DeleteOpenchannel_Transfer_Reports",
19152     "group": "Openchannel_Transfer_Reports",
19153     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19154     "version": "0.0.0",
19155     "filename": "server/api/openchannelTransferReport/index.js",
19156     "groupTitle": "Openchannel_Transfer_Reports"
19157   },
19158   {
19159     "type": "get",
19160     "url": "/api/openchannel/reports/transfer/describe",
19161     "title": "Gets table info about Openchannel Transfer Reports",
19162     "examples": [
19163       {
19164         "title": "Example usage:",
19165         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19166         "type": "json"
19167       }
19168     ],
19169     "name": "DescribeOpenchannel_Transfer_Reports",
19170     "group": "Openchannel_Transfer_Reports",
19171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19172     "version": "0.0.0",
19173     "filename": "server/api/openchannelTransferReport/index.js",
19174     "groupTitle": "Openchannel_Transfer_Reports"
19175   },
19176   {
19177     "type": "get",
19178     "url": "/api/openchannel/reports/transfer",
19179     "title": "Gets a list of Openchannel Transfer Reports",
19180     "examples": [
19181       {
19182         "title": "Example usage:",
19183         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19184         "type": "json"
19185       }
19186     ],
19187     "name": "GetOpenchannel_Transfer_Reports",
19188     "group": "Openchannel_Transfer_Reports",
19189     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19190     "version": "0.0.0",
19191     "filename": "server/api/openchannelTransferReport/index.js",
19192     "groupTitle": "Openchannel_Transfer_Reports"
19193   },
19194   {
19195     "type": "get",
19196     "url": "/api/openchannel/reports/transfer/{id}",
19197     "title": "Gets a single Openchannel Transfer Report",
19198     "examples": [
19199       {
19200         "title": "Example usage:",
19201         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19202         "type": "json"
19203       }
19204     ],
19205     "name": "ShowOpenchannel_Transfer_Reports",
19206     "group": "Openchannel_Transfer_Reports",
19207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19208     "version": "0.0.0",
19209     "filename": "server/api/openchannelTransferReport/index.js",
19210     "groupTitle": "Openchannel_Transfer_Reports"
19211   },
19212   {
19213     "type": "put",
19214     "url": "/api/openchannel/reports/transfer/{id}",
19215     "title": "Update an existing Openchannel Transfer Report",
19216     "examples": [
19217       {
19218         "title": "Example usage:",
19219         "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",
19220         "type": "json"
19221       }
19222     ],
19223     "name": "updateOpenchannel_Transfer_Reports",
19224     "group": "Openchannel_Transfer_Reports",
19225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19226     "version": "0.0.0",
19227     "filename": "server/api/openchannelTransferReport/index.js",
19228     "groupTitle": "Openchannel_Transfer_Reports"
19229   },
19230   {
19231     "type": "post",
19232     "url": "/api/pauses",
19233     "title": "Creates a new Pause",
19234     "examples": [
19235       {
19236         "title": "Example usage:",
19237         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19238         "type": "json"
19239       }
19240     ],
19241     "name": "CreatePauses",
19242     "group": "Pauses",
19243     "parameter": {
19244       "fields": {
19245         "Body": [
19246           {
19247             "group": "Body",
19248             "type": "String",
19249             "optional": false,
19250             "field": "name",
19251             "description": ""
19252           },
19253           {
19254             "group": "Body",
19255             "type": "String",
19256             "optional": true,
19257             "field": "description",
19258             "description": ""
19259           }
19260         ]
19261       }
19262     },
19263     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19264     "version": "0.0.0",
19265     "filename": "server/api/pause/index.js",
19266     "groupTitle": "Pauses"
19267   },
19268   {
19269     "type": "delete",
19270     "url": "/api/pauses/{id}",
19271     "title": "Deletes a Pause",
19272     "examples": [
19273       {
19274         "title": "Example usage:",
19275         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19276         "type": "json"
19277       }
19278     ],
19279     "name": "DeletePauses",
19280     "group": "Pauses",
19281     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19282     "version": "0.0.0",
19283     "filename": "server/api/pause/index.js",
19284     "groupTitle": "Pauses"
19285   },
19286   {
19287     "type": "get",
19288     "url": "/api/pauses",
19289     "title": "Gets a list of Pauses",
19290     "examples": [
19291       {
19292         "title": "Example usage:",
19293         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19294         "type": "json"
19295       }
19296     ],
19297     "name": "GetPauses",
19298     "group": "Pauses",
19299     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19300     "version": "0.0.0",
19301     "filename": "server/api/pause/index.js",
19302     "groupTitle": "Pauses"
19303   },
19304   {
19305     "type": "get",
19306     "url": "/api/pauses/{id}",
19307     "title": "Gets a single Pause",
19308     "examples": [
19309       {
19310         "title": "Example usage:",
19311         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19312         "type": "json"
19313       }
19314     ],
19315     "name": "ShowPauses",
19316     "group": "Pauses",
19317     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19318     "version": "0.0.0",
19319     "filename": "server/api/pause/index.js",
19320     "groupTitle": "Pauses"
19321   },
19322   {
19323     "type": "put",
19324     "url": "/api/pauses/{id}",
19325     "title": "Update an existing Pause",
19326     "examples": [
19327       {
19328         "title": "Example usage:",
19329         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19330         "type": "json"
19331       }
19332     ],
19333     "name": "updatePauses",
19334     "group": "Pauses",
19335     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19336     "version": "0.0.0",
19337     "filename": "server/api/pause/index.js",
19338     "groupTitle": "Pauses"
19339   },
19340   {
19341     "type": "get",
19342     "url": "/api/plugins",
19343     "title": "Gets a list of Plugins",
19344     "examples": [
19345       {
19346         "title": "Example usage:",
19347         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19348         "type": "json"
19349       }
19350     ],
19351     "name": "GetPlugins",
19352     "group": "Plugins",
19353     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19354     "version": "0.0.0",
19355     "filename": "server/api/plugin/index.js",
19356     "groupTitle": "Plugins"
19357   },
19358   {
19359     "type": "get",
19360     "url": "/api/plugins/{id}",
19361     "title": "Gets a single Plugin",
19362     "examples": [
19363       {
19364         "title": "Example usage:",
19365         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19366         "type": "json"
19367       }
19368     ],
19369     "name": "ShowPlugins",
19370     "group": "Plugins",
19371     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19372     "version": "0.0.0",
19373     "filename": "server/api/plugin/index.js",
19374     "groupTitle": "Plugins"
19375   },
19376   {
19377     "type": "delete",
19378     "url": "/api/plugins/{id}",
19379     "title": "Delete a plugin",
19380     "examples": [
19381       {
19382         "title": "Example usage:",
19383         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19384         "type": "json"
19385       }
19386     ],
19387     "name": "destroyPlugin",
19388     "group": "Plugins",
19389     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19390     "version": "0.0.0",
19391     "filename": "server/api/plugin/index.js",
19392     "groupTitle": "Plugins"
19393   },
19394   {
19395     "type": "get",
19396     "url": "/api/plugins/{id}/download",
19397     "title": "Download plugin source code",
19398     "examples": [
19399       {
19400         "title": "Example usage:",
19401         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19402         "type": "json"
19403       }
19404     ],
19405     "name": "download",
19406     "group": "Plugins",
19407     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19408     "version": "0.0.0",
19409     "filename": "server/api/plugin/index.js",
19410     "groupTitle": "Plugins"
19411   },
19412   {
19413     "type": "put",
19414     "url": "/api/plugins/{id}",
19415     "title": "Update an existing plugin",
19416     "examples": [
19417       {
19418         "title": "Example usage:",
19419         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19420         "type": "json"
19421       }
19422     ],
19423     "name": "updatePlugin",
19424     "group": "Plugins",
19425     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19426     "version": "0.0.0",
19427     "filename": "server/api/plugin/index.js",
19428     "groupTitle": "Plugins"
19429   },
19430   {
19431     "type": "post",
19432     "url": "/api/plugins",
19433     "title": "Upload new plugin",
19434     "examples": [
19435       {
19436         "title": "Example usage:",
19437         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19438         "type": "json"
19439       }
19440     ],
19441     "name": "uploadPlugin",
19442     "group": "Plugins",
19443     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19444     "version": "0.0.0",
19445     "filename": "server/api/plugin/index.js",
19446     "groupTitle": "Plugins"
19447   },
19448   {
19449     "type": "post",
19450     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19451     "title": "Redirect a plugin request to the specified path",
19452     "examples": [
19453       {
19454         "title": "Example usage:",
19455         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19456         "type": "json"
19457       }
19458     ],
19459     "name": "webhookPlugin",
19460     "group": "Plugins",
19461     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19462     "version": "0.0.0",
19463     "filename": "server/api/plugin/index.js",
19464     "groupTitle": "Plugins"
19465   },
19466   {
19467     "type": "get",
19468     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19469     "title": "Redirect a plugin request to the specified path",
19470     "examples": [
19471       {
19472         "title": "Example usage:",
19473         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19474         "type": "json"
19475       }
19476     ],
19477     "name": "webhookPlugin",
19478     "group": "Plugins",
19479     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19480     "version": "0.0.0",
19481     "filename": "server/api/plugin/index.js",
19482     "groupTitle": "Plugins"
19483   },
19484   {
19485     "type": "delete",
19486     "url": "/api/pm2/{id}",
19487     "title": "Deletes an existing process",
19488     "examples": [
19489       {
19490         "title": "Example usage:",
19491         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19492         "type": "json"
19493       }
19494     ],
19495     "name": "DeletePm2Process",
19496     "group": "Pm2",
19497     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19498     "version": "0.0.0",
19499     "filename": "server/api/pm2/index.js",
19500     "groupTitle": "Pm2"
19501   },
19502   {
19503     "type": "get",
19504     "url": "/api/pm2/{id}",
19505     "title": "Gets a single pm2 process",
19506     "examples": [
19507       {
19508         "title": "Example usage:",
19509         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19510         "type": "json"
19511       }
19512     ],
19513     "name": "GetPm2Process",
19514     "group": "Pm2",
19515     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19516     "version": "0.0.0",
19517     "filename": "server/api/pm2/index.js",
19518     "groupTitle": "Pm2"
19519   },
19520   {
19521     "type": "get",
19522     "url": "/api/pm2",
19523     "title": "Gets pm2 processes",
19524     "examples": [
19525       {
19526         "title": "Example usage:",
19527         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19528         "type": "json"
19529       }
19530     ],
19531     "name": "GetPm2Processes",
19532     "group": "Pm2",
19533     "description": "<p>Motion returns the pm2 processes list.</p>",
19534     "version": "0.0.0",
19535     "filename": "server/api/pm2/index.js",
19536     "groupTitle": "Pm2"
19537   },
19538   {
19539     "type": "post",
19540     "url": "/api/pm2",
19541     "title": "Start a single pm2 process",
19542     "examples": [
19543       {
19544         "title": "Example usage:",
19545         "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",
19546         "type": "json"
19547       }
19548     ],
19549     "name": "StartPm2Process",
19550     "group": "Pm2",
19551     "parameter": {
19552       "fields": {
19553         "Body": [
19554           {
19555             "group": "Body",
19556             "type": "String",
19557             "optional": false,
19558             "field": "name",
19559             "description": ""
19560           },
19561           {
19562             "group": "Body",
19563             "type": "String",
19564             "optional": false,
19565             "field": "script",
19566             "description": ""
19567           }
19568         ]
19569       }
19570     },
19571     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19572     "version": "0.0.0",
19573     "filename": "server/api/pm2/index.js",
19574     "groupTitle": "Pm2"
19575   },
19576   {
19577     "type": "put",
19578     "url": "/api/pm2/{id}",
19579     "title": "Update an existing process",
19580     "examples": [
19581       {
19582         "title": "Example usage:",
19583         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19584         "type": "json"
19585       }
19586     ],
19587     "name": "UpdatePm2Process",
19588     "group": "Pm2",
19589     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19590     "version": "0.0.0",
19591     "filename": "server/api/pm2/index.js",
19592     "groupTitle": "Pm2"
19593   },
19594   {
19595     "type": "get",
19596     "url": "/api/rpc/campaigns/",
19597     "title": "Gets a list of campaigns",
19598     "examples": [
19599       {
19600         "title": "Example usage:",
19601         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19602         "type": "json"
19603       }
19604     ],
19605     "name": "Campaigns",
19606     "group": "RPC_Realtime",
19607     "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>",
19608     "version": "0.0.0",
19609     "filename": "server/api/rpc/index.js",
19610     "groupTitle": "RPC_Realtime"
19611   },
19612   {
19613     "type": "get",
19614     "url": "/api/rpc/fax/accounts",
19615     "title": "Gets a list of FaxAccounts",
19616     "examples": [
19617       {
19618         "title": "Example usage:",
19619         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19620         "type": "json"
19621       }
19622     ],
19623     "name": "FaxAccounts",
19624     "group": "RPC_Realtime",
19625     "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>",
19626     "version": "0.0.0",
19627     "filename": "server/api/rpc/index.js",
19628     "groupTitle": "RPC_Realtime"
19629   },
19630   {
19631     "type": "put",
19632     "url": "/api/rpc/agents/:id/capacity",
19633     "title": "Sets agent capacity",
19634     "examples": [
19635       {
19636         "title": "Example usage:",
19637         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19638         "type": "json"
19639       }
19640     ],
19641     "name": "RTAgentCapacity",
19642     "group": "RPC_Realtime",
19643     "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>",
19644     "version": "0.0.0",
19645     "filename": "server/api/rpc/index.js",
19646     "groupTitle": "RPC_Realtime"
19647   },
19648   {
19649     "type": "get",
19650     "url": "/api/rpc/agents",
19651     "title": "Gets a list of RTAgents",
19652     "examples": [
19653       {
19654         "title": "Example usage:",
19655         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19656         "type": "json"
19657       }
19658     ],
19659     "name": "RTAgents",
19660     "group": "RPC_Realtime",
19661     "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>",
19662     "version": "0.0.0",
19663     "filename": "server/api/rpc/index.js",
19664     "groupTitle": "RPC_Realtime"
19665   },
19666   {
19667     "type": "get",
19668     "url": "/api/rpc/chat/queues",
19669     "title": "Gets a list of RTChatQueues",
19670     "examples": [
19671       {
19672         "title": "Example usage:",
19673         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19674         "type": "json"
19675       }
19676     ],
19677     "name": "RTChatQueues",
19678     "group": "RPC_Realtime",
19679     "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>",
19680     "version": "0.0.0",
19681     "filename": "server/api/rpc/index.js",
19682     "groupTitle": "RPC_Realtime"
19683   },
19684   {
19685     "type": "get",
19686     "url": "/api/rpc/fax/queues",
19687     "title": "Gets a list of RTFaxQueues",
19688     "examples": [
19689       {
19690         "title": "Example usage:",
19691         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19692         "type": "json"
19693       }
19694     ],
19695     "name": "RTFaxQueues",
19696     "group": "RPC_Realtime",
19697     "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>",
19698     "version": "0.0.0",
19699     "filename": "server/api/rpc/index.js",
19700     "groupTitle": "RPC_Realtime"
19701   },
19702   {
19703     "type": "get",
19704     "url": "/api/rpc/mail/accounts",
19705     "title": "Gets a list of RTMailAccounts",
19706     "examples": [
19707       {
19708         "title": "Example usage:",
19709         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19710         "type": "json"
19711       }
19712     ],
19713     "name": "RTMailAccounts",
19714     "group": "RPC_Realtime",
19715     "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>",
19716     "version": "0.0.0",
19717     "filename": "server/api/rpc/index.js",
19718     "groupTitle": "RPC_Realtime"
19719   },
19720   {
19721     "type": "get",
19722     "url": "/api/rpc/mail/queues",
19723     "title": "Gets a list of RTMailQueues",
19724     "examples": [
19725       {
19726         "title": "Example usage:",
19727         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19728         "type": "json"
19729       }
19730     ],
19731     "name": "RTMailQueues",
19732     "group": "RPC_Realtime",
19733     "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>",
19734     "version": "0.0.0",
19735     "filename": "server/api/rpc/index.js",
19736     "groupTitle": "RPC_Realtime"
19737   },
19738   {
19739     "type": "get",
19740     "url": "/api/rpc/openchannel/queues",
19741     "title": "Gets a list of RTOpenchannelQueues",
19742     "examples": [
19743       {
19744         "title": "Example usage:",
19745         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19746         "type": "json"
19747       }
19748     ],
19749     "name": "RTOpenchannelQueues",
19750     "group": "RPC_Realtime",
19751     "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>",
19752     "version": "0.0.0",
19753     "filename": "server/api/rpc/index.js",
19754     "groupTitle": "RPC_Realtime"
19755   },
19756   {
19757     "type": "get",
19758     "url": "/api/rpc/outbound/channels",
19759     "title": "Gets a list of RTOutboundChannels",
19760     "examples": [
19761       {
19762         "title": "Example usage:",
19763         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19764         "type": "json"
19765       }
19766     ],
19767     "name": "RTOutboundChannels",
19768     "group": "RPC_Realtime",
19769     "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>",
19770     "version": "0.0.0",
19771     "filename": "server/api/rpc/index.js",
19772     "groupTitle": "RPC_Realtime"
19773   },
19774   {
19775     "type": "get",
19776     "url": "/api/rpc/sms/queues",
19777     "title": "Gets a list of RTSmsQueues",
19778     "examples": [
19779       {
19780         "title": "Example usage:",
19781         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19782         "type": "json"
19783       }
19784     ],
19785     "name": "RTSmsQueues",
19786     "group": "RPC_Realtime",
19787     "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>",
19788     "version": "0.0.0",
19789     "filename": "server/api/rpc/index.js",
19790     "groupTitle": "RPC_Realtime"
19791   },
19792   {
19793     "type": "get",
19794     "url": "/api/rpc/telephones",
19795     "title": "Gets a list of RTTelephones",
19796     "examples": [
19797       {
19798         "title": "Example usage:",
19799         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19800         "type": "json"
19801       }
19802     ],
19803     "name": "RTTelephones",
19804     "group": "RPC_Realtime",
19805     "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>",
19806     "version": "0.0.0",
19807     "filename": "server/api/rpc/index.js",
19808     "groupTitle": "RPC_Realtime"
19809   },
19810   {
19811     "type": "get",
19812     "url": "/api/rpc/trunks",
19813     "title": "Gets a list of RTTrunks",
19814     "examples": [
19815       {
19816         "title": "Example usage:",
19817         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19818         "type": "json"
19819       }
19820     ],
19821     "name": "RTTrunks",
19822     "group": "RPC_Realtime",
19823     "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>",
19824     "version": "0.0.0",
19825     "filename": "server/api/rpc/index.js",
19826     "groupTitle": "RPC_Realtime"
19827   },
19828   {
19829     "type": "get",
19830     "url": "/api/rpc/voice/channels",
19831     "title": "Gets a list of RTVoiceChannelMixMonitor",
19832     "examples": [
19833       {
19834         "title": "Example usage:",
19835         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19836         "type": "json"
19837       }
19838     ],
19839     "name": "RTVoiceChannelMixMonitor",
19840     "group": "RPC_Realtime",
19841     "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>",
19842     "version": "0.0.0",
19843     "filename": "server/api/rpc/index.js",
19844     "groupTitle": "RPC_Realtime"
19845   },
19846   {
19847     "type": "get",
19848     "url": "/api/rpc/voice/channels",
19849     "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19850     "examples": [
19851       {
19852         "title": "Example usage:",
19853         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19854         "type": "json"
19855       }
19856     ],
19857     "name": "RTVoiceChannelStopMixMonitor",
19858     "group": "RPC_Realtime",
19859     "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>",
19860     "version": "0.0.0",
19861     "filename": "server/api/rpc/index.js",
19862     "groupTitle": "RPC_Realtime"
19863   },
19864   {
19865     "type": "get",
19866     "url": "/api/rpc/voice/channels",
19867     "title": "Gets a list of RTVoiceChannels",
19868     "examples": [
19869       {
19870         "title": "Example usage:",
19871         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19872         "type": "json"
19873       }
19874     ],
19875     "name": "RTVoiceChannels",
19876     "group": "RPC_Realtime",
19877     "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>",
19878     "version": "0.0.0",
19879     "filename": "server/api/rpc/index.js",
19880     "groupTitle": "RPC_Realtime"
19881   },
19882   {
19883     "type": "get",
19884     "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19885     "title": "Gets a single RTVoiceQueueChannel",
19886     "examples": [
19887       {
19888         "title": "Example usage:",
19889         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19890         "type": "json"
19891       }
19892     ],
19893     "name": "RTVoiceQueueChannel",
19894     "group": "RPC_Realtime",
19895     "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19896     "version": "0.0.0",
19897     "filename": "server/api/rpc/index.js",
19898     "groupTitle": "RPC_Realtime"
19899   },
19900   {
19901     "type": "get",
19902     "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19903     "title": "Hangup a single RTVoiceQueueChannel",
19904     "examples": [
19905       {
19906         "title": "Example usage:",
19907         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19908         "type": "json"
19909       }
19910     ],
19911     "name": "RTVoiceQueueChannelHangup",
19912     "group": "RPC_Realtime",
19913     "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19914     "version": "0.0.0",
19915     "filename": "server/api/rpc/index.js",
19916     "groupTitle": "RPC_Realtime"
19917   },
19918   {
19919     "type": "get",
19920     "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19921     "title": "Hangup a single RTVoiceQueueChannel",
19922     "examples": [
19923       {
19924         "title": "Example usage:",
19925         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19926         "type": "json"
19927       }
19928     ],
19929     "name": "RTVoiceQueueChannelRedirect",
19930     "group": "RPC_Realtime",
19931     "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>",
19932     "version": "0.0.0",
19933     "filename": "server/api/rpc/index.js",
19934     "groupTitle": "RPC_Realtime"
19935   },
19936   {
19937     "type": "get",
19938     "url": "/api/rpc/voice/queues/preview/{id}",
19939     "title": "Gets a single preview contact",
19940     "examples": [
19941       {
19942         "title": "Example usage:",
19943         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19944         "type": "json"
19945       }
19946     ],
19947     "name": "RTVoiceQueuePreview",
19948     "group": "RPC_Realtime",
19949     "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19950     "version": "0.0.0",
19951     "filename": "server/api/rpc/index.js",
19952     "groupTitle": "RPC_Realtime"
19953   },
19954   {
19955     "type": "get",
19956     "url": "/api/rpc/outbound",
19957     "title": "Gets a list of RTOutbound",
19958     "examples": [
19959       {
19960         "title": "Example usage:",
19961         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19962         "type": "json"
19963       }
19964     ],
19965     "name": "RTVoiceQueues",
19966     "group": "RPC_Realtime",
19967     "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>",
19968     "version": "0.0.0",
19969     "filename": "server/api/rpc/index.js",
19970     "groupTitle": "RPC_Realtime"
19971   },
19972   {
19973     "type": "get",
19974     "url": "/api/rpc/voice/queues",
19975     "title": "Gets a list of RTVoiceQueues",
19976     "examples": [
19977       {
19978         "title": "Example usage:",
19979         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19980         "type": "json"
19981       }
19982     ],
19983     "name": "RTVoiceQueues",
19984     "group": "RPC_Realtime",
19985     "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>",
19986     "version": "0.0.0",
19987     "filename": "server/api/rpc/index.js",
19988     "groupTitle": "RPC_Realtime"
19989   },
19990   {
19991     "type": "get",
19992     "url": "/api/rpc/voice/queues/channels",
19993     "title": "Gets a list of RTVoiceQueuesChannels",
19994     "examples": [
19995       {
19996         "title": "Example usage:",
19997         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19998         "type": "json"
19999       }
20000     ],
20001     "name": "RTVoiceQueuesChannels",
20002     "group": "RPC_Realtime",
20003     "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>",
20004     "version": "0.0.0",
20005     "filename": "server/api/rpc/index.js",
20006     "groupTitle": "RPC_Realtime"
20007   },
20008   {
20009     "type": "get",
20010     "url": "/api/rpc/chat/queues/{id}",
20011     "title": "Gets a single RTChatQueue",
20012     "examples": [
20013       {
20014         "title": "Example usage:",
20015         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
20016         "type": "json"
20017       }
20018     ],
20019     "name": "ShowRTChatQueues",
20020     "group": "RPC_Realtime",
20021     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20022     "version": "0.0.0",
20023     "filename": "server/api/rpc/index.js",
20024     "groupTitle": "RPC_Realtime"
20025   },
20026   {
20027     "type": "get",
20028     "url": "/api/rpc/fax/queues/{id}",
20029     "title": "Gets a single RTFaxQueue",
20030     "examples": [
20031       {
20032         "title": "Example usage:",
20033         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
20034         "type": "json"
20035       }
20036     ],
20037     "name": "ShowRTFaxQueues",
20038     "group": "RPC_Realtime",
20039     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20040     "version": "0.0.0",
20041     "filename": "server/api/rpc/index.js",
20042     "groupTitle": "RPC_Realtime"
20043   },
20044   {
20045     "type": "get",
20046     "url": "/api/rpc/mail/queues/{id}",
20047     "title": "Gets a single RTMailQueue",
20048     "examples": [
20049       {
20050         "title": "Example usage:",
20051         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
20052         "type": "json"
20053       }
20054     ],
20055     "name": "ShowRTMailQueues",
20056     "group": "RPC_Realtime",
20057     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20058     "version": "0.0.0",
20059     "filename": "server/api/rpc/index.js",
20060     "groupTitle": "RPC_Realtime"
20061   },
20062   {
20063     "type": "get",
20064     "url": "/api/rpc/openchannel/queues/{id}",
20065     "title": "Gets a single RTOpenchannelQueue",
20066     "examples": [
20067       {
20068         "title": "Example usage:",
20069         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
20070         "type": "json"
20071       }
20072     ],
20073     "name": "ShowRTOpenchannelQueues",
20074     "group": "RPC_Realtime",
20075     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20076     "version": "0.0.0",
20077     "filename": "server/api/rpc/index.js",
20078     "groupTitle": "RPC_Realtime"
20079   },
20080   {
20081     "type": "get",
20082     "url": "/api/rpc/sms/queues/{id}",
20083     "title": "Gets a single RTSmsQueue",
20084     "examples": [
20085       {
20086         "title": "Example usage:",
20087         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20088         "type": "json"
20089       }
20090     ],
20091     "name": "ShowRTSmsQueues",
20092     "group": "RPC_Realtime",
20093     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20094     "version": "0.0.0",
20095     "filename": "server/api/rpc/index.js",
20096     "groupTitle": "RPC_Realtime"
20097   },
20098   {
20099     "type": "get",
20100     "url": "/api/rpc/voice/queues/{id}",
20101     "title": "Gets a single RTVoiceQueue",
20102     "examples": [
20103       {
20104         "title": "Example usage:",
20105         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20106         "type": "json"
20107       }
20108     ],
20109     "name": "ShowRTVoiceQueues",
20110     "group": "RPC_Realtime",
20111     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20112     "version": "0.0.0",
20113     "filename": "server/api/rpc/index.js",
20114     "groupTitle": "RPC_Realtime"
20115   },
20116   {
20117     "type": "put",
20118     "url": "/api/rpc/voice/{id}/queues",
20119     "title": "Updates a single VoiceQueue",
20120     "examples": [
20121       {
20122         "title": "Example usage:",
20123         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20124         "type": "json"
20125       }
20126     ],
20127     "name": "UpdateVoiceQueues",
20128     "group": "RPC_Realtime",
20129     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20130     "version": "0.0.0",
20131     "filename": "server/api/rpc/index.js",
20132     "groupTitle": "RPC_Realtime"
20133   },
20134   {
20135     "type": "post",
20136     "url": "/api/rpc/agents/:id/notify",
20137     "title": "Notify message to a specific agent",
20138     "examples": [
20139       {
20140         "title": "Example usage:",
20141         "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",
20142         "type": "json"
20143       }
20144     ],
20145     "name": "agentNotify",
20146     "group": "RPC_Realtime",
20147     "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>",
20148     "version": "0.0.0",
20149     "filename": "server/api/rpc/index.js",
20150     "groupTitle": "RPC_Realtime"
20151   },
20152   {
20153     "type": "post",
20154     "url": "/api/rpc/chat/queues/:id/notify",
20155     "title": "Notify message to a specific queue",
20156     "examples": [
20157       {
20158         "title": "Example usage:",
20159         "content": "curl https://{domain}/api/rpc/chat/queues/:id/notify -d '{\"messageId\": \"5080\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20160         "type": "json"
20161       }
20162     ],
20163     "name": "chatQueueNotify",
20164     "group": "RPC_Realtime",
20165     "description": "<p>Notify message to a specific queue.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20166     "version": "0.0.0",
20167     "filename": "server/api/rpc/index.js",
20168     "groupTitle": "RPC_Realtime"
20169   },
20170   {
20171     "type": "get",
20172     "url": "/api/rpc/chat/queues/waitinginteractions",
20173     "title": "Gets a list of chatQueuesWaitingInteractions",
20174     "examples": [
20175       {
20176         "title": "Example usage:",
20177         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20178         "type": "json"
20179       }
20180     ],
20181     "name": "chatQueuesWaitingInteractions",
20182     "group": "RPC_Realtime",
20183     "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>",
20184     "version": "0.0.0",
20185     "filename": "server/api/rpc/index.js",
20186     "groupTitle": "RPC_Realtime"
20187   },
20188   {
20189     "type": "post",
20190     "url": "/api/rpc/fax/queues/:id/notify",
20191     "title": "Notify message to a specific queue",
20192     "examples": [
20193       {
20194         "title": "Example usage:",
20195         "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",
20196         "type": "json"
20197       }
20198     ],
20199     "name": "faxQueueNotify",
20200     "group": "RPC_Realtime",
20201     "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>",
20202     "version": "0.0.0",
20203     "filename": "server/api/rpc/index.js",
20204     "groupTitle": "RPC_Realtime"
20205   },
20206   {
20207     "type": "get",
20208     "url": "/api/rpc/fax/queues/waitinginteractions",
20209     "title": "Gets a list of faxQueuesWaitingInteractions",
20210     "examples": [
20211       {
20212         "title": "Example usage:",
20213         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20214         "type": "json"
20215       }
20216     ],
20217     "name": "faxQueuesWaitingInteractions",
20218     "group": "RPC_Realtime",
20219     "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>",
20220     "version": "0.0.0",
20221     "filename": "server/api/rpc/index.js",
20222     "groupTitle": "RPC_Realtime"
20223   },
20224   {
20225     "type": "post",
20226     "url": "/api/rpc/mail/queues/:id/notify",
20227     "title": "Notify message to a specific queue",
20228     "examples": [
20229       {
20230         "title": "Example usage:",
20231         "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",
20232         "type": "json"
20233       }
20234     ],
20235     "name": "mailQueueNotify",
20236     "group": "RPC_Realtime",
20237     "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>",
20238     "version": "0.0.0",
20239     "filename": "server/api/rpc/index.js",
20240     "groupTitle": "RPC_Realtime"
20241   },
20242   {
20243     "type": "get",
20244     "url": "/api/rpc/mail/queues/waitinginteractions",
20245     "title": "Gets a list of mailQueuesWaitingInteractions",
20246     "examples": [
20247       {
20248         "title": "Example usage:",
20249         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20250         "type": "json"
20251       }
20252     ],
20253     "name": "mailQueuesWaitingInteractions",
20254     "group": "RPC_Realtime",
20255     "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>",
20256     "version": "0.0.0",
20257     "filename": "server/api/rpc/index.js",
20258     "groupTitle": "RPC_Realtime"
20259   },
20260   {
20261     "type": "post",
20262     "url": "/api/rpc/openchannel/queues/:id/notify",
20263     "title": "Notify message to a specific queue",
20264     "examples": [
20265       {
20266         "title": "Example usage:",
20267         "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",
20268         "type": "json"
20269       }
20270     ],
20271     "name": "openchannelQueueNotify",
20272     "group": "RPC_Realtime",
20273     "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>",
20274     "version": "0.0.0",
20275     "filename": "server/api/rpc/index.js",
20276     "groupTitle": "RPC_Realtime"
20277   },
20278   {
20279     "type": "get",
20280     "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20281     "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20282     "examples": [
20283       {
20284         "title": "Example usage:",
20285         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20286         "type": "json"
20287       }
20288     ],
20289     "name": "openchannelQueuesIdWaitingInteractions",
20290     "group": "RPC_Realtime",
20291     "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>",
20292     "version": "0.0.0",
20293     "filename": "server/api/rpc/index.js",
20294     "groupTitle": "RPC_Realtime"
20295   },
20296   {
20297     "type": "get",
20298     "url": "/api/rpc/openchannel/queues/waitinginteractions",
20299     "title": "Gets a list of openchannelQueuesWaitingInteractions",
20300     "examples": [
20301       {
20302         "title": "Example usage:",
20303         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20304         "type": "json"
20305       }
20306     ],
20307     "name": "openchannelQueuesWaitingInteractions",
20308     "group": "RPC_Realtime",
20309     "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>",
20310     "version": "0.0.0",
20311     "filename": "server/api/rpc/index.js",
20312     "groupTitle": "RPC_Realtime"
20313   },
20314   {
20315     "type": "post",
20316     "url": "/api/rpc/sms/queues/:id/notify",
20317     "title": "Notify message to a specific queue",
20318     "examples": [
20319       {
20320         "title": "Example usage:",
20321         "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",
20322         "type": "json"
20323       }
20324     ],
20325     "name": "smsQueueNotify",
20326     "group": "RPC_Realtime",
20327     "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>",
20328     "version": "0.0.0",
20329     "filename": "server/api/rpc/index.js",
20330     "groupTitle": "RPC_Realtime"
20331   },
20332   {
20333     "type": "get",
20334     "url": "/api/rpc/sms/queues/waitinginteractions",
20335     "title": "Gets a list of smsQueuesWaitingInteractions",
20336     "examples": [
20337       {
20338         "title": "Example usage:",
20339         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20340         "type": "json"
20341       }
20342     ],
20343     "name": "smsQueuesWaitingInteractions",
20344     "group": "RPC_Realtime",
20345     "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>",
20346     "version": "0.0.0",
20347     "filename": "server/api/rpc/index.js",
20348     "groupTitle": "RPC_Realtime"
20349   },
20350   {
20351     "type": "get",
20352     "url": "/api/realtime/agents",
20353     "title": "Gets realtime agents info",
20354     "examples": [
20355       {
20356         "title": "Example usage:",
20357         "content": "curl https://{domain}/api/realtime/agents -v -u {name}:{password}  -X GET",
20358         "type": "json"
20359       }
20360     ],
20361     "name": "getAgents",
20362     "group": "Realtime",
20363     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20364     "version": "0.0.0",
20365     "filename": "server/api/realtime/index.js",
20366     "groupTitle": "Realtime"
20367   },
20368   {
20369     "type": "get",
20370     "url": "/api/realtime/queues",
20371     "title": "Gets realtime queues info",
20372     "examples": [
20373       {
20374         "title": "Example usage:",
20375         "content": "curl https://{domain}/api/realtime/queues -v -u {name}:{password}  -X GET",
20376         "type": "json"
20377       }
20378     ],
20379     "name": "getQueues",
20380     "group": "Realtime",
20381     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20382     "version": "0.0.0",
20383     "filename": "server/api/realtime/index.js",
20384     "groupTitle": "Realtime"
20385   },
20386   {
20387     "type": "post",
20388     "url": "/api/integrations/salesforce/accounts",
20389     "title": "Creates a new Salesforce Account",
20390     "examples": [
20391       {
20392         "title": "Example usage:",
20393         "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",
20394         "type": "json"
20395       }
20396     ],
20397     "name": "CreateSalesforce_Accounts",
20398     "group": "Salesforce_Accounts",
20399     "parameter": {
20400       "fields": {
20401         "Body": [
20402           {
20403             "group": "Body",
20404             "type": "String",
20405             "optional": true,
20406             "field": "name",
20407             "description": ""
20408           },
20409           {
20410             "group": "Body",
20411             "type": "String",
20412             "optional": true,
20413             "field": "description",
20414             "description": ""
20415           },
20416           {
20417             "group": "Body",
20418             "type": "String",
20419             "optional": true,
20420             "field": "username",
20421             "description": ""
20422           },
20423           {
20424             "group": "Body",
20425             "type": "String",
20426             "optional": true,
20427             "field": "remoteUri",
20428             "description": ""
20429           },
20430           {
20431             "group": "Body",
20432             "type": "String",
20433             "optional": true,
20434             "field": "password",
20435             "description": ""
20436           },
20437           {
20438             "group": "Body",
20439             "type": "String",
20440             "optional": true,
20441             "field": "clientId",
20442             "description": ""
20443           },
20444           {
20445             "group": "Body",
20446             "type": "String",
20447             "optional": true,
20448             "field": "clientSecret",
20449             "description": ""
20450           },
20451           {
20452             "group": "Body",
20453             "type": "String",
20454             "optional": true,
20455             "field": "securityToken",
20456             "description": ""
20457           },
20458           {
20459             "group": "Body",
20460             "type": "String",
20461             "optional": false,
20462             "field": "serverUrl",
20463             "description": ""
20464           },
20465           {
20466             "group": "Body",
20467             "type": "String",
20468             "allowedValues": [
20469               "\"integrationTab\"",
20470               "\"newTab\""
20471             ],
20472             "optional": true,
20473             "field": "type",
20474             "description": ""
20475           }
20476         ]
20477       }
20478     },
20479     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20480     "version": "0.0.0",
20481     "filename": "server/api/intSalesforceAccount/index.js",
20482     "groupTitle": "Salesforce_Accounts"
20483   },
20484   {
20485     "type": "delete",
20486     "url": "/api/integrations/salesforce/accounts/{id}",
20487     "title": "Deletes a Salesforce Account",
20488     "examples": [
20489       {
20490         "title": "Example usage:",
20491         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20492         "type": "json"
20493       }
20494     ],
20495     "name": "DeleteSalesforce_Accounts",
20496     "group": "Salesforce_Accounts",
20497     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20498     "version": "0.0.0",
20499     "filename": "server/api/intSalesforceAccount/index.js",
20500     "groupTitle": "Salesforce_Accounts"
20501   },
20502   {
20503     "type": "get",
20504     "url": "/api/integrations/salesforce/accounts",
20505     "title": "Gets a list of Salesforce Accounts",
20506     "examples": [
20507       {
20508         "title": "Example usage:",
20509         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20510         "type": "json"
20511       }
20512     ],
20513     "name": "GetSalesforce_Accounts",
20514     "group": "Salesforce_Accounts",
20515     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20516     "version": "0.0.0",
20517     "filename": "server/api/intSalesforceAccount/index.js",
20518     "groupTitle": "Salesforce_Accounts"
20519   },
20520   {
20521     "type": "get",
20522     "url": "/api/integrations/salesforce/accounts/{id}",
20523     "title": "Gets a single Salesforce Account",
20524     "examples": [
20525       {
20526         "title": "Example usage:",
20527         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20528         "type": "json"
20529       }
20530     ],
20531     "name": "ShowSalesforce_Accounts",
20532     "group": "Salesforce_Accounts",
20533     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20534     "version": "0.0.0",
20535     "filename": "server/api/intSalesforceAccount/index.js",
20536     "groupTitle": "Salesforce_Accounts"
20537   },
20538   {
20539     "type": "post",
20540     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20541     "title": "Creates new configuration",
20542     "examples": [
20543       {
20544         "title": "Example usage:",
20545         "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",
20546         "type": "json"
20547       }
20548     ],
20549     "name": "addConfiguration",
20550     "group": "Salesforce_Accounts",
20551     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20552     "version": "0.0.0",
20553     "filename": "server/api/intSalesforceAccount/index.js",
20554     "groupTitle": "Salesforce_Accounts"
20555   },
20556   {
20557     "type": "get",
20558     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20559     "title": "Gets account configurations",
20560     "examples": [
20561       {
20562         "title": "Example usage:",
20563         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20564         "type": "json"
20565       }
20566     ],
20567     "name": "getConfigurations",
20568     "group": "Salesforce_Accounts",
20569     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20570     "version": "0.0.0",
20571     "filename": "server/api/intSalesforceAccount/index.js",
20572     "groupTitle": "Salesforce_Accounts"
20573   },
20574   {
20575     "type": "get",
20576     "url": "/api/integrations/salesforce/accounts/{id}/fields",
20577     "title": "Gets account fields",
20578     "examples": [
20579       {
20580         "title": "Example usage:",
20581         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20582         "type": "json"
20583       }
20584     ],
20585     "name": "getFields",
20586     "group": "Salesforce_Accounts",
20587     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20588     "version": "0.0.0",
20589     "filename": "server/api/intSalesforceAccount/index.js",
20590     "groupTitle": "Salesforce_Accounts"
20591   },
20592   {
20593     "type": "put",
20594     "url": "/api/integrations/salesforce/accounts/{id}",
20595     "title": "Update an existing Salesforce Account",
20596     "examples": [
20597       {
20598         "title": "Example usage:",
20599         "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",
20600         "type": "json"
20601       }
20602     ],
20603     "name": "updateSalesforce_Accounts",
20604     "group": "Salesforce_Accounts",
20605     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20606     "version": "0.0.0",
20607     "filename": "server/api/intSalesforceAccount/index.js",
20608     "groupTitle": "Salesforce_Accounts"
20609   },
20610   {
20611     "type": "post",
20612     "url": "/api/integrations/salesforce/configurations",
20613     "title": "Creates a new Salesforce Configuration",
20614     "examples": [
20615       {
20616         "title": "Example usage:",
20617         "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",
20618         "type": "json"
20619       }
20620     ],
20621     "name": "CreateSalesforce_Configurations",
20622     "group": "Salesforce_Configurations",
20623     "parameter": {
20624       "fields": {
20625         "Body": [
20626           {
20627             "group": "Body",
20628             "type": "String",
20629             "optional": true,
20630             "field": "name",
20631             "description": ""
20632           },
20633           {
20634             "group": "Body",
20635             "type": "String",
20636             "optional": true,
20637             "field": "description",
20638             "description": ""
20639           },
20640           {
20641             "group": "Body",
20642             "type": "String",
20643             "allowedValues": [
20644               "\"Task\"",
20645               "\"Case\""
20646             ],
20647             "optional": true,
20648             "field": "ticketType",
20649             "description": ""
20650           },
20651           {
20652             "group": "Body",
20653             "type": "String",
20654             "allowedValues": [
20655               "\"contact_lead\"",
20656               "\"contact\"",
20657               "\"lead\"",
20658               "\"account_contact_lead\"",
20659               "\"account\""
20660             ],
20661             "optional": true,
20662             "field": "moduleSearch",
20663             "description": ""
20664           },
20665           {
20666             "group": "Body",
20667             "type": "String",
20668             "allowedValues": [
20669               "\"nothing\"",
20670               "\"contact\"",
20671               "\"lead\"",
20672               "\"account\""
20673             ],
20674             "optional": true,
20675             "field": "moduleCreate",
20676             "description": ""
20677           },
20678           {
20679             "group": "Body",
20680             "type": "String",
20681             "optional": true,
20682             "field": "leadId",
20683             "description": ""
20684           },
20685           {
20686             "group": "Body",
20687             "type": "String",
20688             "optional": true,
20689             "field": "additionalSearchAccount",
20690             "description": ""
20691           },
20692           {
20693             "group": "Body",
20694             "type": "String",
20695             "optional": true,
20696             "field": "additionalSearchContact",
20697             "description": ""
20698           },
20699           {
20700             "group": "Body",
20701             "type": "String",
20702             "optional": true,
20703             "field": "additionalSearchLead",
20704             "description": ""
20705           }
20706         ]
20707       }
20708     },
20709     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20710     "version": "0.0.0",
20711     "filename": "server/api/intSalesforceConfiguration/index.js",
20712     "groupTitle": "Salesforce_Configurations"
20713   },
20714   {
20715     "type": "delete",
20716     "url": "/api/integrations/salesforce/configurations/{id}",
20717     "title": "Deletes a Salesforce Configuration",
20718     "examples": [
20719       {
20720         "title": "Example usage:",
20721         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20722         "type": "json"
20723       }
20724     ],
20725     "name": "DeleteSalesforce_Configurations",
20726     "group": "Salesforce_Configurations",
20727     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20728     "version": "0.0.0",
20729     "filename": "server/api/intSalesforceConfiguration/index.js",
20730     "groupTitle": "Salesforce_Configurations"
20731   },
20732   {
20733     "type": "get",
20734     "url": "/api/integrations/salesforce/configurations",
20735     "title": "Gets a list of Salesforce Configurations",
20736     "examples": [
20737       {
20738         "title": "Example usage:",
20739         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20740         "type": "json"
20741       }
20742     ],
20743     "name": "GetSalesforce_Configurations",
20744     "group": "Salesforce_Configurations",
20745     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20746     "version": "0.0.0",
20747     "filename": "server/api/intSalesforceConfiguration/index.js",
20748     "groupTitle": "Salesforce_Configurations"
20749   },
20750   {
20751     "type": "get",
20752     "url": "/api/integrations/salesforce/configurations/{id}",
20753     "title": "Gets a single Salesforce Configuration",
20754     "examples": [
20755       {
20756         "title": "Example usage:",
20757         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20758         "type": "json"
20759       }
20760     ],
20761     "name": "ShowSalesforce_Configurations",
20762     "group": "Salesforce_Configurations",
20763     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20764     "version": "0.0.0",
20765     "filename": "server/api/intSalesforceConfiguration/index.js",
20766     "groupTitle": "Salesforce_Configurations"
20767   },
20768   {
20769     "type": "get",
20770     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20771     "title": "Gets configurations descriptions",
20772     "examples": [
20773       {
20774         "title": "Example usage:",
20775         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20776         "type": "json"
20777       }
20778     ],
20779     "name": "getDescriptions",
20780     "group": "Salesforce_Configurations",
20781     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20782     "version": "0.0.0",
20783     "filename": "server/api/intSalesforceConfiguration/index.js",
20784     "groupTitle": "Salesforce_Configurations"
20785   },
20786   {
20787     "type": "get",
20788     "url": "/api/integrations/salesforce/configurations/{id}/fields",
20789     "title": "Gets configurations fields",
20790     "examples": [
20791       {
20792         "title": "Example usage:",
20793         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20794         "type": "json"
20795       }
20796     ],
20797     "name": "getFields",
20798     "group": "Salesforce_Configurations",
20799     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20800     "version": "0.0.0",
20801     "filename": "server/api/intSalesforceConfiguration/index.js",
20802     "groupTitle": "Salesforce_Configurations"
20803   },
20804   {
20805     "type": "get",
20806     "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20807     "title": "Gets configurations subjects",
20808     "examples": [
20809       {
20810         "title": "Example usage:",
20811         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20812         "type": "json"
20813       }
20814     ],
20815     "name": "getSubjects",
20816     "group": "Salesforce_Configurations",
20817     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20818     "version": "0.0.0",
20819     "filename": "server/api/intSalesforceConfiguration/index.js",
20820     "groupTitle": "Salesforce_Configurations"
20821   },
20822   {
20823     "type": "put",
20824     "url": "/api/integrations/salesforce/configurations/{id}",
20825     "title": "Update an existing Salesforce Configuration",
20826     "examples": [
20827       {
20828         "title": "Example usage:",
20829         "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",
20830         "type": "json"
20831       }
20832     ],
20833     "name": "updateSalesforce_Configurations",
20834     "group": "Salesforce_Configurations",
20835     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20836     "version": "0.0.0",
20837     "filename": "server/api/intSalesforceConfiguration/index.js",
20838     "groupTitle": "Salesforce_Configurations"
20839   },
20840   {
20841     "type": "post",
20842     "url": "/api/integrations/salesforce/fields",
20843     "title": "Creates a new Salesforce Field",
20844     "examples": [
20845       {
20846         "title": "Example usage:",
20847         "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",
20848         "type": "json"
20849       }
20850     ],
20851     "name": "CreateSalesforce_Fields",
20852     "group": "Salesforce_Fields",
20853     "parameter": {
20854       "fields": {
20855         "Body": [
20856           {
20857             "group": "Body",
20858             "type": "String",
20859             "allowedValues": [
20860               "\"string\"",
20861               "\"variable\"",
20862               "\"customVariable\"",
20863               "\"keyValue\"",
20864               "\"picklist\""
20865             ],
20866             "optional": true,
20867             "field": "type",
20868             "description": ""
20869           },
20870           {
20871             "group": "Body",
20872             "type": "String",
20873             "optional": true,
20874             "field": "content",
20875             "description": ""
20876           },
20877           {
20878             "group": "Body",
20879             "type": "String",
20880             "optional": true,
20881             "field": "key",
20882             "description": ""
20883           },
20884           {
20885             "group": "Body",
20886             "type": "String",
20887             "allowedValues": [
20888               "\"string\"",
20889               "\"variable\"",
20890               "\"customVariable\""
20891             ],
20892             "optional": true,
20893             "field": "keyType",
20894             "description": ""
20895           },
20896           {
20897             "group": "Body",
20898             "type": "String",
20899             "optional": true,
20900             "field": "keyContent",
20901             "description": ""
20902           },
20903           {
20904             "group": "Body",
20905             "type": "String",
20906             "optional": true,
20907             "field": "idField",
20908             "description": ""
20909           },
20910           {
20911             "group": "Body",
20912             "type": "String",
20913             "optional": true,
20914             "field": "variableName",
20915             "description": ""
20916           }
20917         ]
20918       }
20919     },
20920     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20921     "version": "0.0.0",
20922     "filename": "server/api/intSalesforceField/index.js",
20923     "groupTitle": "Salesforce_Fields"
20924   },
20925   {
20926     "type": "delete",
20927     "url": "/api/integrations/salesforce/fields/{id}",
20928     "title": "Deletes a Salesforce Field",
20929     "examples": [
20930       {
20931         "title": "Example usage:",
20932         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20933         "type": "json"
20934       }
20935     ],
20936     "name": "DeleteSalesforce_Fields",
20937     "group": "Salesforce_Fields",
20938     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20939     "version": "0.0.0",
20940     "filename": "server/api/intSalesforceField/index.js",
20941     "groupTitle": "Salesforce_Fields"
20942   },
20943   {
20944     "type": "get",
20945     "url": "/api/integrations/salesforce/fields",
20946     "title": "Gets a list of Salesforce Fields",
20947     "examples": [
20948       {
20949         "title": "Example usage:",
20950         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20951         "type": "json"
20952       }
20953     ],
20954     "name": "GetSalesforce_Fields",
20955     "group": "Salesforce_Fields",
20956     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20957     "version": "0.0.0",
20958     "filename": "server/api/intSalesforceField/index.js",
20959     "groupTitle": "Salesforce_Fields"
20960   },
20961   {
20962     "type": "get",
20963     "url": "/api/integrations/salesforce/fields/{id}",
20964     "title": "Gets a single Salesforce Field",
20965     "examples": [
20966       {
20967         "title": "Example usage:",
20968         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20969         "type": "json"
20970       }
20971     ],
20972     "name": "ShowSalesforce_Fields",
20973     "group": "Salesforce_Fields",
20974     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20975     "version": "0.0.0",
20976     "filename": "server/api/intSalesforceField/index.js",
20977     "groupTitle": "Salesforce_Fields"
20978   },
20979   {
20980     "type": "put",
20981     "url": "/api/integrations/salesforce/fields/{id}",
20982     "title": "Update an existing Salesforce Field",
20983     "examples": [
20984       {
20985         "title": "Example usage:",
20986         "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",
20987         "type": "json"
20988       }
20989     ],
20990     "name": "updateSalesforce_Fields",
20991     "group": "Salesforce_Fields",
20992     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20993     "version": "0.0.0",
20994     "filename": "server/api/intSalesforceField/index.js",
20995     "groupTitle": "Salesforce_Fields"
20996   },
20997   {
20998     "type": "post",
20999     "url": "/api/schedules",
21000     "title": "Creates a new Schedule",
21001     "examples": [
21002       {
21003         "title": "Example usage:",
21004         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21005         "type": "json"
21006       }
21007     ],
21008     "name": "CreateSchedules",
21009     "group": "Schedules",
21010     "parameter": {
21011       "fields": {
21012         "Body": [
21013           {
21014             "group": "Body",
21015             "type": "String",
21016             "optional": false,
21017             "field": "name",
21018             "description": ""
21019           },
21020           {
21021             "group": "Body",
21022             "type": "String",
21023             "optional": true,
21024             "field": "description",
21025             "description": ""
21026           },
21027           {
21028             "group": "Body",
21029             "type": "Boolean",
21030             "optional": false,
21031             "field": "active",
21032             "description": ""
21033           },
21034           {
21035             "group": "Body",
21036             "type": "String",
21037             "optional": false,
21038             "field": "cron",
21039             "description": ""
21040           },
21041           {
21042             "group": "Body",
21043             "type": "String",
21044             "optional": false,
21045             "field": "startAt",
21046             "description": ""
21047           },
21048           {
21049             "group": "Body",
21050             "type": "String",
21051             "optional": false,
21052             "field": "endAt",
21053             "description": ""
21054           },
21055           {
21056             "group": "Body",
21057             "type": "Integer",
21058             "optional": false,
21059             "field": "subtractNumber",
21060             "description": ""
21061           },
21062           {
21063             "group": "Body",
21064             "type": "String",
21065             "allowedValues": [
21066               "\"years\"",
21067               "\"quarters\"",
21068               "\"months\"",
21069               "\"weeks\"",
21070               "\"days\"",
21071               "\"hours\"",
21072               "\"minutes\""
21073             ],
21074             "optional": false,
21075             "field": "subtractUnit",
21076             "description": ""
21077           },
21078           {
21079             "group": "Body",
21080             "type": "String",
21081             "allowedValues": [
21082               "\"csv\"",
21083               "\"pdf\"",
21084               "\"xlsx\""
21085             ],
21086             "optional": false,
21087             "field": "output",
21088             "description": ""
21089           },
21090           {
21091             "group": "Body",
21092             "type": "String",
21093             "allowedValues": [
21094               "\"custom\"",
21095               "\"default\""
21096             ],
21097             "optional": false,
21098             "field": "type",
21099             "description": ""
21100           },
21101           {
21102             "group": "Body",
21103             "type": "Boolean",
21104             "optional": true,
21105             "field": "sendMail",
21106             "description": ""
21107           },
21108           {
21109             "group": "Body",
21110             "type": "String",
21111             "optional": true,
21112             "field": "email",
21113             "description": ""
21114           },
21115           {
21116             "group": "Body",
21117             "type": "Text",
21118             "optional": true,
21119             "field": "cc",
21120             "description": ""
21121           },
21122           {
21123             "group": "Body",
21124             "type": "Text",
21125             "optional": true,
21126             "field": "bcc",
21127             "description": ""
21128           },
21129           {
21130             "group": "Body",
21131             "type": "Boolean",
21132             "optional": true,
21133             "field": "sendIfEmpty",
21134             "description": ""
21135           }
21136         ]
21137       }
21138     },
21139     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21140     "version": "0.0.0",
21141     "filename": "server/api/schedule/index.js",
21142     "groupTitle": "Schedules"
21143   },
21144   {
21145     "type": "delete",
21146     "url": "/api/schedules/{id}",
21147     "title": "Deletes a Schedule",
21148     "examples": [
21149       {
21150         "title": "Example usage:",
21151         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21152         "type": "json"
21153       }
21154     ],
21155     "name": "DeleteSchedules",
21156     "group": "Schedules",
21157     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21158     "version": "0.0.0",
21159     "filename": "server/api/schedule/index.js",
21160     "groupTitle": "Schedules"
21161   },
21162   {
21163     "type": "get",
21164     "url": "/api/schedules",
21165     "title": "Gets a list of Schedules",
21166     "examples": [
21167       {
21168         "title": "Example usage:",
21169         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21170         "type": "json"
21171       }
21172     ],
21173     "name": "GetSchedules",
21174     "group": "Schedules",
21175     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21176     "version": "0.0.0",
21177     "filename": "server/api/schedule/index.js",
21178     "groupTitle": "Schedules"
21179   },
21180   {
21181     "type": "get",
21182     "url": "/api/schedules/{id}",
21183     "title": "Gets a single Schedule",
21184     "examples": [
21185       {
21186         "title": "Example usage:",
21187         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21188         "type": "json"
21189       }
21190     ],
21191     "name": "ShowSchedules",
21192     "group": "Schedules",
21193     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21194     "version": "0.0.0",
21195     "filename": "server/api/schedule/index.js",
21196     "groupTitle": "Schedules"
21197   },
21198   {
21199     "type": "get",
21200     "url": "/api/schedules/{id}/run",
21201     "title": "Run Scheduler",
21202     "examples": [
21203       {
21204         "title": "Example usage:",
21205         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21206         "type": "json"
21207       }
21208     ],
21209     "name": "run",
21210     "group": "Schedules",
21211     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21212     "version": "0.0.0",
21213     "filename": "server/api/schedule/index.js",
21214     "groupTitle": "Schedules"
21215   },
21216   {
21217     "type": "put",
21218     "url": "/api/schedules/{id}",
21219     "title": "Update an existing Schedule",
21220     "examples": [
21221       {
21222         "title": "Example usage:",
21223         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21224         "type": "json"
21225       }
21226     ],
21227     "name": "updateSchedules",
21228     "group": "Schedules",
21229     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21230     "version": "0.0.0",
21231     "filename": "server/api/schedule/index.js",
21232     "groupTitle": "Schedules"
21233   },
21234   {
21235     "type": "post",
21236     "url": "/api/screen/recordings",
21237     "title": "Creates a new Recording",
21238     "examples": [
21239       {
21240         "title": "Example usage:",
21241         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21242         "type": "json"
21243       }
21244     ],
21245     "name": "CreateRecordings",
21246     "group": "Screen_Recordings",
21247     "parameter": {
21248       "fields": {
21249         "Body": [
21250           {
21251             "group": "Body",
21252             "type": "Virtual",
21253             "optional": true,
21254             "field": "format",
21255             "description": ""
21256           },
21257           {
21258             "group": "Body",
21259             "type": "String",
21260             "optional": true,
21261             "field": "interactionid",
21262             "description": ""
21263           },
21264           {
21265             "group": "Body",
21266             "type": "String",
21267             "optional": true,
21268             "field": "channel",
21269             "description": ""
21270           },
21271           {
21272             "group": "Body",
21273             "type": "String",
21274             "optional": true,
21275             "field": "value",
21276             "description": ""
21277           },
21278           {
21279             "group": "Body",
21280             "type": "Integer",
21281             "optional": true,
21282             "field": "rating",
21283             "description": ""
21284           },
21285           {
21286             "group": "Body",
21287             "type": "Integer",
21288             "optional": true,
21289             "field": "duration",
21290             "description": ""
21291           },
21292           {
21293             "group": "Body",
21294             "type": "String",
21295             "optional": true,
21296             "field": "startedAt",
21297             "description": ""
21298           },
21299           {
21300             "group": "Body",
21301             "type": "String",
21302             "optional": true,
21303             "field": "closedAt",
21304             "description": ""
21305           },
21306           {
21307             "group": "Body",
21308             "type": "String",
21309             "optional": true,
21310             "field": "createdAt",
21311             "description": ""
21312           },
21313           {
21314             "group": "Body",
21315             "type": "String",
21316             "optional": true,
21317             "field": "updatedAt",
21318             "description": ""
21319           }
21320         ]
21321       }
21322     },
21323     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21324     "version": "0.0.0",
21325     "filename": "server/api/screenRecording/index.js",
21326     "groupTitle": "Screen_Recordings"
21327   },
21328   {
21329     "type": "get",
21330     "url": "/api/screen/recordings/describe",
21331     "title": "Gets table info about Recordings",
21332     "examples": [
21333       {
21334         "title": "Example usage:",
21335         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21336         "type": "json"
21337       }
21338     ],
21339     "name": "DescribeRecordings",
21340     "group": "Screen_Recordings",
21341     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21342     "version": "0.0.0",
21343     "filename": "server/api/screenRecording/index.js",
21344     "groupTitle": "Screen_Recordings"
21345   },
21346   {
21347     "type": "get",
21348     "url": "/api/screen/recordings",
21349     "title": "Gets a list of Recordings",
21350     "examples": [
21351       {
21352         "title": "Example usage:",
21353         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21354         "type": "json"
21355       }
21356     ],
21357     "name": "GetRecordings",
21358     "group": "Screen_Recordings",
21359     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21360     "version": "0.0.0",
21361     "filename": "server/api/screenRecording/index.js",
21362     "groupTitle": "Screen_Recordings"
21363   },
21364   {
21365     "type": "get",
21366     "url": "/api/screen/recordings/{id}",
21367     "title": "Gets a single Recording",
21368     "examples": [
21369       {
21370         "title": "Example usage:",
21371         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21372         "type": "json"
21373       }
21374     ],
21375     "name": "ShowRecordings",
21376     "group": "Screen_Recordings",
21377     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21378     "version": "0.0.0",
21379     "filename": "server/api/screenRecording/index.js",
21380     "groupTitle": "Screen_Recordings"
21381   },
21382   {
21383     "type": "delete",
21384     "url": "/api/screen/recordings/{id}",
21385     "title": "Delete screen recording",
21386     "examples": [
21387       {
21388         "title": "Example usage:",
21389         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21390         "type": "json"
21391       }
21392     ],
21393     "name": "destroy",
21394     "group": "Screen_Recordings",
21395     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21396     "version": "0.0.0",
21397     "filename": "server/api/screenRecording/index.js",
21398     "groupTitle": "Screen_Recordings"
21399   },
21400   {
21401     "type": "get",
21402     "url": "/api/screen/recordings/{id}/download",
21403     "title": "Download Recording",
21404     "examples": [
21405       {
21406         "title": "Example usage:",
21407         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21408         "type": "json"
21409       }
21410     ],
21411     "name": "download",
21412     "group": "Screen_Recordings",
21413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21414     "version": "0.0.0",
21415     "filename": "server/api/screenRecording/index.js",
21416     "groupTitle": "Screen_Recordings"
21417   },
21418   {
21419     "type": "put",
21420     "url": "/api/screen/recordings/{id}",
21421     "title": "Update an existing Recording",
21422     "examples": [
21423       {
21424         "title": "Example usage:",
21425         "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",
21426         "type": "json"
21427       }
21428     ],
21429     "name": "updateRecordings",
21430     "group": "Screen_Recordings",
21431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21432     "version": "0.0.0",
21433     "filename": "server/api/screenRecording/index.js",
21434     "groupTitle": "Screen_Recordings"
21435   },
21436   {
21437     "type": "post",
21438     "url": "/api/integrations/servicenow/accounts",
21439     "title": "Creates a new Servicenow Account",
21440     "examples": [
21441       {
21442         "title": "Example usage:",
21443         "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",
21444         "type": "json"
21445       }
21446     ],
21447     "name": "CreateServicenow_Accounts",
21448     "group": "Servicenow_Accounts",
21449     "parameter": {
21450       "fields": {
21451         "Body": [
21452           {
21453             "group": "Body",
21454             "type": "String",
21455             "optional": true,
21456             "field": "name",
21457             "description": ""
21458           },
21459           {
21460             "group": "Body",
21461             "type": "String",
21462             "optional": true,
21463             "field": "description",
21464             "description": ""
21465           },
21466           {
21467             "group": "Body",
21468             "type": "String",
21469             "optional": true,
21470             "field": "username",
21471             "description": ""
21472           },
21473           {
21474             "group": "Body",
21475             "type": "String",
21476             "optional": true,
21477             "field": "password",
21478             "description": ""
21479           },
21480           {
21481             "group": "Body",
21482             "type": "String",
21483             "optional": true,
21484             "field": "email",
21485             "description": ""
21486           },
21487           {
21488             "group": "Body",
21489             "type": "String",
21490             "optional": true,
21491             "field": "remoteUri",
21492             "description": ""
21493           },
21494           {
21495             "group": "Body",
21496             "type": "String",
21497             "optional": false,
21498             "field": "serverUrl",
21499             "description": ""
21500           }
21501         ]
21502       }
21503     },
21504     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21505     "version": "0.0.0",
21506     "filename": "server/api/intServicenowAccount/index.js",
21507     "groupTitle": "Servicenow_Accounts"
21508   },
21509   {
21510     "type": "delete",
21511     "url": "/api/integrations/servicenow/accounts/{id}",
21512     "title": "Deletes a Servicenow Account",
21513     "examples": [
21514       {
21515         "title": "Example usage:",
21516         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21517         "type": "json"
21518       }
21519     ],
21520     "name": "DeleteServicenow_Accounts",
21521     "group": "Servicenow_Accounts",
21522     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21523     "version": "0.0.0",
21524     "filename": "server/api/intServicenowAccount/index.js",
21525     "groupTitle": "Servicenow_Accounts"
21526   },
21527   {
21528     "type": "get",
21529     "url": "/api/integrations/servicenow/accounts",
21530     "title": "Gets a list of Servicenow Accounts",
21531     "examples": [
21532       {
21533         "title": "Example usage:",
21534         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21535         "type": "json"
21536       }
21537     ],
21538     "name": "GetServicenow_Accounts",
21539     "group": "Servicenow_Accounts",
21540     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21541     "version": "0.0.0",
21542     "filename": "server/api/intServicenowAccount/index.js",
21543     "groupTitle": "Servicenow_Accounts"
21544   },
21545   {
21546     "type": "get",
21547     "url": "/api/integrations/servicenow/accounts/{id}",
21548     "title": "Gets a single Servicenow Account",
21549     "examples": [
21550       {
21551         "title": "Example usage:",
21552         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21553         "type": "json"
21554       }
21555     ],
21556     "name": "ShowServicenow_Accounts",
21557     "group": "Servicenow_Accounts",
21558     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21559     "version": "0.0.0",
21560     "filename": "server/api/intServicenowAccount/index.js",
21561     "groupTitle": "Servicenow_Accounts"
21562   },
21563   {
21564     "type": "post",
21565     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21566     "title": "Creates new configuration",
21567     "examples": [
21568       {
21569         "title": "Example usage:",
21570         "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",
21571         "type": "json"
21572       }
21573     ],
21574     "name": "addConfiguration",
21575     "group": "Servicenow_Accounts",
21576     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21577     "version": "0.0.0",
21578     "filename": "server/api/intServicenowAccount/index.js",
21579     "groupTitle": "Servicenow_Accounts"
21580   },
21581   {
21582     "type": "get",
21583     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21584     "title": "Gets account configurations",
21585     "examples": [
21586       {
21587         "title": "Example usage:",
21588         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21589         "type": "json"
21590       }
21591     ],
21592     "name": "getConfigurations",
21593     "group": "Servicenow_Accounts",
21594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21595     "version": "0.0.0",
21596     "filename": "server/api/intServicenowAccount/index.js",
21597     "groupTitle": "Servicenow_Accounts"
21598   },
21599   {
21600     "type": "get",
21601     "url": "/api/integrations/servicenow/accounts/{id}/fields",
21602     "title": "Gets account fields",
21603     "examples": [
21604       {
21605         "title": "Example usage:",
21606         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21607         "type": "json"
21608       }
21609     ],
21610     "name": "getFields",
21611     "group": "Servicenow_Accounts",
21612     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21613     "version": "0.0.0",
21614     "filename": "server/api/intServicenowAccount/index.js",
21615     "groupTitle": "Servicenow_Accounts"
21616   },
21617   {
21618     "type": "put",
21619     "url": "/api/integrations/servicenow/accounts/{id}",
21620     "title": "Update an existing Servicenow Account",
21621     "examples": [
21622       {
21623         "title": "Example usage:",
21624         "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",
21625         "type": "json"
21626       }
21627     ],
21628     "name": "updateServicenow_Accounts",
21629     "group": "Servicenow_Accounts",
21630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21631     "version": "0.0.0",
21632     "filename": "server/api/intServicenowAccount/index.js",
21633     "groupTitle": "Servicenow_Accounts"
21634   },
21635   {
21636     "type": "post",
21637     "url": "/api/integrations/servicenow/configurations",
21638     "title": "Creates a new Servicenow Configuration",
21639     "examples": [
21640       {
21641         "title": "Example usage:",
21642         "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",
21643         "type": "json"
21644       }
21645     ],
21646     "name": "CreateServicenow_Configurations",
21647     "group": "Servicenow_Configurations",
21648     "parameter": {
21649       "fields": {
21650         "Body": [
21651           {
21652             "group": "Body",
21653             "type": "String",
21654             "optional": true,
21655             "field": "name",
21656             "description": ""
21657           },
21658           {
21659             "group": "Body",
21660             "type": "String",
21661             "optional": true,
21662             "field": "description",
21663             "description": ""
21664           }
21665         ]
21666       }
21667     },
21668     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21669     "version": "0.0.0",
21670     "filename": "server/api/intServicenowConfiguration/index.js",
21671     "groupTitle": "Servicenow_Configurations"
21672   },
21673   {
21674     "type": "delete",
21675     "url": "/api/integrations/servicenow/configurations/{id}",
21676     "title": "Deletes a Servicenow Configuration",
21677     "examples": [
21678       {
21679         "title": "Example usage:",
21680         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21681         "type": "json"
21682       }
21683     ],
21684     "name": "DeleteServicenow_Configurations",
21685     "group": "Servicenow_Configurations",
21686     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21687     "version": "0.0.0",
21688     "filename": "server/api/intServicenowConfiguration/index.js",
21689     "groupTitle": "Servicenow_Configurations"
21690   },
21691   {
21692     "type": "get",
21693     "url": "/api/integrations/servicenow/configurations",
21694     "title": "Gets a list of Servicenow Configurations",
21695     "examples": [
21696       {
21697         "title": "Example usage:",
21698         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21699         "type": "json"
21700       }
21701     ],
21702     "name": "GetServicenow_Configurations",
21703     "group": "Servicenow_Configurations",
21704     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21705     "version": "0.0.0",
21706     "filename": "server/api/intServicenowConfiguration/index.js",
21707     "groupTitle": "Servicenow_Configurations"
21708   },
21709   {
21710     "type": "get",
21711     "url": "/api/integrations/servicenow/configurations/{id}",
21712     "title": "Gets a single Servicenow Configuration",
21713     "examples": [
21714       {
21715         "title": "Example usage:",
21716         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21717         "type": "json"
21718       }
21719     ],
21720     "name": "ShowServicenow_Configurations",
21721     "group": "Servicenow_Configurations",
21722     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21723     "version": "0.0.0",
21724     "filename": "server/api/intServicenowConfiguration/index.js",
21725     "groupTitle": "Servicenow_Configurations"
21726   },
21727   {
21728     "type": "get",
21729     "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21730     "title": "Gets configurations descriptions",
21731     "examples": [
21732       {
21733         "title": "Example usage:",
21734         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21735         "type": "json"
21736       }
21737     ],
21738     "name": "getDescriptions",
21739     "group": "Servicenow_Configurations",
21740     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21741     "version": "0.0.0",
21742     "filename": "server/api/intServicenowConfiguration/index.js",
21743     "groupTitle": "Servicenow_Configurations"
21744   },
21745   {
21746     "type": "get",
21747     "url": "/api/integrations/servicenow/configurations/{id}/fields",
21748     "title": "Gets configurations fields",
21749     "examples": [
21750       {
21751         "title": "Example usage:",
21752         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21753         "type": "json"
21754       }
21755     ],
21756     "name": "getFields",
21757     "group": "Servicenow_Configurations",
21758     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21759     "version": "0.0.0",
21760     "filename": "server/api/intServicenowConfiguration/index.js",
21761     "groupTitle": "Servicenow_Configurations"
21762   },
21763   {
21764     "type": "get",
21765     "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21766     "title": "Gets configurations subjects",
21767     "examples": [
21768       {
21769         "title": "Example usage:",
21770         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21771         "type": "json"
21772       }
21773     ],
21774     "name": "getSubjects",
21775     "group": "Servicenow_Configurations",
21776     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21777     "version": "0.0.0",
21778     "filename": "server/api/intServicenowConfiguration/index.js",
21779     "groupTitle": "Servicenow_Configurations"
21780   },
21781   {
21782     "type": "put",
21783     "url": "/api/integrations/servicenow/configurations/{id}",
21784     "title": "Update an existing Servicenow Configuration",
21785     "examples": [
21786       {
21787         "title": "Example usage:",
21788         "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",
21789         "type": "json"
21790       }
21791     ],
21792     "name": "updateServicenow_Configurations",
21793     "group": "Servicenow_Configurations",
21794     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21795     "version": "0.0.0",
21796     "filename": "server/api/intServicenowConfiguration/index.js",
21797     "groupTitle": "Servicenow_Configurations"
21798   },
21799   {
21800     "type": "post",
21801     "url": "/api/integrations/servicenow/fields",
21802     "title": "Creates a new Servicenow Field",
21803     "examples": [
21804       {
21805         "title": "Example usage:",
21806         "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",
21807         "type": "json"
21808       }
21809     ],
21810     "name": "CreateServicenow_Fields",
21811     "group": "Servicenow_Fields",
21812     "parameter": {
21813       "fields": {
21814         "Body": [
21815           {
21816             "group": "Body",
21817             "type": "String",
21818             "allowedValues": [
21819               "\"string\"",
21820               "\"variable\"",
21821               "\"customVariable\"",
21822               "\"keyValue\"",
21823               "\"picklist\""
21824             ],
21825             "optional": true,
21826             "field": "type",
21827             "description": ""
21828           },
21829           {
21830             "group": "Body",
21831             "type": "String",
21832             "optional": true,
21833             "field": "content",
21834             "description": ""
21835           },
21836           {
21837             "group": "Body",
21838             "type": "String",
21839             "optional": true,
21840             "field": "key",
21841             "description": ""
21842           },
21843           {
21844             "group": "Body",
21845             "type": "String",
21846             "allowedValues": [
21847               "\"string\"",
21848               "\"variable\"",
21849               "\"customVariable\""
21850             ],
21851             "optional": true,
21852             "field": "keyType",
21853             "description": ""
21854           },
21855           {
21856             "group": "Body",
21857             "type": "String",
21858             "optional": true,
21859             "field": "keyContent",
21860             "description": ""
21861           },
21862           {
21863             "group": "Body",
21864             "type": "String",
21865             "optional": true,
21866             "field": "idField",
21867             "description": ""
21868           },
21869           {
21870             "group": "Body",
21871             "type": "String",
21872             "optional": true,
21873             "field": "nameField",
21874             "description": ""
21875           },
21876           {
21877             "group": "Body",
21878             "type": "Boolean",
21879             "optional": true,
21880             "field": "customField",
21881             "description": ""
21882           },
21883           {
21884             "group": "Body",
21885             "type": "String",
21886             "optional": true,
21887             "field": "variableName",
21888             "description": ""
21889           }
21890         ]
21891       }
21892     },
21893     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21894     "version": "0.0.0",
21895     "filename": "server/api/intServicenowField/index.js",
21896     "groupTitle": "Servicenow_Fields"
21897   },
21898   {
21899     "type": "delete",
21900     "url": "/api/integrations/servicenow/fields/{id}",
21901     "title": "Deletes a Servicenow Field",
21902     "examples": [
21903       {
21904         "title": "Example usage:",
21905         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21906         "type": "json"
21907       }
21908     ],
21909     "name": "DeleteServicenow_Fields",
21910     "group": "Servicenow_Fields",
21911     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21912     "version": "0.0.0",
21913     "filename": "server/api/intServicenowField/index.js",
21914     "groupTitle": "Servicenow_Fields"
21915   },
21916   {
21917     "type": "get",
21918     "url": "/api/integrations/servicenow/fields",
21919     "title": "Gets a list of Servicenow Fields",
21920     "examples": [
21921       {
21922         "title": "Example usage:",
21923         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21924         "type": "json"
21925       }
21926     ],
21927     "name": "GetServicenow_Fields",
21928     "group": "Servicenow_Fields",
21929     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21930     "version": "0.0.0",
21931     "filename": "server/api/intServicenowField/index.js",
21932     "groupTitle": "Servicenow_Fields"
21933   },
21934   {
21935     "type": "get",
21936     "url": "/api/integrations/servicenow/fields/{id}",
21937     "title": "Gets a single Servicenow Field",
21938     "examples": [
21939       {
21940         "title": "Example usage:",
21941         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21942         "type": "json"
21943       }
21944     ],
21945     "name": "ShowServicenow_Fields",
21946     "group": "Servicenow_Fields",
21947     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21948     "version": "0.0.0",
21949     "filename": "server/api/intServicenowField/index.js",
21950     "groupTitle": "Servicenow_Fields"
21951   },
21952   {
21953     "type": "put",
21954     "url": "/api/integrations/servicenow/fields/{id}",
21955     "title": "Update an existing Servicenow Field",
21956     "examples": [
21957       {
21958         "title": "Example usage:",
21959         "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",
21960         "type": "json"
21961       }
21962     ],
21963     "name": "updateServicenow_Fields",
21964     "group": "Servicenow_Fields",
21965     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21966     "version": "0.0.0",
21967     "filename": "server/api/intServicenowField/index.js",
21968     "groupTitle": "Servicenow_Fields"
21969   },
21970   {
21971     "type": "get",
21972     "url": "/api/settings",
21973     "title": "Gets a list of Settings",
21974     "examples": [
21975       {
21976         "title": "Example usage:",
21977         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21978         "type": "json"
21979       }
21980     ],
21981     "name": "GetSettings",
21982     "group": "Settings",
21983     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21984     "version": "0.0.0",
21985     "filename": "server/api/setting/index.js",
21986     "groupTitle": "Settings"
21987   },
21988   {
21989     "type": "get",
21990     "url": "/api/settings/{id}",
21991     "title": "Gets a single Setting",
21992     "examples": [
21993       {
21994         "title": "Example usage:",
21995         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21996         "type": "json"
21997       }
21998     ],
21999     "name": "ShowSettings",
22000     "group": "Settings",
22001     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22002     "version": "0.0.0",
22003     "filename": "server/api/setting/index.js",
22004     "groupTitle": "Settings"
22005   },
22006   {
22007     "type": "post",
22008     "url": "/api/settings/{id}/favicon",
22009     "title": "Add Favicon",
22010     "examples": [
22011       {
22012         "title": "Example usage:",
22013         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22014         "type": "json"
22015       }
22016     ],
22017     "name": "addFavicon",
22018     "group": "Settings",
22019     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22020     "version": "0.0.0",
22021     "filename": "server/api/setting/index.js",
22022     "groupTitle": "Settings"
22023   },
22024   {
22025     "type": "post",
22026     "url": "/api/settings/{id}/logo",
22027     "title": "Add logo",
22028     "examples": [
22029       {
22030         "title": "Example usage:",
22031         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22032         "type": "json"
22033       }
22034     ],
22035     "name": "addLogo",
22036     "group": "Settings",
22037     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22038     "version": "0.0.0",
22039     "filename": "server/api/setting/index.js",
22040     "groupTitle": "Settings"
22041   },
22042   {
22043     "type": "post",
22044     "url": "/api/settings/{id}/logo_login",
22045     "title": "Add logo login",
22046     "examples": [
22047       {
22048         "title": "Example usage:",
22049         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22050         "type": "json"
22051       }
22052     ],
22053     "name": "addLogoLogin",
22054     "group": "Settings",
22055     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22056     "version": "0.0.0",
22057     "filename": "server/api/setting/index.js",
22058     "groupTitle": "Settings"
22059   },
22060   {
22061     "type": "post",
22062     "url": "/api/settings/{id}/preferred",
22063     "title": "Add Preferred",
22064     "examples": [
22065       {
22066         "title": "Example usage:",
22067         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22068         "type": "json"
22069       }
22070     ],
22071     "name": "addPreferred",
22072     "group": "Settings",
22073     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22074     "version": "0.0.0",
22075     "filename": "server/api/setting/index.js",
22076     "groupTitle": "Settings"
22077   },
22078   {
22079     "type": "get",
22080     "url": "/api/settings/now",
22081     "title": "Get Server Current Date",
22082     "examples": [
22083       {
22084         "title": "Example usage:",
22085         "content": "curl https://{domain}/api/settings/now -v -X GET",
22086         "type": "json"
22087       }
22088     ],
22089     "name": "getDate",
22090     "group": "Settings",
22091     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22092     "version": "0.0.0",
22093     "filename": "server/api/setting/index.js",
22094     "groupTitle": "Settings"
22095   },
22096   {
22097     "type": "get",
22098     "url": "/api/settings/{id}/favicon",
22099     "title": "Get Favicon",
22100     "examples": [
22101       {
22102         "title": "Example usage:",
22103         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
22104         "type": "json"
22105       }
22106     ],
22107     "name": "getFavicon",
22108     "group": "Settings",
22109     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22110     "version": "0.0.0",
22111     "filename": "server/api/setting/index.js",
22112     "groupTitle": "Settings"
22113   },
22114   {
22115     "type": "get",
22116     "url": "/api/settings/{id}/gdpr",
22117     "title": "Get gdpr settings",
22118     "examples": [
22119       {
22120         "title": "Example usage:",
22121         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22122         "type": "json"
22123       }
22124     ],
22125     "name": "getGdpr",
22126     "group": "Settings",
22127     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22128     "version": "0.0.0",
22129     "filename": "server/api/setting/index.js",
22130     "groupTitle": "Settings"
22131   },
22132   {
22133     "type": "get",
22134     "url": "/api/settings/{id}/logo",
22135     "title": "Get logo",
22136     "examples": [
22137       {
22138         "title": "Example usage:",
22139         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22140         "type": "json"
22141       }
22142     ],
22143     "name": "getLogo",
22144     "group": "Settings",
22145     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22146     "version": "0.0.0",
22147     "filename": "server/api/setting/index.js",
22148     "groupTitle": "Settings"
22149   },
22150   {
22151     "type": "get",
22152     "url": "/api/settings/{id}/logo_login",
22153     "title": "Get logo login",
22154     "examples": [
22155       {
22156         "title": "Example usage:",
22157         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22158         "type": "json"
22159       }
22160     ],
22161     "name": "getLogoLogin",
22162     "group": "Settings",
22163     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22164     "version": "0.0.0",
22165     "filename": "server/api/setting/index.js",
22166     "groupTitle": "Settings"
22167   },
22168   {
22169     "type": "get",
22170     "url": "/api/settings/{id}/preferred",
22171     "title": "Get Preferred",
22172     "examples": [
22173       {
22174         "title": "Example usage:",
22175         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22176         "type": "json"
22177       }
22178     ],
22179     "name": "getPreferred",
22180     "group": "Settings",
22181     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22182     "version": "0.0.0",
22183     "filename": "server/api/setting/index.js",
22184     "groupTitle": "Settings"
22185   },
22186   {
22187     "type": "put",
22188     "url": "/api/settings/{id}",
22189     "title": "Update an existing Setting",
22190     "examples": [
22191       {
22192         "title": "Example usage:",
22193         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22194         "type": "json"
22195       }
22196     ],
22197     "name": "updateSettings",
22198     "group": "Settings",
22199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22200     "version": "0.0.0",
22201     "filename": "server/api/setting/index.js",
22202     "groupTitle": "Settings"
22203   },
22204   {
22205     "type": "post",
22206     "url": "/api/sms/accounts/{id}/users",
22207     "title": "Add agents to a sms account",
22208     "examples": [
22209       {
22210         "title": "Example usage:",
22211         "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",
22212         "type": "json"
22213       }
22214     ],
22215     "name": "AddAgents",
22216     "group": "Sms_Accounts",
22217     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22218     "version": "0.0.0",
22219     "filename": "server/api/smsAccount/index.js",
22220     "groupTitle": "Sms_Accounts"
22221   },
22222   {
22223     "type": "post",
22224     "url": "/api/sms/accounts",
22225     "title": "Creates a new Account",
22226     "examples": [
22227       {
22228         "title": "Example usage:",
22229         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22230         "type": "json"
22231       }
22232     ],
22233     "name": "CreateAccounts",
22234     "group": "Sms_Accounts",
22235     "parameter": {
22236       "fields": {
22237         "Body": [
22238           {
22239             "group": "Body",
22240             "type": "String",
22241             "optional": false,
22242             "field": "name",
22243             "description": ""
22244           },
22245           {
22246             "group": "Body",
22247             "type": "String",
22248             "optional": false,
22249             "field": "key",
22250             "description": ""
22251           },
22252           {
22253             "group": "Body",
22254             "type": "String",
22255             "optional": false,
22256             "field": "remote",
22257             "description": ""
22258           },
22259           {
22260             "group": "Body",
22261             "type": "String",
22262             "optional": true,
22263             "field": "token",
22264             "description": ""
22265           },
22266           {
22267             "group": "Body",
22268             "type": "String",
22269             "optional": true,
22270             "field": "phone",
22271             "description": ""
22272           },
22273           {
22274             "group": "Body",
22275             "type": "String",
22276             "allowedValues": [
22277               "\"twilio\"",
22278               "\"skebby\"",
22279               "\"connectel\"",
22280               "\"clicksend\"",
22281               "\"plivo\"",
22282               "\"clickatell\"",
22283               "\"bandwidth\"",
22284               "\"csc\"",
22285               "\"infobip\"",
22286               "\"intelepeer\""
22287             ],
22288             "optional": true,
22289             "field": "type",
22290             "description": ""
22291           },
22292           {
22293             "group": "Body",
22294             "type": "String",
22295             "optional": true,
22296             "field": "accountSid",
22297             "description": ""
22298           },
22299           {
22300             "group": "Body",
22301             "type": "String",
22302             "optional": true,
22303             "field": "authId",
22304             "description": ""
22305           },
22306           {
22307             "group": "Body",
22308             "type": "String",
22309             "optional": true,
22310             "field": "authToken",
22311             "description": ""
22312           },
22313           {
22314             "group": "Body",
22315             "type": "String",
22316             "allowedValues": [
22317               "\"SI\"",
22318               "\"TI\"",
22319               "\"GP\""
22320             ],
22321             "optional": true,
22322             "field": "smsMethod",
22323             "description": ""
22324           },
22325           {
22326             "group": "Body",
22327             "type": "String",
22328             "optional": true,
22329             "field": "username",
22330             "description": ""
22331           },
22332           {
22333             "group": "Body",
22334             "type": "String",
22335             "optional": true,
22336             "field": "password",
22337             "description": ""
22338           },
22339           {
22340             "group": "Body",
22341             "type": "String",
22342             "optional": true,
22343             "field": "apiKey",
22344             "description": ""
22345           },
22346           {
22347             "group": "Body",
22348             "type": "String",
22349             "optional": true,
22350             "field": "applicationId",
22351             "description": ""
22352           },
22353           {
22354             "group": "Body",
22355             "type": "String",
22356             "optional": true,
22357             "field": "accountId",
22358             "description": ""
22359           },
22360           {
22361             "group": "Body",
22362             "type": "String",
22363             "optional": true,
22364             "field": "senderString",
22365             "description": ""
22366           },
22367           {
22368             "group": "Body",
22369             "type": "Boolean",
22370             "optional": true,
22371             "field": "deliveryReport",
22372             "description": ""
22373           },
22374           {
22375             "group": "Body",
22376             "type": "String",
22377             "optional": true,
22378             "field": "description",
22379             "description": ""
22380           },
22381           {
22382             "group": "Body",
22383             "type": "Text",
22384             "optional": true,
22385             "field": "notificationTemplate",
22386             "description": ""
22387           },
22388           {
22389             "group": "Body",
22390             "type": "Boolean",
22391             "optional": true,
22392             "field": "notificationSound",
22393             "description": ""
22394           },
22395           {
22396             "group": "Body",
22397             "type": "Boolean",
22398             "optional": true,
22399             "field": "notificationShake",
22400             "description": ""
22401           },
22402           {
22403             "group": "Body",
22404             "type": "Integer",
22405             "optional": true,
22406             "field": "waitForTheAssignedAgent",
22407             "description": ""
22408           },
22409           {
22410             "group": "Body",
22411             "type": "Boolean",
22412             "optional": true,
22413             "field": "queueTransfer",
22414             "description": ""
22415           },
22416           {
22417             "group": "Body",
22418             "type": "Integer",
22419             "optional": true,
22420             "field": "queueTransferTimeout",
22421             "description": ""
22422           },
22423           {
22424             "group": "Body",
22425             "type": "Boolean",
22426             "optional": true,
22427             "field": "agentTransfer",
22428             "description": ""
22429           },
22430           {
22431             "group": "Body",
22432             "type": "Integer",
22433             "optional": true,
22434             "field": "agentTransferTimeout",
22435             "description": ""
22436           },
22437           {
22438             "group": "Body",
22439             "type": "String",
22440             "optional": true,
22441             "field": "baseUrl",
22442             "description": ""
22443           },
22444           {
22445             "group": "Body",
22446             "type": "Integer",
22447             "optional": true,
22448             "field": "mandatoryDispositionPauseId",
22449             "description": "<p>Status to put when mandatory disposition is enabled</p>"
22450           },
22451           {
22452             "group": "Body",
22453             "type": "Boolean",
22454             "optional": true,
22455             "field": "mandatoryDisposition",
22456             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22457           }
22458         ]
22459       }
22460     },
22461     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22462     "version": "0.0.0",
22463     "filename": "server/api/smsAccount/index.js",
22464     "groupTitle": "Sms_Accounts"
22465   },
22466   {
22467     "type": "delete",
22468     "url": "/api/sms/accounts/{id}",
22469     "title": "Deletes a Account",
22470     "examples": [
22471       {
22472         "title": "Example usage:",
22473         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22474         "type": "json"
22475       }
22476     ],
22477     "name": "DeleteAccounts",
22478     "group": "Sms_Accounts",
22479     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22480     "version": "0.0.0",
22481     "filename": "server/api/smsAccount/index.js",
22482     "groupTitle": "Sms_Accounts"
22483   },
22484   {
22485     "type": "get",
22486     "url": "/api/sms/accounts/describe",
22487     "title": "Gets table info about Accounts",
22488     "examples": [
22489       {
22490         "title": "Example usage:",
22491         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22492         "type": "json"
22493       }
22494     ],
22495     "name": "DescribeAccounts",
22496     "group": "Sms_Accounts",
22497     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22498     "version": "0.0.0",
22499     "filename": "server/api/smsAccount/index.js",
22500     "groupTitle": "Sms_Accounts"
22501   },
22502   {
22503     "type": "get",
22504     "url": "/api/sms/accounts",
22505     "title": "Gets a list of Accounts",
22506     "examples": [
22507       {
22508         "title": "Example usage:",
22509         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22510         "type": "json"
22511       }
22512     ],
22513     "name": "GetAccounts",
22514     "group": "Sms_Accounts",
22515     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22516     "version": "0.0.0",
22517     "filename": "server/api/smsAccount/index.js",
22518     "groupTitle": "Sms_Accounts"
22519   },
22520   {
22521     "type": "get",
22522     "url": "/api/sms/accounts/{id}/users",
22523     "title": "Gets agents from sms account",
22524     "examples": [
22525       {
22526         "title": "Example usage:",
22527         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22528         "type": "json"
22529       }
22530     ],
22531     "name": "GetAgents",
22532     "group": "Sms_Accounts",
22533     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22534     "version": "0.0.0",
22535     "filename": "server/api/smsAccount/index.js",
22536     "groupTitle": "Sms_Accounts"
22537   },
22538   {
22539     "type": "delete",
22540     "url": "/api/sms/accounts/{id}/users",
22541     "title": "Removes agents from a sms account",
22542     "examples": [
22543       {
22544         "title": "Example usage:",
22545         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22546         "type": "json"
22547       }
22548     ],
22549     "name": "RemoveAgents",
22550     "group": "Sms_Accounts",
22551     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22552     "version": "0.0.0",
22553     "filename": "server/api/smsAccount/index.js",
22554     "groupTitle": "Sms_Accounts"
22555   },
22556   {
22557     "type": "delete",
22558     "url": "/api/sms/accounts/{id}/canned_answers",
22559     "title": "Removes canned answers from account",
22560     "examples": [
22561       {
22562         "title": "Example usage:",
22563         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22564         "type": "json"
22565       }
22566     ],
22567     "name": "RemoveAnswers",
22568     "group": "Sms_Accounts",
22569     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22570     "version": "0.0.0",
22571     "filename": "server/api/smsAccount/index.js",
22572     "groupTitle": "Sms_Accounts"
22573   },
22574   {
22575     "type": "delete",
22576     "url": "/api/sms/accounts/{id}/dispositions",
22577     "title": "Removes dispositions from account",
22578     "examples": [
22579       {
22580         "title": "Example usage:",
22581         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22582         "type": "json"
22583       }
22584     ],
22585     "name": "RemoveDispositions",
22586     "group": "Sms_Accounts",
22587     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22588     "version": "0.0.0",
22589     "filename": "server/api/smsAccount/index.js",
22590     "groupTitle": "Sms_Accounts"
22591   },
22592   {
22593     "type": "get",
22594     "url": "/api/sms/accounts/{id}",
22595     "title": "Gets a single Account",
22596     "examples": [
22597       {
22598         "title": "Example usage:",
22599         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22600         "type": "json"
22601       }
22602     ],
22603     "name": "ShowAccounts",
22604     "group": "Sms_Accounts",
22605     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22606     "version": "0.0.0",
22607     "filename": "server/api/smsAccount/index.js",
22608     "groupTitle": "Sms_Accounts"
22609   },
22610   {
22611     "type": "put",
22612     "url": "/api/sms/messages/{id}/accept",
22613     "title": "Accepts message",
22614     "examples": [
22615       {
22616         "title": "Example usage:",
22617         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22618         "type": "json"
22619       }
22620     ],
22621     "name": "acceptMessage",
22622     "group": "Sms_Accounts",
22623     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22624     "version": "0.0.0",
22625     "filename": "server/api/smsMessage/index.js",
22626     "groupTitle": "Sms_Accounts"
22627   },
22628   {
22629     "type": "post",
22630     "url": "/api/sms/accounts/{id}/canned_answers",
22631     "title": "Creates new canned answer",
22632     "examples": [
22633       {
22634         "title": "Example usage:",
22635         "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",
22636         "type": "json"
22637       }
22638     ],
22639     "name": "addAnswer",
22640     "group": "Sms_Accounts",
22641     "parameter": {
22642       "fields": {
22643         "Body": [
22644           {
22645             "group": "Body",
22646             "type": "String",
22647             "optional": false,
22648             "field": "key",
22649             "description": ""
22650           },
22651           {
22652             "group": "Body",
22653             "type": "Text",
22654             "optional": false,
22655             "field": "value",
22656             "description": ""
22657           },
22658           {
22659             "group": "Body",
22660             "type": "String",
22661             "optional": true,
22662             "field": "description",
22663             "description": ""
22664           },
22665           {
22666             "group": "Body",
22667             "type": "Virtual",
22668             "optional": true,
22669             "field": "name",
22670             "description": ""
22671           }
22672         ]
22673       }
22674     },
22675     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22676     "version": "0.0.0",
22677     "filename": "server/api/smsAccount/index.js",
22678     "groupTitle": "Sms_Accounts"
22679   },
22680   {
22681     "type": "post",
22682     "url": "/api/sms/accounts/{id}/applications",
22683     "title": "Creates new applications",
22684     "examples": [
22685       {
22686         "title": "Example usage:",
22687         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22688         "type": "json"
22689       }
22690     ],
22691     "name": "addApplications",
22692     "group": "Sms_Accounts",
22693     "parameter": {
22694       "fields": {
22695         "Body": [
22696           {
22697             "group": "Body",
22698             "type": "Integer",
22699             "optional": false,
22700             "field": "priority",
22701             "description": ""
22702           },
22703           {
22704             "group": "Body",
22705             "type": "String",
22706             "optional": false,
22707             "field": "app",
22708             "description": ""
22709           },
22710           {
22711             "group": "Body",
22712             "type": "Text",
22713             "optional": true,
22714             "field": "appdata",
22715             "description": ""
22716           },
22717           {
22718             "group": "Body",
22719             "type": "String",
22720             "optional": true,
22721             "field": "description",
22722             "description": ""
22723           },
22724           {
22725             "group": "Body",
22726             "type": "String",
22727             "optional": true,
22728             "field": "interval",
22729             "description": ""
22730           }
22731         ]
22732       }
22733     },
22734     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22735     "version": "0.0.0",
22736     "filename": "server/api/smsAccount/index.js",
22737     "groupTitle": "Sms_Accounts"
22738   },
22739   {
22740     "type": "post",
22741     "url": "/api/sms/accounts/{id}/dispositions",
22742     "title": "Creates new disposition",
22743     "examples": [
22744       {
22745         "title": "Example usage:",
22746         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22747         "type": "json"
22748       }
22749     ],
22750     "name": "addDisposition",
22751     "group": "Sms_Accounts",
22752     "parameter": {
22753       "fields": {
22754         "Body": [
22755           {
22756             "group": "Body",
22757             "type": "String",
22758             "optional": false,
22759             "field": "name",
22760             "description": ""
22761           },
22762           {
22763             "group": "Body",
22764             "type": "String",
22765             "allowedValues": [
22766               "\"first\"",
22767               "\"second\"",
22768               "\"third\""
22769             ],
22770             "optional": false,
22771             "field": "level",
22772             "description": ""
22773           },
22774           {
22775             "group": "Body",
22776             "type": "String",
22777             "optional": true,
22778             "field": "description",
22779             "description": ""
22780           }
22781         ]
22782       }
22783     },
22784     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22785     "version": "0.0.0",
22786     "filename": "server/api/smsAccount/index.js",
22787     "groupTitle": "Sms_Accounts"
22788   },
22789   {
22790     "type": "get",
22791     "url": "/api/sms/accounts/{id}/canned_answers",
22792     "title": "Gets account canned answers",
22793     "examples": [
22794       {
22795         "title": "Example usage:",
22796         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22797         "type": "json"
22798       }
22799     ],
22800     "name": "getAnswers",
22801     "group": "Sms_Accounts",
22802     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22803     "version": "0.0.0",
22804     "filename": "server/api/smsAccount/index.js",
22805     "groupTitle": "Sms_Accounts"
22806   },
22807   {
22808     "type": "get",
22809     "url": "/api/sms/accounts/{id}/applications",
22810     "title": "Gets account applications",
22811     "examples": [
22812       {
22813         "title": "Example usage:",
22814         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22815         "type": "json"
22816       }
22817     ],
22818     "name": "getApplications",
22819     "group": "Sms_Accounts",
22820     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22821     "version": "0.0.0",
22822     "filename": "server/api/smsAccount/index.js",
22823     "groupTitle": "Sms_Accounts"
22824   },
22825   {
22826     "type": "get",
22827     "url": "/api/sms/accounts/{id}/dispositions",
22828     "title": "Gets account dispositions",
22829     "examples": [
22830       {
22831         "title": "Example usage:",
22832         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22833         "type": "json"
22834       }
22835     ],
22836     "name": "getDispositions",
22837     "group": "Sms_Accounts",
22838     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22839     "version": "0.0.0",
22840     "filename": "server/api/smsAccount/index.js",
22841     "groupTitle": "Sms_Accounts"
22842   },
22843   {
22844     "type": "get",
22845     "url": "/api/sms/accounts/{id}/interactions",
22846     "title": "Gets Sms Account interactions",
22847     "examples": [
22848       {
22849         "title": "Example usage:",
22850         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22851         "type": "json"
22852       }
22853     ],
22854     "name": "getInteractions",
22855     "group": "Sms_Accounts",
22856     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22857     "version": "0.0.0",
22858     "filename": "server/api/smsAccount/index.js",
22859     "groupTitle": "Sms_Accounts"
22860   },
22861   {
22862     "type": "post",
22863     "url": "/api/sms/accounts/{id}/notify",
22864     "title": "Notify new message",
22865     "examples": [
22866       {
22867         "title": "Example usage:",
22868         "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",
22869         "type": "json"
22870       }
22871     ],
22872     "name": "notify",
22873     "group": "Sms_Accounts",
22874     "description": "<p>Motion 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>",
22875     "version": "0.0.0",
22876     "filename": "server/api/smsAccount/index.js",
22877     "groupTitle": "Sms_Accounts"
22878   },
22879   {
22880     "type": "put",
22881     "url": "/api/sms/messages/{id}/reject",
22882     "title": "Rejects message",
22883     "examples": [
22884       {
22885         "title": "Example usage:",
22886         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22887         "type": "json"
22888       }
22889     ],
22890     "name": "rejectMessage",
22891     "group": "Sms_Accounts",
22892     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22893     "version": "0.0.0",
22894     "filename": "server/api/smsMessage/index.js",
22895     "groupTitle": "Sms_Accounts"
22896   },
22897   {
22898     "type": "post",
22899     "url": "/api/sms/accounts/{id}/send",
22900     "title": "Send new sms message",
22901     "examples": [
22902       {
22903         "title": "Example usage:",
22904         "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",
22905         "type": "json"
22906       }
22907     ],
22908     "name": "sendSms",
22909     "group": "Sms_Accounts",
22910     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22911     "version": "0.0.0",
22912     "filename": "server/api/smsAccount/index.js",
22913     "groupTitle": "Sms_Accounts"
22914   },
22915   {
22916     "type": "get",
22917     "url": "/api/sms/accounts/{id}/status",
22918     "title": "Receive message status as get request",
22919     "examples": [
22920       {
22921         "title": "Example usage:",
22922         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22923         "type": "json"
22924       }
22925     ],
22926     "name": "statusMessage",
22927     "group": "Sms_Accounts",
22928     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22929     "version": "0.0.0",
22930     "filename": "server/api/smsAccount/index.js",
22931     "groupTitle": "Sms_Accounts"
22932   },
22933   {
22934     "type": "post",
22935     "url": "/api/sms/messages/{id}/status",
22936     "title": "Receive message status",
22937     "examples": [
22938       {
22939         "title": "Example usage:",
22940         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22941         "type": "json"
22942       }
22943     ],
22944     "name": "statusMessage",
22945     "group": "Sms_Accounts",
22946     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22947     "version": "0.0.0",
22948     "filename": "server/api/smsMessage/index.js",
22949     "groupTitle": "Sms_Accounts"
22950   },
22951   {
22952     "type": "post",
22953     "url": "/api/sms/accounts/{id}/status",
22954     "title": "Receive message status",
22955     "examples": [
22956       {
22957         "title": "Example usage:",
22958         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22959         "type": "json"
22960       }
22961     ],
22962     "name": "statusMessage",
22963     "group": "Sms_Accounts",
22964     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22965     "version": "0.0.0",
22966     "filename": "server/api/smsAccount/index.js",
22967     "groupTitle": "Sms_Accounts"
22968   },
22969   {
22970     "type": "put",
22971     "url": "/api/sms/accounts/{id}",
22972     "title": "Update an existing Account",
22973     "examples": [
22974       {
22975         "title": "Example usage:",
22976         "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",
22977         "type": "json"
22978       }
22979     ],
22980     "name": "updateAccounts",
22981     "group": "Sms_Accounts",
22982     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22983     "version": "0.0.0",
22984     "filename": "server/api/smsAccount/index.js",
22985     "groupTitle": "Sms_Accounts"
22986   },
22987   {
22988     "type": "post",
22989     "url": "/api/sms/applications",
22990     "title": "Creates a new Application",
22991     "examples": [
22992       {
22993         "title": "Example usage:",
22994         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22995         "type": "json"
22996       }
22997     ],
22998     "name": "CreateApplications",
22999     "group": "Sms_Applications",
23000     "parameter": {
23001       "fields": {
23002         "Body": [
23003           {
23004             "group": "Body",
23005             "type": "Integer",
23006             "optional": false,
23007             "field": "priority",
23008             "description": ""
23009           },
23010           {
23011             "group": "Body",
23012             "type": "String",
23013             "optional": false,
23014             "field": "app",
23015             "description": ""
23016           },
23017           {
23018             "group": "Body",
23019             "type": "Text",
23020             "optional": true,
23021             "field": "appdata",
23022             "description": ""
23023           },
23024           {
23025             "group": "Body",
23026             "type": "String",
23027             "optional": true,
23028             "field": "description",
23029             "description": ""
23030           },
23031           {
23032             "group": "Body",
23033             "type": "String",
23034             "optional": true,
23035             "field": "interval",
23036             "description": ""
23037           }
23038         ]
23039       }
23040     },
23041     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23042     "version": "0.0.0",
23043     "filename": "server/api/smsApplication/index.js",
23044     "groupTitle": "Sms_Applications"
23045   },
23046   {
23047     "type": "delete",
23048     "url": "/api/sms/applications/{id}",
23049     "title": "Deletes a Application",
23050     "examples": [
23051       {
23052         "title": "Example usage:",
23053         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
23054         "type": "json"
23055       }
23056     ],
23057     "name": "DeleteApplications",
23058     "group": "Sms_Applications",
23059     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23060     "version": "0.0.0",
23061     "filename": "server/api/smsApplication/index.js",
23062     "groupTitle": "Sms_Applications"
23063   },
23064   {
23065     "type": "get",
23066     "url": "/api/sms/applications",
23067     "title": "Gets a list of Applications",
23068     "examples": [
23069       {
23070         "title": "Example usage:",
23071         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
23072         "type": "json"
23073       }
23074     ],
23075     "name": "GetApplications",
23076     "group": "Sms_Applications",
23077     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23078     "version": "0.0.0",
23079     "filename": "server/api/smsApplication/index.js",
23080     "groupTitle": "Sms_Applications"
23081   },
23082   {
23083     "type": "get",
23084     "url": "/api/sms/applications/{id}",
23085     "title": "Gets a single Application",
23086     "examples": [
23087       {
23088         "title": "Example usage:",
23089         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
23090         "type": "json"
23091       }
23092     ],
23093     "name": "ShowApplications",
23094     "group": "Sms_Applications",
23095     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23096     "version": "0.0.0",
23097     "filename": "server/api/smsApplication/index.js",
23098     "groupTitle": "Sms_Applications"
23099   },
23100   {
23101     "type": "put",
23102     "url": "/api/sms/applications/{id}",
23103     "title": "Update an existing Application",
23104     "examples": [
23105       {
23106         "title": "Example usage:",
23107         "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",
23108         "type": "json"
23109       }
23110     ],
23111     "name": "updateApplications",
23112     "group": "Sms_Applications",
23113     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23114     "version": "0.0.0",
23115     "filename": "server/api/smsApplication/index.js",
23116     "groupTitle": "Sms_Applications"
23117   },
23118   {
23119     "type": "post",
23120     "url": "/api/sms/interactions/{id}/tags",
23121     "title": "Add tags to the interaction",
23122     "examples": [
23123       {
23124         "title": "Example usage:",
23125         "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",
23126         "type": "json"
23127       }
23128     ],
23129     "name": "AddTags",
23130     "group": "Sms_Interactions",
23131     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23132     "version": "0.0.0",
23133     "filename": "server/api/smsInteraction/index.js",
23134     "groupTitle": "Sms_Interactions"
23135   },
23136   {
23137     "type": "post",
23138     "url": "/api/sms/interactions",
23139     "title": "Creates a new Interaction",
23140     "examples": [
23141       {
23142         "title": "Example usage:",
23143         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23144         "type": "json"
23145       }
23146     ],
23147     "name": "CreateInteractions",
23148     "group": "Sms_Interactions",
23149     "parameter": {
23150       "fields": {
23151         "Body": [
23152           {
23153             "group": "Body",
23154             "type": "Boolean",
23155             "optional": true,
23156             "field": "closed",
23157             "description": ""
23158           },
23159           {
23160             "group": "Body",
23161             "type": "String",
23162             "optional": true,
23163             "field": "closedAt",
23164             "description": ""
23165           },
23166           {
23167             "group": "Body",
23168             "type": "String",
23169             "optional": true,
23170             "field": "disposition",
23171             "description": ""
23172           },
23173           {
23174             "group": "Body",
23175             "type": "String",
23176             "optional": true,
23177             "field": "secondDisposition",
23178             "description": ""
23179           },
23180           {
23181             "group": "Body",
23182             "type": "String",
23183             "optional": true,
23184             "field": "thirdDisposition",
23185             "description": ""
23186           },
23187           {
23188             "group": "Body",
23189             "type": "String",
23190             "optional": true,
23191             "field": "note",
23192             "description": ""
23193           },
23194           {
23195             "group": "Body",
23196             "type": "String",
23197             "optional": true,
23198             "field": "phone",
23199             "description": ""
23200           },
23201           {
23202             "group": "Body",
23203             "type": "String",
23204             "optional": true,
23205             "field": "read1stAt",
23206             "description": ""
23207           },
23208           {
23209             "group": "Body",
23210             "type": "String",
23211             "allowedValues": [
23212               "\"in\"",
23213               "\"out\""
23214             ],
23215             "optional": false,
23216             "field": "firstMsgDirection",
23217             "description": ""
23218           },
23219           {
23220             "group": "Body",
23221             "type": "String",
23222             "optional": true,
23223             "field": "lastMsgAt",
23224             "description": ""
23225           },
23226           {
23227             "group": "Body",
23228             "type": "String",
23229             "allowedValues": [
23230               "\"in\"",
23231               "\"out\""
23232             ],
23233             "optional": false,
23234             "field": "lastMsgDirection",
23235             "description": ""
23236           },
23237           {
23238             "group": "Body",
23239             "type": "Boolean",
23240             "optional": true,
23241             "field": "autoreplyExecuted",
23242             "description": ""
23243           }
23244         ]
23245       }
23246     },
23247     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23248     "version": "0.0.0",
23249     "filename": "server/api/smsInteraction/index.js",
23250     "groupTitle": "Sms_Interactions"
23251   },
23252   {
23253     "type": "delete",
23254     "url": "/api/sms/interactions/{id}",
23255     "title": "Deletes a Interaction",
23256     "examples": [
23257       {
23258         "title": "Example usage:",
23259         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23260         "type": "json"
23261       }
23262     ],
23263     "name": "DeleteInteractions",
23264     "group": "Sms_Interactions",
23265     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23266     "version": "0.0.0",
23267     "filename": "server/api/smsInteraction/index.js",
23268     "groupTitle": "Sms_Interactions"
23269   },
23270   {
23271     "type": "get",
23272     "url": "/api/sms/interactions/describe",
23273     "title": "Gets table info about Interactions",
23274     "examples": [
23275       {
23276         "title": "Example usage:",
23277         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23278         "type": "json"
23279       }
23280     ],
23281     "name": "DescribeInteractions",
23282     "group": "Sms_Interactions",
23283     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23284     "version": "0.0.0",
23285     "filename": "server/api/smsInteraction/index.js",
23286     "groupTitle": "Sms_Interactions"
23287   },
23288   {
23289     "type": "get",
23290     "url": "/api/sms/interactions",
23291     "title": "Gets a list of Interactions",
23292     "examples": [
23293       {
23294         "title": "Example usage:",
23295         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23296         "type": "json"
23297       }
23298     ],
23299     "name": "GetInteractions",
23300     "group": "Sms_Interactions",
23301     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23302     "version": "0.0.0",
23303     "filename": "server/api/smsInteraction/index.js",
23304     "groupTitle": "Sms_Interactions"
23305   },
23306   {
23307     "type": "delete",
23308     "url": "/api/sms/interactions/{id}/tags",
23309     "title": "Removes tags from interaction",
23310     "examples": [
23311       {
23312         "title": "Example usage:",
23313         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23314         "type": "json"
23315       }
23316     ],
23317     "name": "RemoveTags",
23318     "group": "Sms_Interactions",
23319     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23320     "version": "0.0.0",
23321     "filename": "server/api/smsInteraction/index.js",
23322     "groupTitle": "Sms_Interactions"
23323   },
23324   {
23325     "type": "get",
23326     "url": "/api/sms/interactions/{id}",
23327     "title": "Gets a single Interaction",
23328     "examples": [
23329       {
23330         "title": "Example usage:",
23331         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23332         "type": "json"
23333       }
23334     ],
23335     "name": "ShowInteractions",
23336     "group": "Sms_Interactions",
23337     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23338     "version": "0.0.0",
23339     "filename": "server/api/smsInteraction/index.js",
23340     "groupTitle": "Sms_Interactions"
23341   },
23342   {
23343     "type": "post",
23344     "url": "/api/sms/interactions/{id}/messages",
23345     "title": "Creates new messages",
23346     "examples": [
23347       {
23348         "title": "Example usage:",
23349         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23350         "type": "json"
23351       }
23352     ],
23353     "name": "addMessage",
23354     "group": "Sms_Interactions",
23355     "parameter": {
23356       "fields": {
23357         "Body": [
23358           {
23359             "group": "Body",
23360             "type": "Text",
23361             "optional": false,
23362             "field": "body",
23363             "description": ""
23364           },
23365           {
23366             "group": "Body",
23367             "type": "Boolean",
23368             "optional": true,
23369             "field": "read",
23370             "description": ""
23371           },
23372           {
23373             "group": "Body",
23374             "type": "String",
23375             "allowedValues": [
23376               "\"in\"",
23377               "\"out\""
23378             ],
23379             "optional": false,
23380             "field": "direction",
23381             "description": ""
23382           },
23383           {
23384             "group": "Body",
23385             "type": "String",
23386             "optional": true,
23387             "field": "messageId",
23388             "description": ""
23389           },
23390           {
23391             "group": "Body",
23392             "type": "String",
23393             "optional": true,
23394             "field": "phone",
23395             "description": ""
23396           },
23397           {
23398             "group": "Body",
23399             "type": "String",
23400             "optional": true,
23401             "field": "readAt",
23402             "description": ""
23403           },
23404           {
23405             "group": "Body",
23406             "type": "Boolean",
23407             "optional": true,
23408             "field": "secret",
23409             "description": ""
23410           },
23411           {
23412             "group": "Body",
23413             "type": "String",
23414             "optional": true,
23415             "field": "providerName",
23416             "description": ""
23417           },
23418           {
23419             "group": "Body",
23420             "type": "Text",
23421             "optional": true,
23422             "field": "providerResponse",
23423             "description": ""
23424           }
23425         ]
23426       }
23427     },
23428     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23429     "version": "0.0.0",
23430     "filename": "server/api/smsInteraction/index.js",
23431     "groupTitle": "Sms_Interactions"
23432   },
23433   {
23434     "type": "get",
23435     "url": "/api/sms/interactions/{id}/download",
23436     "title": "Gets interaction",
23437     "examples": [
23438       {
23439         "title": "Example usage:",
23440         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23441         "type": "json"
23442       }
23443     ],
23444     "name": "download",
23445     "group": "Sms_Interactions",
23446     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23447     "version": "0.0.0",
23448     "filename": "server/api/smsInteraction/index.js",
23449     "groupTitle": "Sms_Interactions"
23450   },
23451   {
23452     "type": "get",
23453     "url": "/api/sms/interactions/{id}/messages",
23454     "title": "Gets interaction messages",
23455     "examples": [
23456       {
23457         "title": "Example usage:",
23458         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23459         "type": "json"
23460       }
23461     ],
23462     "name": "getMessages",
23463     "group": "Sms_Interactions",
23464     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23465     "version": "0.0.0",
23466     "filename": "server/api/smsInteraction/index.js",
23467     "groupTitle": "Sms_Interactions"
23468   },
23469   {
23470     "type": "put",
23471     "url": "/api/sms/interactions/{id}",
23472     "title": "Update an existing Interaction",
23473     "examples": [
23474       {
23475         "title": "Example usage:",
23476         "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",
23477         "type": "json"
23478       }
23479     ],
23480     "name": "updateInteractions",
23481     "group": "Sms_Interactions",
23482     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23483     "version": "0.0.0",
23484     "filename": "server/api/smsInteraction/index.js",
23485     "groupTitle": "Sms_Interactions"
23486   },
23487   {
23488     "type": "post",
23489     "url": "/api/sms/messages",
23490     "title": "Creates a new Message",
23491     "examples": [
23492       {
23493         "title": "Example usage:",
23494         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23495         "type": "json"
23496       }
23497     ],
23498     "name": "CreateMessages",
23499     "group": "Sms_Messages",
23500     "parameter": {
23501       "fields": {
23502         "Body": [
23503           {
23504             "group": "Body",
23505             "type": "Text",
23506             "optional": false,
23507             "field": "body",
23508             "description": ""
23509           },
23510           {
23511             "group": "Body",
23512             "type": "Boolean",
23513             "optional": true,
23514             "field": "read",
23515             "description": ""
23516           },
23517           {
23518             "group": "Body",
23519             "type": "String",
23520             "allowedValues": [
23521               "\"in\"",
23522               "\"out\""
23523             ],
23524             "optional": false,
23525             "field": "direction",
23526             "description": ""
23527           },
23528           {
23529             "group": "Body",
23530             "type": "String",
23531             "optional": true,
23532             "field": "messageId",
23533             "description": ""
23534           },
23535           {
23536             "group": "Body",
23537             "type": "String",
23538             "optional": true,
23539             "field": "phone",
23540             "description": ""
23541           },
23542           {
23543             "group": "Body",
23544             "type": "String",
23545             "optional": true,
23546             "field": "readAt",
23547             "description": ""
23548           },
23549           {
23550             "group": "Body",
23551             "type": "Boolean",
23552             "optional": true,
23553             "field": "secret",
23554             "description": ""
23555           },
23556           {
23557             "group": "Body",
23558             "type": "String",
23559             "optional": true,
23560             "field": "providerName",
23561             "description": ""
23562           },
23563           {
23564             "group": "Body",
23565             "type": "Text",
23566             "optional": true,
23567             "field": "providerResponse",
23568             "description": ""
23569           }
23570         ]
23571       }
23572     },
23573     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23574     "version": "0.0.0",
23575     "filename": "server/api/smsMessage/index.js",
23576     "groupTitle": "Sms_Messages"
23577   },
23578   {
23579     "type": "delete",
23580     "url": "/api/sms/messages/{id}",
23581     "title": "Deletes a Message",
23582     "examples": [
23583       {
23584         "title": "Example usage:",
23585         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23586         "type": "json"
23587       }
23588     ],
23589     "name": "DeleteMessages",
23590     "group": "Sms_Messages",
23591     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23592     "version": "0.0.0",
23593     "filename": "server/api/smsMessage/index.js",
23594     "groupTitle": "Sms_Messages"
23595   },
23596   {
23597     "type": "get",
23598     "url": "/api/sms/messages/describe",
23599     "title": "Gets table info about Messages",
23600     "examples": [
23601       {
23602         "title": "Example usage:",
23603         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23604         "type": "json"
23605       }
23606     ],
23607     "name": "DescribeMessages",
23608     "group": "Sms_Messages",
23609     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23610     "version": "0.0.0",
23611     "filename": "server/api/smsMessage/index.js",
23612     "groupTitle": "Sms_Messages"
23613   },
23614   {
23615     "type": "get",
23616     "url": "/api/sms/messages",
23617     "title": "Gets a list of Messages",
23618     "examples": [
23619       {
23620         "title": "Example usage:",
23621         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23622         "type": "json"
23623       }
23624     ],
23625     "name": "GetMessages",
23626     "group": "Sms_Messages",
23627     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23628     "version": "0.0.0",
23629     "filename": "server/api/smsMessage/index.js",
23630     "groupTitle": "Sms_Messages"
23631   },
23632   {
23633     "type": "get",
23634     "url": "/api/sms/messages/{id}",
23635     "title": "Gets a single Message",
23636     "examples": [
23637       {
23638         "title": "Example usage:",
23639         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23640         "type": "json"
23641       }
23642     ],
23643     "name": "ShowMessages",
23644     "group": "Sms_Messages",
23645     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23646     "version": "0.0.0",
23647     "filename": "server/api/smsMessage/index.js",
23648     "groupTitle": "Sms_Messages"
23649   },
23650   {
23651     "type": "put",
23652     "url": "/api/sms/messages/{id}",
23653     "title": "Update an existing Message",
23654     "examples": [
23655       {
23656         "title": "Example usage:",
23657         "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",
23658         "type": "json"
23659       }
23660     ],
23661     "name": "updateMessages",
23662     "group": "Sms_Messages",
23663     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23664     "version": "0.0.0",
23665     "filename": "server/api/smsMessage/index.js",
23666     "groupTitle": "Sms_Messages"
23667   },
23668   {
23669     "type": "post",
23670     "url": "/api/sms/reports/queue",
23671     "title": "Creates a new Sms Queue Report",
23672     "examples": [
23673       {
23674         "title": "Example usage:",
23675         "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",
23676         "type": "json"
23677       }
23678     ],
23679     "name": "CreateSms_Queue_Reports",
23680     "group": "Sms_Queue_Reports",
23681     "parameter": {
23682       "fields": {
23683         "Body": [
23684           {
23685             "group": "Body",
23686             "type": "String",
23687             "optional": false,
23688             "field": "uniqueid",
23689             "description": ""
23690           },
23691           {
23692             "group": "Body",
23693             "type": "String",
23694             "optional": true,
23695             "field": "from",
23696             "description": ""
23697           },
23698           {
23699             "group": "Body",
23700             "type": "String",
23701             "optional": true,
23702             "field": "joinAt",
23703             "description": ""
23704           },
23705           {
23706             "group": "Body",
23707             "type": "String",
23708             "optional": true,
23709             "field": "leaveAt",
23710             "description": ""
23711           },
23712           {
23713             "group": "Body",
23714             "type": "String",
23715             "optional": true,
23716             "field": "acceptAt",
23717             "description": ""
23718           },
23719           {
23720             "group": "Body",
23721             "type": "String",
23722             "optional": true,
23723             "field": "exitAt",
23724             "description": ""
23725           },
23726           {
23727             "group": "Body",
23728             "type": "String",
23729             "optional": true,
23730             "field": "reason",
23731             "description": ""
23732           }
23733         ]
23734       }
23735     },
23736     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23737     "version": "0.0.0",
23738     "filename": "server/api/smsQueueReport/index.js",
23739     "groupTitle": "Sms_Queue_Reports"
23740   },
23741   {
23742     "type": "delete",
23743     "url": "/api/sms/reports/queue/{id}",
23744     "title": "Deletes a Sms Queue Report",
23745     "examples": [
23746       {
23747         "title": "Example usage:",
23748         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23749         "type": "json"
23750       }
23751     ],
23752     "name": "DeleteSms_Queue_Reports",
23753     "group": "Sms_Queue_Reports",
23754     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23755     "version": "0.0.0",
23756     "filename": "server/api/smsQueueReport/index.js",
23757     "groupTitle": "Sms_Queue_Reports"
23758   },
23759   {
23760     "type": "get",
23761     "url": "/api/sms/reports/queue/describe",
23762     "title": "Gets table info about Sms Queue Reports",
23763     "examples": [
23764       {
23765         "title": "Example usage:",
23766         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23767         "type": "json"
23768       }
23769     ],
23770     "name": "DescribeSms_Queue_Reports",
23771     "group": "Sms_Queue_Reports",
23772     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23773     "version": "0.0.0",
23774     "filename": "server/api/smsQueueReport/index.js",
23775     "groupTitle": "Sms_Queue_Reports"
23776   },
23777   {
23778     "type": "get",
23779     "url": "/api/sms/reports/queue",
23780     "title": "Gets a list of Sms Queue Reports",
23781     "examples": [
23782       {
23783         "title": "Example usage:",
23784         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23785         "type": "json"
23786       }
23787     ],
23788     "name": "GetSms_Queue_Reports",
23789     "group": "Sms_Queue_Reports",
23790     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23791     "version": "0.0.0",
23792     "filename": "server/api/smsQueueReport/index.js",
23793     "groupTitle": "Sms_Queue_Reports"
23794   },
23795   {
23796     "type": "get",
23797     "url": "/api/sms/reports/queue/{id}",
23798     "title": "Gets a single Sms Queue Report",
23799     "examples": [
23800       {
23801         "title": "Example usage:",
23802         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23803         "type": "json"
23804       }
23805     ],
23806     "name": "ShowSms_Queue_Reports",
23807     "group": "Sms_Queue_Reports",
23808     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23809     "version": "0.0.0",
23810     "filename": "server/api/smsQueueReport/index.js",
23811     "groupTitle": "Sms_Queue_Reports"
23812   },
23813   {
23814     "type": "put",
23815     "url": "/api/sms/reports/queue/{id}",
23816     "title": "Update an existing Sms Queue Report",
23817     "examples": [
23818       {
23819         "title": "Example usage:",
23820         "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",
23821         "type": "json"
23822       }
23823     ],
23824     "name": "updateSms_Queue_Reports",
23825     "group": "Sms_Queue_Reports",
23826     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23827     "version": "0.0.0",
23828     "filename": "server/api/smsQueueReport/index.js",
23829     "groupTitle": "Sms_Queue_Reports"
23830   },
23831   {
23832     "type": "post",
23833     "url": "/api/sms/queues/{id}/users",
23834     "title": "Add agents to a queue",
23835     "examples": [
23836       {
23837         "title": "Example usage:",
23838         "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",
23839         "type": "json"
23840       }
23841     ],
23842     "name": "AddAgents",
23843     "group": "Sms_Queues",
23844     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23845     "version": "0.0.0",
23846     "filename": "server/api/smsQueue/index.js",
23847     "groupTitle": "Sms_Queues"
23848   },
23849   {
23850     "type": "post",
23851     "url": "/api/sms/queues/{id}/teams",
23852     "title": "Add teams to a queue",
23853     "examples": [
23854       {
23855         "title": "Example usage:",
23856         "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",
23857         "type": "json"
23858       }
23859     ],
23860     "name": "AddTeams",
23861     "group": "Sms_Queues",
23862     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23863     "version": "0.0.0",
23864     "filename": "server/api/smsQueue/index.js",
23865     "groupTitle": "Sms_Queues"
23866   },
23867   {
23868     "type": "post",
23869     "url": "/api/sms/queues",
23870     "title": "Creates a new Queue",
23871     "examples": [
23872       {
23873         "title": "Example usage:",
23874         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23875         "type": "json"
23876       }
23877     ],
23878     "name": "CreateQueues",
23879     "group": "Sms_Queues",
23880     "parameter": {
23881       "fields": {
23882         "Body": [
23883           {
23884             "group": "Body",
23885             "type": "String",
23886             "optional": true,
23887             "field": "name",
23888             "description": ""
23889           },
23890           {
23891             "group": "Body",
23892             "type": "String",
23893             "optional": true,
23894             "field": "description",
23895             "description": ""
23896           },
23897           {
23898             "group": "Body",
23899             "type": "Integer",
23900             "optional": true,
23901             "field": "timeout",
23902             "description": ""
23903           },
23904           {
23905             "group": "Body",
23906             "type": "String",
23907             "allowedValues": [
23908               "\"rrmemory\"",
23909               "\"beepall\"",
23910               "\"roundrobin\""
23911             ],
23912             "optional": true,
23913             "field": "strategy",
23914             "description": ""
23915           }
23916         ]
23917       }
23918     },
23919     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</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": "delete",
23926     "url": "/api/sms/queues/{id}",
23927     "title": "Deletes a Queue",
23928     "examples": [
23929       {
23930         "title": "Example usage:",
23931         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23932         "type": "json"
23933       }
23934     ],
23935     "name": "DeleteQueues",
23936     "group": "Sms_Queues",
23937     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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": "get",
23944     "url": "/api/sms/queues/describe",
23945     "title": "Gets table info about Queues",
23946     "examples": [
23947       {
23948         "title": "Example usage:",
23949         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23950         "type": "json"
23951       }
23952     ],
23953     "name": "DescribeQueues",
23954     "group": "Sms_Queues",
23955     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23956     "version": "0.0.0",
23957     "filename": "server/api/smsQueue/index.js",
23958     "groupTitle": "Sms_Queues"
23959   },
23960   {
23961     "type": "get",
23962     "url": "/api/sms/queues/{id}/users",
23963     "title": "Gets queue agents",
23964     "examples": [
23965       {
23966         "title": "Example usage:",
23967         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23968         "type": "json"
23969       }
23970     ],
23971     "name": "GetAgents",
23972     "group": "Sms_Queues",
23973     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23974     "version": "0.0.0",
23975     "filename": "server/api/smsQueue/index.js",
23976     "groupTitle": "Sms_Queues"
23977   },
23978   {
23979     "type": "get",
23980     "url": "/api/sms/queues/{id}/members",
23981     "title": "GetMembers",
23982     "examples": [
23983       {
23984         "title": "Example usage:",
23985         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
23986         "type": "json"
23987       }
23988     ],
23989     "name": "GetMembers",
23990     "group": "Sms_Queues",
23991     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23992     "version": "0.0.0",
23993     "filename": "server/api/smsQueue/index.js",
23994     "groupTitle": "Sms_Queues"
23995   },
23996   {
23997     "type": "get",
23998     "url": "/api/sms/queues",
23999     "title": "Gets a list of Queues",
24000     "examples": [
24001       {
24002         "title": "Example usage:",
24003         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
24004         "type": "json"
24005       }
24006     ],
24007     "name": "GetQueues",
24008     "group": "Sms_Queues",
24009     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24010     "version": "0.0.0",
24011     "filename": "server/api/smsQueue/index.js",
24012     "groupTitle": "Sms_Queues"
24013   },
24014   {
24015     "type": "get",
24016     "url": "/api/sms/queues/{id}/teams",
24017     "title": "Gets queues list",
24018     "examples": [
24019       {
24020         "title": "Example usage:",
24021         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
24022         "type": "json"
24023       }
24024     ],
24025     "name": "GetTeams",
24026     "group": "Sms_Queues",
24027     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24028     "version": "0.0.0",
24029     "filename": "server/api/smsQueue/index.js",
24030     "groupTitle": "Sms_Queues"
24031   },
24032   {
24033     "type": "delete",
24034     "url": "/api/sms/queues/{id}/users",
24035     "title": "Removes agents from a queue",
24036     "examples": [
24037       {
24038         "title": "Example usage:",
24039         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24040         "type": "json"
24041       }
24042     ],
24043     "name": "RemoveAgents",
24044     "group": "Sms_Queues",
24045     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24046     "version": "0.0.0",
24047     "filename": "server/api/smsQueue/index.js",
24048     "groupTitle": "Sms_Queues"
24049   },
24050   {
24051     "type": "get",
24052     "url": "/api/sms/queues/{id}",
24053     "title": "Gets a single Queue",
24054     "examples": [
24055       {
24056         "title": "Example usage:",
24057         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
24058         "type": "json"
24059       }
24060     ],
24061     "name": "ShowQueues",
24062     "group": "Sms_Queues",
24063     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24064     "version": "0.0.0",
24065     "filename": "server/api/smsQueue/index.js",
24066     "groupTitle": "Sms_Queues"
24067   },
24068   {
24069     "type": "put",
24070     "url": "/api/sms/queues/{id}",
24071     "title": "Update an existing Queue",
24072     "examples": [
24073       {
24074         "title": "Example usage:",
24075         "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",
24076         "type": "json"
24077       }
24078     ],
24079     "name": "updateQueues",
24080     "group": "Sms_Queues",
24081     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24082     "version": "0.0.0",
24083     "filename": "server/api/smsQueue/index.js",
24084     "groupTitle": "Sms_Queues"
24085   },
24086   {
24087     "type": "post",
24088     "url": "/api/sms/reports/transfer",
24089     "title": "Creates a new Sms Transfer Report",
24090     "examples": [
24091       {
24092         "title": "Example usage:",
24093         "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",
24094         "type": "json"
24095       }
24096     ],
24097     "name": "CreateSms_Transfer_Reports",
24098     "group": "Sms_Transfer_Reports",
24099     "parameter": {
24100       "fields": {
24101         "Body": [
24102           {
24103             "group": "Body",
24104             "type": "String",
24105             "optional": false,
24106             "field": "uniqueid",
24107             "description": ""
24108           },
24109           {
24110             "group": "Body",
24111             "type": "String",
24112             "allowedValues": [
24113               "\"account\"",
24114               "\"agent\"",
24115               "\"queue\""
24116             ],
24117             "optional": false,
24118             "field": "type",
24119             "description": ""
24120           },
24121           {
24122             "group": "Body",
24123             "type": "String",
24124             "optional": false,
24125             "field": "transferredAt",
24126             "description": ""
24127           }
24128         ]
24129       }
24130     },
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/smsTransferReport/index.js",
24134     "groupTitle": "Sms_Transfer_Reports"
24135   },
24136   {
24137     "type": "delete",
24138     "url": "/api/sms/reports/transfer/{id}",
24139     "title": "Deletes a Sms Transfer Report",
24140     "examples": [
24141       {
24142         "title": "Example usage:",
24143         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24144         "type": "json"
24145       }
24146     ],
24147     "name": "DeleteSms_Transfer_Reports",
24148     "group": "Sms_Transfer_Reports",
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/smsTransferReport/index.js",
24152     "groupTitle": "Sms_Transfer_Reports"
24153   },
24154   {
24155     "type": "get",
24156     "url": "/api/sms/reports/transfer/describe",
24157     "title": "Gets table info about Sms Transfer Reports",
24158     "examples": [
24159       {
24160         "title": "Example usage:",
24161         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24162         "type": "json"
24163       }
24164     ],
24165     "name": "DescribeSms_Transfer_Reports",
24166     "group": "Sms_Transfer_Reports",
24167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24168     "version": "0.0.0",
24169     "filename": "server/api/smsTransferReport/index.js",
24170     "groupTitle": "Sms_Transfer_Reports"
24171   },
24172   {
24173     "type": "get",
24174     "url": "/api/sms/reports/transfer",
24175     "title": "Gets a list of Sms Transfer Reports",
24176     "examples": [
24177       {
24178         "title": "Example usage:",
24179         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24180         "type": "json"
24181       }
24182     ],
24183     "name": "GetSms_Transfer_Reports",
24184     "group": "Sms_Transfer_Reports",
24185     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24186     "version": "0.0.0",
24187     "filename": "server/api/smsTransferReport/index.js",
24188     "groupTitle": "Sms_Transfer_Reports"
24189   },
24190   {
24191     "type": "get",
24192     "url": "/api/sms/reports/transfer/{id}",
24193     "title": "Gets a single Sms Transfer Report",
24194     "examples": [
24195       {
24196         "title": "Example usage:",
24197         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24198         "type": "json"
24199       }
24200     ],
24201     "name": "ShowSms_Transfer_Reports",
24202     "group": "Sms_Transfer_Reports",
24203     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24204     "version": "0.0.0",
24205     "filename": "server/api/smsTransferReport/index.js",
24206     "groupTitle": "Sms_Transfer_Reports"
24207   },
24208   {
24209     "type": "put",
24210     "url": "/api/sms/reports/transfer/{id}",
24211     "title": "Update an existing Sms Transfer Report",
24212     "examples": [
24213       {
24214         "title": "Example usage:",
24215         "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",
24216         "type": "json"
24217       }
24218     ],
24219     "name": "updateSms_Transfer_Reports",
24220     "group": "Sms_Transfer_Reports",
24221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24222     "version": "0.0.0",
24223     "filename": "server/api/smsTransferReport/index.js",
24224     "groupTitle": "Sms_Transfer_Reports"
24225   },
24226   {
24227     "type": "get",
24228     "url": "/api/sounds",
24229     "title": "Gets a list of Sounds",
24230     "examples": [
24231       {
24232         "title": "Example usage:",
24233         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24234         "type": "json"
24235       }
24236     ],
24237     "name": "GetSounds",
24238     "group": "Sounds",
24239     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24240     "version": "0.0.0",
24241     "filename": "server/api/sound/index.js",
24242     "groupTitle": "Sounds"
24243   },
24244   {
24245     "type": "get",
24246     "url": "/api/sounds/{id}",
24247     "title": "Gets a single Sound",
24248     "examples": [
24249       {
24250         "title": "Example usage:",
24251         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24252         "type": "json"
24253       }
24254     ],
24255     "name": "ShowSounds",
24256     "group": "Sounds",
24257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24258     "version": "0.0.0",
24259     "filename": "server/api/sound/index.js",
24260     "groupTitle": "Sounds"
24261   },
24262   {
24263     "type": "post",
24264     "url": "/api/sounds",
24265     "title": "Create a new sound",
24266     "examples": [
24267       {
24268         "title": "Example usage:",
24269         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24270         "type": "json"
24271       }
24272     ],
24273     "name": "addSound",
24274     "group": "Sounds",
24275     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24276     "version": "0.0.0",
24277     "filename": "server/api/sound/index.js",
24278     "groupTitle": "Sounds"
24279   },
24280   {
24281     "type": "delete",
24282     "url": "/api/sounds/{id}",
24283     "title": "Deletes a sound",
24284     "examples": [
24285       {
24286         "title": "Example usage:",
24287         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24288         "type": "json"
24289       }
24290     ],
24291     "name": "destroySound",
24292     "group": "Sounds",
24293     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24294     "version": "0.0.0",
24295     "filename": "server/api/sound/index.js",
24296     "groupTitle": "Sounds"
24297   },
24298   {
24299     "type": "get",
24300     "url": "/api/sounds/{id}/download",
24301     "title": "Download Sound",
24302     "examples": [
24303       {
24304         "title": "Example usage:",
24305         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24306         "type": "json"
24307       }
24308     ],
24309     "name": "download",
24310     "group": "Sounds",
24311     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24312     "version": "0.0.0",
24313     "filename": "server/api/sound/index.js",
24314     "groupTitle": "Sounds"
24315   },
24316   {
24317     "type": "put",
24318     "url": "/api/sounds",
24319     "title": "Update an existing new sound",
24320     "examples": [
24321       {
24322         "title": "Example usage:",
24323         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24324         "type": "json"
24325       }
24326     ],
24327     "name": "updateSound",
24328     "group": "Sounds",
24329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24330     "version": "0.0.0",
24331     "filename": "server/api/sound/index.js",
24332     "groupTitle": "Sounds"
24333   },
24334   {
24335     "type": "post",
24336     "url": "/api/square/details/reports",
24337     "title": "Creates a new Square Detail Report",
24338     "examples": [
24339       {
24340         "title": "Example usage:",
24341         "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",
24342         "type": "json"
24343       }
24344     ],
24345     "name": "CreateSquare_Detail_Reports",
24346     "group": "Square_Details_Reports",
24347     "parameter": {
24348       "fields": {
24349         "Body": [
24350           {
24351             "group": "Body",
24352             "type": "String",
24353             "optional": true,
24354             "field": "uniqueid",
24355             "description": ""
24356           },
24357           {
24358             "group": "Body",
24359             "type": "String",
24360             "optional": true,
24361             "field": "node",
24362             "description": ""
24363           },
24364           {
24365             "group": "Body",
24366             "type": "String",
24367             "optional": true,
24368             "field": "application",
24369             "description": ""
24370           },
24371           {
24372             "group": "Body",
24373             "type": "Text",
24374             "optional": true,
24375             "field": "data",
24376             "description": ""
24377           },
24378           {
24379             "group": "Body",
24380             "type": "String",
24381             "optional": true,
24382             "field": "project_name",
24383             "description": ""
24384           },
24385           {
24386             "group": "Body",
24387             "type": "String",
24388             "optional": true,
24389             "field": "callerid",
24390             "description": ""
24391           }
24392         ]
24393       }
24394     },
24395     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24396     "version": "0.0.0",
24397     "filename": "server/api/squareReportDetail/index.js",
24398     "groupTitle": "Square_Details_Reports"
24399   },
24400   {
24401     "type": "delete",
24402     "url": "/api/square/details/reports/{id}",
24403     "title": "Deletes a Square Detail Report",
24404     "examples": [
24405       {
24406         "title": "Example usage:",
24407         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24408         "type": "json"
24409       }
24410     ],
24411     "name": "DeleteSquare_Detail_Reports",
24412     "group": "Square_Details_Reports",
24413     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24414     "version": "0.0.0",
24415     "filename": "server/api/squareReportDetail/index.js",
24416     "groupTitle": "Square_Details_Reports"
24417   },
24418   {
24419     "type": "get",
24420     "url": "/api/square/details/reports/describe",
24421     "title": "Gets table info about Square Detail Reports",
24422     "examples": [
24423       {
24424         "title": "Example usage:",
24425         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24426         "type": "json"
24427       }
24428     ],
24429     "name": "DescribeSquare_Detail_Reports",
24430     "group": "Square_Details_Reports",
24431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24432     "version": "0.0.0",
24433     "filename": "server/api/squareReportDetail/index.js",
24434     "groupTitle": "Square_Details_Reports"
24435   },
24436   {
24437     "type": "get",
24438     "url": "/api/square/details/reports",
24439     "title": "Gets a list of Square Detail Reports",
24440     "examples": [
24441       {
24442         "title": "Example usage:",
24443         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24444         "type": "json"
24445       }
24446     ],
24447     "name": "GetSquare_Detail_Reports",
24448     "group": "Square_Details_Reports",
24449     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24450     "version": "0.0.0",
24451     "filename": "server/api/squareReportDetail/index.js",
24452     "groupTitle": "Square_Details_Reports"
24453   },
24454   {
24455     "type": "get",
24456     "url": "/api/square/details/reports/{id}",
24457     "title": "Gets a single Square Detail Report",
24458     "examples": [
24459       {
24460         "title": "Example usage:",
24461         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24462         "type": "json"
24463       }
24464     ],
24465     "name": "ShowSquare_Detail_Reports",
24466     "group": "Square_Details_Reports",
24467     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24468     "version": "0.0.0",
24469     "filename": "server/api/squareReportDetail/index.js",
24470     "groupTitle": "Square_Details_Reports"
24471   },
24472   {
24473     "type": "put",
24474     "url": "/api/square/details/reports/{id}",
24475     "title": "Update an existing Square Detail Report",
24476     "examples": [
24477       {
24478         "title": "Example usage:",
24479         "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",
24480         "type": "json"
24481       }
24482     ],
24483     "name": "updateSquare_Detail_Reports",
24484     "group": "Square_Details_Reports",
24485     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24486     "version": "0.0.0",
24487     "filename": "server/api/squareReportDetail/index.js",
24488     "groupTitle": "Square_Details_Reports"
24489   },
24490   {
24491     "type": "post",
24492     "url": "/api/square/messages",
24493     "title": "Creates a new Message",
24494     "examples": [
24495       {
24496         "title": "Example usage:",
24497         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24498         "type": "json"
24499       }
24500     ],
24501     "name": "CreateMessages",
24502     "group": "Square_Messages",
24503     "parameter": {
24504       "fields": {
24505         "Body": [
24506           {
24507             "group": "Body",
24508             "type": "String",
24509             "optional": true,
24510             "field": "uniqueid",
24511             "description": ""
24512           },
24513           {
24514             "group": "Body",
24515             "type": "Text",
24516             "optional": false,
24517             "field": "body",
24518             "description": ""
24519           },
24520           {
24521             "group": "Body",
24522             "type": "String",
24523             "allowedValues": [
24524               "\"in\"",
24525               "\"out\""
24526             ],
24527             "optional": false,
24528             "field": "direction",
24529             "description": ""
24530           },
24531           {
24532             "group": "Body",
24533             "type": "String",
24534             "optional": true,
24535             "field": "providerName",
24536             "description": ""
24537           },
24538           {
24539             "group": "Body",
24540             "type": "Text",
24541             "optional": true,
24542             "field": "providerResponse",
24543             "description": ""
24544           }
24545         ]
24546       }
24547     },
24548     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24549     "version": "0.0.0",
24550     "filename": "server/api/squareMessage/index.js",
24551     "groupTitle": "Square_Messages"
24552   },
24553   {
24554     "type": "delete",
24555     "url": "/api/square/messages/{id}",
24556     "title": "Deletes a Message",
24557     "examples": [
24558       {
24559         "title": "Example usage:",
24560         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24561         "type": "json"
24562       }
24563     ],
24564     "name": "DeleteMessages",
24565     "group": "Square_Messages",
24566     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24567     "version": "0.0.0",
24568     "filename": "server/api/squareMessage/index.js",
24569     "groupTitle": "Square_Messages"
24570   },
24571   {
24572     "type": "get",
24573     "url": "/api/square/messages",
24574     "title": "Gets a list of Messages",
24575     "examples": [
24576       {
24577         "title": "Example usage:",
24578         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24579         "type": "json"
24580       }
24581     ],
24582     "name": "GetMessages",
24583     "group": "Square_Messages",
24584     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24585     "version": "0.0.0",
24586     "filename": "server/api/squareMessage/index.js",
24587     "groupTitle": "Square_Messages"
24588   },
24589   {
24590     "type": "get",
24591     "url": "/api/square/messages/{id}",
24592     "title": "Gets a single Message",
24593     "examples": [
24594       {
24595         "title": "Example usage:",
24596         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24597         "type": "json"
24598       }
24599     ],
24600     "name": "ShowMessages",
24601     "group": "Square_Messages",
24602     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24603     "version": "0.0.0",
24604     "filename": "server/api/squareMessage/index.js",
24605     "groupTitle": "Square_Messages"
24606   },
24607   {
24608     "type": "put",
24609     "url": "/api/square/messages/{id}",
24610     "title": "Update an existing Message",
24611     "examples": [
24612       {
24613         "title": "Example usage:",
24614         "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",
24615         "type": "json"
24616       }
24617     ],
24618     "name": "updateMessages",
24619     "group": "Square_Messages",
24620     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24621     "version": "0.0.0",
24622     "filename": "server/api/squareMessage/index.js",
24623     "groupTitle": "Square_Messages"
24624   },
24625   {
24626     "type": "post",
24627     "url": "/api/square/odbc",
24628     "title": "Creates a new ODBC",
24629     "examples": [
24630       {
24631         "title": "Example usage:",
24632         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24633         "type": "json"
24634       }
24635     ],
24636     "name": "CreateODBCs",
24637     "group": "Square_ODBC",
24638     "parameter": {
24639       "fields": {
24640         "Body": [
24641           {
24642             "group": "Body",
24643             "type": "String",
24644             "optional": false,
24645             "field": "name",
24646             "description": ""
24647           },
24648           {
24649             "group": "Body",
24650             "type": "String",
24651             "optional": true,
24652             "field": "dsn",
24653             "description": ""
24654           },
24655           {
24656             "group": "Body",
24657             "type": "String",
24658             "optional": true,
24659             "field": "description",
24660             "description": ""
24661           }
24662         ]
24663       }
24664     },
24665     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24666     "version": "0.0.0",
24667     "filename": "server/api/squareOdbc/index.js",
24668     "groupTitle": "Square_ODBC"
24669   },
24670   {
24671     "type": "delete",
24672     "url": "/api/square/odbc/{id}",
24673     "title": "Deletes a ODBC",
24674     "examples": [
24675       {
24676         "title": "Example usage:",
24677         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24678         "type": "json"
24679       }
24680     ],
24681     "name": "DeleteODBCs",
24682     "group": "Square_ODBC",
24683     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24684     "version": "0.0.0",
24685     "filename": "server/api/squareOdbc/index.js",
24686     "groupTitle": "Square_ODBC"
24687   },
24688   {
24689     "type": "get",
24690     "url": "/api/square/odbc",
24691     "title": "Gets a list of ODBCs",
24692     "examples": [
24693       {
24694         "title": "Example usage:",
24695         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24696         "type": "json"
24697       }
24698     ],
24699     "name": "GetODBCs",
24700     "group": "Square_ODBC",
24701     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24702     "version": "0.0.0",
24703     "filename": "server/api/squareOdbc/index.js",
24704     "groupTitle": "Square_ODBC"
24705   },
24706   {
24707     "type": "get",
24708     "url": "/api/square/odbc/{id}",
24709     "title": "Gets a single ODBC",
24710     "examples": [
24711       {
24712         "title": "Example usage:",
24713         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24714         "type": "json"
24715       }
24716     ],
24717     "name": "ShowODBCs",
24718     "group": "Square_ODBC",
24719     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24720     "version": "0.0.0",
24721     "filename": "server/api/squareOdbc/index.js",
24722     "groupTitle": "Square_ODBC"
24723   },
24724   {
24725     "type": "get",
24726     "url": "/api/square/odbc/{id}/test",
24727     "title": "Test Odbc",
24728     "examples": [
24729       {
24730         "title": "Example usage:",
24731         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24732         "type": "json"
24733       }
24734     ],
24735     "name": "test",
24736     "group": "Square_ODBC",
24737     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24738     "version": "0.0.0",
24739     "filename": "server/api/squareOdbc/index.js",
24740     "groupTitle": "Square_ODBC"
24741   },
24742   {
24743     "type": "put",
24744     "url": "/api/square/odbc/{id}",
24745     "title": "Update an existing ODBC",
24746     "examples": [
24747       {
24748         "title": "Example usage:",
24749         "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",
24750         "type": "json"
24751       }
24752     ],
24753     "name": "updateODBCs",
24754     "group": "Square_ODBC",
24755     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24756     "version": "0.0.0",
24757     "filename": "server/api/squareOdbc/index.js",
24758     "groupTitle": "Square_ODBC"
24759   },
24760   {
24761     "type": "post",
24762     "url": "/api/square/projects",
24763     "title": "Creates a new Project",
24764     "examples": [
24765       {
24766         "title": "Example usage:",
24767         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24768         "type": "json"
24769       }
24770     ],
24771     "name": "CreateProjects",
24772     "group": "Square_Projects",
24773     "parameter": {
24774       "fields": {
24775         "Body": [
24776           {
24777             "group": "Body",
24778             "type": "String",
24779             "optional": false,
24780             "field": "name",
24781             "description": ""
24782           },
24783           {
24784             "group": "Body",
24785             "type": "String",
24786             "optional": true,
24787             "field": "description",
24788             "description": ""
24789           },
24790           {
24791             "group": "Body",
24792             "type": "Text",
24793             "optional": true,
24794             "field": "notes",
24795             "description": ""
24796           },
24797           {
24798             "group": "Body",
24799             "type": "Blob",
24800             "optional": true,
24801             "field": "preproduction",
24802             "description": ""
24803           },
24804           {
24805             "group": "Body",
24806             "type": "Blob",
24807             "optional": true,
24808             "field": "production",
24809             "description": ""
24810           },
24811           {
24812             "group": "Body",
24813             "type": "String",
24814             "optional": true,
24815             "field": "savedAt",
24816             "description": ""
24817           },
24818           {
24819             "group": "Body",
24820             "type": "String",
24821             "optional": true,
24822             "field": "publishedAt",
24823             "description": ""
24824           }
24825         ]
24826       }
24827     },
24828     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24829     "version": "0.0.0",
24830     "filename": "server/api/squareProject/index.js",
24831     "groupTitle": "Square_Projects"
24832   },
24833   {
24834     "type": "delete",
24835     "url": "/api/square/projects/{id}",
24836     "title": "Deletes a Project",
24837     "examples": [
24838       {
24839         "title": "Example usage:",
24840         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24841         "type": "json"
24842       }
24843     ],
24844     "name": "DeleteProjects",
24845     "group": "Square_Projects",
24846     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24847     "version": "0.0.0",
24848     "filename": "server/api/squareProject/index.js",
24849     "groupTitle": "Square_Projects"
24850   },
24851   {
24852     "type": "get",
24853     "url": "/api/square/projects",
24854     "title": "Gets a list of Projects",
24855     "examples": [
24856       {
24857         "title": "Example usage:",
24858         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24859         "type": "json"
24860       }
24861     ],
24862     "name": "GetProjects",
24863     "group": "Square_Projects",
24864     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24865     "version": "0.0.0",
24866     "filename": "server/api/squareProject/index.js",
24867     "groupTitle": "Square_Projects"
24868   },
24869   {
24870     "type": "get",
24871     "url": "/api/square/projects/{id}",
24872     "title": "Gets a single Project",
24873     "examples": [
24874       {
24875         "title": "Example usage:",
24876         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24877         "type": "json"
24878       }
24879     ],
24880     "name": "ShowProjects",
24881     "group": "Square_Projects",
24882     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24883     "version": "0.0.0",
24884     "filename": "server/api/squareProject/index.js",
24885     "groupTitle": "Square_Projects"
24886   },
24887   {
24888     "type": "post",
24889     "url": "/api/square/projects/{id}/users",
24890     "title": "Adds user permissions to a Project",
24891     "examples": [
24892       {
24893         "title": "Example usage:",
24894         "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",
24895         "type": "json"
24896       }
24897     ],
24898     "name": "addUsers",
24899     "group": "Square_Projects",
24900     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24901     "version": "0.0.0",
24902     "filename": "server/api/squareProject/index.js",
24903     "groupTitle": "Square_Projects"
24904   },
24905   {
24906     "type": "get",
24907     "url": "/api/square/projects/{id}/users",
24908     "title": "Gets users permissions from Project",
24909     "examples": [
24910       {
24911         "title": "Example usage:",
24912         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24913         "type": "json"
24914       }
24915     ],
24916     "name": "getUsers",
24917     "group": "Square_Projects",
24918     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24919     "version": "0.0.0",
24920     "filename": "server/api/squareProject/index.js",
24921     "groupTitle": "Square_Projects"
24922   },
24923   {
24924     "type": "delete",
24925     "url": "/api/square/projects/{id}/users",
24926     "title": "Removes user permissions from a Project",
24927     "examples": [
24928       {
24929         "title": "Example usage:",
24930         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24931         "type": "json"
24932       }
24933     ],
24934     "name": "removeUsers",
24935     "group": "Square_Projects",
24936     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24937     "version": "0.0.0",
24938     "filename": "server/api/squareProject/index.js",
24939     "groupTitle": "Square_Projects"
24940   },
24941   {
24942     "type": "put",
24943     "url": "/api/square/projects/{id}",
24944     "title": "Update an existing Project",
24945     "examples": [
24946       {
24947         "title": "Example usage:",
24948         "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",
24949         "type": "json"
24950       }
24951     ],
24952     "name": "updateProjects",
24953     "group": "Square_Projects",
24954     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24955     "version": "0.0.0",
24956     "filename": "server/api/squareProject/index.js",
24957     "groupTitle": "Square_Projects"
24958   },
24959   {
24960     "type": "post",
24961     "url": "/api/square/recordings",
24962     "title": "Creates a new Recording",
24963     "examples": [
24964       {
24965         "title": "Example usage:",
24966         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24967         "type": "json"
24968       }
24969     ],
24970     "name": "CreateRecordings",
24971     "group": "Square_Recordings",
24972     "parameter": {
24973       "fields": {
24974         "Body": [
24975           {
24976             "group": "Body",
24977             "type": "String",
24978             "optional": true,
24979             "field": "uniqueid",
24980             "description": ""
24981           },
24982           {
24983             "group": "Body",
24984             "type": "String",
24985             "optional": true,
24986             "field": "callerid",
24987             "description": ""
24988           },
24989           {
24990             "group": "Body",
24991             "type": "String",
24992             "optional": true,
24993             "field": "calleridname",
24994             "description": ""
24995           },
24996           {
24997             "group": "Body",
24998             "type": "String",
24999             "optional": true,
25000             "field": "context",
25001             "description": ""
25002           },
25003           {
25004             "group": "Body",
25005             "type": "String",
25006             "optional": true,
25007             "field": "extension",
25008             "description": ""
25009           },
25010           {
25011             "group": "Body",
25012             "type": "String",
25013             "optional": true,
25014             "field": "priority",
25015             "description": ""
25016           },
25017           {
25018             "group": "Body",
25019             "type": "String",
25020             "optional": true,
25021             "field": "accountcode",
25022             "description": ""
25023           },
25024           {
25025             "group": "Body",
25026             "type": "String",
25027             "optional": true,
25028             "field": "dnid",
25029             "description": ""
25030           },
25031           {
25032             "group": "Body",
25033             "type": "String",
25034             "optional": true,
25035             "field": "projectName",
25036             "description": ""
25037           },
25038           {
25039             "group": "Body",
25040             "type": "String",
25041             "optional": true,
25042             "field": "saveName",
25043             "description": ""
25044           },
25045           {
25046             "group": "Body",
25047             "type": "String",
25048             "optional": true,
25049             "field": "filename",
25050             "description": ""
25051           },
25052           {
25053             "group": "Body",
25054             "type": "String",
25055             "optional": true,
25056             "field": "savePath",
25057             "description": ""
25058           },
25059           {
25060             "group": "Body",
25061             "type": "Virtual",
25062             "optional": true,
25063             "field": "format",
25064             "description": ""
25065           }
25066         ]
25067       }
25068     },
25069     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25070     "version": "0.0.0",
25071     "filename": "server/api/squareRecording/index.js",
25072     "groupTitle": "Square_Recordings"
25073   },
25074   {
25075     "type": "get",
25076     "url": "/api/square/recordings",
25077     "title": "Gets a list of Recordings",
25078     "examples": [
25079       {
25080         "title": "Example usage:",
25081         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
25082         "type": "json"
25083       }
25084     ],
25085     "name": "GetRecordings",
25086     "group": "Square_Recordings",
25087     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25088     "version": "0.0.0",
25089     "filename": "server/api/squareRecording/index.js",
25090     "groupTitle": "Square_Recordings"
25091   },
25092   {
25093     "type": "get",
25094     "url": "/api/square/recordings/{id}",
25095     "title": "Gets a single Recording",
25096     "examples": [
25097       {
25098         "title": "Example usage:",
25099         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
25100         "type": "json"
25101       }
25102     ],
25103     "name": "ShowRecordings",
25104     "group": "Square_Recordings",
25105     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25106     "version": "0.0.0",
25107     "filename": "server/api/squareRecording/index.js",
25108     "groupTitle": "Square_Recordings"
25109   },
25110   {
25111     "type": "delete",
25112     "url": "/api/square/recordings/{id}",
25113     "title": "Delete recording",
25114     "examples": [
25115       {
25116         "title": "Example usage:",
25117         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
25118         "type": "json"
25119       }
25120     ],
25121     "name": "destroy",
25122     "group": "Square_Recordings",
25123     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25124     "version": "0.0.0",
25125     "filename": "server/api/squareRecording/index.js",
25126     "groupTitle": "Square_Recordings"
25127   },
25128   {
25129     "type": "get",
25130     "url": "/api/square/recordings/{id}/download",
25131     "title": "Download Recording",
25132     "examples": [
25133       {
25134         "title": "Example usage:",
25135         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25136         "type": "json"
25137       }
25138     ],
25139     "name": "download",
25140     "group": "Square_Recordings",
25141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25142     "version": "0.0.0",
25143     "filename": "server/api/squareRecording/index.js",
25144     "groupTitle": "Square_Recordings"
25145   },
25146   {
25147     "type": "put",
25148     "url": "/api/square/recordings/{id}",
25149     "title": "Update an existing Recording",
25150     "examples": [
25151       {
25152         "title": "Example usage:",
25153         "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",
25154         "type": "json"
25155       }
25156     ],
25157     "name": "updateRecordings",
25158     "group": "Square_Recordings",
25159     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25160     "version": "0.0.0",
25161     "filename": "server/api/squareRecording/index.js",
25162     "groupTitle": "Square_Recordings"
25163   },
25164   {
25165     "type": "post",
25166     "url": "/api/square/reports",
25167     "title": "Creates a new Square Report",
25168     "examples": [
25169       {
25170         "title": "Example usage:",
25171         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25172         "type": "json"
25173       }
25174     ],
25175     "name": "CreateSquare_Reports",
25176     "group": "Square_Reports",
25177     "parameter": {
25178       "fields": {
25179         "Body": [
25180           {
25181             "group": "Body",
25182             "type": "String",
25183             "optional": true,
25184             "field": "network",
25185             "description": ""
25186           },
25187           {
25188             "group": "Body",
25189             "type": "String",
25190             "optional": true,
25191             "field": "network_script",
25192             "description": ""
25193           },
25194           {
25195             "group": "Body",
25196             "type": "String",
25197             "optional": true,
25198             "field": "request",
25199             "description": ""
25200           },
25201           {
25202             "group": "Body",
25203             "type": "String",
25204             "optional": true,
25205             "field": "channel",
25206             "description": ""
25207           },
25208           {
25209             "group": "Body",
25210             "type": "String",
25211             "optional": true,
25212             "field": "language",
25213             "description": ""
25214           },
25215           {
25216             "group": "Body",
25217             "type": "String",
25218             "optional": true,
25219             "field": "type",
25220             "description": ""
25221           },
25222           {
25223             "group": "Body",
25224             "type": "String",
25225             "optional": true,
25226             "field": "uniqueid",
25227             "description": ""
25228           },
25229           {
25230             "group": "Body",
25231             "type": "String",
25232             "optional": true,
25233             "field": "version",
25234             "description": ""
25235           },
25236           {
25237             "group": "Body",
25238             "type": "String",
25239             "optional": true,
25240             "field": "callerid",
25241             "description": ""
25242           },
25243           {
25244             "group": "Body",
25245             "type": "String",
25246             "optional": true,
25247             "field": "calleridname",
25248             "description": ""
25249           },
25250           {
25251             "group": "Body",
25252             "type": "String",
25253             "optional": true,
25254             "field": "callingpres",
25255             "description": ""
25256           },
25257           {
25258             "group": "Body",
25259             "type": "String",
25260             "optional": true,
25261             "field": "callingani2",
25262             "description": ""
25263           },
25264           {
25265             "group": "Body",
25266             "type": "String",
25267             "optional": true,
25268             "field": "callington",
25269             "description": ""
25270           },
25271           {
25272             "group": "Body",
25273             "type": "String",
25274             "optional": true,
25275             "field": "callingtns",
25276             "description": ""
25277           },
25278           {
25279             "group": "Body",
25280             "type": "String",
25281             "optional": true,
25282             "field": "dnid",
25283             "description": ""
25284           },
25285           {
25286             "group": "Body",
25287             "type": "String",
25288             "optional": true,
25289             "field": "rdnis",
25290             "description": ""
25291           },
25292           {
25293             "group": "Body",
25294             "type": "String",
25295             "optional": true,
25296             "field": "context",
25297             "description": ""
25298           },
25299           {
25300             "group": "Body",
25301             "type": "String",
25302             "optional": true,
25303             "field": "extension",
25304             "description": ""
25305           },
25306           {
25307             "group": "Body",
25308             "type": "String",
25309             "optional": true,
25310             "field": "priority",
25311             "description": ""
25312           },
25313           {
25314             "group": "Body",
25315             "type": "String",
25316             "optional": true,
25317             "field": "enhanced",
25318             "description": ""
25319           },
25320           {
25321             "group": "Body",
25322             "type": "String",
25323             "optional": true,
25324             "field": "accountcode",
25325             "description": ""
25326           },
25327           {
25328             "group": "Body",
25329             "type": "String",
25330             "optional": true,
25331             "field": "threadid",
25332             "description": ""
25333           },
25334           {
25335             "group": "Body",
25336             "type": "String",
25337             "optional": true,
25338             "field": "project_name",
25339             "description": ""
25340           },
25341           {
25342             "group": "Body",
25343             "type": "String",
25344             "optional": true,
25345             "field": "joinAt",
25346             "description": ""
25347           },
25348           {
25349             "group": "Body",
25350             "type": "String",
25351             "optional": true,
25352             "field": "leaveAt",
25353             "description": ""
25354           },
25355           {
25356             "group": "Body",
25357             "type": "Boolean",
25358             "optional": true,
25359             "field": "bot",
25360             "description": ""
25361           }
25362         ]
25363       }
25364     },
25365     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25366     "version": "0.0.0",
25367     "filename": "server/api/squareReport/index.js",
25368     "groupTitle": "Square_Reports"
25369   },
25370   {
25371     "type": "delete",
25372     "url": "/api/square/reports/{id}",
25373     "title": "Deletes a Square Report",
25374     "examples": [
25375       {
25376         "title": "Example usage:",
25377         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25378         "type": "json"
25379       }
25380     ],
25381     "name": "DeleteSquare_Reports",
25382     "group": "Square_Reports",
25383     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25384     "version": "0.0.0",
25385     "filename": "server/api/squareReport/index.js",
25386     "groupTitle": "Square_Reports"
25387   },
25388   {
25389     "type": "get",
25390     "url": "/api/square/reports/describe",
25391     "title": "Gets table info about Square Reports",
25392     "examples": [
25393       {
25394         "title": "Example usage:",
25395         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25396         "type": "json"
25397       }
25398     ],
25399     "name": "DescribeSquare_Reports",
25400     "group": "Square_Reports",
25401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25402     "version": "0.0.0",
25403     "filename": "server/api/squareReport/index.js",
25404     "groupTitle": "Square_Reports"
25405   },
25406   {
25407     "type": "get",
25408     "url": "/api/square/reports",
25409     "title": "Gets a list of Square Reports",
25410     "examples": [
25411       {
25412         "title": "Example usage:",
25413         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25414         "type": "json"
25415       }
25416     ],
25417     "name": "GetSquare_Reports",
25418     "group": "Square_Reports",
25419     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25420     "version": "0.0.0",
25421     "filename": "server/api/squareReport/index.js",
25422     "groupTitle": "Square_Reports"
25423   },
25424   {
25425     "type": "get",
25426     "url": "/api/square/reports/{id}",
25427     "title": "Gets a single Square Report",
25428     "examples": [
25429       {
25430         "title": "Example usage:",
25431         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25432         "type": "json"
25433       }
25434     ],
25435     "name": "ShowSquare_Reports",
25436     "group": "Square_Reports",
25437     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25438     "version": "0.0.0",
25439     "filename": "server/api/squareReport/index.js",
25440     "groupTitle": "Square_Reports"
25441   },
25442   {
25443     "type": "put",
25444     "url": "/api/square/reports/{id}",
25445     "title": "Update an existing Square Report",
25446     "examples": [
25447       {
25448         "title": "Example usage:",
25449         "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",
25450         "type": "json"
25451       }
25452     ],
25453     "name": "updateSquare_Reports",
25454     "group": "Square_Reports",
25455     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25456     "version": "0.0.0",
25457     "filename": "server/api/squareReport/index.js",
25458     "groupTitle": "Square_Reports"
25459   },
25460   {
25461     "type": "post",
25462     "url": "/api/integrations/sugarcrm/configurations",
25463     "title": "Creates a new SugarCRM Configuration",
25464     "examples": [
25465       {
25466         "title": "Example usage:",
25467         "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",
25468         "type": "json"
25469       }
25470     ],
25471     "name": "CreateSugarCRM_Configurations",
25472     "group": "SugarCRM_Configurations",
25473     "parameter": {
25474       "fields": {
25475         "Body": [
25476           {
25477             "group": "Body",
25478             "type": "String",
25479             "optional": true,
25480             "field": "name",
25481             "description": ""
25482           },
25483           {
25484             "group": "Body",
25485             "type": "String",
25486             "optional": true,
25487             "field": "description",
25488             "description": ""
25489           }
25490         ]
25491       }
25492     },
25493     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25494     "version": "0.0.0",
25495     "filename": "server/api/intSugarcrmConfiguration/index.js",
25496     "groupTitle": "SugarCRM_Configurations"
25497   },
25498   {
25499     "type": "delete",
25500     "url": "/api/integrations/sugarcrm/configurations/{id}",
25501     "title": "Deletes a SugarCRM Configuration",
25502     "examples": [
25503       {
25504         "title": "Example usage:",
25505         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25506         "type": "json"
25507       }
25508     ],
25509     "name": "DeleteSugarCRM_Configurations",
25510     "group": "SugarCRM_Configurations",
25511     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25512     "version": "0.0.0",
25513     "filename": "server/api/intSugarcrmConfiguration/index.js",
25514     "groupTitle": "SugarCRM_Configurations"
25515   },
25516   {
25517     "type": "get",
25518     "url": "/api/integrations/sugarcrm/configurations",
25519     "title": "Gets a list of SugarCRM Configurations",
25520     "examples": [
25521       {
25522         "title": "Example usage:",
25523         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25524         "type": "json"
25525       }
25526     ],
25527     "name": "GetSugarCRM_Configurations",
25528     "group": "SugarCRM_Configurations",
25529     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25530     "version": "0.0.0",
25531     "filename": "server/api/intSugarcrmConfiguration/index.js",
25532     "groupTitle": "SugarCRM_Configurations"
25533   },
25534   {
25535     "type": "get",
25536     "url": "/api/integrations/sugarcrm/configurations/{id}",
25537     "title": "Gets a single SugarCRM Configuration",
25538     "examples": [
25539       {
25540         "title": "Example usage:",
25541         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25542         "type": "json"
25543       }
25544     ],
25545     "name": "ShowSugarCRM_Configurations",
25546     "group": "SugarCRM_Configurations",
25547     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25548     "version": "0.0.0",
25549     "filename": "server/api/intSugarcrmConfiguration/index.js",
25550     "groupTitle": "SugarCRM_Configurations"
25551   },
25552   {
25553     "type": "put",
25554     "url": "/api/integrations/sugarcrm/configurations/{id}",
25555     "title": "Update an existing SugarCRM Configuration",
25556     "examples": [
25557       {
25558         "title": "Example usage:",
25559         "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",
25560         "type": "json"
25561       }
25562     ],
25563     "name": "updateSugarCRM_Configurations",
25564     "group": "SugarCRM_Configurations",
25565     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25566     "version": "0.0.0",
25567     "filename": "server/api/intSugarcrmConfiguration/index.js",
25568     "groupTitle": "SugarCRM_Configurations"
25569   },
25570   {
25571     "type": "post",
25572     "url": "/api/integrations/sugarcrm/accounts",
25573     "title": "Creates a new Sugarcrm Account",
25574     "examples": [
25575       {
25576         "title": "Example usage:",
25577         "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",
25578         "type": "json"
25579       }
25580     ],
25581     "name": "CreateSugarcrm_Accounts",
25582     "group": "Sugarcrm_Accounts",
25583     "parameter": {
25584       "fields": {
25585         "Body": [
25586           {
25587             "group": "Body",
25588             "type": "String",
25589             "optional": true,
25590             "field": "name",
25591             "description": ""
25592           },
25593           {
25594             "group": "Body",
25595             "type": "String",
25596             "optional": true,
25597             "field": "description",
25598             "description": ""
25599           },
25600           {
25601             "group": "Body",
25602             "type": "String",
25603             "optional": true,
25604             "field": "username",
25605             "description": ""
25606           },
25607           {
25608             "group": "Body",
25609             "type": "String",
25610             "optional": true,
25611             "field": "password",
25612             "description": ""
25613           },
25614           {
25615             "group": "Body",
25616             "type": "String",
25617             "optional": true,
25618             "field": "remoteUri",
25619             "description": ""
25620           },
25621           {
25622             "group": "Body",
25623             "type": "String",
25624             "optional": false,
25625             "field": "serverUrl",
25626             "description": ""
25627           }
25628         ]
25629       }
25630     },
25631     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25632     "version": "0.0.0",
25633     "filename": "server/api/intSugarcrmAccount/index.js",
25634     "groupTitle": "Sugarcrm_Accounts"
25635   },
25636   {
25637     "type": "delete",
25638     "url": "/api/integrations/sugarcrm/accounts/{id}",
25639     "title": "Deletes a Sugarcrm Account",
25640     "examples": [
25641       {
25642         "title": "Example usage:",
25643         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25644         "type": "json"
25645       }
25646     ],
25647     "name": "DeleteSugarcrm_Accounts",
25648     "group": "Sugarcrm_Accounts",
25649     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/intSugarcrmAccount/index.js",
25652     "groupTitle": "Sugarcrm_Accounts"
25653   },
25654   {
25655     "type": "get",
25656     "url": "/api/integrations/sugarcrm/accounts",
25657     "title": "Gets a list of Sugarcrm Accounts",
25658     "examples": [
25659       {
25660         "title": "Example usage:",
25661         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25662         "type": "json"
25663       }
25664     ],
25665     "name": "GetSugarcrm_Accounts",
25666     "group": "Sugarcrm_Accounts",
25667     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25668     "version": "0.0.0",
25669     "filename": "server/api/intSugarcrmAccount/index.js",
25670     "groupTitle": "Sugarcrm_Accounts"
25671   },
25672   {
25673     "type": "get",
25674     "url": "/api/integrations/sugarcrm/accounts/{id}",
25675     "title": "Gets a single Sugarcrm Account",
25676     "examples": [
25677       {
25678         "title": "Example usage:",
25679         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25680         "type": "json"
25681       }
25682     ],
25683     "name": "ShowSugarcrm_Accounts",
25684     "group": "Sugarcrm_Accounts",
25685     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25686     "version": "0.0.0",
25687     "filename": "server/api/intSugarcrmAccount/index.js",
25688     "groupTitle": "Sugarcrm_Accounts"
25689   },
25690   {
25691     "type": "post",
25692     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25693     "title": "Creates new configuration",
25694     "examples": [
25695       {
25696         "title": "Example usage:",
25697         "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",
25698         "type": "json"
25699       }
25700     ],
25701     "name": "addConfiguration",
25702     "group": "Sugarcrm_Accounts",
25703     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25704     "version": "0.0.0",
25705     "filename": "server/api/intSugarcrmAccount/index.js",
25706     "groupTitle": "Sugarcrm_Accounts"
25707   },
25708   {
25709     "type": "get",
25710     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25711     "title": "Gets account configurations",
25712     "examples": [
25713       {
25714         "title": "Example usage:",
25715         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25716         "type": "json"
25717       }
25718     ],
25719     "name": "getConfigurations",
25720     "group": "Sugarcrm_Accounts",
25721     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25722     "version": "0.0.0",
25723     "filename": "server/api/intSugarcrmAccount/index.js",
25724     "groupTitle": "Sugarcrm_Accounts"
25725   },
25726   {
25727     "type": "get",
25728     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25729     "title": "Gets account fields",
25730     "examples": [
25731       {
25732         "title": "Example usage:",
25733         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25734         "type": "json"
25735       }
25736     ],
25737     "name": "getFields",
25738     "group": "Sugarcrm_Accounts",
25739     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25740     "version": "0.0.0",
25741     "filename": "server/api/intSugarcrmAccount/index.js",
25742     "groupTitle": "Sugarcrm_Accounts"
25743   },
25744   {
25745     "type": "put",
25746     "url": "/api/integrations/sugarcrm/accounts/{id}",
25747     "title": "Update an existing Sugarcrm Account",
25748     "examples": [
25749       {
25750         "title": "Example usage:",
25751         "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",
25752         "type": "json"
25753       }
25754     ],
25755     "name": "updateSugarcrm_Accounts",
25756     "group": "Sugarcrm_Accounts",
25757     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25758     "version": "0.0.0",
25759     "filename": "server/api/intSugarcrmAccount/index.js",
25760     "groupTitle": "Sugarcrm_Accounts"
25761   },
25762   {
25763     "type": "get",
25764     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25765     "title": "Gets configurations descriptions",
25766     "examples": [
25767       {
25768         "title": "Example usage:",
25769         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25770         "type": "json"
25771       }
25772     ],
25773     "name": "getDescriptions",
25774     "group": "Sugarcrm_Configurations",
25775     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25776     "version": "0.0.0",
25777     "filename": "server/api/intSugarcrmConfiguration/index.js",
25778     "groupTitle": "Sugarcrm_Configurations"
25779   },
25780   {
25781     "type": "get",
25782     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25783     "title": "Gets configurations fields",
25784     "examples": [
25785       {
25786         "title": "Example usage:",
25787         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25788         "type": "json"
25789       }
25790     ],
25791     "name": "getFields",
25792     "group": "Sugarcrm_Configurations",
25793     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25794     "version": "0.0.0",
25795     "filename": "server/api/intSugarcrmConfiguration/index.js",
25796     "groupTitle": "Sugarcrm_Configurations"
25797   },
25798   {
25799     "type": "get",
25800     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25801     "title": "Gets configurations subjects",
25802     "examples": [
25803       {
25804         "title": "Example usage:",
25805         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25806         "type": "json"
25807       }
25808     ],
25809     "name": "getSubjects",
25810     "group": "Sugarcrm_Configurations",
25811     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25812     "version": "0.0.0",
25813     "filename": "server/api/intSugarcrmConfiguration/index.js",
25814     "groupTitle": "Sugarcrm_Configurations"
25815   },
25816   {
25817     "type": "post",
25818     "url": "/api/integrations/sugarcrm/fields",
25819     "title": "Creates a new Sugarcrm Field",
25820     "examples": [
25821       {
25822         "title": "Example usage:",
25823         "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",
25824         "type": "json"
25825       }
25826     ],
25827     "name": "CreateSugarcrm_Fields",
25828     "group": "Sugarcrm_Fields",
25829     "parameter": {
25830       "fields": {
25831         "Body": [
25832           {
25833             "group": "Body",
25834             "type": "String",
25835             "allowedValues": [
25836               "\"string\"",
25837               "\"variable\"",
25838               "\"customVariable\"",
25839               "\"keyValue\"",
25840               "\"picklist\""
25841             ],
25842             "optional": true,
25843             "field": "type",
25844             "description": ""
25845           },
25846           {
25847             "group": "Body",
25848             "type": "String",
25849             "optional": true,
25850             "field": "content",
25851             "description": ""
25852           },
25853           {
25854             "group": "Body",
25855             "type": "String",
25856             "optional": true,
25857             "field": "key",
25858             "description": ""
25859           },
25860           {
25861             "group": "Body",
25862             "type": "String",
25863             "allowedValues": [
25864               "\"string\"",
25865               "\"variable\"",
25866               "\"customVariable\""
25867             ],
25868             "optional": true,
25869             "field": "keyType",
25870             "description": ""
25871           },
25872           {
25873             "group": "Body",
25874             "type": "String",
25875             "optional": true,
25876             "field": "keyContent",
25877             "description": ""
25878           },
25879           {
25880             "group": "Body",
25881             "type": "String",
25882             "optional": true,
25883             "field": "idField",
25884             "description": ""
25885           },
25886           {
25887             "group": "Body",
25888             "type": "String",
25889             "optional": true,
25890             "field": "nameField",
25891             "description": ""
25892           },
25893           {
25894             "group": "Body",
25895             "type": "Boolean",
25896             "optional": true,
25897             "field": "customField",
25898             "description": ""
25899           },
25900           {
25901             "group": "Body",
25902             "type": "String",
25903             "optional": true,
25904             "field": "variableName",
25905             "description": ""
25906           }
25907         ]
25908       }
25909     },
25910     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25911     "version": "0.0.0",
25912     "filename": "server/api/intSugarcrmField/index.js",
25913     "groupTitle": "Sugarcrm_Fields"
25914   },
25915   {
25916     "type": "delete",
25917     "url": "/api/integrations/sugarcrm/fields/{id}",
25918     "title": "Deletes a Sugarcrm Field",
25919     "examples": [
25920       {
25921         "title": "Example usage:",
25922         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25923         "type": "json"
25924       }
25925     ],
25926     "name": "DeleteSugarcrm_Fields",
25927     "group": "Sugarcrm_Fields",
25928     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25929     "version": "0.0.0",
25930     "filename": "server/api/intSugarcrmField/index.js",
25931     "groupTitle": "Sugarcrm_Fields"
25932   },
25933   {
25934     "type": "get",
25935     "url": "/api/integrations/sugarcrm/fields",
25936     "title": "Gets a list of Sugarcrm Fields",
25937     "examples": [
25938       {
25939         "title": "Example usage:",
25940         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25941         "type": "json"
25942       }
25943     ],
25944     "name": "GetSugarcrm_Fields",
25945     "group": "Sugarcrm_Fields",
25946     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25947     "version": "0.0.0",
25948     "filename": "server/api/intSugarcrmField/index.js",
25949     "groupTitle": "Sugarcrm_Fields"
25950   },
25951   {
25952     "type": "get",
25953     "url": "/api/integrations/sugarcrm/fields/{id}",
25954     "title": "Gets a single Sugarcrm Field",
25955     "examples": [
25956       {
25957         "title": "Example usage:",
25958         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25959         "type": "json"
25960       }
25961     ],
25962     "name": "ShowSugarcrm_Fields",
25963     "group": "Sugarcrm_Fields",
25964     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25965     "version": "0.0.0",
25966     "filename": "server/api/intSugarcrmField/index.js",
25967     "groupTitle": "Sugarcrm_Fields"
25968   },
25969   {
25970     "type": "put",
25971     "url": "/api/integrations/sugarcrm/fields/{id}",
25972     "title": "Update an existing Sugarcrm Field",
25973     "examples": [
25974       {
25975         "title": "Example usage:",
25976         "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",
25977         "type": "json"
25978       }
25979     ],
25980     "name": "updateSugarcrm_Fields",
25981     "group": "Sugarcrm_Fields",
25982     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25983     "version": "0.0.0",
25984     "filename": "server/api/intSugarcrmField/index.js",
25985     "groupTitle": "Sugarcrm_Fields"
25986   },
25987   {
25988     "type": "get",
25989     "url": "/api/system/process",
25990     "title": "Gets system information",
25991     "examples": [
25992       {
25993         "title": "Example usage:",
25994         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25995         "type": "json"
25996       }
25997     ],
25998     "name": "GetSystemInformation",
25999     "group": "System_Information",
26000     "description": "<p>Motion returns the system information.</p>",
26001     "version": "0.0.0",
26002     "filename": "server/api/system/index.js",
26003     "groupTitle": "System_Information"
26004   },
26005   {
26006     "type": "get",
26007     "url": "/api/system",
26008     "title": "Gets system information",
26009     "examples": [
26010       {
26011         "title": "Example usage:",
26012         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26013         "type": "json"
26014       }
26015     ],
26016     "name": "GetSystemInformation",
26017     "group": "System_Information",
26018     "description": "<p>Motion returns the system information.</p>",
26019     "version": "0.0.0",
26020     "filename": "server/api/system/index.js",
26021     "groupTitle": "System_Information"
26022   },
26023   {
26024     "type": "post",
26025     "url": "/api/tags",
26026     "title": "Creates a new Tag",
26027     "examples": [
26028       {
26029         "title": "Example usage:",
26030         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26031         "type": "json"
26032       }
26033     ],
26034     "name": "CreateTags",
26035     "group": "Tags",
26036     "parameter": {
26037       "fields": {
26038         "Body": [
26039           {
26040             "group": "Body",
26041             "type": "String",
26042             "optional": false,
26043             "field": "name",
26044             "description": ""
26045           },
26046           {
26047             "group": "Body",
26048             "type": "String",
26049             "optional": true,
26050             "field": "color",
26051             "description": ""
26052           },
26053           {
26054             "group": "Body",
26055             "type": "String",
26056             "optional": true,
26057             "field": "description",
26058             "description": ""
26059           }
26060         ]
26061       }
26062     },
26063     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26064     "version": "0.0.0",
26065     "filename": "server/api/tag/index.js",
26066     "groupTitle": "Tags"
26067   },
26068   {
26069     "type": "delete",
26070     "url": "/api/tags/{id}",
26071     "title": "Deletes a Tag",
26072     "examples": [
26073       {
26074         "title": "Example usage:",
26075         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
26076         "type": "json"
26077       }
26078     ],
26079     "name": "DeleteTags",
26080     "group": "Tags",
26081     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26082     "version": "0.0.0",
26083     "filename": "server/api/tag/index.js",
26084     "groupTitle": "Tags"
26085   },
26086   {
26087     "type": "get",
26088     "url": "/api/tags",
26089     "title": "Gets a list of Tags",
26090     "examples": [
26091       {
26092         "title": "Example usage:",
26093         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
26094         "type": "json"
26095       }
26096     ],
26097     "name": "GetTags",
26098     "group": "Tags",
26099     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26100     "version": "0.0.0",
26101     "filename": "server/api/tag/index.js",
26102     "groupTitle": "Tags"
26103   },
26104   {
26105     "type": "get",
26106     "url": "/api/tags/{id}",
26107     "title": "Gets a single Tag",
26108     "examples": [
26109       {
26110         "title": "Example usage:",
26111         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
26112         "type": "json"
26113       }
26114     ],
26115     "name": "ShowTags",
26116     "group": "Tags",
26117     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26118     "version": "0.0.0",
26119     "filename": "server/api/tag/index.js",
26120     "groupTitle": "Tags"
26121   },
26122   {
26123     "type": "put",
26124     "url": "/api/tags/{id}",
26125     "title": "Update an existing Tag",
26126     "examples": [
26127       {
26128         "title": "Example usage:",
26129         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26130         "type": "json"
26131       }
26132     ],
26133     "name": "updateTags",
26134     "group": "Tags",
26135     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26136     "version": "0.0.0",
26137     "filename": "server/api/tag/index.js",
26138     "groupTitle": "Tags"
26139   },
26140   {
26141     "type": "post",
26142     "url": "/api/teams/{id}/queues",
26143     "title": "Add queues to a team",
26144     "examples": [
26145       {
26146         "title": "Example usage:",
26147         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26148         "type": "json"
26149       }
26150     ],
26151     "name": "AddQueues",
26152     "group": "Teams",
26153     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26154     "version": "0.0.0",
26155     "filename": "server/api/team/index.js",
26156     "groupTitle": "Teams"
26157   },
26158   {
26159     "type": "post",
26160     "url": "/api/teams",
26161     "title": "Creates a new Team",
26162     "examples": [
26163       {
26164         "title": "Example usage:",
26165         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26166         "type": "json"
26167       }
26168     ],
26169     "name": "CreateTeams",
26170     "group": "Teams",
26171     "parameter": {
26172       "fields": {
26173         "Body": [
26174           {
26175             "group": "Body",
26176             "type": "String",
26177             "optional": false,
26178             "field": "name",
26179             "description": ""
26180           },
26181           {
26182             "group": "Body",
26183             "type": "String",
26184             "optional": true,
26185             "field": "description",
26186             "description": ""
26187           }
26188         ]
26189       }
26190     },
26191     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26192     "version": "0.0.0",
26193     "filename": "server/api/team/index.js",
26194     "groupTitle": "Teams"
26195   },
26196   {
26197     "type": "delete",
26198     "url": "/api/teams/{id}",
26199     "title": "Deletes a Team",
26200     "examples": [
26201       {
26202         "title": "Example usage:",
26203         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26204         "type": "json"
26205       }
26206     ],
26207     "name": "DeleteTeams",
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/team/index.js",
26212     "groupTitle": "Teams"
26213   },
26214   {
26215     "type": "get",
26216     "url": "/api/teams/{id}/users",
26217     "title": "Gets agents from team",
26218     "examples": [
26219       {
26220         "title": "Example usage:",
26221         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26222         "type": "json"
26223       }
26224     ],
26225     "name": "GetAgents",
26226     "group": "Teams",
26227     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/team/index.js",
26230     "groupTitle": "Teams"
26231   },
26232   {
26233     "type": "get",
26234     "url": "/api/teams/{id}/queues?channel={channel}",
26235     "title": "Gets Queues list",
26236     "examples": [
26237       {
26238         "title": "Example usage:",
26239         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26240         "type": "json"
26241       }
26242     ],
26243     "name": "GetQueues",
26244     "group": "Teams",
26245     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/team/index.js",
26248     "groupTitle": "Teams"
26249   },
26250   {
26251     "type": "get",
26252     "url": "/api/teams",
26253     "title": "Gets a list of Teams",
26254     "examples": [
26255       {
26256         "title": "Example usage:",
26257         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26258         "type": "json"
26259       }
26260     ],
26261     "name": "GetTeams",
26262     "group": "Teams",
26263     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26264     "version": "0.0.0",
26265     "filename": "server/api/team/index.js",
26266     "groupTitle": "Teams"
26267   },
26268   {
26269     "type": "delete",
26270     "url": "/api/teams/{id}/users",
26271     "title": "Removes agents from a team",
26272     "examples": [
26273       {
26274         "title": "Example usage:",
26275         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26276         "type": "json"
26277       }
26278     ],
26279     "name": "RemoveAgents",
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/team/index.js",
26284     "groupTitle": "Teams"
26285   },
26286   {
26287     "type": "delete",
26288     "url": "/api/teams/{id}/queues",
26289     "title": "Remove queues to a team",
26290     "examples": [
26291       {
26292         "title": "Example usage:",
26293         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26294         "type": "json"
26295       }
26296     ],
26297     "name": "RemoveQueues",
26298     "group": "Teams",
26299     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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": "delete",
26306     "url": "/api/fax/queues/{id}/teams",
26307     "title": "Remove teams from a queue",
26308     "examples": [
26309       {
26310         "title": "Example usage:",
26311         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26312         "type": "json"
26313       }
26314     ],
26315     "name": "RemoveTeams",
26316     "group": "Teams",
26317     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26318     "version": "0.0.0",
26319     "filename": "server/api/faxQueue/index.js",
26320     "groupTitle": "Teams"
26321   },
26322   {
26323     "type": "delete",
26324     "url": "/api/voice/queues/{id}/teams",
26325     "title": "Remove teams from a queue",
26326     "examples": [
26327       {
26328         "title": "Example usage:",
26329         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26330         "type": "json"
26331       }
26332     ],
26333     "name": "RemoveTeams",
26334     "group": "Teams",
26335     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/voiceQueue/index.js",
26338     "groupTitle": "Teams"
26339   },
26340   {
26341     "type": "delete",
26342     "url": "/api/voice/Prefixes/{id}/teams",
26343     "title": "Remove teams from a voice prefix",
26344     "examples": [
26345       {
26346         "title": "Example usage:",
26347         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password} -X DELETE",
26348         "type": "json"
26349       }
26350     ],
26351     "name": "RemoveTeams",
26352     "group": "Teams",
26353     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26354     "version": "0.0.0",
26355     "filename": "server/api/voicePrefix/index.js",
26356     "groupTitle": "Teams"
26357   },
26358   {
26359     "type": "delete",
26360     "url": "/api/sms/queues/{id}/teams",
26361     "title": "Remove teams from a queue",
26362     "examples": [
26363       {
26364         "title": "Example usage:",
26365         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26366         "type": "json"
26367       }
26368     ],
26369     "name": "RemoveTeams",
26370     "group": "Teams",
26371     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26372     "version": "0.0.0",
26373     "filename": "server/api/smsQueue/index.js",
26374     "groupTitle": "Teams"
26375   },
26376   {
26377     "type": "delete",
26378     "url": "/api/mail/queues/{id}/teams",
26379     "title": "Remove teams from a queue",
26380     "examples": [
26381       {
26382         "title": "Example usage:",
26383         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26384         "type": "json"
26385       }
26386     ],
26387     "name": "RemoveTeams",
26388     "group": "Teams",
26389     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26390     "version": "0.0.0",
26391     "filename": "server/api/mailQueue/index.js",
26392     "groupTitle": "Teams"
26393   },
26394   {
26395     "type": "delete",
26396     "url": "/api/openchannel/queues/{id}/teams",
26397     "title": "Remove teams from a queue",
26398     "examples": [
26399       {
26400         "title": "Example usage:",
26401         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26402         "type": "json"
26403       }
26404     ],
26405     "name": "RemoveTeams",
26406     "group": "Teams",
26407     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26408     "version": "0.0.0",
26409     "filename": "server/api/openchannelQueue/index.js",
26410     "groupTitle": "Teams"
26411   },
26412   {
26413     "type": "delete",
26414     "url": "/api/chat/queues/{id}/teams",
26415     "title": "Remove teams from a queue",
26416     "examples": [
26417       {
26418         "title": "Example usage:",
26419         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26420         "type": "json"
26421       }
26422     ],
26423     "name": "RemoveTeams",
26424     "group": "Teams",
26425     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26426     "version": "0.0.0",
26427     "filename": "server/api/chatQueue/index.js",
26428     "groupTitle": "Teams"
26429   },
26430   {
26431     "type": "delete",
26432     "url": "/api/whatsapp/queues/{id}/teams",
26433     "title": "Remove teams from a queue",
26434     "examples": [
26435       {
26436         "title": "Example usage:",
26437         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26438         "type": "json"
26439       }
26440     ],
26441     "name": "RemoveTeams",
26442     "group": "Teams",
26443     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26444     "version": "0.0.0",
26445     "filename": "server/api/whatsappQueue/index.js",
26446     "groupTitle": "Teams"
26447   },
26448   {
26449     "type": "get",
26450     "url": "/api/teams/{id}",
26451     "title": "Gets a single Team",
26452     "examples": [
26453       {
26454         "title": "Example usage:",
26455         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26456         "type": "json"
26457       }
26458     ],
26459     "name": "ShowTeams",
26460     "group": "Teams",
26461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26462     "version": "0.0.0",
26463     "filename": "server/api/team/index.js",
26464     "groupTitle": "Teams"
26465   },
26466   {
26467     "type": "post",
26468     "url": "/api/teams/{id}/users",
26469     "title": "Adds agents to a team",
26470     "examples": [
26471       {
26472         "title": "Example usage:",
26473         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26474         "type": "json"
26475       }
26476     ],
26477     "name": "addAgents",
26478     "group": "Teams",
26479     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26480     "version": "0.0.0",
26481     "filename": "server/api/team/index.js",
26482     "groupTitle": "Teams"
26483   },
26484   {
26485     "type": "put",
26486     "url": "/api/teams/{id}",
26487     "title": "Update an existing Team",
26488     "examples": [
26489       {
26490         "title": "Example usage:",
26491         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26492         "type": "json"
26493       }
26494     ],
26495     "name": "updateTeams",
26496     "group": "Teams",
26497     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26498     "version": "0.0.0",
26499     "filename": "server/api/team/index.js",
26500     "groupTitle": "Teams"
26501   },
26502   {
26503     "type": "post",
26504     "url": "/api/templates",
26505     "title": "Creates a new Template",
26506     "examples": [
26507       {
26508         "title": "Example usage:",
26509         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26510         "type": "json"
26511       }
26512     ],
26513     "name": "CreateTemplates",
26514     "group": "Templates",
26515     "parameter": {
26516       "fields": {
26517         "Body": [
26518           {
26519             "group": "Body",
26520             "type": "String",
26521             "optional": true,
26522             "field": "name",
26523             "description": ""
26524           },
26525           {
26526             "group": "Body",
26527             "type": "String",
26528             "optional": true,
26529             "field": "description",
26530             "description": ""
26531           },
26532           {
26533             "group": "Body",
26534             "type": "Text",
26535             "optional": true,
26536             "field": "html",
26537             "description": ""
26538           }
26539         ]
26540       }
26541     },
26542     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26543     "version": "0.0.0",
26544     "filename": "server/api/template/index.js",
26545     "groupTitle": "Templates"
26546   },
26547   {
26548     "type": "delete",
26549     "url": "/api/templates/{id}",
26550     "title": "Deletes a Template",
26551     "examples": [
26552       {
26553         "title": "Example usage:",
26554         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26555         "type": "json"
26556       }
26557     ],
26558     "name": "DeleteTemplates",
26559     "group": "Templates",
26560     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26561     "version": "0.0.0",
26562     "filename": "server/api/template/index.js",
26563     "groupTitle": "Templates"
26564   },
26565   {
26566     "type": "get",
26567     "url": "/api/templates",
26568     "title": "Gets a list of Templates",
26569     "examples": [
26570       {
26571         "title": "Example usage:",
26572         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26573         "type": "json"
26574       }
26575     ],
26576     "name": "GetTemplates",
26577     "group": "Templates",
26578     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26579     "version": "0.0.0",
26580     "filename": "server/api/template/index.js",
26581     "groupTitle": "Templates"
26582   },
26583   {
26584     "type": "get",
26585     "url": "/api/templates/{id}",
26586     "title": "Gets a single Template",
26587     "examples": [
26588       {
26589         "title": "Example usage:",
26590         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26591         "type": "json"
26592       }
26593     ],
26594     "name": "ShowTemplates",
26595     "group": "Templates",
26596     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26597     "version": "0.0.0",
26598     "filename": "server/api/template/index.js",
26599     "groupTitle": "Templates"
26600   },
26601   {
26602     "type": "put",
26603     "url": "/api/templates/{id}",
26604     "title": "Update an existing Template",
26605     "examples": [
26606       {
26607         "title": "Example usage:",
26608         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26609         "type": "json"
26610       }
26611     ],
26612     "name": "updateTemplates",
26613     "group": "Templates",
26614     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26615     "version": "0.0.0",
26616     "filename": "server/api/template/index.js",
26617     "groupTitle": "Templates"
26618   },
26619   {
26620     "type": "post",
26621     "url": "/api/triggers",
26622     "title": "Creates a new Trigger",
26623     "examples": [
26624       {
26625         "title": "Example usage:",
26626         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26627         "type": "json"
26628       }
26629     ],
26630     "name": "CreateTriggers",
26631     "group": "Triggers",
26632     "parameter": {
26633       "fields": {
26634         "Body": [
26635           {
26636             "group": "Body",
26637             "type": "String",
26638             "optional": true,
26639             "field": "name",
26640             "description": ""
26641           },
26642           {
26643             "group": "Body",
26644             "type": "String",
26645             "optional": true,
26646             "field": "channel",
26647             "description": ""
26648           },
26649           {
26650             "group": "Body",
26651             "type": "String",
26652             "optional": true,
26653             "field": "description",
26654             "description": ""
26655           },
26656           {
26657             "group": "Body",
26658             "type": "Boolean",
26659             "optional": true,
26660             "field": "status",
26661             "description": ""
26662           }
26663         ]
26664       }
26665     },
26666     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26667     "version": "0.0.0",
26668     "filename": "server/api/trigger/index.js",
26669     "groupTitle": "Triggers"
26670   },
26671   {
26672     "type": "delete",
26673     "url": "/api/triggers/{id}",
26674     "title": "Deletes a Trigger",
26675     "examples": [
26676       {
26677         "title": "Example usage:",
26678         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26679         "type": "json"
26680       }
26681     ],
26682     "name": "DeleteTriggers",
26683     "group": "Triggers",
26684     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26685     "version": "0.0.0",
26686     "filename": "server/api/trigger/index.js",
26687     "groupTitle": "Triggers"
26688   },
26689   {
26690     "type": "get",
26691     "url": "/api/triggers",
26692     "title": "Gets a list of Triggers",
26693     "examples": [
26694       {
26695         "title": "Example usage:",
26696         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26697         "type": "json"
26698       }
26699     ],
26700     "name": "GetTriggers",
26701     "group": "Triggers",
26702     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26703     "version": "0.0.0",
26704     "filename": "server/api/trigger/index.js",
26705     "groupTitle": "Triggers"
26706   },
26707   {
26708     "type": "get",
26709     "url": "/api/triggers/{id}",
26710     "title": "Gets a single Trigger",
26711     "examples": [
26712       {
26713         "title": "Example usage:",
26714         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26715         "type": "json"
26716       }
26717     ],
26718     "name": "ShowTriggers",
26719     "group": "Triggers",
26720     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26721     "version": "0.0.0",
26722     "filename": "server/api/trigger/index.js",
26723     "groupTitle": "Triggers"
26724   },
26725   {
26726     "type": "post",
26727     "url": "/api/triggers/{id}/actions",
26728     "title": "Creates new actions",
26729     "examples": [
26730       {
26731         "title": "Example usage:",
26732         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26733         "type": "json"
26734       }
26735     ],
26736     "name": "addAction",
26737     "group": "Triggers",
26738     "parameter": {
26739       "fields": {
26740         "Body": [
26741           {
26742             "group": "Body",
26743             "type": "Virtual",
26744             "optional": true,
26745             "field": "name",
26746             "description": ""
26747           },
26748           {
26749             "group": "Body",
26750             "type": "String",
26751             "optional": false,
26752             "field": "action",
26753             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26754           },
26755           {
26756             "group": "Body",
26757             "type": "String",
26758             "optional": true,
26759             "field": "data1",
26760             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26761           },
26762           {
26763             "group": "Body",
26764             "type": "String",
26765             "optional": true,
26766             "field": "data2",
26767             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26768           },
26769           {
26770             "group": "Body",
26771             "type": "String",
26772             "optional": true,
26773             "field": "data3",
26774             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26775           },
26776           {
26777             "group": "Body",
26778             "type": "String",
26779             "optional": true,
26780             "field": "data4",
26781             "description": ""
26782           },
26783           {
26784             "group": "Body",
26785             "type": "String",
26786             "optional": true,
26787             "field": "data5",
26788             "description": ""
26789           },
26790           {
26791             "group": "Body",
26792             "type": "String",
26793             "optional": true,
26794             "field": "data6",
26795             "description": ""
26796           },
26797           {
26798             "group": "Body",
26799             "type": "Text",
26800             "optional": true,
26801             "field": "data7",
26802             "description": ""
26803           }
26804         ]
26805       }
26806     },
26807     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26808     "version": "0.0.0",
26809     "filename": "server/api/trigger/index.js",
26810     "groupTitle": "Triggers"
26811   },
26812   {
26813     "type": "post",
26814     "url": "/api/triggers/{id}/all_conditions",
26815     "title": "Creates a new \"AND\"condition",
26816     "examples": [
26817       {
26818         "title": "Example usage:",
26819         "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",
26820         "type": "json"
26821       }
26822     ],
26823     "name": "addAllCondition",
26824     "group": "Triggers",
26825     "parameter": {
26826       "fields": {
26827         "Body": [
26828           {
26829             "group": "Body",
26830             "type": "Virtual",
26831             "optional": true,
26832             "field": "name",
26833             "description": ""
26834           },
26835           {
26836             "group": "Body",
26837             "type": "String",
26838             "optional": false,
26839             "field": "field",
26840             "description": ""
26841           },
26842           {
26843             "group": "Body",
26844             "type": "String",
26845             "optional": false,
26846             "field": "operator",
26847             "description": ""
26848           },
26849           {
26850             "group": "Body",
26851             "type": "String",
26852             "optional": false,
26853             "field": "value",
26854             "description": ""
26855           }
26856         ]
26857       }
26858     },
26859     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26860     "version": "0.0.0",
26861     "filename": "server/api/trigger/index.js",
26862     "groupTitle": "Triggers"
26863   },
26864   {
26865     "type": "post",
26866     "url": "/api/triggers/{id}/any_conditions",
26867     "title": "Creates a new \"OR\"condition",
26868     "examples": [
26869       {
26870         "title": "Example usage:",
26871         "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",
26872         "type": "json"
26873       }
26874     ],
26875     "name": "addAnyCondition",
26876     "group": "Triggers",
26877     "parameter": {
26878       "fields": {
26879         "Body": [
26880           {
26881             "group": "Body",
26882             "type": "Virtual",
26883             "optional": true,
26884             "field": "name",
26885             "description": ""
26886           },
26887           {
26888             "group": "Body",
26889             "type": "String",
26890             "optional": false,
26891             "field": "field",
26892             "description": ""
26893           },
26894           {
26895             "group": "Body",
26896             "type": "String",
26897             "optional": false,
26898             "field": "operator",
26899             "description": ""
26900           },
26901           {
26902             "group": "Body",
26903             "type": "String",
26904             "optional": false,
26905             "field": "value",
26906             "description": ""
26907           }
26908         ]
26909       }
26910     },
26911     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26912     "version": "0.0.0",
26913     "filename": "server/api/trigger/index.js",
26914     "groupTitle": "Triggers"
26915   },
26916   {
26917     "type": "get",
26918     "url": "/api/triggers/{id}/actions",
26919     "title": "Gets Trigger Actions",
26920     "examples": [
26921       {
26922         "title": "Example usage:",
26923         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26924         "type": "json"
26925       }
26926     ],
26927     "name": "getActions",
26928     "group": "Triggers",
26929     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26930     "version": "0.0.0",
26931     "filename": "server/api/trigger/index.js",
26932     "groupTitle": "Triggers"
26933   },
26934   {
26935     "type": "get",
26936     "url": "/api/triggers/{id}/all_conditions",
26937     "title": "Gets \"AND\" Trigger Conditions",
26938     "examples": [
26939       {
26940         "title": "Example usage:",
26941         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26942         "type": "json"
26943       }
26944     ],
26945     "name": "getAllConditions",
26946     "group": "Triggers",
26947     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26948     "version": "0.0.0",
26949     "filename": "server/api/trigger/index.js",
26950     "groupTitle": "Triggers"
26951   },
26952   {
26953     "type": "get",
26954     "url": "/api/triggers/{id}/any_conditions",
26955     "title": "Gets \"OR\" Trigger Conditions",
26956     "examples": [
26957       {
26958         "title": "Example usage:",
26959         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26960         "type": "json"
26961       }
26962     ],
26963     "name": "getAnyConditions",
26964     "group": "Triggers",
26965     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26966     "version": "0.0.0",
26967     "filename": "server/api/trigger/index.js",
26968     "groupTitle": "Triggers"
26969   },
26970   {
26971     "type": "put",
26972     "url": "/api/triggers/{id}",
26973     "title": "Update an existing Trigger",
26974     "examples": [
26975       {
26976         "title": "Example usage:",
26977         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26978         "type": "json"
26979       }
26980     ],
26981     "name": "updateTriggers",
26982     "group": "Triggers",
26983     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26984     "version": "0.0.0",
26985     "filename": "server/api/trigger/index.js",
26986     "groupTitle": "Triggers"
26987   },
26988   {
26989     "type": "post",
26990     "url": "/api/trunks/clone",
26991     "title": "Clone an existing Trunk",
26992     "examples": [
26993       {
26994         "title": "Example usage:",
26995         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26996         "type": "json"
26997       }
26998     ],
26999     "name": "CloneTrunks",
27000     "group": "Trunks",
27001     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27002     "version": "0.0.0",
27003     "filename": "server/api/trunk/index.js",
27004     "groupTitle": "Trunks"
27005   },
27006   {
27007     "type": "post",
27008     "url": "/api/trunks",
27009     "title": "Create a new trunk",
27010     "examples": [
27011       {
27012         "title": "Example usage:",
27013         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
27014         "type": "json"
27015       }
27016     ],
27017     "name": "Create",
27018     "group": "Trunks",
27019     "parameter": {
27020       "fields": {
27021         "Body": [
27022           {
27023             "group": "Body",
27024             "type": "String",
27025             "optional": false,
27026             "field": "name",
27027             "description": ""
27028           },
27029           {
27030             "group": "Body",
27031             "type": "String",
27032             "allowedValues": [
27033               "\"friend\"",
27034               "\"user\"",
27035               "\"peer\""
27036             ],
27037             "optional": false,
27038             "field": "type",
27039             "description": ""
27040           },
27041           {
27042             "group": "Body",
27043             "type": "String",
27044             "optional": false,
27045             "field": "context",
27046             "description": ""
27047           },
27048           {
27049             "group": "Body",
27050             "type": "String",
27051             "allowedValues": [
27052               "\"ALLOWED_NOT_SCREENED\"",
27053               "\"ALLOWED_PASSED_SCREEN\"",
27054               "\"ALLOWED_FAILED_SCREEN\"",
27055               "\"ALLOWED\"",
27056               "\"PROHIB_NOT_SCREENED\"",
27057               "\"PROHIB_PASSED_SCREEN\"",
27058               "\"PROHIB_FAILED_SCREEN\"",
27059               "\"PROHIB\""
27060             ],
27061             "optional": true,
27062             "field": "callingpres",
27063             "description": ""
27064           },
27065           {
27066             "group": "Body",
27067             "type": "String",
27068             "optional": true,
27069             "field": "deny",
27070             "description": ""
27071           },
27072           {
27073             "group": "Body",
27074             "type": "String",
27075             "optional": true,
27076             "field": "permit",
27077             "description": ""
27078           },
27079           {
27080             "group": "Body",
27081             "type": "String",
27082             "optional": true,
27083             "field": "secret",
27084             "description": ""
27085           },
27086           {
27087             "group": "Body",
27088             "type": "String",
27089             "optional": true,
27090             "field": "md5secret",
27091             "description": ""
27092           },
27093           {
27094             "group": "Body",
27095             "type": "String",
27096             "optional": true,
27097             "field": "remotesecret",
27098             "description": ""
27099           },
27100           {
27101             "group": "Body",
27102             "type": "String",
27103             "optional": true,
27104             "field": "transport",
27105             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
27106           },
27107           {
27108             "group": "Body",
27109             "type": "String",
27110             "allowedValues": [
27111               "\"rfc2833\"",
27112               "\"info\"",
27113               "\"shortinfo\"",
27114               "\"inband\"",
27115               "\"auto\""
27116             ],
27117             "optional": true,
27118             "field": "dtmfmode",
27119             "description": ""
27120           },
27121           {
27122             "group": "Body",
27123             "type": "String",
27124             "allowedValues": [
27125               "\"yes\"",
27126               "\"no\"",
27127               "\"nonat\"",
27128               "\"update\"",
27129               "\"outgoing\""
27130             ],
27131             "optional": true,
27132             "field": "directmedia",
27133             "description": ""
27134           },
27135           {
27136             "group": "Body",
27137             "type": "String",
27138             "allowedValues": [
27139               "\"yes\"",
27140               "\"no\""
27141             ],
27142             "optional": true,
27143             "field": "directrtpsetup",
27144             "description": ""
27145           },
27146           {
27147             "group": "Body",
27148             "type": "String",
27149             "optional": true,
27150             "field": "directmediapermit",
27151             "description": ""
27152           },
27153           {
27154             "group": "Body",
27155             "type": "String",
27156             "optional": true,
27157             "field": "directmediadeny",
27158             "description": ""
27159           },
27160           {
27161             "group": "Body",
27162             "type": "String",
27163             "optional": true,
27164             "field": "nat",
27165             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
27166           },
27167           {
27168             "group": "Body",
27169             "type": "String",
27170             "optional": true,
27171             "field": "callgroup",
27172             "description": ""
27173           },
27174           {
27175             "group": "Body",
27176             "type": "String",
27177             "optional": true,
27178             "field": "namedcallgroup",
27179             "description": ""
27180           },
27181           {
27182             "group": "Body",
27183             "type": "String",
27184             "optional": true,
27185             "field": "pickupgroup",
27186             "description": ""
27187           },
27188           {
27189             "group": "Body",
27190             "type": "String",
27191             "optional": true,
27192             "field": "namedpickupgroup",
27193             "description": ""
27194           },
27195           {
27196             "group": "Body",
27197             "type": "String",
27198             "optional": true,
27199             "field": "language",
27200             "description": ""
27201           },
27202           {
27203             "group": "Body",
27204             "type": "String",
27205             "optional": true,
27206             "field": "tonezone",
27207             "description": ""
27208           },
27209           {
27210             "group": "Body",
27211             "type": "String",
27212             "optional": true,
27213             "field": "disallow",
27214             "description": ""
27215           },
27216           {
27217             "group": "Body",
27218             "type": "String",
27219             "optional": false,
27220             "field": "allow",
27221             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
27222           },
27223           {
27224             "group": "Body",
27225             "type": "String",
27226             "allowedValues": [
27227               "\"yes\"",
27228               "\"no\""
27229             ],
27230             "optional": true,
27231             "field": "autoframing",
27232             "description": ""
27233           },
27234           {
27235             "group": "Body",
27236             "type": "String",
27237             "optional": true,
27238             "field": "insecure",
27239             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
27240           },
27241           {
27242             "group": "Body",
27243             "type": "String",
27244             "allowedValues": [
27245               "\"yes\"",
27246               "\"no\""
27247             ],
27248             "optional": true,
27249             "field": "trustrpid",
27250             "description": ""
27251           },
27252           {
27253             "group": "Body",
27254             "type": "String",
27255             "allowedValues": [
27256               "\"yes\"",
27257               "\"no\""
27258             ],
27259             "optional": true,
27260             "field": "trust_id_outbound",
27261             "description": ""
27262           },
27263           {
27264             "group": "Body",
27265             "type": "String",
27266             "allowedValues": [
27267               "\"yes\"",
27268               "\"no\"",
27269               "\"never\""
27270             ],
27271             "optional": true,
27272             "field": "progressinband",
27273             "description": ""
27274           },
27275           {
27276             "group": "Body",
27277             "type": "String",
27278             "allowedValues": [
27279               "\"yes\"",
27280               "\"no\""
27281             ],
27282             "optional": true,
27283             "field": "promiscredir",
27284             "description": ""
27285           },
27286           {
27287             "group": "Body",
27288             "type": "String",
27289             "allowedValues": [
27290               "\"yes\"",
27291               "\"no\""
27292             ],
27293             "optional": true,
27294             "field": "useclientcode",
27295             "description": ""
27296           },
27297           {
27298             "group": "Body",
27299             "type": "Integer",
27300             "optional": true,
27301             "field": "accountcode",
27302             "description": ""
27303           },
27304           {
27305             "group": "Body",
27306             "type": "String",
27307             "optional": true,
27308             "field": "setvar",
27309             "description": ""
27310           },
27311           {
27312             "group": "Body",
27313             "type": "String",
27314             "optional": true,
27315             "field": "callerid",
27316             "description": ""
27317           },
27318           {
27319             "group": "Body",
27320             "type": "String",
27321             "optional": true,
27322             "field": "amaflags",
27323             "description": ""
27324           },
27325           {
27326             "group": "Body",
27327             "type": "String",
27328             "allowedValues": [
27329               "\"yes\"",
27330               "\"no\""
27331             ],
27332             "optional": true,
27333             "field": "callcounter",
27334             "description": ""
27335           },
27336           {
27337             "group": "Body",
27338             "type": "Integer",
27339             "optional": true,
27340             "field": "busylevel",
27341             "description": ""
27342           },
27343           {
27344             "group": "Body",
27345             "type": "String",
27346             "allowedValues": [
27347               "\"yes\"",
27348               "\"no\""
27349             ],
27350             "optional": true,
27351             "field": "allowoverlap",
27352             "description": ""
27353           },
27354           {
27355             "group": "Body",
27356             "type": "String",
27357             "allowedValues": [
27358               "\"yes\"",
27359               "\"no\""
27360             ],
27361             "optional": true,
27362             "field": "allowsubscribe",
27363             "description": ""
27364           },
27365           {
27366             "group": "Body",
27367             "type": "String",
27368             "allowedValues": [
27369               "\"yes\"",
27370               "\"no\""
27371             ],
27372             "optional": true,
27373             "field": "allowtransfer",
27374             "description": ""
27375           },
27376           {
27377             "group": "Body",
27378             "type": "String",
27379             "allowedValues": [
27380               "\"yes\"",
27381               "\"no\""
27382             ],
27383             "optional": true,
27384             "field": "ignoresdpversion",
27385             "description": ""
27386           },
27387           {
27388             "group": "Body",
27389             "type": "String",
27390             "optional": true,
27391             "field": "subscribecontext",
27392             "description": ""
27393           },
27394           {
27395             "group": "Body",
27396             "type": "String",
27397             "optional": true,
27398             "field": "template",
27399             "description": ""
27400           },
27401           {
27402             "group": "Body",
27403             "type": "String",
27404             "allowedValues": [
27405               "\"yes\"",
27406               "\"no\"",
27407               "\"always\""
27408             ],
27409             "optional": true,
27410             "field": "videosupport",
27411             "description": ""
27412           },
27413           {
27414             "group": "Body",
27415             "type": "Integer",
27416             "optional": true,
27417             "field": "maxcallbitrate",
27418             "description": ""
27419           },
27420           {
27421             "group": "Body",
27422             "type": "String",
27423             "allowedValues": [
27424               "\"yes\"",
27425               "\"no\""
27426             ],
27427             "optional": true,
27428             "field": "rfc2833compensate",
27429             "description": ""
27430           },
27431           {
27432             "group": "Body",
27433             "type": "String",
27434             "optional": true,
27435             "field": "mailbox",
27436             "description": ""
27437           },
27438           {
27439             "group": "Body",
27440             "type": "String",
27441             "allowedValues": [
27442               "\"accept\"",
27443               "\"refuse\"",
27444               "\"originate\""
27445             ],
27446             "optional": true,
27447             "field": "session_timers",
27448             "description": ""
27449           },
27450           {
27451             "group": "Body",
27452             "type": "Integer",
27453             "optional": true,
27454             "field": "session_expires",
27455             "description": ""
27456           },
27457           {
27458             "group": "Body",
27459             "type": "Integer",
27460             "optional": true,
27461             "field": "session_minse",
27462             "description": ""
27463           },
27464           {
27465             "group": "Body",
27466             "type": "String",
27467             "allowedValues": [
27468               "\"uac\"",
27469               "\"uas\""
27470             ],
27471             "optional": true,
27472             "field": "session_refresher",
27473             "description": ""
27474           },
27475           {
27476             "group": "Body",
27477             "type": "String",
27478             "optional": true,
27479             "field": "t38pt_usertpsource",
27480             "description": ""
27481           },
27482           {
27483             "group": "Body",
27484             "type": "String",
27485             "optional": true,
27486             "field": "regexten",
27487             "description": ""
27488           },
27489           {
27490             "group": "Body",
27491             "type": "String",
27492             "optional": true,
27493             "field": "fromdomain",
27494             "description": ""
27495           },
27496           {
27497             "group": "Body",
27498             "type": "String",
27499             "optional": true,
27500             "field": "fromuser",
27501             "description": ""
27502           },
27503           {
27504             "group": "Body",
27505             "type": "Integer",
27506             "optional": true,
27507             "field": "port",
27508             "description": ""
27509           },
27510           {
27511             "group": "Body",
27512             "type": "String",
27513             "allowedValues": [
27514               "\"yes\"",
27515               "\"no\""
27516             ],
27517             "optional": true,
27518             "field": "qualify",
27519             "description": ""
27520           },
27521           {
27522             "group": "Body",
27523             "type": "Integer",
27524             "optional": true,
27525             "field": "keepalive",
27526             "description": ""
27527           },
27528           {
27529             "group": "Body",
27530             "type": "String",
27531             "optional": true,
27532             "field": "defaultip",
27533             "description": ""
27534           },
27535           {
27536             "group": "Body",
27537             "type": "String",
27538             "optional": true,
27539             "field": "defaultuser",
27540             "description": ""
27541           },
27542           {
27543             "group": "Body",
27544             "type": "Integer",
27545             "optional": true,
27546             "field": "rtptimeout",
27547             "description": ""
27548           },
27549           {
27550             "group": "Body",
27551             "type": "Integer",
27552             "optional": true,
27553             "field": "rtpholdtimeout",
27554             "description": ""
27555           },
27556           {
27557             "group": "Body",
27558             "type": "Integer",
27559             "optional": true,
27560             "field": "rtpkeepalive",
27561             "description": ""
27562           },
27563           {
27564             "group": "Body",
27565             "type": "String",
27566             "allowedValues": [
27567               "\"yes\"",
27568               "\"no\"",
27569               "\"pai\""
27570             ],
27571             "optional": true,
27572             "field": "sendrpid",
27573             "description": ""
27574           },
27575           {
27576             "group": "Body",
27577             "type": "String",
27578             "optional": true,
27579             "field": "outboundproxy",
27580             "description": ""
27581           },
27582           {
27583             "group": "Body",
27584             "type": "String",
27585             "optional": true,
27586             "field": "callbackextension",
27587             "description": ""
27588           },
27589           {
27590             "group": "Body",
27591             "type": "Integer",
27592             "optional": true,
27593             "field": "timert1",
27594             "description": ""
27595           },
27596           {
27597             "group": "Body",
27598             "type": "Integer",
27599             "optional": true,
27600             "field": "timerb",
27601             "description": ""
27602           },
27603           {
27604             "group": "Body",
27605             "type": "Integer",
27606             "optional": true,
27607             "field": "qualifyfreq",
27608             "description": ""
27609           },
27610           {
27611             "group": "Body",
27612             "type": "String",
27613             "optional": true,
27614             "field": "contactpermit",
27615             "description": ""
27616           },
27617           {
27618             "group": "Body",
27619             "type": "String",
27620             "optional": true,
27621             "field": "contactdeny",
27622             "description": ""
27623           },
27624           {
27625             "group": "Body",
27626             "type": "String",
27627             "optional": true,
27628             "field": "contactacl",
27629             "description": ""
27630           },
27631           {
27632             "group": "Body",
27633             "type": "String",
27634             "optional": true,
27635             "field": "unsolicited_mailbox",
27636             "description": ""
27637           },
27638           {
27639             "group": "Body",
27640             "type": "String",
27641             "optional": true,
27642             "field": "use_q850_reason",
27643             "description": ""
27644           },
27645           {
27646             "group": "Body",
27647             "type": "Integer",
27648             "optional": true,
27649             "field": "maxforwards",
27650             "description": ""
27651           },
27652           {
27653             "group": "Body",
27654             "type": "String",
27655             "allowedValues": [
27656               "\"yes\"",
27657               "\"no\""
27658             ],
27659             "optional": true,
27660             "field": "encryption",
27661             "description": ""
27662           },
27663           {
27664             "group": "Body",
27665             "type": "String",
27666             "allowedValues": [
27667               "\"yes\"",
27668               "\"no\""
27669             ],
27670             "optional": true,
27671             "field": "avpf",
27672             "description": ""
27673           },
27674           {
27675             "group": "Body",
27676             "type": "String",
27677             "allowedValues": [
27678               "\"yes\"",
27679               "\"no\""
27680             ],
27681             "optional": true,
27682             "field": "force_avp",
27683             "description": ""
27684           },
27685           {
27686             "group": "Body",
27687             "type": "String",
27688             "allowedValues": [
27689               "\"yes\"",
27690               "\"no\""
27691             ],
27692             "optional": true,
27693             "field": "icesupport",
27694             "description": ""
27695           },
27696           {
27697             "group": "Body",
27698             "type": "String",
27699             "allowedValues": [
27700               "\"yes\"",
27701               "\"no\""
27702             ],
27703             "optional": true,
27704             "field": "dtlsenable",
27705             "description": ""
27706           },
27707           {
27708             "group": "Body",
27709             "type": "String",
27710             "allowedValues": [
27711               "\"yes\"",
27712               "\"no\"",
27713               "\"fingerprint\"",
27714               "\"certificate\""
27715             ],
27716             "optional": true,
27717             "field": "dtlsverify",
27718             "description": ""
27719           },
27720           {
27721             "group": "Body",
27722             "type": "Integer",
27723             "optional": true,
27724             "field": "dtlsrekey",
27725             "description": ""
27726           },
27727           {
27728             "group": "Body",
27729             "type": "String",
27730             "optional": true,
27731             "field": "dtlscertfile",
27732             "description": ""
27733           },
27734           {
27735             "group": "Body",
27736             "type": "String",
27737             "optional": true,
27738             "field": "dtlsprivatekey",
27739             "description": ""
27740           },
27741           {
27742             "group": "Body",
27743             "type": "String",
27744             "optional": true,
27745             "field": "dtlscipher",
27746             "description": ""
27747           },
27748           {
27749             "group": "Body",
27750             "type": "String",
27751             "optional": true,
27752             "field": "dtlscafile",
27753             "description": ""
27754           },
27755           {
27756             "group": "Body",
27757             "type": "String",
27758             "optional": true,
27759             "field": "dtlscapath",
27760             "description": ""
27761           },
27762           {
27763             "group": "Body",
27764             "type": "String",
27765             "allowedValues": [
27766               "\"active\"",
27767               "\"passive\"",
27768               "\"actpass\""
27769             ],
27770             "optional": true,
27771             "field": "dtlssetup",
27772             "description": ""
27773           },
27774           {
27775             "group": "Body",
27776             "type": "String",
27777             "optional": true,
27778             "field": "dtlsfingerprint",
27779             "description": ""
27780           },
27781           {
27782             "group": "Body",
27783             "type": "String",
27784             "allowedValues": [
27785               "\"yes\"",
27786               "\"no\""
27787             ],
27788             "optional": true,
27789             "field": "usereqphone",
27790             "description": ""
27791           },
27792           {
27793             "group": "Body",
27794             "type": "String",
27795             "optional": true,
27796             "field": "recordonfeature",
27797             "description": ""
27798           },
27799           {
27800             "group": "Body",
27801             "type": "String",
27802             "optional": true,
27803             "field": "recordofffeature",
27804             "description": ""
27805           },
27806           {
27807             "group": "Body",
27808             "type": "Integer",
27809             "optional": true,
27810             "field": "call_limit",
27811             "description": ""
27812           },
27813           {
27814             "group": "Body",
27815             "type": "String",
27816             "allowedValues": [
27817               "\"yes\"",
27818               "\"no\""
27819             ],
27820             "optional": true,
27821             "field": "registertrying",
27822             "description": ""
27823           },
27824           {
27825             "group": "Body",
27826             "type": "String",
27827             "allowedValues": [
27828               "\"yes\"",
27829               "\"no\""
27830             ],
27831             "optional": true,
27832             "field": "subscribemwi",
27833             "description": ""
27834           },
27835           {
27836             "group": "Body",
27837             "type": "String",
27838             "optional": true,
27839             "field": "vmexten",
27840             "description": ""
27841           },
27842           {
27843             "group": "Body",
27844             "type": "String",
27845             "optional": true,
27846             "field": "mohinterpret",
27847             "description": ""
27848           },
27849           {
27850             "group": "Body",
27851             "type": "String",
27852             "optional": true,
27853             "field": "mohsuggest",
27854             "description": ""
27855           },
27856           {
27857             "group": "Body",
27858             "type": "String",
27859             "optional": true,
27860             "field": "parkinglot",
27861             "description": ""
27862           },
27863           {
27864             "group": "Body",
27865             "type": "String",
27866             "optional": true,
27867             "field": "description",
27868             "description": ""
27869           },
27870           {
27871             "group": "Body",
27872             "type": "String",
27873             "optional": true,
27874             "field": "host",
27875             "description": ""
27876           },
27877           {
27878             "group": "Body",
27879             "type": "String",
27880             "allowedValues": [
27881               "\"yes\"",
27882               "\"no\"",
27883               "\"nonat\"",
27884               "\"update\"",
27885               "\"update,nonat\""
27886             ],
27887             "optional": true,
27888             "field": "canreinvite",
27889             "description": ""
27890           },
27891           {
27892             "group": "Body",
27893             "type": "String",
27894             "optional": true,
27895             "field": "registry",
27896             "description": ""
27897           },
27898           {
27899             "group": "Body",
27900             "type": "String",
27901             "optional": true,
27902             "field": "otherFields",
27903             "description": ""
27904           },
27905           {
27906             "group": "Body",
27907             "type": "Boolean",
27908             "optional": false,
27909             "field": "active",
27910             "description": ""
27911           },
27912           {
27913             "group": "Body",
27914             "type": "String",
27915             "optional": true,
27916             "field": "t38pt_udptl",
27917             "description": ""
27918           }
27919         ]
27920       }
27921     },
27922     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27923     "version": "0.0.0",
27924     "filename": "server/api/trunk/index.js",
27925     "groupTitle": "Trunks"
27926   },
27927   {
27928     "type": "delete",
27929     "url": "/api/trunks/{id}",
27930     "title": "Deletes a trunk",
27931     "examples": [
27932       {
27933         "title": "Example usage:",
27934         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27935         "type": "json"
27936       }
27937     ],
27938     "name": "Delete",
27939     "group": "Trunks",
27940     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27941     "version": "0.0.0",
27942     "filename": "server/api/trunk/index.js",
27943     "groupTitle": "Trunks"
27944   },
27945   {
27946     "type": "get",
27947     "url": "/api/trunks",
27948     "title": "Gets a list of Trunks",
27949     "examples": [
27950       {
27951         "title": "Example usage:",
27952         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27953         "type": "json"
27954       }
27955     ],
27956     "name": "GetTrunks",
27957     "group": "Trunks",
27958     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27959     "version": "0.0.0",
27960     "filename": "server/api/trunk/index.js",
27961     "groupTitle": "Trunks"
27962   },
27963   {
27964     "type": "get",
27965     "url": "/api/trunks/{id}",
27966     "title": "Gets a single Trunk",
27967     "examples": [
27968       {
27969         "title": "Example usage:",
27970         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27971         "type": "json"
27972       }
27973     ],
27974     "name": "ShowTrunks",
27975     "group": "Trunks",
27976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27977     "version": "0.0.0",
27978     "filename": "server/api/trunk/index.js",
27979     "groupTitle": "Trunks"
27980   },
27981   {
27982     "type": "put",
27983     "url": "/api/trunks/{id}",
27984     "title": "Update an existing trunk",
27985     "examples": [
27986       {
27987         "title": "Example usage:",
27988         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27989         "type": "json"
27990       }
27991     ],
27992     "name": "Update",
27993     "group": "Trunks",
27994     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27995     "version": "0.0.0",
27996     "filename": "server/api/trunk/index.js",
27997     "groupTitle": "Trunks"
27998   },
27999   {
28000     "type": "post",
28001     "url": "/api/userNotifications",
28002     "title": "Send notification to user",
28003     "examples": [
28004       {
28005         "title": "Example usage:",
28006         "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28007         "type": "json"
28008       }
28009     ],
28010     "name": "Send",
28011     "group": "UserNotifications",
28012     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28013     "version": "0.0.0",
28014     "filename": "server/api/userNotification/index.js",
28015     "groupTitle": "UserNotifications"
28016   },
28017   {
28018     "type": "post",
28019     "url": "/api/userProfile/resources",
28020     "title": "Creates a new User Profile Resource",
28021     "examples": [
28022       {
28023         "title": "Example usage:",
28024         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28025         "type": "json"
28026       }
28027     ],
28028     "name": "CreateUser_Profile_Resources",
28029     "group": "User_Profile_Resources",
28030     "parameter": {
28031       "fields": {
28032         "Body": [
28033           {
28034             "group": "Body",
28035             "type": "String",
28036             "optional": false,
28037             "field": "name",
28038             "description": ""
28039           },
28040           {
28041             "group": "Body",
28042             "type": "Integer",
28043             "optional": false,
28044             "field": "resourceId",
28045             "description": ""
28046           },
28047           {
28048             "group": "Body",
28049             "type": "String",
28050             "optional": false,
28051             "field": "type",
28052             "description": ""
28053           }
28054         ]
28055       }
28056     },
28057     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28058     "version": "0.0.0",
28059     "filename": "server/api/userProfileResource/index.js",
28060     "groupTitle": "User_Profile_Resources"
28061   },
28062   {
28063     "type": "delete",
28064     "url": "/api/userProfile/resources/{id}",
28065     "title": "Deletes a User Profile Resource",
28066     "examples": [
28067       {
28068         "title": "Example usage:",
28069         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
28070         "type": "json"
28071       }
28072     ],
28073     "name": "DeleteUser_Profile_Resources",
28074     "group": "User_Profile_Resources",
28075     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28076     "version": "0.0.0",
28077     "filename": "server/api/userProfileResource/index.js",
28078     "groupTitle": "User_Profile_Resources"
28079   },
28080   {
28081     "type": "get",
28082     "url": "/api/userProfile/resources/describe",
28083     "title": "Gets table info about User Profile Resources",
28084     "examples": [
28085       {
28086         "title": "Example usage:",
28087         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
28088         "type": "json"
28089       }
28090     ],
28091     "name": "DescribeUser_Profile_Resources",
28092     "group": "User_Profile_Resources",
28093     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28094     "version": "0.0.0",
28095     "filename": "server/api/userProfileResource/index.js",
28096     "groupTitle": "User_Profile_Resources"
28097   },
28098   {
28099     "type": "get",
28100     "url": "/api/userProfile/resources",
28101     "title": "Gets a list of User Profile Resources",
28102     "examples": [
28103       {
28104         "title": "Example usage:",
28105         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
28106         "type": "json"
28107       }
28108     ],
28109     "name": "GetUser_Profile_Resources",
28110     "group": "User_Profile_Resources",
28111     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28112     "version": "0.0.0",
28113     "filename": "server/api/userProfileResource/index.js",
28114     "groupTitle": "User_Profile_Resources"
28115   },
28116   {
28117     "type": "get",
28118     "url": "/api/userProfile/resources/{id}",
28119     "title": "Gets a single User Profile Resource",
28120     "examples": [
28121       {
28122         "title": "Example usage:",
28123         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
28124         "type": "json"
28125       }
28126     ],
28127     "name": "ShowUser_Profile_Resources",
28128     "group": "User_Profile_Resources",
28129     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28130     "version": "0.0.0",
28131     "filename": "server/api/userProfileResource/index.js",
28132     "groupTitle": "User_Profile_Resources"
28133   },
28134   {
28135     "type": "put",
28136     "url": "/api/userProfile/resources/{id}",
28137     "title": "Update an existing User Profile Resource",
28138     "examples": [
28139       {
28140         "title": "Example usage:",
28141         "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",
28142         "type": "json"
28143       }
28144     ],
28145     "name": "updateUser_Profile_Resources",
28146     "group": "User_Profile_Resources",
28147     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28148     "version": "0.0.0",
28149     "filename": "server/api/userProfileResource/index.js",
28150     "groupTitle": "User_Profile_Resources"
28151   },
28152   {
28153     "type": "post",
28154     "url": "/api/userProfile/sections",
28155     "title": "Creates a new User Profile Section",
28156     "examples": [
28157       {
28158         "title": "Example usage:",
28159         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28160         "type": "json"
28161       }
28162     ],
28163     "name": "CreateUser_Profile_Sections",
28164     "group": "User_Profile_Sections",
28165     "parameter": {
28166       "fields": {
28167         "Body": [
28168           {
28169             "group": "Body",
28170             "type": "String",
28171             "optional": false,
28172             "field": "name",
28173             "description": ""
28174           },
28175           {
28176             "group": "Body",
28177             "type": "String",
28178             "optional": false,
28179             "field": "category",
28180             "description": ""
28181           },
28182           {
28183             "group": "Body",
28184             "type": "Integer",
28185             "optional": false,
28186             "field": "sectionId",
28187             "description": ""
28188           },
28189           {
28190             "group": "Body",
28191             "type": "Boolean",
28192             "optional": true,
28193             "field": "enabled",
28194             "description": ""
28195           },
28196           {
28197             "group": "Body",
28198             "type": "Boolean",
28199             "optional": true,
28200             "field": "autoAssociation",
28201             "description": ""
28202           },
28203           {
28204             "group": "Body",
28205             "type": "String",
28206             "optional": true,
28207             "field": "crudPermissions",
28208             "description": ""
28209           }
28210         ]
28211       }
28212     },
28213     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28214     "version": "0.0.0",
28215     "filename": "server/api/userProfileSection/index.js",
28216     "groupTitle": "User_Profile_Sections"
28217   },
28218   {
28219     "type": "delete",
28220     "url": "/api/userProfile/sections/{id}",
28221     "title": "Deletes a User Profile Section",
28222     "examples": [
28223       {
28224         "title": "Example usage:",
28225         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28226         "type": "json"
28227       }
28228     ],
28229     "name": "DeleteUser_Profile_Sections",
28230     "group": "User_Profile_Sections",
28231     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28232     "version": "0.0.0",
28233     "filename": "server/api/userProfileSection/index.js",
28234     "groupTitle": "User_Profile_Sections"
28235   },
28236   {
28237     "type": "get",
28238     "url": "/api/userProfile/sections/describe",
28239     "title": "Gets table info about User Profile Sections",
28240     "examples": [
28241       {
28242         "title": "Example usage:",
28243         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28244         "type": "json"
28245       }
28246     ],
28247     "name": "DescribeUser_Profile_Sections",
28248     "group": "User_Profile_Sections",
28249     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28250     "version": "0.0.0",
28251     "filename": "server/api/userProfileSection/index.js",
28252     "groupTitle": "User_Profile_Sections"
28253   },
28254   {
28255     "type": "get",
28256     "url": "/api/userProfile/sections",
28257     "title": "Gets a list of User Profile Sections",
28258     "examples": [
28259       {
28260         "title": "Example usage:",
28261         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28262         "type": "json"
28263       }
28264     ],
28265     "name": "GetUser_Profile_Sections",
28266     "group": "User_Profile_Sections",
28267     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28268     "version": "0.0.0",
28269     "filename": "server/api/userProfileSection/index.js",
28270     "groupTitle": "User_Profile_Sections"
28271   },
28272   {
28273     "type": "get",
28274     "url": "/api/userProfile/sections/{id}",
28275     "title": "Gets a single User Profile Section",
28276     "examples": [
28277       {
28278         "title": "Example usage:",
28279         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28280         "type": "json"
28281       }
28282     ],
28283     "name": "ShowUser_Profile_Sections",
28284     "group": "User_Profile_Sections",
28285     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28286     "version": "0.0.0",
28287     "filename": "server/api/userProfileSection/index.js",
28288     "groupTitle": "User_Profile_Sections"
28289   },
28290   {
28291     "type": "put",
28292     "url": "/api/userProfile/sections/{id}",
28293     "title": "Update an existing User Profile Section",
28294     "examples": [
28295       {
28296         "title": "Example usage:",
28297         "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",
28298         "type": "json"
28299       }
28300     ],
28301     "name": "updateUser_Profile_Sections",
28302     "group": "User_Profile_Sections",
28303     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28304     "version": "0.0.0",
28305     "filename": "server/api/userProfileSection/index.js",
28306     "groupTitle": "User_Profile_Sections"
28307   },
28308   {
28309     "type": "post",
28310     "url": "/api/userProfiles/{id}/resources",
28311     "title": "Add resources' permissions to User Profile",
28312     "examples": [
28313       {
28314         "title": "Example usage:",
28315         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28316         "type": "json"
28317       }
28318     ],
28319     "name": "AddResources",
28320     "group": "User_Profiles",
28321     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28322     "version": "0.0.0",
28323     "filename": "server/api/userProfile/index.js",
28324     "groupTitle": "User_Profiles"
28325   },
28326   {
28327     "type": "post",
28328     "url": "/api/userProfiles/{id}/sections",
28329     "title": "Add sections' permissions to User Profile",
28330     "examples": [
28331       {
28332         "title": "Example usage:",
28333         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28334         "type": "json"
28335       }
28336     ],
28337     "name": "AddSections",
28338     "group": "User_Profiles",
28339     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28340     "version": "0.0.0",
28341     "filename": "server/api/userProfile/index.js",
28342     "groupTitle": "User_Profiles"
28343   },
28344   {
28345     "type": "post",
28346     "url": "/api/userProfiles/clone",
28347     "title": "Clone an existing User Profile",
28348     "examples": [
28349       {
28350         "title": "Example usage:",
28351         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28352         "type": "json"
28353       }
28354     ],
28355     "name": "CloneUser_Profiles",
28356     "group": "User_Profiles",
28357     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28358     "version": "0.0.0",
28359     "filename": "server/api/userProfile/index.js",
28360     "groupTitle": "User_Profiles"
28361   },
28362   {
28363     "type": "post",
28364     "url": "/api/userProfiles",
28365     "title": "Creates a new User Profile",
28366     "examples": [
28367       {
28368         "title": "Example usage:",
28369         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28370         "type": "json"
28371       }
28372     ],
28373     "name": "CreateUser_Profiles",
28374     "group": "User_Profiles",
28375     "parameter": {
28376       "fields": {
28377         "Body": [
28378           {
28379             "group": "Body",
28380             "type": "String",
28381             "optional": false,
28382             "field": "name",
28383             "description": ""
28384           },
28385           {
28386             "group": "Body",
28387             "type": "String",
28388             "optional": false,
28389             "field": "crudPermissions",
28390             "description": ""
28391           },
28392           {
28393             "group": "Body",
28394             "type": "String",
28395             "optional": true,
28396             "field": "description",
28397             "description": ""
28398           },
28399           {
28400             "group": "Body",
28401             "type": "Boolean",
28402             "optional": true,
28403             "field": "privacyEnabled",
28404             "description": ""
28405           },
28406           {
28407             "group": "Body",
28408             "type": "Boolean",
28409             "optional": true,
28410             "field": "downloadAttachments",
28411             "description": ""
28412           },
28413           {
28414             "group": "Body",
28415             "type": "Boolean",
28416             "optional": true,
28417             "field": "downloadCallySquareRecordings",
28418             "description": ""
28419           },
28420           {
28421             "group": "Body",
28422             "type": "Boolean",
28423             "optional": true,
28424             "field": "downloadContactManagerLists",
28425             "description": ""
28426           },
28427           {
28428             "group": "Body",
28429             "type": "Boolean",
28430             "optional": true,
28431             "field": "downloadJscriptySessions",
28432             "description": ""
28433           },
28434           {
28435             "group": "Body",
28436             "type": "Boolean",
28437             "optional": true,
28438             "field": "downloadOmnichannelInteractions",
28439             "description": ""
28440           },
28441           {
28442             "group": "Body",
28443             "type": "Boolean",
28444             "optional": true,
28445             "field": "downloadScreenRecordings",
28446             "description": ""
28447           },
28448           {
28449             "group": "Body",
28450             "type": "Boolean",
28451             "optional": true,
28452             "field": "downloadVoiceRecordings",
28453             "description": ""
28454           }
28455         ]
28456       }
28457     },
28458     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28459     "version": "0.0.0",
28460     "filename": "server/api/userProfile/index.js",
28461     "groupTitle": "User_Profiles"
28462   },
28463   {
28464     "type": "delete",
28465     "url": "/api/userProfiles/{id}",
28466     "title": "Deletes a User Profile",
28467     "examples": [
28468       {
28469         "title": "Example usage:",
28470         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28471         "type": "json"
28472       }
28473     ],
28474     "name": "DeleteUser_Profiles",
28475     "group": "User_Profiles",
28476     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28477     "version": "0.0.0",
28478     "filename": "server/api/userProfile/index.js",
28479     "groupTitle": "User_Profiles"
28480   },
28481   {
28482     "type": "get",
28483     "url": "/api/userProfiles/describe",
28484     "title": "Gets table info about User Profiles",
28485     "examples": [
28486       {
28487         "title": "Example usage:",
28488         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28489         "type": "json"
28490       }
28491     ],
28492     "name": "DescribeUser_Profiles",
28493     "group": "User_Profiles",
28494     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28495     "version": "0.0.0",
28496     "filename": "server/api/userProfile/index.js",
28497     "groupTitle": "User_Profiles"
28498   },
28499   {
28500     "type": "get",
28501     "url": "/api/userProfiles/{id}/resources?section={section}",
28502     "title": "Get Resources assigned to a Section",
28503     "examples": [
28504       {
28505         "title": "Example usage:",
28506         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28507         "type": "json"
28508       }
28509     ],
28510     "name": "GetResources",
28511     "group": "User_Profiles",
28512     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28513     "version": "0.0.0",
28514     "filename": "server/api/userProfile/index.js",
28515     "groupTitle": "User_Profiles"
28516   },
28517   {
28518     "type": "get",
28519     "url": "/api/userProfiles/{id}/sections",
28520     "title": "Get sections associated to a User Profile",
28521     "examples": [
28522       {
28523         "title": "Example usage:",
28524         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28525         "type": "json"
28526       }
28527     ],
28528     "name": "GetSections",
28529     "group": "User_Profiles",
28530     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28531     "version": "0.0.0",
28532     "filename": "server/api/userProfile/index.js",
28533     "groupTitle": "User_Profiles"
28534   },
28535   {
28536     "type": "get",
28537     "url": "/api/userProfiles",
28538     "title": "Gets a list of User Profiles",
28539     "examples": [
28540       {
28541         "title": "Example usage:",
28542         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28543         "type": "json"
28544       }
28545     ],
28546     "name": "GetUser_Profiles",
28547     "group": "User_Profiles",
28548     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28549     "version": "0.0.0",
28550     "filename": "server/api/userProfile/index.js",
28551     "groupTitle": "User_Profiles"
28552   },
28553   {
28554     "type": "delete",
28555     "url": "/api/userProfiles/{id}/resources",
28556     "title": "Removes resources' permissions from User Profile",
28557     "examples": [
28558       {
28559         "title": "Example usage:",
28560         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28561         "type": "json"
28562       }
28563     ],
28564     "name": "RemoveResources",
28565     "group": "User_Profiles",
28566     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28567     "version": "0.0.0",
28568     "filename": "server/api/userProfile/index.js",
28569     "groupTitle": "User_Profiles"
28570   },
28571   {
28572     "type": "delete",
28573     "url": "/api/userProfiles/{id}/sections",
28574     "title": "Removes sections' permissions from User Profile",
28575     "examples": [
28576       {
28577         "title": "Example usage:",
28578         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28579         "type": "json"
28580       }
28581     ],
28582     "name": "RemoveSections",
28583     "group": "User_Profiles",
28584     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28585     "version": "0.0.0",
28586     "filename": "server/api/userProfile/index.js",
28587     "groupTitle": "User_Profiles"
28588   },
28589   {
28590     "type": "get",
28591     "url": "/api/userProfiles/{id}",
28592     "title": "Gets a single User Profile",
28593     "examples": [
28594       {
28595         "title": "Example usage:",
28596         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28597         "type": "json"
28598       }
28599     ],
28600     "name": "ShowUser_Profiles",
28601     "group": "User_Profiles",
28602     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28603     "version": "0.0.0",
28604     "filename": "server/api/userProfile/index.js",
28605     "groupTitle": "User_Profiles"
28606   },
28607   {
28608     "type": "put",
28609     "url": "/api/userProfiles/{id}",
28610     "title": "Update an existing User Profile",
28611     "examples": [
28612       {
28613         "title": "Example usage:",
28614         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28615         "type": "json"
28616       }
28617     ],
28618     "name": "updateUser_Profiles",
28619     "group": "User_Profiles",
28620     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28621     "version": "0.0.0",
28622     "filename": "server/api/userProfile/index.js",
28623     "groupTitle": "User_Profiles"
28624   },
28625   {
28626     "type": "post",
28627     "url": "/api/users/{id}/chat_interactions",
28628     "title": "Add chat interaction tabs to an agent",
28629     "examples": [
28630       {
28631         "title": "Example usage:",
28632         "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",
28633         "type": "json"
28634       }
28635     ],
28636     "name": "AddChatInteractions",
28637     "group": "Users",
28638     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28639     "version": "0.0.0",
28640     "filename": "server/api/user/index.js",
28641     "groupTitle": "Users"
28642   },
28643   {
28644     "type": "post",
28645     "url": "/api/users/{id}/chat_websites",
28646     "title": "Add a Chat Website to a user",
28647     "examples": [
28648       {
28649         "title": "Example usage:",
28650         "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",
28651         "type": "json"
28652       }
28653     ],
28654     "name": "AddChatWebsites",
28655     "group": "Users",
28656     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28657     "version": "0.0.0",
28658     "filename": "server/api/user/index.js",
28659     "groupTitle": "Users"
28660   },
28661   {
28662     "type": "post",
28663     "url": "/api/users/{id}/contacts",
28664     "title": "Add contacts to a user",
28665     "examples": [
28666       {
28667         "title": "Example usage:",
28668         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28669         "type": "json"
28670       }
28671     ],
28672     "name": "AddContacts",
28673     "group": "Users",
28674     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28675     "version": "0.0.0",
28676     "filename": "server/api/user/index.js",
28677     "groupTitle": "Users"
28678   },
28679   {
28680     "type": "post",
28681     "url": "/api/users/{id}/fax_accounts",
28682     "title": "Add a Fax Account to a user",
28683     "examples": [
28684       {
28685         "title": "Example usage:",
28686         "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",
28687         "type": "json"
28688       }
28689     ],
28690     "name": "AddFaxAccounts",
28691     "group": "Users",
28692     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28693     "version": "0.0.0",
28694     "filename": "server/api/user/index.js",
28695     "groupTitle": "Users"
28696   },
28697   {
28698     "type": "post",
28699     "url": "/api/users/{id}/fax_interactions",
28700     "title": "Add fax interaction tabs to an agent",
28701     "examples": [
28702       {
28703         "title": "Example usage:",
28704         "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",
28705         "type": "json"
28706       }
28707     ],
28708     "name": "AddFaxInteractions",
28709     "group": "Users",
28710     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28711     "version": "0.0.0",
28712     "filename": "server/api/user/index.js",
28713     "groupTitle": "Users"
28714   },
28715   {
28716     "type": "post",
28717     "url": "/api/users/{id}/mail_accounts",
28718     "title": "Add a Mail Account to a user",
28719     "examples": [
28720       {
28721         "title": "Example usage:",
28722         "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",
28723         "type": "json"
28724       }
28725     ],
28726     "name": "AddMailAccounts",
28727     "group": "Users",
28728     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28729     "version": "0.0.0",
28730     "filename": "server/api/user/index.js",
28731     "groupTitle": "Users"
28732   },
28733   {
28734     "type": "post",
28735     "url": "/api/users/{id}/mail_interactions",
28736     "title": "Add mail interaction tabs to an agent",
28737     "examples": [
28738       {
28739         "title": "Example usage:",
28740         "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",
28741         "type": "json"
28742       }
28743     ],
28744     "name": "AddMailInteractions",
28745     "group": "Users",
28746     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28747     "version": "0.0.0",
28748     "filename": "server/api/user/index.js",
28749     "groupTitle": "Users"
28750   },
28751   {
28752     "type": "post",
28753     "url": "/api/users/{id}/openchannel_accounts",
28754     "title": "Add a Open Channel Account to a user",
28755     "examples": [
28756       {
28757         "title": "Example usage:",
28758         "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",
28759         "type": "json"
28760       }
28761     ],
28762     "name": "AddOpenchannelAccounts",
28763     "group": "Users",
28764     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28765     "version": "0.0.0",
28766     "filename": "server/api/user/index.js",
28767     "groupTitle": "Users"
28768   },
28769   {
28770     "type": "post",
28771     "url": "/api/users/{id}/openchannel_interactions",
28772     "title": "Add openchannel interaction tabs to an agent",
28773     "examples": [
28774       {
28775         "title": "Example usage:",
28776         "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",
28777         "type": "json"
28778       }
28779     ],
28780     "name": "AddOpenchannelInteractions",
28781     "group": "Users",
28782     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28783     "version": "0.0.0",
28784     "filename": "server/api/user/index.js",
28785     "groupTitle": "Users"
28786   },
28787   {
28788     "type": "post",
28789     "url": "/api/users/{id}/queues",
28790     "title": "Add queues to an agent",
28791     "examples": [
28792       {
28793         "title": "Example usage:",
28794         "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",
28795         "type": "json"
28796       }
28797     ],
28798     "name": "AddQueues",
28799     "group": "Users",
28800     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28801     "version": "0.0.0",
28802     "filename": "server/api/user/index.js",
28803     "groupTitle": "Users"
28804   },
28805   {
28806     "type": "post",
28807     "url": "/api/users/{id}/sms_accounts",
28808     "title": "Add a Sms Account to a user",
28809     "examples": [
28810       {
28811         "title": "Example usage:",
28812         "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",
28813         "type": "json"
28814       }
28815     ],
28816     "name": "AddSmsAccounts",
28817     "group": "Users",
28818     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28819     "version": "0.0.0",
28820     "filename": "server/api/user/index.js",
28821     "groupTitle": "Users"
28822   },
28823   {
28824     "type": "post",
28825     "url": "/api/users/{id}/sms_interactions",
28826     "title": "Add sms interaction tabs to an agent",
28827     "examples": [
28828       {
28829         "title": "Example usage:",
28830         "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",
28831         "type": "json"
28832       }
28833     ],
28834     "name": "AddSmsInteractions",
28835     "group": "Users",
28836     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28837     "version": "0.0.0",
28838     "filename": "server/api/user/index.js",
28839     "groupTitle": "Users"
28840   },
28841   {
28842     "type": "post",
28843     "url": "/api/users/{id}/square_projects",
28844     "title": "Add a Square Project to a user",
28845     "examples": [
28846       {
28847         "title": "Example usage:",
28848         "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",
28849         "type": "json"
28850       }
28851     ],
28852     "name": "AddSquareProjects",
28853     "group": "Users",
28854     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28855     "version": "0.0.0",
28856     "filename": "server/api/user/index.js",
28857     "groupTitle": "Users"
28858   },
28859   {
28860     "type": "post",
28861     "url": "/api/users/{id}/teams",
28862     "title": "Add teams to an agent",
28863     "examples": [
28864       {
28865         "title": "Example usage:",
28866         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28867         "type": "json"
28868       }
28869     ],
28870     "name": "AddTeams",
28871     "group": "Users",
28872     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28873     "version": "0.0.0",
28874     "filename": "server/api/user/index.js",
28875     "groupTitle": "Users"
28876   },
28877   {
28878     "type": "post",
28879     "url": "/api/users/{id}/whatsapp_accounts",
28880     "title": "Add a Whatsapp Account to a user",
28881     "examples": [
28882       {
28883         "title": "Example usage:",
28884         "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",
28885         "type": "json"
28886       }
28887     ],
28888     "name": "AddWhatsappAccounts",
28889     "group": "Users",
28890     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28891     "version": "0.0.0",
28892     "filename": "server/api/user/index.js",
28893     "groupTitle": "Users"
28894   },
28895   {
28896     "type": "post",
28897     "url": "/api/users/{id}/whatsapp_interactions",
28898     "title": "Add Whatsapp interaction tabs to an agent",
28899     "examples": [
28900       {
28901         "title": "Example usage:",
28902         "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",
28903         "type": "json"
28904       }
28905     ],
28906     "name": "AddWhatsappInteractions",
28907     "group": "Users",
28908     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28909     "version": "0.0.0",
28910     "filename": "server/api/user/index.js",
28911     "groupTitle": "Users"
28912   },
28913   {
28914     "type": "put",
28915     "url": "/api/users/{id}/password",
28916     "title": "Change user password",
28917     "examples": [
28918       {
28919         "title": "Example usage:",
28920         "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",
28921         "type": "json"
28922       }
28923     ],
28924     "name": "ChangePwd",
28925     "group": "Users",
28926     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28927     "version": "0.0.0",
28928     "filename": "server/api/user/index.js",
28929     "groupTitle": "Users"
28930   },
28931   {
28932     "type": "post",
28933     "url": "/api/users",
28934     "title": "Create a new user",
28935     "examples": [
28936       {
28937         "title": "Example usage:",
28938         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28939         "type": "json"
28940       }
28941     ],
28942     "name": "Create",
28943     "group": "Users",
28944     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28945     "version": "0.0.0",
28946     "filename": "server/api/user/index.js",
28947     "groupTitle": "Users"
28948   },
28949   {
28950     "type": "post",
28951     "url": "/api/users/{id}/api_key",
28952     "title": "Create a new API access key for the user",
28953     "examples": [
28954       {
28955         "title": "Example usage:",
28956         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28957         "type": "json"
28958       }
28959     ],
28960     "name": "CreateApiKey",
28961     "group": "Users",
28962     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28963     "version": "0.0.0",
28964     "filename": "server/api/user/index.js",
28965     "groupTitle": "Users"
28966   },
28967   {
28968     "type": "delete",
28969     "url": "/api/users/{id}",
28970     "title": "Deletes a user",
28971     "examples": [
28972       {
28973         "title": "Example usage:",
28974         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
28975         "type": "json"
28976       }
28977     ],
28978     "name": "Delete",
28979     "group": "Users",
28980     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28981     "version": "0.0.0",
28982     "filename": "server/api/user/index.js",
28983     "groupTitle": "Users"
28984   },
28985   {
28986     "type": "get",
28987     "url": "/api/users/describe",
28988     "title": "Gets table info about Users",
28989     "examples": [
28990       {
28991         "title": "Example usage:",
28992         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
28993         "type": "json"
28994       }
28995     ],
28996     "name": "DescribeUsers",
28997     "group": "Users",
28998     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28999     "version": "0.0.0",
29000     "filename": "server/api/user/index.js",
29001     "groupTitle": "Users"
29002   },
29003   {
29004     "type": "get",
29005     "url": "/api/users/{id}/agents",
29006     "title": "GetAgents",
29007     "examples": [
29008       {
29009         "title": "Example usage:",
29010         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29011         "type": "json"
29012       }
29013     ],
29014     "name": "GetAgents",
29015     "group": "Users",
29016     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29017     "version": "0.0.0",
29018     "filename": "server/api/user/index.js",
29019     "groupTitle": "Users"
29020   },
29021   {
29022     "type": "get",
29023     "url": "/api/users/{id}/api_key",
29024     "title": "Get the API access key for the user",
29025     "examples": [
29026       {
29027         "title": "Example usage:",
29028         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29029         "type": "json"
29030       }
29031     ],
29032     "name": "GetApiKey",
29033     "group": "Users",
29034     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29035     "version": "0.0.0",
29036     "filename": "server/api/user/index.js",
29037     "groupTitle": "Users"
29038   },
29039   {
29040     "type": "get",
29041     "url": "/api/users/{id}/groups",
29042     "title": "GetChatGroups",
29043     "examples": [
29044       {
29045         "title": "Example usage:",
29046         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29047         "type": "json"
29048       }
29049     ],
29050     "name": "GetChatGroups",
29051     "group": "Users",
29052     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29053     "version": "0.0.0",
29054     "filename": "server/api/user/index.js",
29055     "groupTitle": "Users"
29056   },
29057   {
29058     "type": "get",
29059     "url": "/api/users/{id}/chat/interactions",
29060     "title": "GetChatInteractions",
29061     "examples": [
29062       {
29063         "title": "Example usage:",
29064         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29065         "type": "json"
29066       }
29067     ],
29068     "name": "GetChatInteractions",
29069     "group": "Users",
29070     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29071     "version": "0.0.0",
29072     "filename": "server/api/user/index.js",
29073     "groupTitle": "Users"
29074   },
29075   {
29076     "type": "get",
29077     "url": "/api/users/{id}/chat_websites",
29078     "title": "GetChatWebsites",
29079     "examples": [
29080       {
29081         "title": "Example usage:",
29082         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29083         "type": "json"
29084       }
29085     ],
29086     "name": "GetChatWebsites",
29087     "group": "Users",
29088     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29089     "version": "0.0.0",
29090     "filename": "server/api/user/index.js",
29091     "groupTitle": "Users"
29092   },
29093   {
29094     "type": "get",
29095     "url": "/api/users/{id}/contacts",
29096     "title": "GetContacts",
29097     "examples": [
29098       {
29099         "title": "Example usage:",
29100         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29101         "type": "json"
29102       }
29103     ],
29104     "name": "GetContacts",
29105     "group": "Users",
29106     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29107     "version": "0.0.0",
29108     "filename": "server/api/user/index.js",
29109     "groupTitle": "Users"
29110   },
29111   {
29112     "type": "get",
29113     "url": "/api/users/{id}/fax_accounts",
29114     "title": "GetFaxAccounts",
29115     "examples": [
29116       {
29117         "title": "Example usage:",
29118         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29119         "type": "json"
29120       }
29121     ],
29122     "name": "GetFaxAccounts",
29123     "group": "Users",
29124     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29125     "version": "0.0.0",
29126     "filename": "server/api/user/index.js",
29127     "groupTitle": "Users"
29128   },
29129   {
29130     "type": "get",
29131     "url": "/api/users/{id}/fax/interactions",
29132     "title": "GetFaxInteractions",
29133     "examples": [
29134       {
29135         "title": "Example usage:",
29136         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29137         "type": "json"
29138       }
29139     ],
29140     "name": "GetFaxInteractions",
29141     "group": "Users",
29142     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29143     "version": "0.0.0",
29144     "filename": "server/api/user/index.js",
29145     "groupTitle": "Users"
29146   },
29147   {
29148     "type": "get",
29149     "url": "/api/users/{id}/lists",
29150     "title": "GetLists",
29151     "examples": [
29152       {
29153         "title": "Example usage:",
29154         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29155         "type": "json"
29156       }
29157     ],
29158     "name": "GetLists",
29159     "group": "Users",
29160     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29161     "version": "0.0.0",
29162     "filename": "server/api/user/index.js",
29163     "groupTitle": "Users"
29164   },
29165   {
29166     "type": "get",
29167     "url": "/api/users/{id}/mail_accounts",
29168     "title": "GetMailAccounts",
29169     "examples": [
29170       {
29171         "title": "Example usage:",
29172         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29173         "type": "json"
29174       }
29175     ],
29176     "name": "GetMailAccounts",
29177     "group": "Users",
29178     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29179     "version": "0.0.0",
29180     "filename": "server/api/user/index.js",
29181     "groupTitle": "Users"
29182   },
29183   {
29184     "type": "get",
29185     "url": "/api/users/{id}/mail/interactions",
29186     "title": "GetMailInteractions",
29187     "examples": [
29188       {
29189         "title": "Example usage:",
29190         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29191         "type": "json"
29192       }
29193     ],
29194     "name": "GetMailInteractions",
29195     "group": "Users",
29196     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29197     "version": "0.0.0",
29198     "filename": "server/api/user/index.js",
29199     "groupTitle": "Users"
29200   },
29201   {
29202     "type": "get",
29203     "url": "/api/users/{id}/openchannel_accounts",
29204     "title": "GetOpenchannelAccounts",
29205     "examples": [
29206       {
29207         "title": "Example usage:",
29208         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29209         "type": "json"
29210       }
29211     ],
29212     "name": "GetOpenchannelAccounts",
29213     "group": "Users",
29214     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29215     "version": "0.0.0",
29216     "filename": "server/api/user/index.js",
29217     "groupTitle": "Users"
29218   },
29219   {
29220     "type": "get",
29221     "url": "/api/users/{id}/openchannel/interactions",
29222     "title": "GetOpenchannelInteractions",
29223     "examples": [
29224       {
29225         "title": "Example usage:",
29226         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29227         "type": "json"
29228       }
29229     ],
29230     "name": "GetOpenchannelInteractions",
29231     "group": "Users",
29232     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29233     "version": "0.0.0",
29234     "filename": "server/api/user/index.js",
29235     "groupTitle": "Users"
29236   },
29237   {
29238     "type": "get",
29239     "url": "/api/users/{id}/prefixes",
29240     "title": "GetPrefixes",
29241     "examples": [
29242       {
29243         "title": "Example usage:",
29244         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29245         "type": "json"
29246       }
29247     ],
29248     "name": "GetPrefixes",
29249     "group": "Users",
29250     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29251     "version": "0.0.0",
29252     "filename": "server/api/user/index.js",
29253     "groupTitle": "Users"
29254   },
29255   {
29256     "type": "get",
29257     "url": "/api/users/{id}/queues?channel={channel}",
29258     "title": "Gets Queues list",
29259     "examples": [
29260       {
29261         "title": "Example usage:",
29262         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29263         "type": "json"
29264       }
29265     ],
29266     "name": "GetQueues",
29267     "group": "Users",
29268     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29269     "version": "0.0.0",
29270     "filename": "server/api/user/index.js",
29271     "groupTitle": "Users"
29272   },
29273   {
29274     "type": "get",
29275     "url": "/api/users/{id}/recordings",
29276     "title": "GetRecordings",
29277     "examples": [
29278       {
29279         "title": "Example usage:",
29280         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29281         "type": "json"
29282       }
29283     ],
29284     "name": "GetRecordings",
29285     "group": "Users",
29286     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29287     "version": "0.0.0",
29288     "filename": "server/api/user/index.js",
29289     "groupTitle": "Users"
29290   },
29291   {
29292     "type": "get",
29293     "url": "/api/users/{id}/scheduled_calls",
29294     "title": "GetScheduledCalls",
29295     "examples": [
29296       {
29297         "title": "Example usage:",
29298         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29299         "type": "json"
29300       }
29301     ],
29302     "name": "GetScheduledCalls",
29303     "group": "Users",
29304     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29305     "version": "0.0.0",
29306     "filename": "server/api/user/index.js",
29307     "groupTitle": "Users"
29308   },
29309   {
29310     "type": "get",
29311     "url": "/api/users/{id}/screen_recordings",
29312     "title": "GetScreenRecordings",
29313     "examples": [
29314       {
29315         "title": "Example usage:",
29316         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29317         "type": "json"
29318       }
29319     ],
29320     "name": "GetScreenRecordings",
29321     "group": "Users",
29322     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29323     "version": "0.0.0",
29324     "filename": "server/api/user/index.js",
29325     "groupTitle": "Users"
29326   },
29327   {
29328     "type": "get",
29329     "url": "/api/users/{id}/sms_accounts",
29330     "title": "GetSmsAccounts",
29331     "examples": [
29332       {
29333         "title": "Example usage:",
29334         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29335         "type": "json"
29336       }
29337     ],
29338     "name": "GetSmsAccounts",
29339     "group": "Users",
29340     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29341     "version": "0.0.0",
29342     "filename": "server/api/user/index.js",
29343     "groupTitle": "Users"
29344   },
29345   {
29346     "type": "get",
29347     "url": "/api/users/{id}/sms/interactions",
29348     "title": "GetSmsInteractions",
29349     "examples": [
29350       {
29351         "title": "Example usage:",
29352         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29353         "type": "json"
29354       }
29355     ],
29356     "name": "GetSmsInteractions",
29357     "group": "Users",
29358     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29359     "version": "0.0.0",
29360     "filename": "server/api/user/index.js",
29361     "groupTitle": "Users"
29362   },
29363   {
29364     "type": "get",
29365     "url": "/api/users/{id}/square_projects",
29366     "title": "GetSquareProjects",
29367     "examples": [
29368       {
29369         "title": "Example usage:",
29370         "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29371         "type": "json"
29372       }
29373     ],
29374     "name": "GetSquareProjects",
29375     "group": "Users",
29376     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29377     "version": "0.0.0",
29378     "filename": "server/api/user/index.js",
29379     "groupTitle": "Users"
29380   },
29381   {
29382     "type": "get",
29383     "url": "/api/users/{id}/teams",
29384     "title": "GetTeams",
29385     "examples": [
29386       {
29387         "title": "Example usage:",
29388         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29389         "type": "json"
29390       }
29391     ],
29392     "name": "GetTeams",
29393     "group": "Users",
29394     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29395     "version": "0.0.0",
29396     "filename": "server/api/user/index.js",
29397     "groupTitle": "Users"
29398   },
29399   {
29400     "type": "get",
29401     "url": "/api/users",
29402     "title": "Gets a list of Users",
29403     "examples": [
29404       {
29405         "title": "Example usage:",
29406         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29407         "type": "json"
29408       }
29409     ],
29410     "name": "GetUsers",
29411     "group": "Users",
29412     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29413     "version": "0.0.0",
29414     "filename": "server/api/user/index.js",
29415     "groupTitle": "Users"
29416   },
29417   {
29418     "type": "get",
29419     "url": "/api/users/{id}/queues_rt",
29420     "title": "GetVoiceQueuesRt",
29421     "examples": [
29422       {
29423         "title": "Example usage:",
29424         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29425         "type": "json"
29426       }
29427     ],
29428     "name": "GetVoiceQueuesRt",
29429     "group": "Users",
29430     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29431     "version": "0.0.0",
29432     "filename": "server/api/user/index.js",
29433     "groupTitle": "Users"
29434   },
29435   {
29436     "type": "get",
29437     "url": "/api/users/{id}/whatsapp_accounts",
29438     "title": "GetWhatsappAccounts",
29439     "examples": [
29440       {
29441         "title": "Example usage:",
29442         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29443         "type": "json"
29444       }
29445     ],
29446     "name": "GetWhatsappAccounts",
29447     "group": "Users",
29448     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29449     "version": "0.0.0",
29450     "filename": "server/api/user/index.js",
29451     "groupTitle": "Users"
29452   },
29453   {
29454     "type": "get",
29455     "url": "/api/users/{id}/whatsapp/interactions",
29456     "title": "GetWhatsappInteractions",
29457     "examples": [
29458       {
29459         "title": "Example usage:",
29460         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29461         "type": "json"
29462       }
29463     ],
29464     "name": "GetWhatsappInteractions",
29465     "group": "Users",
29466     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29467     "version": "0.0.0",
29468     "filename": "server/api/user/index.js",
29469     "groupTitle": "Users"
29470   },
29471   {
29472     "type": "post",
29473     "url": "/api/users/{id}/login",
29474     "title": "Login",
29475     "examples": [
29476       {
29477         "title": "Example usage:",
29478         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
29479         "type": "json"
29480       }
29481     ],
29482     "name": "Login",
29483     "group": "Users",
29484     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29485     "version": "0.0.0",
29486     "filename": "server/api/user/index.js",
29487     "groupTitle": "Users"
29488   },
29489   {
29490     "type": "post",
29491     "url": "/api/users/{id}/logout",
29492     "title": "Logout",
29493     "examples": [
29494       {
29495         "title": "Example usage:",
29496         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29497         "type": "json"
29498       }
29499     ],
29500     "name": "Logout",
29501     "group": "Users",
29502     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29503     "version": "0.0.0",
29504     "filename": "server/api/user/index.js",
29505     "groupTitle": "Users"
29506   },
29507   {
29508     "type": "post",
29509     "url": "/api/users/{id}/pause",
29510     "title": "Pause",
29511     "examples": [
29512       {
29513         "title": "Example usage:",
29514         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29515         "type": "json"
29516       }
29517     ],
29518     "name": "Pause",
29519     "group": "Users",
29520     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29521     "version": "0.0.0",
29522     "filename": "server/api/user/index.js",
29523     "groupTitle": "Users"
29524   },
29525   {
29526     "type": "delete",
29527     "url": "/api/users/{id}/api_key",
29528     "title": "Remove API access key for the user",
29529     "examples": [
29530       {
29531         "title": "Example usage:",
29532         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29533         "type": "json"
29534       }
29535     ],
29536     "name": "RemoveApiKey",
29537     "group": "Users",
29538     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29539     "version": "0.0.0",
29540     "filename": "server/api/user/index.js",
29541     "groupTitle": "Users"
29542   },
29543   {
29544     "type": "delete",
29545     "url": "/api/users/{id}/chat_interactions",
29546     "title": "Removes interactions from an agent",
29547     "examples": [
29548       {
29549         "title": "Example usage:",
29550         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29551         "type": "json"
29552       }
29553     ],
29554     "name": "RemoveChatInteractions",
29555     "group": "Users",
29556     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29557     "version": "0.0.0",
29558     "filename": "server/api/user/index.js",
29559     "groupTitle": "Users"
29560   },
29561   {
29562     "type": "delete",
29563     "url": "/api/users/{id}/chat_websites",
29564     "title": "Removes a Chat Website from a user",
29565     "examples": [
29566       {
29567         "title": "Example usage:",
29568         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29569         "type": "json"
29570       }
29571     ],
29572     "name": "RemoveChatWebsites",
29573     "group": "Users",
29574     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29575     "version": "0.0.0",
29576     "filename": "server/api/user/index.js",
29577     "groupTitle": "Users"
29578   },
29579   {
29580     "type": "delete",
29581     "url": "/api/users/{id}/fax_accounts",
29582     "title": "Removes a Fax Account from a user",
29583     "examples": [
29584       {
29585         "title": "Example usage:",
29586         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29587         "type": "json"
29588       }
29589     ],
29590     "name": "RemoveFaxAccounts",
29591     "group": "Users",
29592     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29593     "version": "0.0.0",
29594     "filename": "server/api/user/index.js",
29595     "groupTitle": "Users"
29596   },
29597   {
29598     "type": "delete",
29599     "url": "/api/users/{id}/fax_interactions",
29600     "title": "Removes interactions from an agent",
29601     "examples": [
29602       {
29603         "title": "Example usage:",
29604         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29605         "type": "json"
29606       }
29607     ],
29608     "name": "RemoveFaxInteractions",
29609     "group": "Users",
29610     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29611     "version": "0.0.0",
29612     "filename": "server/api/user/index.js",
29613     "groupTitle": "Users"
29614   },
29615   {
29616     "type": "delete",
29617     "url": "/api/users/{id}/mail_accounts",
29618     "title": "Removes a Mail Account from a user",
29619     "examples": [
29620       {
29621         "title": "Example usage:",
29622         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29623         "type": "json"
29624       }
29625     ],
29626     "name": "RemoveMailAccounts",
29627     "group": "Users",
29628     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29629     "version": "0.0.0",
29630     "filename": "server/api/user/index.js",
29631     "groupTitle": "Users"
29632   },
29633   {
29634     "type": "delete",
29635     "url": "/api/users/{id}/mail_interactions",
29636     "title": "Removes interactions from an agent",
29637     "examples": [
29638       {
29639         "title": "Example usage:",
29640         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29641         "type": "json"
29642       }
29643     ],
29644     "name": "RemoveMailInteractions",
29645     "group": "Users",
29646     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29647     "version": "0.0.0",
29648     "filename": "server/api/user/index.js",
29649     "groupTitle": "Users"
29650   },
29651   {
29652     "type": "delete",
29653     "url": "/api/users/{id}/openchannel_accounts",
29654     "title": "Removes a Open Channel Account from a user",
29655     "examples": [
29656       {
29657         "title": "Example usage:",
29658         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29659         "type": "json"
29660       }
29661     ],
29662     "name": "RemoveOpenchannelAccounts",
29663     "group": "Users",
29664     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29665     "version": "0.0.0",
29666     "filename": "server/api/user/index.js",
29667     "groupTitle": "Users"
29668   },
29669   {
29670     "type": "delete",
29671     "url": "/api/users/{id}/openchannel_interactions",
29672     "title": "Removes openchannel interactions from an agent",
29673     "examples": [
29674       {
29675         "title": "Example usage:",
29676         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29677         "type": "json"
29678       }
29679     ],
29680     "name": "RemoveOpenchannelInteractions",
29681     "group": "Users",
29682     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29683     "version": "0.0.0",
29684     "filename": "server/api/user/index.js",
29685     "groupTitle": "Users"
29686   },
29687   {
29688     "type": "delete",
29689     "url": "/api/users/{id}/queues",
29690     "title": "Remove queues to an agent",
29691     "examples": [
29692       {
29693         "title": "Example usage:",
29694         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29695         "type": "json"
29696       }
29697     ],
29698     "name": "RemoveQueues",
29699     "group": "Users",
29700     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29701     "version": "0.0.0",
29702     "filename": "server/api/user/index.js",
29703     "groupTitle": "Users"
29704   },
29705   {
29706     "type": "delete",
29707     "url": "/api/users/{id}/sms_accounts",
29708     "title": "Removes a Sms Account from a user",
29709     "examples": [
29710       {
29711         "title": "Example usage:",
29712         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29713         "type": "json"
29714       }
29715     ],
29716     "name": "RemoveSmsAccounts",
29717     "group": "Users",
29718     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29719     "version": "0.0.0",
29720     "filename": "server/api/user/index.js",
29721     "groupTitle": "Users"
29722   },
29723   {
29724     "type": "delete",
29725     "url": "/api/users/{id}/sms_interactions",
29726     "title": "Removes interactions from an agent",
29727     "examples": [
29728       {
29729         "title": "Example usage:",
29730         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29731         "type": "json"
29732       }
29733     ],
29734     "name": "RemoveSmsInteractions",
29735     "group": "Users",
29736     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29737     "version": "0.0.0",
29738     "filename": "server/api/user/index.js",
29739     "groupTitle": "Users"
29740   },
29741   {
29742     "type": "delete",
29743     "url": "/api/users/{id}/square_projects",
29744     "title": "Removes a Square Project from a user",
29745     "examples": [
29746       {
29747         "title": "Example usage:",
29748         "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29749         "type": "json"
29750       }
29751     ],
29752     "name": "RemoveSquareProjects",
29753     "group": "Users",
29754     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29755     "version": "0.0.0",
29756     "filename": "server/api/user/index.js",
29757     "groupTitle": "Users"
29758   },
29759   {
29760     "type": "delete",
29761     "url": "/api/users/{id}/teams",
29762     "title": "Removes teams from an agent",
29763     "examples": [
29764       {
29765         "title": "Example usage:",
29766         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29767         "type": "json"
29768       }
29769     ],
29770     "name": "RemoveTeams",
29771     "group": "Users",
29772     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29773     "version": "0.0.0",
29774     "filename": "server/api/user/index.js",
29775     "groupTitle": "Users"
29776   },
29777   {
29778     "type": "delete",
29779     "url": "/api/users/{id}/whatsapp_accounts",
29780     "title": "Removes a Whatsapp Account from a user",
29781     "examples": [
29782       {
29783         "title": "Example usage:",
29784         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29785         "type": "json"
29786       }
29787     ],
29788     "name": "RemoveWhatsappAccounts",
29789     "group": "Users",
29790     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29791     "version": "0.0.0",
29792     "filename": "server/api/user/index.js",
29793     "groupTitle": "Users"
29794   },
29795   {
29796     "type": "delete",
29797     "url": "/api/users/{id}/whatsapp_interactions",
29798     "title": "Removes Whatsapp interactions from an agent",
29799     "examples": [
29800       {
29801         "title": "Example usage:",
29802         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29803         "type": "json"
29804       }
29805     ],
29806     "name": "RemoveWhatsappInteractions",
29807     "group": "Users",
29808     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29809     "version": "0.0.0",
29810     "filename": "server/api/user/index.js",
29811     "groupTitle": "Users"
29812   },
29813   {
29814     "type": "get",
29815     "url": "/api/users/{id}",
29816     "title": "Gets a single User",
29817     "examples": [
29818       {
29819         "title": "Example usage:",
29820         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29821         "type": "json"
29822       }
29823     ],
29824     "name": "ShowUsers",
29825     "group": "Users",
29826     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29827     "version": "0.0.0",
29828     "filename": "server/api/user/index.js",
29829     "groupTitle": "Users"
29830   },
29831   {
29832     "type": "post",
29833     "url": "/api/users/{id}/unpause",
29834     "title": "Unpause",
29835     "examples": [
29836       {
29837         "title": "Example usage:",
29838         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29839         "type": "json"
29840       }
29841     ],
29842     "name": "Unpause",
29843     "group": "Users",
29844     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29845     "version": "0.0.0",
29846     "filename": "server/api/user/index.js",
29847     "groupTitle": "Users"
29848   },
29849   {
29850     "type": "get",
29851     "url": "/api/users/whoami",
29852     "title": "WhoAmI",
29853     "examples": [
29854       {
29855         "title": "Example usage:",
29856         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29857         "type": "json"
29858       }
29859     ],
29860     "name": "WhoAmI",
29861     "group": "Users",
29862     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29863     "version": "0.0.0",
29864     "filename": "server/api/user/index.js",
29865     "groupTitle": "Users"
29866   },
29867   {
29868     "type": "post",
29869     "url": "/api/users/{id}/avatar",
29870     "title": "Add avatar",
29871     "examples": [
29872       {
29873         "title": "Example usage:",
29874         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29875         "type": "json"
29876       }
29877     ],
29878     "name": "addAvatar",
29879     "group": "Users",
29880     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29881     "version": "0.0.0",
29882     "filename": "server/api/user/index.js",
29883     "groupTitle": "Users"
29884   },
29885   {
29886     "type": "post",
29887     "url": "/api/users/create_many",
29888     "title": "Create Users",
29889     "examples": [
29890       {
29891         "title": "Example usage:",
29892         "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29893         "type": "json"
29894       }
29895     ],
29896     "name": "bulkCreate",
29897     "group": "Users",
29898     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29899     "version": "0.0.0",
29900     "filename": "server/api/user/index.js",
29901     "groupTitle": "Users"
29902   },
29903   {
29904     "type": "get",
29905     "url": "/api/users/{id}/avatar",
29906     "title": "Get avatar",
29907     "examples": [
29908       {
29909         "title": "Example usage:",
29910         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29911         "type": "json"
29912       }
29913     ],
29914     "name": "getAvatar",
29915     "group": "Users",
29916     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29917     "version": "0.0.0",
29918     "filename": "server/api/user/index.js",
29919     "groupTitle": "Users"
29920   },
29921   {
29922     "type": "get",
29923     "url": "/api/users/{id}/open_tabs",
29924     "title": "Get interactions opened tabs",
29925     "examples": [
29926       {
29927         "title": "Example usage:",
29928         "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
29929         "type": "json"
29930       }
29931     ],
29932     "name": "getOpenTabs",
29933     "group": "Users",
29934     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29935     "version": "0.0.0",
29936     "filename": "server/api/user/index.js",
29937     "groupTitle": "Users"
29938   },
29939   {
29940     "type": "get",
29941     "url": "/api/users/presence",
29942     "title": "Gets agent presence",
29943     "examples": [
29944       {
29945         "title": "Example usage:",
29946         "content": "curl https://{domain}/api/users/presence -v -u {name}:{password}  -X GET",
29947         "type": "json"
29948       }
29949     ],
29950     "name": "getPresence",
29951     "group": "Users",
29952     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29953     "version": "0.0.0",
29954     "filename": "server/api/user/index.js",
29955     "groupTitle": "Users"
29956   },
29957   {
29958     "type": "put",
29959     "url": "/api/users/{id}",
29960     "title": "Update an existing User",
29961     "examples": [
29962       {
29963         "title": "Example usage:",
29964         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29965         "type": "json"
29966       }
29967     ],
29968     "name": "updateUsers",
29969     "group": "Users",
29970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29971     "version": "0.0.0",
29972     "filename": "server/api/user/index.js",
29973     "groupTitle": "Users"
29974   },
29975   {
29976     "type": "post",
29977     "url": "/api/variables",
29978     "title": "Creates a new Variable",
29979     "examples": [
29980       {
29981         "title": "Example usage:",
29982         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29983         "type": "json"
29984       }
29985     ],
29986     "name": "CreateVariables",
29987     "group": "Variables",
29988     "parameter": {
29989       "fields": {
29990         "Body": [
29991           {
29992             "group": "Body",
29993             "type": "String",
29994             "optional": false,
29995             "field": "name",
29996             "description": ""
29997           },
29998           {
29999             "group": "Body",
30000             "type": "String",
30001             "optional": true,
30002             "field": "description",
30003             "description": ""
30004           }
30005         ]
30006       }
30007     },
30008     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30009     "version": "0.0.0",
30010     "filename": "server/api/variable/index.js",
30011     "groupTitle": "Variables"
30012   },
30013   {
30014     "type": "delete",
30015     "url": "/api/variables/{id}",
30016     "title": "Deletes a Variable",
30017     "examples": [
30018       {
30019         "title": "Example usage:",
30020         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30021         "type": "json"
30022       }
30023     ],
30024     "name": "DeleteVariables",
30025     "group": "Variables",
30026     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30027     "version": "0.0.0",
30028     "filename": "server/api/variable/index.js",
30029     "groupTitle": "Variables"
30030   },
30031   {
30032     "type": "get",
30033     "url": "/api/variables",
30034     "title": "Gets a list of Variables",
30035     "examples": [
30036       {
30037         "title": "Example usage:",
30038         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30039         "type": "json"
30040       }
30041     ],
30042     "name": "GetVariables",
30043     "group": "Variables",
30044     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30045     "version": "0.0.0",
30046     "filename": "server/api/variable/index.js",
30047     "groupTitle": "Variables"
30048   },
30049   {
30050     "type": "get",
30051     "url": "/api/variables/{id}",
30052     "title": "Gets a single Variable",
30053     "examples": [
30054       {
30055         "title": "Example usage:",
30056         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30057         "type": "json"
30058       }
30059     ],
30060     "name": "ShowVariables",
30061     "group": "Variables",
30062     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30063     "version": "0.0.0",
30064     "filename": "server/api/variable/index.js",
30065     "groupTitle": "Variables"
30066   },
30067   {
30068     "type": "put",
30069     "url": "/api/variables/{id}",
30070     "title": "Update an existing Variable",
30071     "examples": [
30072       {
30073         "title": "Example usage:",
30074         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30075         "type": "json"
30076       }
30077     ],
30078     "name": "updateVariables",
30079     "group": "Variables",
30080     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30081     "version": "0.0.0",
30082     "filename": "server/api/variable/index.js",
30083     "groupTitle": "Variables"
30084   },
30085   {
30086     "type": "get",
30087     "url": "/api/version/fetch",
30088     "title": "Fetch git version",
30089     "examples": [
30090       {
30091         "title": "Example usage:",
30092         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30093         "type": "json"
30094       }
30095     ],
30096     "name": "FetchVersion",
30097     "group": "Version",
30098     "description": "<p>Motion run the following command: git fetch origin master</p>",
30099     "version": "0.0.0",
30100     "filename": "server/api/version/index.js",
30101     "groupTitle": "Version"
30102   },
30103   {
30104     "type": "get",
30105     "url": "/api/version",
30106     "title": "Gets version",
30107     "examples": [
30108       {
30109         "title": "Example usage:",
30110         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30111         "type": "json"
30112       }
30113     ],
30114     "name": "GetVersion",
30115     "group": "Version",
30116     "description": "<p>Motion returns the current and latest motion version.</p>",
30117     "version": "0.0.0",
30118     "filename": "server/api/version/index.js",
30119     "groupTitle": "Version"
30120   },
30121   {
30122     "type": "get",
30123     "url": "/api/version/migrations",
30124     "title": "Launch database migrations",
30125     "examples": [
30126       {
30127         "title": "Example usage:",
30128         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30129         "type": "json"
30130       }
30131     ],
30132     "name": "MigrateVersion",
30133     "group": "Version",
30134     "description": "<p>Motion launch the database migrations, according to the application version</p>",
30135     "version": "0.0.0",
30136     "filename": "server/api/version/index.js",
30137     "groupTitle": "Version"
30138   },
30139   {
30140     "type": "get",
30141     "url": "/api/version/pull",
30142     "title": "Pull git version",
30143     "examples": [
30144       {
30145         "title": "Example usage:",
30146         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30147         "type": "json"
30148       }
30149     ],
30150     "name": "PullVersion",
30151     "group": "Version",
30152     "description": "<p>Motion run the following command: git pull</p>",
30153     "version": "0.0.0",
30154     "filename": "server/api/version/index.js",
30155     "groupTitle": "Version"
30156   },
30157   {
30158     "type": "get",
30159     "url": "/api/version/reset",
30160     "title": "Reset git version",
30161     "examples": [
30162       {
30163         "title": "Example usage:",
30164         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30165         "type": "json"
30166       }
30167     ],
30168     "name": "ResetVersion",
30169     "group": "Version",
30170     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30171     "version": "0.0.0",
30172     "filename": "server/api/version/index.js",
30173     "groupTitle": "Version"
30174   },
30175   {
30176     "type": "get",
30177     "url": "/api/version/restart",
30178     "title": "Restart motion2 after update",
30179     "examples": [
30180       {
30181         "title": "Example usage:",
30182         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30183         "type": "json"
30184       }
30185     ],
30186     "name": "RestartVersion",
30187     "group": "Version",
30188     "description": "<p>Motion run the following command: pm2 restart motion</p>",
30189     "version": "0.0.0",
30190     "filename": "server/api/version/index.js",
30191     "groupTitle": "Version"
30192   },
30193   {
30194     "type": "get",
30195     "url": "/api/voice/agents/reports/describe",
30196     "title": "Gets table info about Agent Reports",
30197     "examples": [
30198       {
30199         "title": "Example usage:",
30200         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30201         "type": "json"
30202       }
30203     ],
30204     "name": "DescribeAgent_Reports",
30205     "group": "Voice_Agent_Reports",
30206     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30207     "version": "0.0.0",
30208     "filename": "server/api/voiceAgentReport/index.js",
30209     "groupTitle": "Voice_Agent_Reports"
30210   },
30211   {
30212     "type": "get",
30213     "url": "/api/voice/agents/reports",
30214     "title": "Gets a list of Agent Reports",
30215     "examples": [
30216       {
30217         "title": "Example usage:",
30218         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30219         "type": "json"
30220       }
30221     ],
30222     "name": "GetAgent_Reports",
30223     "group": "Voice_Agent_Reports",
30224     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30225     "version": "0.0.0",
30226     "filename": "server/api/voiceAgentReport/index.js",
30227     "groupTitle": "Voice_Agent_Reports"
30228   },
30229   {
30230     "type": "get",
30231     "url": "/api/voice/agents/reports/{id}",
30232     "title": "Gets a single Agent Report",
30233     "examples": [
30234       {
30235         "title": "Example usage:",
30236         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30237         "type": "json"
30238       }
30239     ],
30240     "name": "ShowAgent_Reports",
30241     "group": "Voice_Agent_Reports",
30242     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30243     "version": "0.0.0",
30244     "filename": "server/api/voiceAgentReport/index.js",
30245     "groupTitle": "Voice_Agent_Reports"
30246   },
30247   {
30248     "type": "get",
30249     "url": "/api/voice/calls/reports/describe",
30250     "title": "Gets table info about Call Reports",
30251     "examples": [
30252       {
30253         "title": "Example usage:",
30254         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30255         "type": "json"
30256       }
30257     ],
30258     "name": "DescribeCall_Reports",
30259     "group": "Voice_Call_Reports",
30260     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30261     "version": "0.0.0",
30262     "filename": "server/api/voiceCallReport/index.js",
30263     "groupTitle": "Voice_Call_Reports"
30264   },
30265   {
30266     "type": "get",
30267     "url": "/api/voice/calls/reports",
30268     "title": "Gets a list of Call Reports",
30269     "examples": [
30270       {
30271         "title": "Example usage:",
30272         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30273         "type": "json"
30274       }
30275     ],
30276     "name": "GetCall_Reports",
30277     "group": "Voice_Call_Reports",
30278     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30279     "version": "0.0.0",
30280     "filename": "server/api/voiceCallReport/index.js",
30281     "groupTitle": "Voice_Call_Reports"
30282   },
30283   {
30284     "type": "get",
30285     "url": "/api/voice/calls/reports/{id}",
30286     "title": "Gets a single Call Report",
30287     "examples": [
30288       {
30289         "title": "Example usage:",
30290         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30291         "type": "json"
30292       }
30293     ],
30294     "name": "ShowCall_Reports",
30295     "group": "Voice_Call_Reports",
30296     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30297     "version": "0.0.0",
30298     "filename": "server/api/voiceCallReport/index.js",
30299     "groupTitle": "Voice_Call_Reports"
30300   },
30301   {
30302     "type": "put",
30303     "url": "/api/voice/calls/reports/{id}",
30304     "title": "Update a single cdr",
30305     "examples": [
30306       {
30307         "title": "Example usage:",
30308         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30309         "type": "json"
30310       }
30311     ],
30312     "name": "update",
30313     "group": "Voice_Call_Reports",
30314     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30315     "version": "0.0.0",
30316     "filename": "server/api/voiceCallReport/index.js",
30317     "groupTitle": "Voice_Call_Reports"
30318   },
30319   {
30320     "type": "post",
30321     "url": "/api/voice/chanspy",
30322     "title": "Creates a new ChanSpy",
30323     "examples": [
30324       {
30325         "title": "Example usage:",
30326         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30327         "type": "json"
30328       }
30329     ],
30330     "name": "CreateChanSpy",
30331     "group": "Voice_ChanSpy",
30332     "parameter": {
30333       "fields": {
30334         "Body": [
30335           {
30336             "group": "Body",
30337             "type": "String",
30338             "optional": true,
30339             "field": "name",
30340             "description": ""
30341           },
30342           {
30343             "group": "Body",
30344             "type": "String",
30345             "optional": false,
30346             "field": "prefix",
30347             "description": ""
30348           },
30349           {
30350             "group": "Body",
30351             "type": "String",
30352             "optional": true,
30353             "field": "options",
30354             "description": ""
30355           },
30356           {
30357             "group": "Body",
30358             "type": "Boolean",
30359             "optional": true,
30360             "field": "auth",
30361             "description": ""
30362           },
30363           {
30364             "group": "Body",
30365             "type": "String",
30366             "optional": true,
30367             "field": "password",
30368             "description": ""
30369           },
30370           {
30371             "group": "Body",
30372             "type": "Boolean",
30373             "optional": true,
30374             "field": "record",
30375             "description": ""
30376           },
30377           {
30378             "group": "Body",
30379             "type": "String",
30380             "optional": true,
30381             "field": "recordingFormat",
30382             "description": ""
30383           },
30384           {
30385             "group": "Body",
30386             "type": "String",
30387             "optional": true,
30388             "field": "description",
30389             "description": ""
30390           }
30391         ]
30392       }
30393     },
30394     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30395     "version": "0.0.0",
30396     "filename": "server/api/voiceChanSpy/index.js",
30397     "groupTitle": "Voice_ChanSpy"
30398   },
30399   {
30400     "type": "delete",
30401     "url": "/api/voice/chanspy/{id}",
30402     "title": "Deletes a ChanSpy",
30403     "examples": [
30404       {
30405         "title": "Example usage:",
30406         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30407         "type": "json"
30408       }
30409     ],
30410     "name": "DeleteChanSpy",
30411     "group": "Voice_ChanSpy",
30412     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30413     "version": "0.0.0",
30414     "filename": "server/api/voiceChanSpy/index.js",
30415     "groupTitle": "Voice_ChanSpy"
30416   },
30417   {
30418     "type": "get",
30419     "url": "/api/voice/chanspy",
30420     "title": "Gets a list of ChanSpy",
30421     "examples": [
30422       {
30423         "title": "Example usage:",
30424         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30425         "type": "json"
30426       }
30427     ],
30428     "name": "GetChanSpy",
30429     "group": "Voice_ChanSpy",
30430     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30431     "version": "0.0.0",
30432     "filename": "server/api/voiceChanSpy/index.js",
30433     "groupTitle": "Voice_ChanSpy"
30434   },
30435   {
30436     "type": "get",
30437     "url": "/api/voice/chanspy/{id}",
30438     "title": "Gets a single ChanSpy",
30439     "examples": [
30440       {
30441         "title": "Example usage:",
30442         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30443         "type": "json"
30444       }
30445     ],
30446     "name": "ShowChanSpy",
30447     "group": "Voice_ChanSpy",
30448     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30449     "version": "0.0.0",
30450     "filename": "server/api/voiceChanSpy/index.js",
30451     "groupTitle": "Voice_ChanSpy"
30452   },
30453   {
30454     "type": "put",
30455     "url": "/api/voice/chanspy/{id}",
30456     "title": "Update an existing ChanSpy",
30457     "examples": [
30458       {
30459         "title": "Example usage:",
30460         "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",
30461         "type": "json"
30462       }
30463     ],
30464     "name": "updateChanSpy",
30465     "group": "Voice_ChanSpy",
30466     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30467     "version": "0.0.0",
30468     "filename": "server/api/voiceChanSpy/index.js",
30469     "groupTitle": "Voice_ChanSpy"
30470   },
30471   {
30472     "type": "post",
30473     "url": "/api/voice/contexts",
30474     "title": "Create a new context",
30475     "examples": [
30476       {
30477         "title": "Example usage:",
30478         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30479         "type": "json"
30480       }
30481     ],
30482     "name": "Create",
30483     "group": "Voice_Contexts",
30484     "parameter": {
30485       "fields": {
30486         "Body": [
30487           {
30488             "group": "Body",
30489             "type": "String",
30490             "optional": true,
30491             "field": "name",
30492             "description": ""
30493           },
30494           {
30495             "group": "Body",
30496             "type": "String",
30497             "optional": true,
30498             "field": "description",
30499             "description": ""
30500           },
30501           {
30502             "group": "Body",
30503             "type": "Boolean",
30504             "optional": true,
30505             "field": "defaultEntry",
30506             "description": ""
30507           }
30508         ]
30509       }
30510     },
30511     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30512     "version": "0.0.0",
30513     "filename": "server/api/voiceContext/index.js",
30514     "groupTitle": "Voice_Contexts"
30515   },
30516   {
30517     "type": "delete",
30518     "url": "/api/voice/contexts/{id}",
30519     "title": "Deletes a context",
30520     "examples": [
30521       {
30522         "title": "Example usage:",
30523         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30524         "type": "json"
30525       }
30526     ],
30527     "name": "Delete",
30528     "group": "Voice_Contexts",
30529     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30530     "version": "0.0.0",
30531     "filename": "server/api/voiceContext/index.js",
30532     "groupTitle": "Voice_Contexts"
30533   },
30534   {
30535     "type": "get",
30536     "url": "/api/voice/contexts",
30537     "title": "Gets a list of Contexts",
30538     "examples": [
30539       {
30540         "title": "Example usage:",
30541         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30542         "type": "json"
30543       }
30544     ],
30545     "name": "GetContexts",
30546     "group": "Voice_Contexts",
30547     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30548     "version": "0.0.0",
30549     "filename": "server/api/voiceContext/index.js",
30550     "groupTitle": "Voice_Contexts"
30551   },
30552   {
30553     "type": "get",
30554     "url": "/api/voice/contexts/{id}",
30555     "title": "Gets a single Context",
30556     "examples": [
30557       {
30558         "title": "Example usage:",
30559         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30560         "type": "json"
30561       }
30562     ],
30563     "name": "ShowContexts",
30564     "group": "Voice_Contexts",
30565     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30566     "version": "0.0.0",
30567     "filename": "server/api/voiceContext/index.js",
30568     "groupTitle": "Voice_Contexts"
30569   },
30570   {
30571     "type": "put",
30572     "url": "/api/voice/contexts/{id}",
30573     "title": "Update an existing context",
30574     "examples": [
30575       {
30576         "title": "Example usage:",
30577         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30578         "type": "json"
30579       }
30580     ],
30581     "name": "Update",
30582     "group": "Voice_Contexts",
30583     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30584     "version": "0.0.0",
30585     "filename": "server/api/voiceContext/index.js",
30586     "groupTitle": "Voice_Contexts"
30587   },
30588   {
30589     "type": "get",
30590     "url": "/api/voice/dials/reports/describe",
30591     "title": "Gets table info about Dial Reports",
30592     "examples": [
30593       {
30594         "title": "Example usage:",
30595         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30596         "type": "json"
30597       }
30598     ],
30599     "name": "DescribeDial_Reports",
30600     "group": "Voice_Dial_Reports",
30601     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30602     "version": "0.0.0",
30603     "filename": "server/api/voiceDialReport/index.js",
30604     "groupTitle": "Voice_Dial_Reports"
30605   },
30606   {
30607     "type": "get",
30608     "url": "/api/voice/dials/reports",
30609     "title": "Gets a list of Dial Reports",
30610     "examples": [
30611       {
30612         "title": "Example usage:",
30613         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30614         "type": "json"
30615       }
30616     ],
30617     "name": "GetDial_Reports",
30618     "group": "Voice_Dial_Reports",
30619     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30620     "version": "0.0.0",
30621     "filename": "server/api/voiceDialReport/index.js",
30622     "groupTitle": "Voice_Dial_Reports"
30623   },
30624   {
30625     "type": "get",
30626     "url": "/api/voice/dials/reports/{id}",
30627     "title": "Gets a single Dial Report",
30628     "examples": [
30629       {
30630         "title": "Example usage:",
30631         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30632         "type": "json"
30633       }
30634     ],
30635     "name": "ShowDial_Reports",
30636     "group": "Voice_Dial_Reports",
30637     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30638     "version": "0.0.0",
30639     "filename": "server/api/voiceDialReport/index.js",
30640     "groupTitle": "Voice_Dial_Reports"
30641   },
30642   {
30643     "type": "delete",
30644     "url": "/api/voice/extensions/{id}",
30645     "title": "Deletes a Extension",
30646     "examples": [
30647       {
30648         "title": "Example usage:",
30649         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30650         "type": "json"
30651       }
30652     ],
30653     "name": "DeleteExtensions",
30654     "group": "Voice_Extensions",
30655     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30656     "version": "0.0.0",
30657     "filename": "server/api/voiceExtension/index.js",
30658     "groupTitle": "Voice_Extensions"
30659   },
30660   {
30661     "type": "get",
30662     "url": "/api/voice/extensions",
30663     "title": "Gets a list of Extensions",
30664     "examples": [
30665       {
30666         "title": "Example usage:",
30667         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30668         "type": "json"
30669       }
30670     ],
30671     "name": "GetExtensions",
30672     "group": "Voice_Extensions",
30673     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30674     "version": "0.0.0",
30675     "filename": "server/api/voiceExtension/index.js",
30676     "groupTitle": "Voice_Extensions"
30677   },
30678   {
30679     "type": "get",
30680     "url": "/api/voice/extensions/{id}",
30681     "title": "Gets a single Extension",
30682     "examples": [
30683       {
30684         "title": "Example usage:",
30685         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30686         "type": "json"
30687       }
30688     ],
30689     "name": "ShowExtensions",
30690     "group": "Voice_Extensions",
30691     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30692     "version": "0.0.0",
30693     "filename": "server/api/voiceExtension/index.js",
30694     "groupTitle": "Voice_Extensions"
30695   },
30696   {
30697     "type": "post",
30698     "url": "/api/voice/extensions",
30699     "title": "Create new applications",
30700     "examples": [
30701       {
30702         "title": "Example usage:",
30703         "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",
30704         "type": "json"
30705       }
30706     ],
30707     "name": "addApplications",
30708     "group": "Voice_Extensions",
30709     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30710     "version": "0.0.0",
30711     "filename": "server/api/voiceExtension/index.js",
30712     "groupTitle": "Voice_Extensions"
30713   },
30714   {
30715     "type": "post",
30716     "url": "/api/voice/extensions",
30717     "title": "Create an extension",
30718     "examples": [
30719       {
30720         "title": "Example usage:",
30721         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30722         "type": "json"
30723       }
30724     ],
30725     "name": "create",
30726     "group": "Voice_Extensions",
30727     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30728     "version": "0.0.0",
30729     "filename": "server/api/voiceExtension/index.js",
30730     "groupTitle": "Voice_Extensions"
30731   },
30732   {
30733     "type": "put",
30734     "url": "/api/voice/extensions/{id}",
30735     "title": "Update an extension",
30736     "examples": [
30737       {
30738         "title": "Example usage:",
30739         "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",
30740         "type": "json"
30741       }
30742     ],
30743     "name": "update",
30744     "group": "Voice_Extensions",
30745     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30746     "version": "0.0.0",
30747     "filename": "server/api/voiceExtension/index.js",
30748     "groupTitle": "Voice_Extensions"
30749   },
30750   {
30751     "type": "post",
30752     "url": "/api/voice/mohs",
30753     "title": "Create a new a new MOH",
30754     "examples": [
30755       {
30756         "title": "Example usage:",
30757         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30758         "type": "json"
30759       }
30760     ],
30761     "name": "AddMoh",
30762     "group": "Voice_MOHs",
30763     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30764     "version": "0.0.0",
30765     "filename": "server/api/voiceMusicOnHold/index.js",
30766     "groupTitle": "Voice_MOHs"
30767   },
30768   {
30769     "type": "post",
30770     "url": "/api/voice/mohs/{id}/sounds",
30771     "title": "Add sound to MOH",
30772     "examples": [
30773       {
30774         "title": "Example usage:",
30775         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30776         "type": "json"
30777       }
30778     ],
30779     "name": "AddSound",
30780     "group": "Voice_MOHs",
30781     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30782     "version": "0.0.0",
30783     "filename": "server/api/voiceMusicOnHold/index.js",
30784     "groupTitle": "Voice_MOHs"
30785   },
30786   {
30787     "type": "delete",
30788     "url": "/api/voice/mohs/{id}",
30789     "title": "Deletes an MOH",
30790     "examples": [
30791       {
30792         "title": "Example usage:",
30793         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30794         "type": "json"
30795       }
30796     ],
30797     "name": "DestroyMoh",
30798     "group": "Voice_MOHs",
30799     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30800     "version": "0.0.0",
30801     "filename": "server/api/voiceMusicOnHold/index.js",
30802     "groupTitle": "Voice_MOHs"
30803   },
30804   {
30805     "type": "get",
30806     "url": "/api/voice/mohs",
30807     "title": "Gets a list of Music On Holds",
30808     "examples": [
30809       {
30810         "title": "Example usage:",
30811         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30812         "type": "json"
30813       }
30814     ],
30815     "name": "GetMusic_On_Holds",
30816     "group": "Voice_MOHs",
30817     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30818     "version": "0.0.0",
30819     "filename": "server/api/voiceMusicOnHold/index.js",
30820     "groupTitle": "Voice_MOHs"
30821   },
30822   {
30823     "type": "get",
30824     "url": "/api/voice/mohs/{id}/sounds",
30825     "title": "Gets sounds from MOH",
30826     "examples": [
30827       {
30828         "title": "Example usage:",
30829         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30830         "type": "json"
30831       }
30832     ],
30833     "name": "GetSounds",
30834     "group": "Voice_MOHs",
30835     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30836     "version": "0.0.0",
30837     "filename": "server/api/voiceMusicOnHold/index.js",
30838     "groupTitle": "Voice_MOHs"
30839   },
30840   {
30841     "type": "delete",
30842     "url": "/api/voice/mohs/{id}/sounds/{id2}",
30843     "title": "Remove sound from MOH",
30844     "examples": [
30845       {
30846         "title": "Example usage:",
30847         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30848         "type": "json"
30849       }
30850     ],
30851     "name": "RemoveSound",
30852     "group": "Voice_MOHs",
30853     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30854     "version": "0.0.0",
30855     "filename": "server/api/voiceMusicOnHold/index.js",
30856     "groupTitle": "Voice_MOHs"
30857   },
30858   {
30859     "type": "get",
30860     "url": "/api/voice/mohs/{id}",
30861     "title": "Gets a single Music On Hold",
30862     "examples": [
30863       {
30864         "title": "Example usage:",
30865         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30866         "type": "json"
30867       }
30868     ],
30869     "name": "ShowMusic_On_Holds",
30870     "group": "Voice_MOHs",
30871     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30872     "version": "0.0.0",
30873     "filename": "server/api/voiceMusicOnHold/index.js",
30874     "groupTitle": "Voice_MOHs"
30875   },
30876   {
30877     "type": "put",
30878     "url": "/api/voice/mohs/{id}",
30879     "title": "Update an existing Music On Hold",
30880     "examples": [
30881       {
30882         "title": "Example usage:",
30883         "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",
30884         "type": "json"
30885       }
30886     ],
30887     "name": "updateMusic_On_Holds",
30888     "group": "Voice_MOHs",
30889     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30890     "version": "0.0.0",
30891     "filename": "server/api/voiceMusicOnHold/index.js",
30892     "groupTitle": "Voice_MOHs"
30893   },
30894   {
30895     "type": "post",
30896     "url": "/api/voice/mails",
30897     "title": "Creates a new Mail",
30898     "examples": [
30899       {
30900         "title": "Example usage:",
30901         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30902         "type": "json"
30903       }
30904     ],
30905     "name": "CreateMails",
30906     "group": "Voice_Mails",
30907     "parameter": {
30908       "fields": {
30909         "Body": [
30910           {
30911             "group": "Body",
30912             "type": "String",
30913             "optional": true,
30914             "field": "customer_id",
30915             "description": ""
30916           },
30917           {
30918             "group": "Body",
30919             "type": "String",
30920             "optional": true,
30921             "field": "context",
30922             "description": ""
30923           },
30924           {
30925             "group": "Body",
30926             "type": "String",
30927             "optional": false,
30928             "field": "mailbox",
30929             "description": ""
30930           },
30931           {
30932             "group": "Body",
30933             "type": "String",
30934             "optional": true,
30935             "field": "password",
30936             "description": ""
30937           },
30938           {
30939             "group": "Body",
30940             "type": "String",
30941             "optional": true,
30942             "field": "fullname",
30943             "description": ""
30944           },
30945           {
30946             "group": "Body",
30947             "type": "String",
30948             "optional": true,
30949             "field": "email",
30950             "description": ""
30951           },
30952           {
30953             "group": "Body",
30954             "type": "String",
30955             "optional": true,
30956             "field": "pager",
30957             "description": ""
30958           },
30959           {
30960             "group": "Body",
30961             "type": "String",
30962             "optional": true,
30963             "field": "tz",
30964             "description": ""
30965           },
30966           {
30967             "group": "Body",
30968             "type": "String",
30969             "allowedValues": [
30970               "\"yes\"",
30971               "\"no\""
30972             ],
30973             "optional": false,
30974             "field": "attach",
30975             "description": ""
30976           },
30977           {
30978             "group": "Body",
30979             "type": "String",
30980             "allowedValues": [
30981               "\"yes\"",
30982               "\"no\""
30983             ],
30984             "optional": false,
30985             "field": "saycid",
30986             "description": ""
30987           },
30988           {
30989             "group": "Body",
30990             "type": "String",
30991             "optional": true,
30992             "field": "dialout",
30993             "description": ""
30994           },
30995           {
30996             "group": "Body",
30997             "type": "String",
30998             "optional": true,
30999             "field": "callback",
31000             "description": ""
31001           },
31002           {
31003             "group": "Body",
31004             "type": "String",
31005             "allowedValues": [
31006               "\"yes\"",
31007               "\"no\""
31008             ],
31009             "optional": false,
31010             "field": "review",
31011             "description": ""
31012           },
31013           {
31014             "group": "Body",
31015             "type": "String",
31016             "allowedValues": [
31017               "\"yes\"",
31018               "\"no\""
31019             ],
31020             "optional": false,
31021             "field": "operator",
31022             "description": ""
31023           },
31024           {
31025             "group": "Body",
31026             "type": "String",
31027             "allowedValues": [
31028               "\"yes\"",
31029               "\"no\""
31030             ],
31031             "optional": false,
31032             "field": "envelope",
31033             "description": ""
31034           },
31035           {
31036             "group": "Body",
31037             "type": "String",
31038             "allowedValues": [
31039               "\"yes\"",
31040               "\"no\""
31041             ],
31042             "optional": false,
31043             "field": "sayduration",
31044             "description": ""
31045           },
31046           {
31047             "group": "Body",
31048             "type": "String",
31049             "optional": false,
31050             "field": "saydurationm",
31051             "description": ""
31052           },
31053           {
31054             "group": "Body",
31055             "type": "String",
31056             "allowedValues": [
31057               "\"yes\"",
31058               "\"no\""
31059             ],
31060             "optional": false,
31061             "field": "sendvoicemail",
31062             "description": ""
31063           },
31064           {
31065             "group": "Body",
31066             "type": "String",
31067             "allowedValues": [
31068               "\"yes\"",
31069               "\"no\""
31070             ],
31071             "optional": false,
31072             "field": "delete",
31073             "description": ""
31074           },
31075           {
31076             "group": "Body",
31077             "type": "String",
31078             "allowedValues": [
31079               "\"yes\"",
31080               "\"no\""
31081             ],
31082             "optional": false,
31083             "field": "nextaftercmd",
31084             "description": ""
31085           },
31086           {
31087             "group": "Body",
31088             "type": "String",
31089             "allowedValues": [
31090               "\"yes\"",
31091               "\"no\""
31092             ],
31093             "optional": false,
31094             "field": "forcename",
31095             "description": ""
31096           },
31097           {
31098             "group": "Body",
31099             "type": "String",
31100             "allowedValues": [
31101               "\"yes\"",
31102               "\"no\""
31103             ],
31104             "optional": false,
31105             "field": "forcegreetings",
31106             "description": ""
31107           },
31108           {
31109             "group": "Body",
31110             "type": "String",
31111             "allowedValues": [
31112               "\"yes\"",
31113               "\"no\""
31114             ],
31115             "optional": false,
31116             "field": "hidefromdir",
31117             "description": ""
31118           },
31119           {
31120             "group": "Body",
31121             "type": "String",
31122             "optional": true,
31123             "field": "stamp",
31124             "description": ""
31125           },
31126           {
31127             "group": "Body",
31128             "type": "String",
31129             "optional": true,
31130             "field": "emailsubject",
31131             "description": ""
31132           },
31133           {
31134             "group": "Body",
31135             "type": "String",
31136             "optional": true,
31137             "field": "emailbody",
31138             "description": ""
31139           },
31140           {
31141             "group": "Body",
31142             "type": "Integer",
31143             "optional": false,
31144             "field": "maxsecs",
31145             "description": ""
31146           },
31147           {
31148             "group": "Body",
31149             "type": "Integer",
31150             "optional": false,
31151             "field": "maxmsg",
31152             "description": ""
31153           },
31154           {
31155             "group": "Body",
31156             "type": "Virtual",
31157             "optional": true,
31158             "field": "name",
31159             "description": ""
31160           }
31161         ]
31162       }
31163     },
31164     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31165     "version": "0.0.0",
31166     "filename": "server/api/voiceMail/index.js",
31167     "groupTitle": "Voice_Mails"
31168   },
31169   {
31170     "type": "delete",
31171     "url": "/api/voice/mails/{id}",
31172     "title": "Deletes a Mail",
31173     "examples": [
31174       {
31175         "title": "Example usage:",
31176         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31177         "type": "json"
31178       }
31179     ],
31180     "name": "DeleteMails",
31181     "group": "Voice_Mails",
31182     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31183     "version": "0.0.0",
31184     "filename": "server/api/voiceMail/index.js",
31185     "groupTitle": "Voice_Mails"
31186   },
31187   {
31188     "type": "get",
31189     "url": "/api/voice/mails",
31190     "title": "Gets a list of Mails",
31191     "examples": [
31192       {
31193         "title": "Example usage:",
31194         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31195         "type": "json"
31196       }
31197     ],
31198     "name": "GetMails",
31199     "group": "Voice_Mails",
31200     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31201     "version": "0.0.0",
31202     "filename": "server/api/voiceMail/index.js",
31203     "groupTitle": "Voice_Mails"
31204   },
31205   {
31206     "type": "get",
31207     "url": "/api/voice/mails/{id}",
31208     "title": "Gets a single Mail",
31209     "examples": [
31210       {
31211         "title": "Example usage:",
31212         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31213         "type": "json"
31214       }
31215     ],
31216     "name": "ShowMails",
31217     "group": "Voice_Mails",
31218     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31219     "version": "0.0.0",
31220     "filename": "server/api/voiceMail/index.js",
31221     "groupTitle": "Voice_Mails"
31222   },
31223   {
31224     "type": "get",
31225     "url": "/api/voice/mails/{id}/messages",
31226     "title": "Gets voice mail messages",
31227     "examples": [
31228       {
31229         "title": "Example usage:",
31230         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31231         "type": "json"
31232       }
31233     ],
31234     "name": "getMessages",
31235     "group": "Voice_Mails",
31236     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31237     "version": "0.0.0",
31238     "filename": "server/api/voiceMail/index.js",
31239     "groupTitle": "Voice_Mails"
31240   },
31241   {
31242     "type": "put",
31243     "url": "/api/voice/mails/{id}",
31244     "title": "Update an existing Mail",
31245     "examples": [
31246       {
31247         "title": "Example usage:",
31248         "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",
31249         "type": "json"
31250       }
31251     ],
31252     "name": "updateMails",
31253     "group": "Voice_Mails",
31254     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31255     "version": "0.0.0",
31256     "filename": "server/api/voiceMail/index.js",
31257     "groupTitle": "Voice_Mails"
31258   },
31259   {
31260     "type": "post",
31261     "url": "/api/voice/mails/messages",
31262     "title": "Creates a new Message",
31263     "examples": [
31264       {
31265         "title": "Example usage:",
31266         "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",
31267         "type": "json"
31268       }
31269     ],
31270     "name": "CreateMessages",
31271     "group": "Voice_Messages",
31272     "parameter": {
31273       "fields": {
31274         "Body": [
31275           {
31276             "group": "Body",
31277             "type": "Virtual",
31278             "optional": true,
31279             "field": "name",
31280             "description": ""
31281           },
31282           {
31283             "group": "Body",
31284             "type": "Integer",
31285             "optional": false,
31286             "field": "msgnum",
31287             "description": ""
31288           },
31289           {
31290             "group": "Body",
31291             "type": "String",
31292             "optional": true,
31293             "field": "dir",
31294             "description": ""
31295           },
31296           {
31297             "group": "Body",
31298             "type": "String",
31299             "optional": true,
31300             "field": "context",
31301             "description": ""
31302           },
31303           {
31304             "group": "Body",
31305             "type": "String",
31306             "optional": true,
31307             "field": "macrocontext",
31308             "description": ""
31309           },
31310           {
31311             "group": "Body",
31312             "type": "String",
31313             "optional": true,
31314             "field": "callerid",
31315             "description": ""
31316           },
31317           {
31318             "group": "Body",
31319             "type": "String",
31320             "optional": true,
31321             "field": "origtime",
31322             "description": ""
31323           },
31324           {
31325             "group": "Body",
31326             "type": "String",
31327             "optional": true,
31328             "field": "duration",
31329             "description": ""
31330           },
31331           {
31332             "group": "Body",
31333             "type": "String",
31334             "optional": true,
31335             "field": "mailboxuser",
31336             "description": ""
31337           },
31338           {
31339             "group": "Body",
31340             "type": "String",
31341             "optional": true,
31342             "field": "mailboxcontext",
31343             "description": ""
31344           },
31345           {
31346             "group": "Body",
31347             "type": "Blob",
31348             "optional": true,
31349             "field": "recording",
31350             "description": ""
31351           },
31352           {
31353             "group": "Body",
31354             "type": "String",
31355             "optional": true,
31356             "field": "flag",
31357             "description": ""
31358           },
31359           {
31360             "group": "Body",
31361             "type": "String",
31362             "optional": true,
31363             "field": "msg_id",
31364             "description": ""
31365           },
31366           {
31367             "group": "Body",
31368             "type": "String",
31369             "optional": true,
31370             "field": "stamp",
31371             "description": ""
31372           }
31373         ]
31374       }
31375     },
31376     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31377     "version": "0.0.0",
31378     "filename": "server/api/voiceMailMessage/index.js",
31379     "groupTitle": "Voice_Messages"
31380   },
31381   {
31382     "type": "delete",
31383     "url": "/api/voice/mails/messages/{id}",
31384     "title": "Deletes a Message",
31385     "examples": [
31386       {
31387         "title": "Example usage:",
31388         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31389         "type": "json"
31390       }
31391     ],
31392     "name": "DeleteMessages",
31393     "group": "Voice_Messages",
31394     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31395     "version": "0.0.0",
31396     "filename": "server/api/voiceMailMessage/index.js",
31397     "groupTitle": "Voice_Messages"
31398   },
31399   {
31400     "type": "get",
31401     "url": "/api/voice/mails/messages",
31402     "title": "Gets a list of Messages",
31403     "examples": [
31404       {
31405         "title": "Example usage:",
31406         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31407         "type": "json"
31408       }
31409     ],
31410     "name": "GetMessages",
31411     "group": "Voice_Messages",
31412     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31413     "version": "0.0.0",
31414     "filename": "server/api/voiceMailMessage/index.js",
31415     "groupTitle": "Voice_Messages"
31416   },
31417   {
31418     "type": "get",
31419     "url": "/api/voice/mails/messages/{id}",
31420     "title": "Gets a single Message",
31421     "examples": [
31422       {
31423         "title": "Example usage:",
31424         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31425         "type": "json"
31426       }
31427     ],
31428     "name": "ShowMessages",
31429     "group": "Voice_Messages",
31430     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31431     "version": "0.0.0",
31432     "filename": "server/api/voiceMailMessage/index.js",
31433     "groupTitle": "Voice_Messages"
31434   },
31435   {
31436     "type": "get",
31437     "url": "voice/mails/messages/{id}/download",
31438     "title": "Download Voice Message",
31439     "examples": [
31440       {
31441         "title": "Example usage:",
31442         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31443         "type": "json"
31444       }
31445     ],
31446     "name": "download",
31447     "group": "Voice_Messages",
31448     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31449     "version": "0.0.0",
31450     "filename": "server/api/voiceMailMessage/index.js",
31451     "groupTitle": "Voice_Messages"
31452   },
31453   {
31454     "type": "put",
31455     "url": "/api/voice/mails/messages/{id}",
31456     "title": "Update an existing Message",
31457     "examples": [
31458       {
31459         "title": "Example usage:",
31460         "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",
31461         "type": "json"
31462       }
31463     ],
31464     "name": "updateMessages",
31465     "group": "Voice_Messages",
31466     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31467     "version": "0.0.0",
31468     "filename": "server/api/voiceMailMessage/index.js",
31469     "groupTitle": "Voice_Messages"
31470   },
31471   {
31472     "type": "post",
31473     "url": "/api/voice/prefixes/{id}/teams",
31474     "title": "Add teams to voice prefix",
31475     "examples": [
31476       {
31477         "title": "Example usage:",
31478         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31479         "type": "json"
31480       }
31481     ],
31482     "name": "AddTeams",
31483     "group": "Voice_Prefix",
31484     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31485     "version": "0.0.0",
31486     "filename": "server/api/voicePrefix/index.js",
31487     "groupTitle": "Voice_Prefix"
31488   },
31489   {
31490     "type": "get",
31491     "url": "/api/voice/prefixes/{id}/teams",
31492     "title": "Gets voice prefix team",
31493     "examples": [
31494       {
31495         "title": "Example usage:",
31496         "content": "curl https://{domain}/api/voice/prefixes/{id}/teams -v -u {name}:{password}  -X GET",
31497         "type": "json"
31498       }
31499     ],
31500     "name": "GetTeams",
31501     "group": "Voice_Prefix",
31502     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31503     "version": "0.0.0",
31504     "filename": "server/api/voicePrefix/index.js",
31505     "groupTitle": "Voice_Prefix"
31506   },
31507   {
31508     "type": "post",
31509     "url": "/api/voice/prefixes/{id}/users",
31510     "title": "Add agents to a prefix",
31511     "examples": [
31512       {
31513         "title": "Example usage:",
31514         "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",
31515         "type": "json"
31516       }
31517     ],
31518     "name": "AddAgents",
31519     "group": "Voice_Prefixes",
31520     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31521     "version": "0.0.0",
31522     "filename": "server/api/voicePrefix/index.js",
31523     "groupTitle": "Voice_Prefixes"
31524   },
31525   {
31526     "type": "delete",
31527     "url": "/api/voice/prefixes/{id}",
31528     "title": "Deletes a Prefix",
31529     "examples": [
31530       {
31531         "title": "Example usage:",
31532         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31533         "type": "json"
31534       }
31535     ],
31536     "name": "DeletePrefixes",
31537     "group": "Voice_Prefixes",
31538     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31539     "version": "0.0.0",
31540     "filename": "server/api/voicePrefix/index.js",
31541     "groupTitle": "Voice_Prefixes"
31542   },
31543   {
31544     "type": "get",
31545     "url": "/api/voice/prefixes/describe",
31546     "title": "Gets table info about Prefixes",
31547     "examples": [
31548       {
31549         "title": "Example usage:",
31550         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31551         "type": "json"
31552       }
31553     ],
31554     "name": "DescribePrefixes",
31555     "group": "Voice_Prefixes",
31556     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31557     "version": "0.0.0",
31558     "filename": "server/api/voicePrefix/index.js",
31559     "groupTitle": "Voice_Prefixes"
31560   },
31561   {
31562     "type": "get",
31563     "url": "/api/voice/prefixes/{id}/users",
31564     "title": "Gets agents from prefix",
31565     "examples": [
31566       {
31567         "title": "Example usage:",
31568         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31569         "type": "json"
31570       }
31571     ],
31572     "name": "GetAgents",
31573     "group": "Voice_Prefixes",
31574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31575     "version": "0.0.0",
31576     "filename": "server/api/voicePrefix/index.js",
31577     "groupTitle": "Voice_Prefixes"
31578   },
31579   {
31580     "type": "get",
31581     "url": "/api/voice/prefixes",
31582     "title": "Gets a list of Prefixes",
31583     "examples": [
31584       {
31585         "title": "Example usage:",
31586         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31587         "type": "json"
31588       }
31589     ],
31590     "name": "GetPrefixes",
31591     "group": "Voice_Prefixes",
31592     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31593     "version": "0.0.0",
31594     "filename": "server/api/voicePrefix/index.js",
31595     "groupTitle": "Voice_Prefixes"
31596   },
31597   {
31598     "type": "delete",
31599     "url": "/api/voice/prefixes/{id}/users",
31600     "title": "Removes agents from a prefix",
31601     "examples": [
31602       {
31603         "title": "Example usage:",
31604         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31605         "type": "json"
31606       }
31607     ],
31608     "name": "RemoveAgents",
31609     "group": "Voice_Prefixes",
31610     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31611     "version": "0.0.0",
31612     "filename": "server/api/voicePrefix/index.js",
31613     "groupTitle": "Voice_Prefixes"
31614   },
31615   {
31616     "type": "get",
31617     "url": "/api/voice/prefixes/{id}",
31618     "title": "Gets a single Prefix",
31619     "examples": [
31620       {
31621         "title": "Example usage:",
31622         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31623         "type": "json"
31624       }
31625     ],
31626     "name": "ShowPrefixes",
31627     "group": "Voice_Prefixes",
31628     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31629     "version": "0.0.0",
31630     "filename": "server/api/voicePrefix/index.js",
31631     "groupTitle": "Voice_Prefixes"
31632   },
31633   {
31634     "type": "put",
31635     "url": "/api/voice/prefixes/{id}",
31636     "title": "Update an existing prefix",
31637     "examples": [
31638       {
31639         "title": "Example usage:",
31640         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31641         "type": "json"
31642       }
31643     ],
31644     "name": "Update",
31645     "group": "Voice_Prefixes",
31646     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31647     "version": "0.0.0",
31648     "filename": "server/api/voicePrefix/index.js",
31649     "groupTitle": "Voice_Prefixes"
31650   },
31651   {
31652     "type": "post",
31653     "url": "/api/voice/prefixes",
31654     "title": "Create a prefix",
31655     "examples": [
31656       {
31657         "title": "Example usage:",
31658         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31659         "type": "json"
31660       }
31661     ],
31662     "name": "create",
31663     "group": "Voice_Prefixes",
31664     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31665     "version": "0.0.0",
31666     "filename": "server/api/voicePrefix/index.js",
31667     "groupTitle": "Voice_Prefixes"
31668   },
31669   {
31670     "type": "get",
31671     "url": "/api/voice/queues/reports/describe",
31672     "title": "Gets table info about Queue Reports",
31673     "examples": [
31674       {
31675         "title": "Example usage:",
31676         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31677         "type": "json"
31678       }
31679     ],
31680     "name": "DescribeQueue_Reports",
31681     "group": "Voice_Queue_Reports",
31682     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31683     "version": "0.0.0",
31684     "filename": "server/api/voiceQueueReport/index.js",
31685     "groupTitle": "Voice_Queue_Reports"
31686   },
31687   {
31688     "type": "get",
31689     "url": "/api/voice/queues/reports",
31690     "title": "Gets a list of Queue Reports",
31691     "examples": [
31692       {
31693         "title": "Example usage:",
31694         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31695         "type": "json"
31696       }
31697     ],
31698     "name": "GetQueue_Reports",
31699     "group": "Voice_Queue_Reports",
31700     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31701     "version": "0.0.0",
31702     "filename": "server/api/voiceQueueReport/index.js",
31703     "groupTitle": "Voice_Queue_Reports"
31704   },
31705   {
31706     "type": "get",
31707     "url": "/api/voice/queues/reports/{id}",
31708     "title": "Gets a single Queue Report",
31709     "examples": [
31710       {
31711         "title": "Example usage:",
31712         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31713         "type": "json"
31714       }
31715     ],
31716     "name": "ShowQueue_Reports",
31717     "group": "Voice_Queue_Reports",
31718     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31719     "version": "0.0.0",
31720     "filename": "server/api/voiceQueueReport/index.js",
31721     "groupTitle": "Voice_Queue_Reports"
31722   },
31723   {
31724     "type": "get",
31725     "url": "/api/voice/queues/reports/index",
31726     "title": "Get Voice Queues Report",
31727     "examples": [
31728       {
31729         "title": "Example usage:",
31730         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31731         "type": "json"
31732       }
31733     ],
31734     "name": "getVoiceQueuesReport",
31735     "group": "Voice_Queue_Reports",
31736     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31737     "version": "0.0.0",
31738     "filename": "server/api/voiceQueueReport/index.js",
31739     "groupTitle": "Voice_Queue_Reports"
31740   },
31741   {
31742     "type": "post",
31743     "url": "/api/voice/queues/{id}/users",
31744     "title": "Add agents to queue",
31745     "examples": [
31746       {
31747         "title": "Example usage:",
31748         "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",
31749         "type": "json"
31750       }
31751     ],
31752     "name": "AddAgents",
31753     "group": "Voice_Queues",
31754     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31755     "version": "0.0.0",
31756     "filename": "server/api/voiceQueue/index.js",
31757     "groupTitle": "Voice_Queues"
31758   },
31759   {
31760     "type": "post",
31761     "url": "/api/voice/queues/{id}/blacklists",
31762     "title": "Add blacklists to a queue",
31763     "examples": [
31764       {
31765         "title": "Example usage:",
31766         "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",
31767         "type": "json"
31768       }
31769     ],
31770     "name": "AddBlackLists",
31771     "group": "Voice_Queues",
31772     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31773     "version": "0.0.0",
31774     "filename": "server/api/voiceQueue/index.js",
31775     "groupTitle": "Voice_Queues"
31776   },
31777   {
31778     "type": "post",
31779     "url": "/api/voice/queues/{id}/lists",
31780     "title": "Add lists to a queue",
31781     "examples": [
31782       {
31783         "title": "Example usage:",
31784         "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",
31785         "type": "json"
31786       }
31787     ],
31788     "name": "AddLists",
31789     "group": "Voice_Queues",
31790     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31791     "version": "0.0.0",
31792     "filename": "server/api/voiceQueue/index.js",
31793     "groupTitle": "Voice_Queues"
31794   },
31795   {
31796     "type": "post",
31797     "url": "/api/voice/queues/{id}/teams",
31798     "title": "Add teams to queue",
31799     "examples": [
31800       {
31801         "title": "Example usage:",
31802         "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",
31803         "type": "json"
31804       }
31805     ],
31806     "name": "AddTeams",
31807     "group": "Voice_Queues",
31808     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31809     "version": "0.0.0",
31810     "filename": "server/api/voiceQueue/index.js",
31811     "groupTitle": "Voice_Queues"
31812   },
31813   {
31814     "type": "post",
31815     "url": "/api/voice/queues/clone",
31816     "title": "Clone an existing Queue",
31817     "examples": [
31818       {
31819         "title": "Example usage:",
31820         "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",
31821         "type": "json"
31822       }
31823     ],
31824     "name": "CloneQueues",
31825     "group": "Voice_Queues",
31826     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31827     "version": "0.0.0",
31828     "filename": "server/api/voiceQueue/index.js",
31829     "groupTitle": "Voice_Queues"
31830   },
31831   {
31832     "type": "post",
31833     "url": "/api/voice/queues",
31834     "title": "Creates a new Queue",
31835     "examples": [
31836       {
31837         "title": "Example usage:",
31838         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31839         "type": "json"
31840       }
31841     ],
31842     "name": "CreateQueues",
31843     "group": "Voice_Queues",
31844     "parameter": {
31845       "fields": {
31846         "Body": [
31847           {
31848             "group": "Body",
31849             "type": "String",
31850             "optional": false,
31851             "field": "name",
31852             "description": ""
31853           },
31854           {
31855             "group": "Body",
31856             "type": "String",
31857             "allowedValues": [
31858               "\"inbound\"",
31859               "\"outbound\""
31860             ],
31861             "optional": false,
31862             "field": "type",
31863             "description": ""
31864           },
31865           {
31866             "group": "Body",
31867             "type": "String",
31868             "optional": true,
31869             "field": "musiconhold",
31870             "description": ""
31871           },
31872           {
31873             "group": "Body",
31874             "type": "String",
31875             "optional": true,
31876             "field": "announce",
31877             "description": ""
31878           },
31879           {
31880             "group": "Body",
31881             "type": "String",
31882             "allowedValues": [
31883               "\"rr\"",
31884               "\"ringall\"",
31885               "\"leastrecent\"",
31886               "\"fewestcalls\"",
31887               "\"random\"",
31888               "\"rrmemory\"",
31889               "\"linear\"",
31890               "\"wrandom\"",
31891               "\"rrordered\""
31892             ],
31893             "optional": false,
31894             "field": "strategy",
31895             "description": ""
31896           },
31897           {
31898             "group": "Body",
31899             "type": "Integer",
31900             "optional": true,
31901             "field": "servicelevel",
31902             "description": ""
31903           },
31904           {
31905             "group": "Body",
31906             "type": "String",
31907             "optional": true,
31908             "field": "context",
31909             "description": ""
31910           },
31911           {
31912             "group": "Body",
31913             "type": "Integer",
31914             "optional": true,
31915             "field": "penaltymemberslimit",
31916             "description": ""
31917           },
31918           {
31919             "group": "Body",
31920             "type": "Integer",
31921             "optional": true,
31922             "field": "timeout",
31923             "description": ""
31924           },
31925           {
31926             "group": "Body",
31927             "type": "Integer",
31928             "optional": true,
31929             "field": "retry",
31930             "description": ""
31931           },
31932           {
31933             "group": "Body",
31934             "type": "String",
31935             "optional": true,
31936             "field": "timeoutpriority",
31937             "description": ""
31938           },
31939           {
31940             "group": "Body",
31941             "type": "Integer",
31942             "optional": true,
31943             "field": "weight",
31944             "description": ""
31945           },
31946           {
31947             "group": "Body",
31948             "type": "Integer",
31949             "optional": true,
31950             "field": "wrapuptime",
31951             "description": ""
31952           },
31953           {
31954             "group": "Body",
31955             "type": "String",
31956             "allowedValues": [
31957               "\"yes\"",
31958               "\"no\""
31959             ],
31960             "optional": true,
31961             "field": "autofill",
31962             "description": ""
31963           },
31964           {
31965             "group": "Body",
31966             "type": "String",
31967             "allowedValues": [
31968               "\"yes\"",
31969               "\"no\"",
31970               "\"all\""
31971             ],
31972             "optional": true,
31973             "field": "autopause",
31974             "description": ""
31975           },
31976           {
31977             "group": "Body",
31978             "type": "Integer",
31979             "optional": true,
31980             "field": "autopausedelay",
31981             "description": ""
31982           },
31983           {
31984             "group": "Body",
31985             "type": "String",
31986             "allowedValues": [
31987               "\"yes\"",
31988               "\"no\""
31989             ],
31990             "optional": true,
31991             "field": "autopausebusy",
31992             "description": ""
31993           },
31994           {
31995             "group": "Body",
31996             "type": "String",
31997             "allowedValues": [
31998               "\"yes\"",
31999               "\"no\""
32000             ],
32001             "optional": true,
32002             "field": "autopauseunavail",
32003             "description": ""
32004           },
32005           {
32006             "group": "Body",
32007             "type": "Integer",
32008             "optional": true,
32009             "field": "maxlen",
32010             "description": ""
32011           },
32012           {
32013             "group": "Body",
32014             "type": "String",
32015             "allowedValues": [
32016               "\"yes\"",
32017               "\"no\""
32018             ],
32019             "optional": true,
32020             "field": "setinterfacevar",
32021             "description": ""
32022           },
32023           {
32024             "group": "Body",
32025             "type": "String",
32026             "allowedValues": [
32027               "\"yes\"",
32028               "\"no\""
32029             ],
32030             "optional": true,
32031             "field": "setqueueentryvar",
32032             "description": ""
32033           },
32034           {
32035             "group": "Body",
32036             "type": "String",
32037             "allowedValues": [
32038               "\"yes\"",
32039               "\"no\""
32040             ],
32041             "optional": true,
32042             "field": "setqueuevar",
32043             "description": ""
32044           },
32045           {
32046             "group": "Body",
32047             "type": "String",
32048             "allowedValues": [
32049               "\"yes\"",
32050               "\"no\""
32051             ],
32052             "optional": true,
32053             "field": "eventmemberstatus",
32054             "description": ""
32055           },
32056           {
32057             "group": "Body",
32058             "type": "String",
32059             "optional": true,
32060             "field": "membermacro",
32061             "description": ""
32062           },
32063           {
32064             "group": "Body",
32065             "type": "String",
32066             "optional": true,
32067             "field": "membergosub",
32068             "description": ""
32069           },
32070           {
32071             "group": "Body",
32072             "type": "Integer",
32073             "optional": true,
32074             "field": "announce_frequency",
32075             "description": ""
32076           },
32077           {
32078             "group": "Body",
32079             "type": "Integer",
32080             "optional": true,
32081             "field": "min_announce_frequency",
32082             "description": ""
32083           },
32084           {
32085             "group": "Body",
32086             "type": "Integer",
32087             "optional": true,
32088             "field": "periodic_announce_frequency",
32089             "description": ""
32090           },
32091           {
32092             "group": "Body",
32093             "type": "String",
32094             "allowedValues": [
32095               "\"yes\"",
32096               "\"no\""
32097             ],
32098             "optional": true,
32099             "field": "random_periodic_announce",
32100             "description": ""
32101           },
32102           {
32103             "group": "Body",
32104             "type": "String",
32105             "allowedValues": [
32106               "\"yes\"",
32107               "\"no\""
32108             ],
32109             "optional": true,
32110             "field": "relative_periodic_announce",
32111             "description": ""
32112           },
32113           {
32114             "group": "Body",
32115             "type": "String",
32116             "allowedValues": [
32117               "\"yes\"",
32118               "\"no\"",
32119               "\"once\""
32120             ],
32121             "optional": true,
32122             "field": "announce_holdtime",
32123             "description": ""
32124           },
32125           {
32126             "group": "Body",
32127             "type": "String",
32128             "optional": true,
32129             "field": "announce_position",
32130             "description": ""
32131           },
32132           {
32133             "group": "Body",
32134             "type": "String",
32135             "allowedValues": [
32136               "\"yes\"",
32137               "\"no\""
32138             ],
32139             "optional": true,
32140             "field": "announce_to_first_user",
32141             "description": ""
32142           },
32143           {
32144             "group": "Body",
32145             "type": "Integer",
32146             "optional": true,
32147             "field": "announce_position_limit",
32148             "description": ""
32149           },
32150           {
32151             "group": "Body",
32152             "type": "String",
32153             "allowedValues": [
32154               "\"0\"",
32155               "\"5\"",
32156               "\"10\"",
32157               "\"15\"",
32158               "\"20\"",
32159               "\"30\""
32160             ],
32161             "optional": true,
32162             "field": "announce_round_seconds",
32163             "description": ""
32164           },
32165           {
32166             "group": "Body",
32167             "type": "String",
32168             "optional": true,
32169             "field": "monitor_format",
32170             "description": ""
32171           },
32172           {
32173             "group": "Body",
32174             "type": "String",
32175             "optional": true,
32176             "field": "monitor_type",
32177             "description": ""
32178           },
32179           {
32180             "group": "Body",
32181             "type": "String",
32182             "optional": true,
32183             "field": "queue_youarenext",
32184             "description": ""
32185           },
32186           {
32187             "group": "Body",
32188             "type": "String",
32189             "optional": true,
32190             "field": "queue_thereare",
32191             "description": ""
32192           },
32193           {
32194             "group": "Body",
32195             "type": "String",
32196             "optional": true,
32197             "field": "queue_callswaiting",
32198             "description": ""
32199           },
32200           {
32201             "group": "Body",
32202             "type": "String",
32203             "optional": true,
32204             "field": "queue_holdtime",
32205             "description": ""
32206           },
32207           {
32208             "group": "Body",
32209             "type": "String",
32210             "optional": true,
32211             "field": "queue_minute",
32212             "description": ""
32213           },
32214           {
32215             "group": "Body",
32216             "type": "String",
32217             "optional": true,
32218             "field": "queue_minutes",
32219             "description": ""
32220           },
32221           {
32222             "group": "Body",
32223             "type": "String",
32224             "optional": true,
32225             "field": "queue_seconds",
32226             "description": ""
32227           },
32228           {
32229             "group": "Body",
32230             "type": "String",
32231             "optional": true,
32232             "field": "queue_thankyou",
32233             "description": ""
32234           },
32235           {
32236             "group": "Body",
32237             "type": "String",
32238             "optional": true,
32239             "field": "queue_reporthold",
32240             "description": ""
32241           },
32242           {
32243             "group": "Body",
32244             "type": "String",
32245             "optional": true,
32246             "field": "queue_quantity1",
32247             "description": ""
32248           },
32249           {
32250             "group": "Body",
32251             "type": "String",
32252             "optional": true,
32253             "field": "queue_quantity2",
32254             "description": ""
32255           },
32256           {
32257             "group": "Body",
32258             "type": "String",
32259             "optional": true,
32260             "field": "queue_periodic_announce",
32261             "description": ""
32262           },
32263           {
32264             "group": "Body",
32265             "type": "String",
32266             "optional": true,
32267             "field": "queue_less_than",
32268             "description": ""
32269           },
32270           {
32271             "group": "Body",
32272             "type": "Text",
32273             "optional": true,
32274             "field": "periodic_announce",
32275             "description": ""
32276           },
32277           {
32278             "group": "Body",
32279             "type": "String",
32280             "optional": true,
32281             "field": "joinempty",
32282             "description": ""
32283           },
32284           {
32285             "group": "Body",
32286             "type": "String",
32287             "optional": true,
32288             "field": "leavewhenempty",
32289             "description": ""
32290           },
32291           {
32292             "group": "Body",
32293             "type": "String",
32294             "allowedValues": [
32295               "\"yes\"",
32296               "\"no\""
32297             ],
32298             "optional": true,
32299             "field": "reportholdtime",
32300             "description": ""
32301           },
32302           {
32303             "group": "Body",
32304             "type": "String",
32305             "allowedValues": [
32306               "\"yes\"",
32307               "\"no\""
32308             ],
32309             "optional": true,
32310             "field": "ringinuse",
32311             "description": ""
32312           },
32313           {
32314             "group": "Body",
32315             "type": "Integer",
32316             "optional": true,
32317             "field": "memberdelay",
32318             "description": ""
32319           },
32320           {
32321             "group": "Body",
32322             "type": "String",
32323             "allowedValues": [
32324               "\"yes\"",
32325               "\"no\""
32326             ],
32327             "optional": true,
32328             "field": "timeoutrestart",
32329             "description": ""
32330           },
32331           {
32332             "group": "Body",
32333             "type": "String",
32334             "optional": true,
32335             "field": "defaultrule",
32336             "description": ""
32337           },
32338           {
32339             "group": "Body",
32340             "type": "String",
32341             "optional": true,
32342             "field": "description",
32343             "description": ""
32344           },
32345           {
32346             "group": "Body",
32347             "type": "Boolean",
32348             "optional": true,
32349             "field": "acw",
32350             "description": ""
32351           },
32352           {
32353             "group": "Body",
32354             "type": "Integer",
32355             "optional": true,
32356             "field": "acwTimeout",
32357             "description": ""
32358           },
32359           {
32360             "group": "Body",
32361             "type": "Boolean",
32362             "optional": true,
32363             "field": "dialActive",
32364             "description": "<p>Active/Disactive Campaign</p>"
32365           },
32366           {
32367             "group": "Body",
32368             "type": "String",
32369             "allowedValues": [
32370               "\"preview\"",
32371               "\"progressive\"",
32372               "\"power\"",
32373               "\"predictive\"",
32374               "\"booked\""
32375             ],
32376             "optional": true,
32377             "field": "dialMethod",
32378             "description": "<p>Dial Method.</p>"
32379           },
32380           {
32381             "group": "Body",
32382             "type": "Integer",
32383             "optional": true,
32384             "field": "dialLimitChannel",
32385             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32386           },
32387           {
32388             "group": "Body",
32389             "type": "Integer",
32390             "optional": true,
32391             "field": "dialLimitQueue",
32392             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32393           },
32394           {
32395             "group": "Body",
32396             "type": "Float",
32397             "optional": true,
32398             "field": "dialPowerLevel",
32399             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32400           },
32401           {
32402             "group": "Body",
32403             "type": "String",
32404             "allowedValues": [
32405               "\"agentBusyFactor\"",
32406               "\"dropRate\""
32407             ],
32408             "optional": true,
32409             "field": "dialPredictiveOptimization",
32410             "description": "<p>Only for predictive method.</p>"
32411           },
32412           {
32413             "group": "Body",
32414             "type": "Float",
32415             "optional": true,
32416             "field": "dialPredictiveOptimizationPercentage",
32417             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32418           },
32419           {
32420             "group": "Body",
32421             "type": "Integer",
32422             "optional": true,
32423             "field": "dialPredictiveInterval",
32424             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32425           },
32426           {
32427             "group": "Body",
32428             "type": "String",
32429             "optional": true,
32430             "field": "dialOriginateCallerIdName",
32431             "description": ""
32432           },
32433           {
32434             "group": "Body",
32435             "type": "String",
32436             "optional": true,
32437             "field": "dialOriginateCallerIdNumber",
32438             "description": ""
32439           },
32440           {
32441             "group": "Body",
32442             "type": "Integer",
32443             "optional": true,
32444             "field": "dialOriginateTimeout",
32445             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32446           },
32447           {
32448             "group": "Body",
32449             "type": "String",
32450             "optional": true,
32451             "field": "dialQueueOptions",
32452             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32453           },
32454           {
32455             "group": "Body",
32456             "type": "Integer",
32457             "optional": true,
32458             "field": "dialQueueTimeout",
32459             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32460           },
32461           {
32462             "group": "Body",
32463             "type": "String",
32464             "optional": true,
32465             "field": "dialQueueProject",
32466             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32467           },
32468           {
32469             "group": "Body",
32470             "type": "Integer",
32471             "optional": true,
32472             "field": "dialCongestionMaxRetry",
32473             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32474           },
32475           {
32476             "group": "Body",
32477             "type": "Integer",
32478             "optional": true,
32479             "field": "dialCongestionRetryFrequency",
32480             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32481           },
32482           {
32483             "group": "Body",
32484             "type": "Integer",
32485             "optional": true,
32486             "field": "dialBusyMaxRetry",
32487             "description": "<p>#Busy Retry (min:1, max:999)</p>"
32488           },
32489           {
32490             "group": "Body",
32491             "type": "Integer",
32492             "optional": true,
32493             "field": "dialBusyRetryFrequency",
32494             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32495           },
32496           {
32497             "group": "Body",
32498             "type": "Integer",
32499             "optional": true,
32500             "field": "dialNoAnswerMaxRetry",
32501             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32502           },
32503           {
32504             "group": "Body",
32505             "type": "Integer",
32506             "optional": true,
32507             "field": "dialNoAnswerRetryFrequency",
32508             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32509           },
32510           {
32511             "group": "Body",
32512             "type": "Integer",
32513             "optional": true,
32514             "field": "dialGlobalMaxRetry",
32515             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32516           },
32517           {
32518             "group": "Body",
32519             "type": "String",
32520             "optional": true,
32521             "field": "dialTimezone",
32522             "description": ""
32523           },
32524           {
32525             "group": "Body",
32526             "type": "String",
32527             "optional": true,
32528             "field": "dialGlobalInterval",
32529             "description": ""
32530           },
32531           {
32532             "group": "Body",
32533             "type": "String",
32534             "optional": true,
32535             "field": "dialPrefix",
32536             "description": ""
32537           },
32538           {
32539             "group": "Body",
32540             "type": "String",
32541             "allowedValues": [
32542               "\"always\"",
32543               "\"never\"",
32544               "\"onlyIfOpen\""
32545             ],
32546             "optional": true,
32547             "field": "dialCheckDuplicateType",
32548             "description": ""
32549           },
32550           {
32551             "group": "Body",
32552             "type": "Boolean",
32553             "optional": true,
32554             "field": "dialAMDActive",
32555             "description": "<p>Active/Disactive AMD</p>"
32556           },
32557           {
32558             "group": "Body",
32559             "type": "Integer",
32560             "optional": true,
32561             "field": "dialAMDInitialSilence",
32562             "description": "<p>#AMD Initial Silence</p>"
32563           },
32564           {
32565             "group": "Body",
32566             "type": "Integer",
32567             "optional": true,
32568             "field": "dialAMDGreeting",
32569             "description": "<p>#AMD Greeting</p>"
32570           },
32571           {
32572             "group": "Body",
32573             "type": "Integer",
32574             "optional": true,
32575             "field": "dialAMDAfterGreetingSilence",
32576             "description": "<p>#AMD After Greeting Silence</p>"
32577           },
32578           {
32579             "group": "Body",
32580             "type": "Integer",
32581             "optional": true,
32582             "field": "dialAMDTotalAnalysisTime",
32583             "description": "<p>#AMD Total Analysis Time</p>"
32584           },
32585           {
32586             "group": "Body",
32587             "type": "Integer",
32588             "optional": true,
32589             "field": "dialAMDMinWordLength",
32590             "description": "<p>#AMD Min Word Length</p>"
32591           },
32592           {
32593             "group": "Body",
32594             "type": "Integer",
32595             "optional": true,
32596             "field": "dialAMDBetweenWordsSilence",
32597             "description": "<p>#AMD Between Words Silence</p>"
32598           },
32599           {
32600             "group": "Body",
32601             "type": "Integer",
32602             "optional": true,
32603             "field": "dialAMDMaximumNumberOfWords",
32604             "description": "<p>#AMD Maximum Number Of Words</p>"
32605           },
32606           {
32607             "group": "Body",
32608             "type": "Integer",
32609             "optional": true,
32610             "field": "dialAMDSilenceThreshold",
32611             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32612           },
32613           {
32614             "group": "Body",
32615             "type": "Integer",
32616             "optional": true,
32617             "field": "dialAMDMaximumWordLength",
32618             "description": "<p>#AMD Maximum Word Length</p>"
32619           },
32620           {
32621             "group": "Body",
32622             "type": "Integer",
32623             "optional": true,
32624             "field": "dialRecallMeTimeout",
32625             "description": "<p>#RecallMe Timeout (min:1)</p>"
32626           },
32627           {
32628             "group": "Body",
32629             "type": "Boolean",
32630             "optional": true,
32631             "field": "dialRecallInQueue",
32632             "description": "<p>Active/Disactive Recall In Queue</p>"
32633           },
32634           {
32635             "group": "Body",
32636             "type": "String",
32637             "allowedValues": [
32638               "\"DESC\"",
32639               "\"ASC\""
32640             ],
32641             "optional": true,
32642             "field": "dialOrderByScheduledAt",
32643             "description": ""
32644           },
32645           {
32646             "group": "Body",
32647             "type": "String",
32648             "optional": true,
32649             "field": "dialQueueProject2",
32650             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32651           },
32652           {
32653             "group": "Body",
32654             "type": "Boolean",
32655             "optional": true,
32656             "field": "dialAgiAfterHangupClient",
32657             "description": ""
32658           },
32659           {
32660             "group": "Body",
32661             "type": "Boolean",
32662             "optional": true,
32663             "field": "dialAgiAfterHangupAgent",
32664             "description": ""
32665           },
32666           {
32667             "group": "Body",
32668             "type": "Integer",
32669             "optional": true,
32670             "field": "dialRandomLastDigitCallerIdNumber",
32671             "description": "<p>Random Last Digit (min:1, max:15)</p>"
32672           },
32673           {
32674             "group": "Body",
32675             "type": "Integer",
32676             "optional": true,
32677             "field": "dialCutDigit",
32678             "description": "<p>Cut Digit (min:1, max:15)</p>"
32679           },
32680           {
32681             "group": "Body",
32682             "type": "Integer",
32683             "optional": true,
32684             "field": "dialNoSuchNumberMaxRetry",
32685             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32686           },
32687           {
32688             "group": "Body",
32689             "type": "Integer",
32690             "optional": true,
32691             "field": "dialNoSuchNumberRetryFrequency",
32692             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32693           },
32694           {
32695             "group": "Body",
32696             "type": "Integer",
32697             "optional": true,
32698             "field": "dialDropMaxRetry",
32699             "description": "<p>#Drop Retry (min:1, max:999)</p>"
32700           },
32701           {
32702             "group": "Body",
32703             "type": "Integer",
32704             "optional": true,
32705             "field": "dialDropRetryFrequency",
32706             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32707           },
32708           {
32709             "group": "Body",
32710             "type": "Integer",
32711             "optional": true,
32712             "field": "dialAbandonedMaxRetry",
32713             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32714           },
32715           {
32716             "group": "Body",
32717             "type": "Integer",
32718             "optional": true,
32719             "field": "dialAbandonedRetryFrequency",
32720             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32721           },
32722           {
32723             "group": "Body",
32724             "type": "Integer",
32725             "optional": true,
32726             "field": "dialMachineMaxRetry",
32727             "description": "<p>#Machine Retry (min:1, max:999)</p>"
32728           },
32729           {
32730             "group": "Body",
32731             "type": "Integer",
32732             "optional": true,
32733             "field": "dialMachineRetryFrequency",
32734             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32735           },
32736           {
32737             "group": "Body",
32738             "type": "Integer",
32739             "optional": true,
32740             "field": "dialAgentRejectMaxRetry",
32741             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32742           },
32743           {
32744             "group": "Body",
32745             "type": "Integer",
32746             "optional": true,
32747             "field": "dialAgentRejectRetryFrequency",
32748             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32749           },
32750           {
32751             "group": "Body",
32752             "type": "Integer",
32753             "optional": true,
32754             "field": "mandatoryDispositionPauseId",
32755             "description": "<p>Status to put when mandatory disposition is enabled</p>"
32756           },
32757           {
32758             "group": "Body",
32759             "type": "Boolean",
32760             "optional": true,
32761             "field": "mandatoryDisposition",
32762             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32763           },
32764           {
32765             "group": "Body",
32766             "type": "Integer",
32767             "optional": true,
32768             "field": "dialPredictiveIntervalMaxThreshold",
32769             "description": ""
32770           },
32771           {
32772             "group": "Body",
32773             "type": "Integer",
32774             "optional": true,
32775             "field": "dialPredictiveIntervalMinThreshold",
32776             "description": ""
32777           },
32778           {
32779             "group": "Body",
32780             "type": "Boolean",
32781             "optional": true,
32782             "field": "dialPreviewAutoRecallMe",
32783             "description": ""
32784           }
32785         ]
32786       }
32787     },
32788     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32789     "version": "0.0.0",
32790     "filename": "server/api/voiceQueue/index.js",
32791     "groupTitle": "Voice_Queues"
32792   },
32793   {
32794     "type": "delete",
32795     "url": "/api/voice/queues/{id}",
32796     "title": "Deletes a Queue",
32797     "examples": [
32798       {
32799         "title": "Example usage:",
32800         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32801         "type": "json"
32802       }
32803     ],
32804     "name": "DeleteQueues",
32805     "group": "Voice_Queues",
32806     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32807     "version": "0.0.0",
32808     "filename": "server/api/voiceQueue/index.js",
32809     "groupTitle": "Voice_Queues"
32810   },
32811   {
32812     "type": "get",
32813     "url": "/api/voice/queues/{id}/users",
32814     "title": "Gets queue agents",
32815     "examples": [
32816       {
32817         "title": "Example usage:",
32818         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32819         "type": "json"
32820       }
32821     ],
32822     "name": "GetAgents",
32823     "group": "Voice_Queues",
32824     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32825     "version": "0.0.0",
32826     "filename": "server/api/voiceQueue/index.js",
32827     "groupTitle": "Voice_Queues"
32828   },
32829   {
32830     "type": "get",
32831     "url": "/api/voice/queues/{id}/blacklists",
32832     "title": "Get queue blacklists",
32833     "examples": [
32834       {
32835         "title": "Example usage:",
32836         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32837         "type": "json"
32838       }
32839     ],
32840     "name": "GetBlackLists",
32841     "group": "Voice_Queues",
32842     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32843     "version": "0.0.0",
32844     "filename": "server/api/voiceQueue/index.js",
32845     "groupTitle": "Voice_Queues"
32846   },
32847   {
32848     "type": "get",
32849     "url": "/api/voice/queues/{id}/finals",
32850     "title": "Gets queue hopper finals",
32851     "examples": [
32852       {
32853         "title": "Example usage:",
32854         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
32855         "type": "json"
32856       }
32857     ],
32858     "name": "GetHopperFinals",
32859     "group": "Voice_Queues",
32860     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32861     "version": "0.0.0",
32862     "filename": "server/api/voiceQueue/index.js",
32863     "groupTitle": "Voice_Queues"
32864   },
32865   {
32866     "type": "get",
32867     "url": "/api/voice/queues/{id}/hopper_histories",
32868     "title": "Gets queue hopper histories",
32869     "examples": [
32870       {
32871         "title": "Example usage:",
32872         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32873         "type": "json"
32874       }
32875     ],
32876     "name": "GetHopperHistories",
32877     "group": "Voice_Queues",
32878     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32879     "version": "0.0.0",
32880     "filename": "server/api/voiceQueue/index.js",
32881     "groupTitle": "Voice_Queues"
32882   },
32883   {
32884     "type": "get",
32885     "url": "/api/voice/queues/{id}/hoppers",
32886     "title": "Gets queue hoppers",
32887     "examples": [
32888       {
32889         "title": "Example usage:",
32890         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32891         "type": "json"
32892       }
32893     ],
32894     "name": "GetHoppers",
32895     "group": "Voice_Queues",
32896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32897     "version": "0.0.0",
32898     "filename": "server/api/voiceQueue/index.js",
32899     "groupTitle": "Voice_Queues"
32900   },
32901   {
32902     "type": "get",
32903     "url": "/api/voice/queues/{id}/lists",
32904     "title": "Get queue lists",
32905     "examples": [
32906       {
32907         "title": "Example usage:",
32908         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32909         "type": "json"
32910       }
32911     ],
32912     "name": "GetLists",
32913     "group": "Voice_Queues",
32914     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32915     "version": "0.0.0",
32916     "filename": "server/api/voiceQueue/index.js",
32917     "groupTitle": "Voice_Queues"
32918   },
32919   {
32920     "type": "get",
32921     "url": "/api/voice/queues/{id}/members",
32922     "title": "Gets queue members",
32923     "examples": [
32924       {
32925         "title": "Example usage:",
32926         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32927         "type": "json"
32928       }
32929     ],
32930     "name": "GetMembers",
32931     "group": "Voice_Queues",
32932     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32933     "version": "0.0.0",
32934     "filename": "server/api/voiceQueue/index.js",
32935     "groupTitle": "Voice_Queues"
32936   },
32937   {
32938     "type": "get",
32939     "url": "/api/voice/queues",
32940     "title": "Gets a list of Queues",
32941     "examples": [
32942       {
32943         "title": "Example usage:",
32944         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32945         "type": "json"
32946       }
32947     ],
32948     "name": "GetQueues",
32949     "group": "Voice_Queues",
32950     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32951     "version": "0.0.0",
32952     "filename": "server/api/voiceQueue/index.js",
32953     "groupTitle": "Voice_Queues"
32954   },
32955   {
32956     "type": "get",
32957     "url": "/api/voice/queues/{id}/teams",
32958     "title": "Gets queue team",
32959     "examples": [
32960       {
32961         "title": "Example usage:",
32962         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
32963         "type": "json"
32964       }
32965     ],
32966     "name": "GetTeams",
32967     "group": "Voice_Queues",
32968     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32969     "version": "0.0.0",
32970     "filename": "server/api/voiceQueue/index.js",
32971     "groupTitle": "Voice_Queues"
32972   },
32973   {
32974     "type": "delete",
32975     "url": "/api/voice/queues/{id}/users",
32976     "title": "Removes agents from a queue",
32977     "examples": [
32978       {
32979         "title": "Example usage:",
32980         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32981         "type": "json"
32982       }
32983     ],
32984     "name": "RemoveAgents",
32985     "group": "Voice_Queues",
32986     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32987     "version": "0.0.0",
32988     "filename": "server/api/voiceQueue/index.js",
32989     "groupTitle": "Voice_Queues"
32990   },
32991   {
32992     "type": "delete",
32993     "url": "/api/voice/queues/{id}/blacklists",
32994     "title": "Remove blacklists from a queue",
32995     "examples": [
32996       {
32997         "title": "Example usage:",
32998         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32999         "type": "json"
33000       }
33001     ],
33002     "name": "RemoveBlackLists",
33003     "group": "Voice_Queues",
33004     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33005     "version": "0.0.0",
33006     "filename": "server/api/voiceQueue/index.js",
33007     "groupTitle": "Voice_Queues"
33008   },
33009   {
33010     "type": "delete",
33011     "url": "/api/voice/queues/{id}/lists",
33012     "title": "Remove lists from a queue",
33013     "examples": [
33014       {
33015         "title": "Example usage:",
33016         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33017         "type": "json"
33018       }
33019     ],
33020     "name": "RemoveLists",
33021     "group": "Voice_Queues",
33022     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33023     "version": "0.0.0",
33024     "filename": "server/api/voiceQueue/index.js",
33025     "groupTitle": "Voice_Queues"
33026   },
33027   {
33028     "type": "get",
33029     "url": "/api/voice/queues/{id}",
33030     "title": "Gets a single Queue",
33031     "examples": [
33032       {
33033         "title": "Example usage:",
33034         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33035         "type": "json"
33036       }
33037     ],
33038     "name": "ShowQueues",
33039     "group": "Voice_Queues",
33040     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33041     "version": "0.0.0",
33042     "filename": "server/api/voiceQueue/index.js",
33043     "groupTitle": "Voice_Queues"
33044   },
33045   {
33046     "type": "get",
33047     "url": "/api/voice/queues/{id}/blacks",
33048     "title": "Gets queue hopper blacks",
33049     "examples": [
33050       {
33051         "title": "Example usage:",
33052         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
33053         "type": "json"
33054       }
33055     ],
33056     "name": "getHopperBlacks",
33057     "group": "Voice_Queues",
33058     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33059     "version": "0.0.0",
33060     "filename": "server/api/voiceQueue/index.js",
33061     "groupTitle": "Voice_Queues"
33062   },
33063   {
33064     "type": "put",
33065     "url": "/api/voice/queues/{id}",
33066     "title": "Update an existing Queue",
33067     "examples": [
33068       {
33069         "title": "Example usage:",
33070         "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",
33071         "type": "json"
33072       }
33073     ],
33074     "name": "updateQueues",
33075     "group": "Voice_Queues",
33076     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33077     "version": "0.0.0",
33078     "filename": "server/api/voiceQueue/index.js",
33079     "groupTitle": "Voice_Queues"
33080   },
33081   {
33082     "type": "post",
33083     "url": "/api/voice/recordings",
33084     "title": "Creates a new Recording",
33085     "examples": [
33086       {
33087         "title": "Example usage:",
33088         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33089         "type": "json"
33090       }
33091     ],
33092     "name": "CreateRecordings",
33093     "group": "Voice_Recordings",
33094     "parameter": {
33095       "fields": {
33096         "Body": [
33097           {
33098             "group": "Body",
33099             "type": "Virtual",
33100             "optional": true,
33101             "field": "format",
33102             "description": ""
33103           },
33104           {
33105             "group": "Body",
33106             "type": "String",
33107             "optional": true,
33108             "field": "uniqueid",
33109             "description": ""
33110           },
33111           {
33112             "group": "Body",
33113             "type": "String",
33114             "optional": true,
33115             "field": "channel",
33116             "description": ""
33117           },
33118           {
33119             "group": "Body",
33120             "type": "String",
33121             "optional": true,
33122             "field": "membername",
33123             "description": ""
33124           },
33125           {
33126             "group": "Body",
33127             "type": "String",
33128             "optional": true,
33129             "field": "calleridnum",
33130             "description": ""
33131           },
33132           {
33133             "group": "Body",
33134             "type": "String",
33135             "optional": true,
33136             "field": "calleridname",
33137             "description": ""
33138           },
33139           {
33140             "group": "Body",
33141             "type": "String",
33142             "optional": true,
33143             "field": "connectedlinenum",
33144             "description": ""
33145           },
33146           {
33147             "group": "Body",
33148             "type": "String",
33149             "optional": true,
33150             "field": "connectedlinename",
33151             "description": ""
33152           },
33153           {
33154             "group": "Body",
33155             "type": "String",
33156             "optional": true,
33157             "field": "accountcode",
33158             "description": ""
33159           },
33160           {
33161             "group": "Body",
33162             "type": "String",
33163             "optional": true,
33164             "field": "context",
33165             "description": ""
33166           },
33167           {
33168             "group": "Body",
33169             "type": "String",
33170             "optional": true,
33171             "field": "exten",
33172             "description": ""
33173           },
33174           {
33175             "group": "Body",
33176             "type": "String",
33177             "optional": true,
33178             "field": "value",
33179             "description": ""
33180           },
33181           {
33182             "group": "Body",
33183             "type": "String",
33184             "optional": true,
33185             "field": "type",
33186             "description": ""
33187           },
33188           {
33189             "group": "Body",
33190             "type": "Integer",
33191             "optional": true,
33192             "field": "rating",
33193             "description": ""
33194           },
33195           {
33196             "group": "Body",
33197             "type": "String",
33198             "optional": true,
33199             "field": "queue",
33200             "description": ""
33201           },
33202           {
33203             "group": "Body",
33204             "type": "String",
33205             "optional": true,
33206             "field": "userDisposition",
33207             "description": ""
33208           },
33209           {
33210             "group": "Body",
33211             "type": "String",
33212             "optional": true,
33213             "field": "userSecondDisposition",
33214             "description": ""
33215           },
33216           {
33217             "group": "Body",
33218             "type": "String",
33219             "optional": true,
33220             "field": "userThirdDisposition",
33221             "description": ""
33222           },
33223           {
33224             "group": "Body",
33225             "type": "Text",
33226             "optional": true,
33227             "field": "location",
33228             "description": ""
33229           },
33230           {
33231             "group": "Body",
33232             "type": "String",
33233             "optional": true,
33234             "field": "transcribeName",
33235             "description": ""
33236           },
33237           {
33238             "group": "Body",
33239             "type": "String",
33240             "optional": true,
33241             "field": "transcribeStatus",
33242             "description": ""
33243           },
33244           {
33245             "group": "Body",
33246             "type": "Text",
33247             "optional": true,
33248             "field": "fileUri",
33249             "description": ""
33250           },
33251           {
33252             "group": "Body",
33253             "type": "Text",
33254             "optional": true,
33255             "field": "fileText",
33256             "description": ""
33257           },
33258           {
33259             "group": "Body",
33260             "type": "Text",
33261             "optional": true,
33262             "field": "failureReason",
33263             "description": ""
33264           },
33265           {
33266             "group": "Body",
33267             "type": "String",
33268             "optional": true,
33269             "field": "sentiment",
33270             "description": ""
33271           },
33272           {
33273             "group": "Body",
33274             "type": "Float",
33275             "optional": true,
33276             "field": "sPositive",
33277             "description": ""
33278           },
33279           {
33280             "group": "Body",
33281             "type": "Float",
33282             "optional": true,
33283             "field": "sNegative",
33284             "description": ""
33285           },
33286           {
33287             "group": "Body",
33288             "type": "Float",
33289             "optional": true,
33290             "field": "sNeutral",
33291             "description": ""
33292           },
33293           {
33294             "group": "Body",
33295             "type": "Float",
33296             "optional": true,
33297             "field": "sMixed",
33298             "description": ""
33299           },
33300           {
33301             "group": "Body",
33302             "type": "Boolean",
33303             "optional": true,
33304             "field": "tempSentiment",
33305             "description": ""
33306           },
33307           {
33308             "group": "Body",
33309             "type": "String",
33310             "optional": true,
33311             "field": "createdAt",
33312             "description": ""
33313           },
33314           {
33315             "group": "Body",
33316             "type": "String",
33317             "optional": true,
33318             "field": "updatedAt",
33319             "description": ""
33320           }
33321         ]
33322       }
33323     },
33324     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33325     "version": "0.0.0",
33326     "filename": "server/api/voiceRecording/index.js",
33327     "groupTitle": "Voice_Recordings"
33328   },
33329   {
33330     "type": "get",
33331     "url": "/api/voice/recordings/describe",
33332     "title": "Gets table info about Recordings",
33333     "examples": [
33334       {
33335         "title": "Example usage:",
33336         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33337         "type": "json"
33338       }
33339     ],
33340     "name": "DescribeRecordings",
33341     "group": "Voice_Recordings",
33342     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33343     "version": "0.0.0",
33344     "filename": "server/api/voiceRecording/index.js",
33345     "groupTitle": "Voice_Recordings"
33346   },
33347   {
33348     "type": "get",
33349     "url": "/api/voice/recordings",
33350     "title": "Gets a list of Recordings",
33351     "examples": [
33352       {
33353         "title": "Example usage:",
33354         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33355         "type": "json"
33356       }
33357     ],
33358     "name": "GetRecordings",
33359     "group": "Voice_Recordings",
33360     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33361     "version": "0.0.0",
33362     "filename": "server/api/voiceRecording/index.js",
33363     "groupTitle": "Voice_Recordings"
33364   },
33365   {
33366     "type": "get",
33367     "url": "/api/voice/recordings/{id}",
33368     "title": "Gets a single Recording",
33369     "examples": [
33370       {
33371         "title": "Example usage:",
33372         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33373         "type": "json"
33374       }
33375     ],
33376     "name": "ShowRecordings",
33377     "group": "Voice_Recordings",
33378     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33379     "version": "0.0.0",
33380     "filename": "server/api/voiceRecording/index.js",
33381     "groupTitle": "Voice_Recordings"
33382   },
33383   {
33384     "type": "delete",
33385     "url": "/api/voice/recordings/{id}",
33386     "title": "Delete voice recording",
33387     "examples": [
33388       {
33389         "title": "Example usage:",
33390         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33391         "type": "json"
33392       }
33393     ],
33394     "name": "destroy",
33395     "group": "Voice_Recordings",
33396     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33397     "version": "0.0.0",
33398     "filename": "server/api/voiceRecording/index.js",
33399     "groupTitle": "Voice_Recordings"
33400   },
33401   {
33402     "type": "get",
33403     "url": "/api/voice/recordings/{id}/download",
33404     "title": "Download Recording",
33405     "examples": [
33406       {
33407         "title": "Example usage:",
33408         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33409         "type": "json"
33410       }
33411     ],
33412     "name": "download",
33413     "group": "Voice_Recordings",
33414     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33415     "version": "0.0.0",
33416     "filename": "server/api/voiceRecording/index.js",
33417     "groupTitle": "Voice_Recordings"
33418   },
33419   {
33420     "type": "get",
33421     "url": "/api/voice/recordings/{id}/downloads",
33422     "title": "Download Recording",
33423     "examples": [
33424       {
33425         "title": "Example usage:",
33426         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33427         "type": "json"
33428       }
33429     ],
33430     "name": "downloads",
33431     "group": "Voice_Recordings",
33432     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33433     "version": "0.0.0",
33434     "filename": "server/api/voiceRecording/index.js",
33435     "groupTitle": "Voice_Recordings"
33436   },
33437   {
33438     "type": "post",
33439     "url": "/api/voice/recordings/{id}/transcribe",
33440     "title": "Run Transcribe Recording",
33441     "examples": [
33442       {
33443         "title": "Example usage:",
33444         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33445         "type": "json"
33446       }
33447     ],
33448     "name": "transcribe",
33449     "group": "Voice_Recordings",
33450     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33451     "version": "0.0.0",
33452     "filename": "server/api/voiceRecording/index.js",
33453     "groupTitle": "Voice_Recordings"
33454   },
33455   {
33456     "type": "get",
33457     "url": "/api/voice/recordings/{id}/transcribe",
33458     "title": "Run Transcribe Recording",
33459     "examples": [
33460       {
33461         "title": "Example usage:",
33462         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33463         "type": "json"
33464       }
33465     ],
33466     "name": "transcribe",
33467     "group": "Voice_Recordings",
33468     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33469     "version": "0.0.0",
33470     "filename": "server/api/voiceRecording/index.js",
33471     "groupTitle": "Voice_Recordings"
33472   },
33473   {
33474     "type": "put",
33475     "url": "/api/voice/recordings/{id}",
33476     "title": "Update an existing Recording",
33477     "examples": [
33478       {
33479         "title": "Example usage:",
33480         "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",
33481         "type": "json"
33482       }
33483     ],
33484     "name": "updateRecordings",
33485     "group": "Voice_Recordings",
33486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33487     "version": "0.0.0",
33488     "filename": "server/api/voiceRecording/index.js",
33489     "groupTitle": "Voice_Recordings"
33490   },
33491   {
33492     "type": "post",
33493     "url": "/api/voice/transfers/reports",
33494     "title": "Creates a new Transfer Report",
33495     "examples": [
33496       {
33497         "title": "Example usage:",
33498         "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",
33499         "type": "json"
33500       }
33501     ],
33502     "name": "CreateTransfer_Reports",
33503     "group": "Voice_Transfer_Reports",
33504     "parameter": {
33505       "fields": {
33506         "Body": [
33507           {
33508             "group": "Body",
33509             "type": "String",
33510             "allowedValues": [
33511               "\"blind\"",
33512               "\"attended\""
33513             ],
33514             "optional": true,
33515             "field": "type",
33516             "description": ""
33517           },
33518           {
33519             "group": "Body",
33520             "type": "String",
33521             "optional": true,
33522             "field": "result",
33523             "description": ""
33524           },
33525           {
33526             "group": "Body",
33527             "type": "String",
33528             "optional": true,
33529             "field": "transfererchannel",
33530             "description": ""
33531           },
33532           {
33533             "group": "Body",
33534             "type": "String",
33535             "optional": true,
33536             "field": "transferercalleridnum",
33537             "description": ""
33538           },
33539           {
33540             "group": "Body",
33541             "type": "String",
33542             "optional": true,
33543             "field": "transferercalleridname",
33544             "description": ""
33545           },
33546           {
33547             "group": "Body",
33548             "type": "String",
33549             "optional": true,
33550             "field": "transfererconnectedlinenum",
33551             "description": ""
33552           },
33553           {
33554             "group": "Body",
33555             "type": "String",
33556             "optional": true,
33557             "field": "transfererconnectedlinename",
33558             "description": ""
33559           },
33560           {
33561             "group": "Body",
33562             "type": "String",
33563             "optional": true,
33564             "field": "transfereraccountcode",
33565             "description": ""
33566           },
33567           {
33568             "group": "Body",
33569             "type": "String",
33570             "optional": true,
33571             "field": "transferercontext",
33572             "description": ""
33573           },
33574           {
33575             "group": "Body",
33576             "type": "String",
33577             "optional": true,
33578             "field": "transfererexten",
33579             "description": ""
33580           },
33581           {
33582             "group": "Body",
33583             "type": "String",
33584             "optional": true,
33585             "field": "transfererlinkedid",
33586             "description": ""
33587           },
33588           {
33589             "group": "Body",
33590             "type": "String",
33591             "optional": true,
33592             "field": "transfereechannel",
33593             "description": ""
33594           },
33595           {
33596             "group": "Body",
33597             "type": "String",
33598             "optional": true,
33599             "field": "transfereecalleridnum",
33600             "description": ""
33601           },
33602           {
33603             "group": "Body",
33604             "type": "String",
33605             "optional": true,
33606             "field": "transfereecalleridname",
33607             "description": ""
33608           },
33609           {
33610             "group": "Body",
33611             "type": "String",
33612             "optional": true,
33613             "field": "transfereeconnectedlinenum",
33614             "description": ""
33615           },
33616           {
33617             "group": "Body",
33618             "type": "String",
33619             "optional": true,
33620             "field": "transfereeconnectedlinename",
33621             "description": ""
33622           },
33623           {
33624             "group": "Body",
33625             "type": "String",
33626             "optional": true,
33627             "field": "transfereeaccountcode",
33628             "description": ""
33629           },
33630           {
33631             "group": "Body",
33632             "type": "String",
33633             "optional": true,
33634             "field": "transfereecontext",
33635             "description": ""
33636           },
33637           {
33638             "group": "Body",
33639             "type": "String",
33640             "optional": true,
33641             "field": "transfereeexten",
33642             "description": ""
33643           },
33644           {
33645             "group": "Body",
33646             "type": "String",
33647             "optional": true,
33648             "field": "transfereelinkedid",
33649             "description": ""
33650           },
33651           {
33652             "group": "Body",
33653             "type": "String",
33654             "allowedValues": [
33655               "\"Yes\"",
33656               "\"No\""
33657             ],
33658             "optional": true,
33659             "field": "isexternal",
33660             "description": ""
33661           },
33662           {
33663             "group": "Body",
33664             "type": "String",
33665             "optional": true,
33666             "field": "context",
33667             "description": ""
33668           },
33669           {
33670             "group": "Body",
33671             "type": "String",
33672             "optional": true,
33673             "field": "extension",
33674             "description": ""
33675           }
33676         ]
33677       }
33678     },
33679     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33680     "version": "0.0.0",
33681     "filename": "server/api/voiceTransferReport/index.js",
33682     "groupTitle": "Voice_Transfer_Reports"
33683   },
33684   {
33685     "type": "delete",
33686     "url": "/api/voice/transfers/reports/{id}",
33687     "title": "Deletes a Transfer Report",
33688     "examples": [
33689       {
33690         "title": "Example usage:",
33691         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33692         "type": "json"
33693       }
33694     ],
33695     "name": "DeleteTransfer_Reports",
33696     "group": "Voice_Transfer_Reports",
33697     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33698     "version": "0.0.0",
33699     "filename": "server/api/voiceTransferReport/index.js",
33700     "groupTitle": "Voice_Transfer_Reports"
33701   },
33702   {
33703     "type": "get",
33704     "url": "/api/voice/transfers/reports/describe",
33705     "title": "Gets table info about Transfer Reports",
33706     "examples": [
33707       {
33708         "title": "Example usage:",
33709         "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
33710         "type": "json"
33711       }
33712     ],
33713     "name": "DescribeTransfer_Reports",
33714     "group": "Voice_Transfer_Reports",
33715     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33716     "version": "0.0.0",
33717     "filename": "server/api/voiceTransferReport/index.js",
33718     "groupTitle": "Voice_Transfer_Reports"
33719   },
33720   {
33721     "type": "get",
33722     "url": "/api/voice/transfers/reports",
33723     "title": "Gets a list of Transfer Reports",
33724     "examples": [
33725       {
33726         "title": "Example usage:",
33727         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33728         "type": "json"
33729       }
33730     ],
33731     "name": "GetTransfer_Reports",
33732     "group": "Voice_Transfer_Reports",
33733     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33734     "version": "0.0.0",
33735     "filename": "server/api/voiceTransferReport/index.js",
33736     "groupTitle": "Voice_Transfer_Reports"
33737   },
33738   {
33739     "type": "get",
33740     "url": "/api/voice/transfers/reports/{id}",
33741     "title": "Gets a single Transfer Report",
33742     "examples": [
33743       {
33744         "title": "Example usage:",
33745         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33746         "type": "json"
33747       }
33748     ],
33749     "name": "ShowTransfer_Reports",
33750     "group": "Voice_Transfer_Reports",
33751     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33752     "version": "0.0.0",
33753     "filename": "server/api/voiceTransferReport/index.js",
33754     "groupTitle": "Voice_Transfer_Reports"
33755   },
33756   {
33757     "type": "put",
33758     "url": "/api/voice/transfers/reports/{id}",
33759     "title": "Update an existing Transfer Report",
33760     "examples": [
33761       {
33762         "title": "Example usage:",
33763         "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",
33764         "type": "json"
33765       }
33766     ],
33767     "name": "updateTransfer_Reports",
33768     "group": "Voice_Transfer_Reports",
33769     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33770     "version": "0.0.0",
33771     "filename": "server/api/voiceTransferReport/index.js",
33772     "groupTitle": "Voice_Transfer_Reports"
33773   },
33774   {
33775     "type": "post",
33776     "url": "/api/integrations/vtiger/accounts",
33777     "title": "Creates a new Vtiger Account",
33778     "examples": [
33779       {
33780         "title": "Example usage:",
33781         "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",
33782         "type": "json"
33783       }
33784     ],
33785     "name": "CreateVtiger_Accounts",
33786     "group": "Vtiger_Accounts",
33787     "parameter": {
33788       "fields": {
33789         "Body": [
33790           {
33791             "group": "Body",
33792             "type": "String",
33793             "optional": false,
33794             "field": "name",
33795             "description": ""
33796           },
33797           {
33798             "group": "Body",
33799             "type": "String",
33800             "optional": true,
33801             "field": "description",
33802             "description": ""
33803           },
33804           {
33805             "group": "Body",
33806             "type": "String",
33807             "optional": false,
33808             "field": "username",
33809             "description": ""
33810           },
33811           {
33812             "group": "Body",
33813             "type": "String",
33814             "optional": false,
33815             "field": "moduleName",
33816             "description": ""
33817           },
33818           {
33819             "group": "Body",
33820             "type": "String",
33821             "optional": false,
33822             "field": "remoteUri",
33823             "description": ""
33824           },
33825           {
33826             "group": "Body",
33827             "type": "String",
33828             "optional": false,
33829             "field": "serverUrl",
33830             "description": ""
33831           },
33832           {
33833             "group": "Body",
33834             "type": "String",
33835             "optional": false,
33836             "field": "accessKey",
33837             "description": ""
33838           }
33839         ]
33840       }
33841     },
33842     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33843     "version": "0.0.0",
33844     "filename": "server/api/intVtigerAccount/index.js",
33845     "groupTitle": "Vtiger_Accounts"
33846   },
33847   {
33848     "type": "delete",
33849     "url": "/api/integrations/vtiger/accounts/{id}",
33850     "title": "Deletes a Vtiger Account",
33851     "examples": [
33852       {
33853         "title": "Example usage:",
33854         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33855         "type": "json"
33856       }
33857     ],
33858     "name": "DeleteVtiger_Accounts",
33859     "group": "Vtiger_Accounts",
33860     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/intVtigerAccount/index.js",
33863     "groupTitle": "Vtiger_Accounts"
33864   },
33865   {
33866     "type": "get",
33867     "url": "/api/integrations/vtiger/accounts",
33868     "title": "Gets a list of Vtiger Accounts",
33869     "examples": [
33870       {
33871         "title": "Example usage:",
33872         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33873         "type": "json"
33874       }
33875     ],
33876     "name": "GetVtiger_Accounts",
33877     "group": "Vtiger_Accounts",
33878     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33879     "version": "0.0.0",
33880     "filename": "server/api/intVtigerAccount/index.js",
33881     "groupTitle": "Vtiger_Accounts"
33882   },
33883   {
33884     "type": "get",
33885     "url": "/api/integrations/vtiger/accounts/{id}",
33886     "title": "Gets a single Vtiger Account",
33887     "examples": [
33888       {
33889         "title": "Example usage:",
33890         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33891         "type": "json"
33892       }
33893     ],
33894     "name": "ShowVtiger_Accounts",
33895     "group": "Vtiger_Accounts",
33896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33897     "version": "0.0.0",
33898     "filename": "server/api/intVtigerAccount/index.js",
33899     "groupTitle": "Vtiger_Accounts"
33900   },
33901   {
33902     "type": "post",
33903     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33904     "title": "Creates new configuration",
33905     "examples": [
33906       {
33907         "title": "Example usage:",
33908         "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",
33909         "type": "json"
33910       }
33911     ],
33912     "name": "addConfiguration",
33913     "group": "Vtiger_Accounts",
33914     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33915     "version": "0.0.0",
33916     "filename": "server/api/intVtigerAccount/index.js",
33917     "groupTitle": "Vtiger_Accounts"
33918   },
33919   {
33920     "type": "get",
33921     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33922     "title": "Gets account configurations",
33923     "examples": [
33924       {
33925         "title": "Example usage:",
33926         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33927         "type": "json"
33928       }
33929     ],
33930     "name": "getConfigurations",
33931     "group": "Vtiger_Accounts",
33932     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33933     "version": "0.0.0",
33934     "filename": "server/api/intVtigerAccount/index.js",
33935     "groupTitle": "Vtiger_Accounts"
33936   },
33937   {
33938     "type": "get",
33939     "url": "/api/integrations/vtiger/accounts/{id}/fields",
33940     "title": "Gets account fields",
33941     "examples": [
33942       {
33943         "title": "Example usage:",
33944         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33945         "type": "json"
33946       }
33947     ],
33948     "name": "getFields",
33949     "group": "Vtiger_Accounts",
33950     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33951     "version": "0.0.0",
33952     "filename": "server/api/intVtigerAccount/index.js",
33953     "groupTitle": "Vtiger_Accounts"
33954   },
33955   {
33956     "type": "put",
33957     "url": "/api/integrations/vtiger/accounts/{id}",
33958     "title": "Update an existing Vtiger Account",
33959     "examples": [
33960       {
33961         "title": "Example usage:",
33962         "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",
33963         "type": "json"
33964       }
33965     ],
33966     "name": "updateVtiger_Accounts",
33967     "group": "Vtiger_Accounts",
33968     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33969     "version": "0.0.0",
33970     "filename": "server/api/intVtigerAccount/index.js",
33971     "groupTitle": "Vtiger_Accounts"
33972   },
33973   {
33974     "type": "post",
33975     "url": "/api/integrations/vtiger/configurations",
33976     "title": "Creates a new Vtiger Configuration",
33977     "examples": [
33978       {
33979         "title": "Example usage:",
33980         "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",
33981         "type": "json"
33982       }
33983     ],
33984     "name": "CreateVtiger_Configurations",
33985     "group": "Vtiger_Configurations",
33986     "parameter": {
33987       "fields": {
33988         "Body": [
33989           {
33990             "group": "Body",
33991             "type": "String",
33992             "optional": true,
33993             "field": "name",
33994             "description": ""
33995           },
33996           {
33997             "group": "Body",
33998             "type": "String",
33999             "optional": true,
34000             "field": "description",
34001             "description": ""
34002           }
34003         ]
34004       }
34005     },
34006     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34007     "version": "0.0.0",
34008     "filename": "server/api/intVtigerConfiguration/index.js",
34009     "groupTitle": "Vtiger_Configurations"
34010   },
34011   {
34012     "type": "delete",
34013     "url": "/api/integrations/vtiger/configurations/{id}",
34014     "title": "Deletes a Vtiger Configuration",
34015     "examples": [
34016       {
34017         "title": "Example usage:",
34018         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34019         "type": "json"
34020       }
34021     ],
34022     "name": "DeleteVtiger_Configurations",
34023     "group": "Vtiger_Configurations",
34024     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34025     "version": "0.0.0",
34026     "filename": "server/api/intVtigerConfiguration/index.js",
34027     "groupTitle": "Vtiger_Configurations"
34028   },
34029   {
34030     "type": "get",
34031     "url": "/api/integrations/vtiger/configurations",
34032     "title": "Gets a list of Vtiger Configurations",
34033     "examples": [
34034       {
34035         "title": "Example usage:",
34036         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34037         "type": "json"
34038       }
34039     ],
34040     "name": "GetVtiger_Configurations",
34041     "group": "Vtiger_Configurations",
34042     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34043     "version": "0.0.0",
34044     "filename": "server/api/intVtigerConfiguration/index.js",
34045     "groupTitle": "Vtiger_Configurations"
34046   },
34047   {
34048     "type": "get",
34049     "url": "/api/integrations/vtiger/configurations/{id}",
34050     "title": "Gets a single Vtiger Configuration",
34051     "examples": [
34052       {
34053         "title": "Example usage:",
34054         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34055         "type": "json"
34056       }
34057     ],
34058     "name": "ShowVtiger_Configurations",
34059     "group": "Vtiger_Configurations",
34060     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34061     "version": "0.0.0",
34062     "filename": "server/api/intVtigerConfiguration/index.js",
34063     "groupTitle": "Vtiger_Configurations"
34064   },
34065   {
34066     "type": "get",
34067     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34068     "title": "Gets configurations descriptions",
34069     "examples": [
34070       {
34071         "title": "Example usage:",
34072         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34073         "type": "json"
34074       }
34075     ],
34076     "name": "getDescriptions",
34077     "group": "Vtiger_Configurations",
34078     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34079     "version": "0.0.0",
34080     "filename": "server/api/intVtigerConfiguration/index.js",
34081     "groupTitle": "Vtiger_Configurations"
34082   },
34083   {
34084     "type": "get",
34085     "url": "/api/integrations/vtiger/configurations/{id}/fields",
34086     "title": "Gets configurations fields",
34087     "examples": [
34088       {
34089         "title": "Example usage:",
34090         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34091         "type": "json"
34092       }
34093     ],
34094     "name": "getFields",
34095     "group": "Vtiger_Configurations",
34096     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34097     "version": "0.0.0",
34098     "filename": "server/api/intVtigerConfiguration/index.js",
34099     "groupTitle": "Vtiger_Configurations"
34100   },
34101   {
34102     "type": "get",
34103     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34104     "title": "Gets configurations subjects",
34105     "examples": [
34106       {
34107         "title": "Example usage:",
34108         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34109         "type": "json"
34110       }
34111     ],
34112     "name": "getSubjects",
34113     "group": "Vtiger_Configurations",
34114     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34115     "version": "0.0.0",
34116     "filename": "server/api/intVtigerConfiguration/index.js",
34117     "groupTitle": "Vtiger_Configurations"
34118   },
34119   {
34120     "type": "put",
34121     "url": "/api/integrations/vtiger/configurations/{id}",
34122     "title": "Update an existing Vtiger Configuration",
34123     "examples": [
34124       {
34125         "title": "Example usage:",
34126         "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",
34127         "type": "json"
34128       }
34129     ],
34130     "name": "updateVtiger_Configurations",
34131     "group": "Vtiger_Configurations",
34132     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34133     "version": "0.0.0",
34134     "filename": "server/api/intVtigerConfiguration/index.js",
34135     "groupTitle": "Vtiger_Configurations"
34136   },
34137   {
34138     "type": "post",
34139     "url": "/api/integrations/vtiger/fields",
34140     "title": "Creates a new Vtiger Field",
34141     "examples": [
34142       {
34143         "title": "Example usage:",
34144         "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",
34145         "type": "json"
34146       }
34147     ],
34148     "name": "CreateVtiger_Fields",
34149     "group": "Vtiger_Fields",
34150     "parameter": {
34151       "fields": {
34152         "Body": [
34153           {
34154             "group": "Body",
34155             "type": "String",
34156             "allowedValues": [
34157               "\"string\"",
34158               "\"variable\"",
34159               "\"customVariable\"",
34160               "\"keyValue\"",
34161               "\"picklist\""
34162             ],
34163             "optional": true,
34164             "field": "type",
34165             "description": ""
34166           },
34167           {
34168             "group": "Body",
34169             "type": "String",
34170             "optional": true,
34171             "field": "content",
34172             "description": ""
34173           },
34174           {
34175             "group": "Body",
34176             "type": "String",
34177             "optional": true,
34178             "field": "key",
34179             "description": ""
34180           },
34181           {
34182             "group": "Body",
34183             "type": "String",
34184             "allowedValues": [
34185               "\"string\"",
34186               "\"variable\"",
34187               "\"customVariable\""
34188             ],
34189             "optional": true,
34190             "field": "keyType",
34191             "description": ""
34192           },
34193           {
34194             "group": "Body",
34195             "type": "String",
34196             "optional": true,
34197             "field": "keyContent",
34198             "description": ""
34199           },
34200           {
34201             "group": "Body",
34202             "type": "String",
34203             "optional": true,
34204             "field": "idField",
34205             "description": ""
34206           },
34207           {
34208             "group": "Body",
34209             "type": "String",
34210             "optional": true,
34211             "field": "nameField",
34212             "description": ""
34213           },
34214           {
34215             "group": "Body",
34216             "type": "Boolean",
34217             "optional": true,
34218             "field": "customField",
34219             "description": ""
34220           },
34221           {
34222             "group": "Body",
34223             "type": "String",
34224             "optional": true,
34225             "field": "variableName",
34226             "description": ""
34227           }
34228         ]
34229       }
34230     },
34231     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34232     "version": "0.0.0",
34233     "filename": "server/api/intVtigerField/index.js",
34234     "groupTitle": "Vtiger_Fields"
34235   },
34236   {
34237     "type": "delete",
34238     "url": "/api/integrations/vtiger/fields/{id}",
34239     "title": "Deletes a Vtiger Field",
34240     "examples": [
34241       {
34242         "title": "Example usage:",
34243         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34244         "type": "json"
34245       }
34246     ],
34247     "name": "DeleteVtiger_Fields",
34248     "group": "Vtiger_Fields",
34249     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34250     "version": "0.0.0",
34251     "filename": "server/api/intVtigerField/index.js",
34252     "groupTitle": "Vtiger_Fields"
34253   },
34254   {
34255     "type": "get",
34256     "url": "/api/integrations/vtiger/fields",
34257     "title": "Gets a list of Vtiger Fields",
34258     "examples": [
34259       {
34260         "title": "Example usage:",
34261         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34262         "type": "json"
34263       }
34264     ],
34265     "name": "GetVtiger_Fields",
34266     "group": "Vtiger_Fields",
34267     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34268     "version": "0.0.0",
34269     "filename": "server/api/intVtigerField/index.js",
34270     "groupTitle": "Vtiger_Fields"
34271   },
34272   {
34273     "type": "get",
34274     "url": "/api/integrations/vtiger/fields/{id}",
34275     "title": "Gets a single Vtiger Field",
34276     "examples": [
34277       {
34278         "title": "Example usage:",
34279         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34280         "type": "json"
34281       }
34282     ],
34283     "name": "ShowVtiger_Fields",
34284     "group": "Vtiger_Fields",
34285     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34286     "version": "0.0.0",
34287     "filename": "server/api/intVtigerField/index.js",
34288     "groupTitle": "Vtiger_Fields"
34289   },
34290   {
34291     "type": "put",
34292     "url": "/api/integrations/vtiger/fields/{id}",
34293     "title": "Update an existing Vtiger Field",
34294     "examples": [
34295       {
34296         "title": "Example usage:",
34297         "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",
34298         "type": "json"
34299       }
34300     ],
34301     "name": "updateVtiger_Fields",
34302     "group": "Vtiger_Fields",
34303     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34304     "version": "0.0.0",
34305     "filename": "server/api/intVtigerField/index.js",
34306     "groupTitle": "Vtiger_Fields"
34307   },
34308   {
34309     "type": "post",
34310     "url": "/api/webbar/answer",
34311     "title": "answer webrtc call",
34312     "examples": [
34313       {
34314         "title": "Example usage:",
34315         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34316         "type": "json"
34317       }
34318     ],
34319     "name": "Web_Bar_answer",
34320     "group": "WebBar",
34321     "parameter": {
34322       "fields": {
34323         "Body": [
34324           {
34325             "group": "Body",
34326             "type": "String",
34327             "optional": false,
34328             "field": "sessionId",
34329             "description": ""
34330           },
34331           {
34332             "group": "Body",
34333             "type": "number",
34334             "optional": false,
34335             "field": "userId",
34336             "description": ""
34337           }
34338         ]
34339       }
34340     },
34341     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34342     "version": "0.0.0",
34343     "filename": "server/api/webbar/index.js",
34344     "groupTitle": "WebBar"
34345   },
34346   {
34347     "type": "post",
34348     "url": "/api/webbar/calls",
34349     "title": "webrtc call list",
34350     "examples": [
34351       {
34352         "title": "Example usage:",
34353         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34354         "type": "json"
34355       }
34356     ],
34357     "name": "Web_Bar_calls",
34358     "group": "WebBar",
34359     "parameter": {
34360       "fields": {
34361         "Body": [
34362           {
34363             "group": "Body",
34364             "type": "number",
34365             "optional": false,
34366             "field": "userId",
34367             "description": ""
34368           }
34369         ]
34370       }
34371     },
34372     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34373     "version": "0.0.0",
34374     "filename": "server/api/webbar/index.js",
34375     "groupTitle": "WebBar"
34376   },
34377   {
34378     "type": "post",
34379     "url": "/api/webbar/hangup",
34380     "title": "hangup webrtc call",
34381     "examples": [
34382       {
34383         "title": "Example usage:",
34384         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34385         "type": "json"
34386       }
34387     ],
34388     "name": "Web_Bar_hangup",
34389     "group": "WebBar",
34390     "parameter": {
34391       "fields": {
34392         "Body": [
34393           {
34394             "group": "Body",
34395             "type": "String",
34396             "optional": false,
34397             "field": "sessionId",
34398             "description": ""
34399           },
34400           {
34401             "group": "Body",
34402             "type": "number",
34403             "optional": false,
34404             "field": "userId",
34405             "description": ""
34406           }
34407         ]
34408       }
34409     },
34410     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34411     "version": "0.0.0",
34412     "filename": "server/api/webbar/index.js",
34413     "groupTitle": "WebBar"
34414   },
34415   {
34416     "type": "post",
34417     "url": "/api/webbar/unhold",
34418     "title": "unhold webrtc call",
34419     "examples": [
34420       {
34421         "title": "Example usage:",
34422         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34423         "type": "json"
34424       }
34425     ],
34426     "name": "Web_Bar_hold",
34427     "group": "WebBar",
34428     "parameter": {
34429       "fields": {
34430         "Body": [
34431           {
34432             "group": "Body",
34433             "type": "String",
34434             "optional": false,
34435             "field": "sessionId",
34436             "description": ""
34437           },
34438           {
34439             "group": "Body",
34440             "type": "number",
34441             "optional": false,
34442             "field": "userId",
34443             "description": ""
34444           }
34445         ]
34446       }
34447     },
34448     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34449     "version": "0.0.0",
34450     "filename": "server/api/webbar/index.js",
34451     "groupTitle": "WebBar"
34452   },
34453   {
34454     "type": "post",
34455     "url": "/api/webbar/hold",
34456     "title": "hold webrtc call",
34457     "examples": [
34458       {
34459         "title": "Example usage:",
34460         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34461         "type": "json"
34462       }
34463     ],
34464     "name": "Web_Bar_hold",
34465     "group": "WebBar",
34466     "parameter": {
34467       "fields": {
34468         "Body": [
34469           {
34470             "group": "Body",
34471             "type": "String",
34472             "optional": true,
34473             "field": "sessionId",
34474             "description": ""
34475           },
34476           {
34477             "group": "Body",
34478             "type": "number",
34479             "optional": false,
34480             "field": "userId",
34481             "description": ""
34482           }
34483         ]
34484       }
34485     },
34486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34487     "version": "0.0.0",
34488     "filename": "server/api/webbar/index.js",
34489     "groupTitle": "WebBar"
34490   },
34491   {
34492     "type": "post",
34493     "url": "/api/webbar/originate",
34494     "title": "Originate new webrtc call",
34495     "examples": [
34496       {
34497         "title": "Example usage:",
34498         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34499         "type": "json"
34500       }
34501     ],
34502     "name": "Web_Bar_originate",
34503     "group": "WebBar",
34504     "parameter": {
34505       "fields": {
34506         "Body": [
34507           {
34508             "group": "Body",
34509             "type": "String",
34510             "optional": false,
34511             "field": "callNumber",
34512             "description": ""
34513           },
34514           {
34515             "group": "Body",
34516             "type": "number",
34517             "optional": false,
34518             "field": "userId",
34519             "description": ""
34520           },
34521           {
34522             "group": "Body",
34523             "type": "String",
34524             "optional": false,
34525             "field": "callerId",
34526             "description": ""
34527           },
34528           {
34529             "group": "Body",
34530             "type": "String",
34531             "optional": false,
34532             "field": "callbackUrl",
34533             "description": ""
34534           }
34535         ]
34536       }
34537     },
34538     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34539     "version": "0.0.0",
34540     "filename": "server/api/webbar/index.js",
34541     "groupTitle": "WebBar"
34542   },
34543   {
34544     "type": "post",
34545     "url": "/api/webbar/transfer",
34546     "title": "blind transfer webrtc call",
34547     "examples": [
34548       {
34549         "title": "Example usage:",
34550         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34551         "type": "json"
34552       }
34553     ],
34554     "name": "Web_Bar_transfer",
34555     "group": "WebBar",
34556     "parameter": {
34557       "fields": {
34558         "Body": [
34559           {
34560             "group": "Body",
34561             "type": "number",
34562             "optional": false,
34563             "field": "userId",
34564             "description": ""
34565           },
34566           {
34567             "group": "Body",
34568             "type": "string",
34569             "optional": false,
34570             "field": "sessionId",
34571             "description": ""
34572           },
34573           {
34574             "group": "Body",
34575             "type": "string",
34576             "optional": false,
34577             "field": "transferNumber",
34578             "description": ""
34579           }
34580         ]
34581       }
34582     },
34583     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34584     "version": "0.0.0",
34585     "filename": "server/api/webbar/index.js",
34586     "groupTitle": "WebBar"
34587   },
34588   {
34589     "type": "post",
34590     "url": "/api/whatsapp/accounts/{id}/users",
34591     "title": "Add agents to a whatsapp account",
34592     "examples": [
34593       {
34594         "title": "Example usage:",
34595         "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",
34596         "type": "json"
34597       }
34598     ],
34599     "name": "AddAgents",
34600     "group": "Whatsapp_Accounts",
34601     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34602     "version": "0.0.0",
34603     "filename": "server/api/whatsappAccount/index.js",
34604     "groupTitle": "Whatsapp_Accounts"
34605   },
34606   {
34607     "type": "post",
34608     "url": "/api/whatsapp/accounts",
34609     "title": "Creates a new Account",
34610     "examples": [
34611       {
34612         "title": "Example usage:",
34613         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34614         "type": "json"
34615       }
34616     ],
34617     "name": "CreateAccounts",
34618     "group": "Whatsapp_Accounts",
34619     "parameter": {
34620       "fields": {
34621         "Body": [
34622           {
34623             "group": "Body",
34624             "type": "String",
34625             "optional": false,
34626             "field": "name",
34627             "description": ""
34628           },
34629           {
34630             "group": "Body",
34631             "type": "String",
34632             "optional": false,
34633             "field": "key",
34634             "description": ""
34635           },
34636           {
34637             "group": "Body",
34638             "type": "String",
34639             "optional": false,
34640             "field": "remote",
34641             "description": ""
34642           },
34643           {
34644             "group": "Body",
34645             "type": "String",
34646             "optional": true,
34647             "field": "token",
34648             "description": ""
34649           },
34650           {
34651             "group": "Body",
34652             "type": "String",
34653             "optional": true,
34654             "field": "phone",
34655             "description": ""
34656           },
34657           {
34658             "group": "Body",
34659             "type": "String",
34660             "allowedValues": [
34661               "\"twilio\""
34662             ],
34663             "optional": true,
34664             "field": "type",
34665             "description": ""
34666           },
34667           {
34668             "group": "Body",
34669             "type": "String",
34670             "optional": true,
34671             "field": "accountSid",
34672             "description": ""
34673           },
34674           {
34675             "group": "Body",
34676             "type": "String",
34677             "optional": true,
34678             "field": "authToken",
34679             "description": ""
34680           },
34681           {
34682             "group": "Body",
34683             "type": "Text",
34684             "optional": true,
34685             "field": "notificationTemplate",
34686             "description": ""
34687           },
34688           {
34689             "group": "Body",
34690             "type": "Boolean",
34691             "optional": true,
34692             "field": "notificationSound",
34693             "description": ""
34694           },
34695           {
34696             "group": "Body",
34697             "type": "Boolean",
34698             "optional": true,
34699             "field": "notificationShake",
34700             "description": ""
34701           },
34702           {
34703             "group": "Body",
34704             "type": "Integer",
34705             "optional": true,
34706             "field": "waitForTheAssignedAgent",
34707             "description": ""
34708           },
34709           {
34710             "group": "Body",
34711             "type": "Boolean",
34712             "optional": true,
34713             "field": "queueTransfer",
34714             "description": ""
34715           },
34716           {
34717             "group": "Body",
34718             "type": "Integer",
34719             "optional": true,
34720             "field": "queueTransferTimeout",
34721             "description": ""
34722           },
34723           {
34724             "group": "Body",
34725             "type": "Boolean",
34726             "optional": true,
34727             "field": "agentTransfer",
34728             "description": ""
34729           },
34730           {
34731             "group": "Body",
34732             "type": "Integer",
34733             "optional": true,
34734             "field": "agentTransferTimeout",
34735             "description": ""
34736           },
34737           {
34738             "group": "Body",
34739             "type": "Integer",
34740             "optional": true,
34741             "field": "mandatoryDispositionPauseId",
34742             "description": "<p>Status to put when mandatory disposition is enabled</p>"
34743           },
34744           {
34745             "group": "Body",
34746             "type": "Boolean",
34747             "optional": true,
34748             "field": "mandatoryDisposition",
34749             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34750           },
34751           {
34752             "group": "Body",
34753             "type": "String",
34754             "optional": true,
34755             "field": "description",
34756             "description": ""
34757           }
34758         ]
34759       }
34760     },
34761     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34762     "version": "0.0.0",
34763     "filename": "server/api/whatsappAccount/index.js",
34764     "groupTitle": "Whatsapp_Accounts"
34765   },
34766   {
34767     "type": "delete",
34768     "url": "/api/whatsapp/accounts/{id}",
34769     "title": "Deletes a Account",
34770     "examples": [
34771       {
34772         "title": "Example usage:",
34773         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34774         "type": "json"
34775       }
34776     ],
34777     "name": "DeleteAccounts",
34778     "group": "Whatsapp_Accounts",
34779     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34780     "version": "0.0.0",
34781     "filename": "server/api/whatsappAccount/index.js",
34782     "groupTitle": "Whatsapp_Accounts"
34783   },
34784   {
34785     "type": "get",
34786     "url": "/api/whatsapp/accounts/describe",
34787     "title": "Gets table info about Accounts",
34788     "examples": [
34789       {
34790         "title": "Example usage:",
34791         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34792         "type": "json"
34793       }
34794     ],
34795     "name": "DescribeAccounts",
34796     "group": "Whatsapp_Accounts",
34797     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34798     "version": "0.0.0",
34799     "filename": "server/api/whatsappAccount/index.js",
34800     "groupTitle": "Whatsapp_Accounts"
34801   },
34802   {
34803     "type": "get",
34804     "url": "/api/whatsapp/accounts",
34805     "title": "Gets a list of Accounts",
34806     "examples": [
34807       {
34808         "title": "Example usage:",
34809         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34810         "type": "json"
34811       }
34812     ],
34813     "name": "GetAccounts",
34814     "group": "Whatsapp_Accounts",
34815     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34816     "version": "0.0.0",
34817     "filename": "server/api/whatsappAccount/index.js",
34818     "groupTitle": "Whatsapp_Accounts"
34819   },
34820   {
34821     "type": "get",
34822     "url": "/api/whatsapp/accounts/{id}/users",
34823     "title": "Gets agents from whatsapp account",
34824     "examples": [
34825       {
34826         "title": "Example usage:",
34827         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34828         "type": "json"
34829       }
34830     ],
34831     "name": "GetAgents",
34832     "group": "Whatsapp_Accounts",
34833     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34834     "version": "0.0.0",
34835     "filename": "server/api/whatsappAccount/index.js",
34836     "groupTitle": "Whatsapp_Accounts"
34837   },
34838   {
34839     "type": "delete",
34840     "url": "/api/whatsapp/accounts/{id}/users",
34841     "title": "Removes agents from a whatsapp account",
34842     "examples": [
34843       {
34844         "title": "Example usage:",
34845         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34846         "type": "json"
34847       }
34848     ],
34849     "name": "RemoveAgents",
34850     "group": "Whatsapp_Accounts",
34851     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34852     "version": "0.0.0",
34853     "filename": "server/api/whatsappAccount/index.js",
34854     "groupTitle": "Whatsapp_Accounts"
34855   },
34856   {
34857     "type": "delete",
34858     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34859     "title": "Removes canned answers from account",
34860     "examples": [
34861       {
34862         "title": "Example usage:",
34863         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34864         "type": "json"
34865       }
34866     ],
34867     "name": "RemoveAnswers",
34868     "group": "Whatsapp_Accounts",
34869     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34870     "version": "0.0.0",
34871     "filename": "server/api/whatsappAccount/index.js",
34872     "groupTitle": "Whatsapp_Accounts"
34873   },
34874   {
34875     "type": "delete",
34876     "url": "/api/whatsapp/accounts/{id}/dispositions",
34877     "title": "Removes dispositions from account",
34878     "examples": [
34879       {
34880         "title": "Example usage:",
34881         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34882         "type": "json"
34883       }
34884     ],
34885     "name": "RemoveDispositions",
34886     "group": "Whatsapp_Accounts",
34887     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34888     "version": "0.0.0",
34889     "filename": "server/api/whatsappAccount/index.js",
34890     "groupTitle": "Whatsapp_Accounts"
34891   },
34892   {
34893     "type": "get",
34894     "url": "/api/whatsapp/accounts/{id}",
34895     "title": "Gets a single Account",
34896     "examples": [
34897       {
34898         "title": "Example usage:",
34899         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34900         "type": "json"
34901       }
34902     ],
34903     "name": "ShowAccounts",
34904     "group": "Whatsapp_Accounts",
34905     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34906     "version": "0.0.0",
34907     "filename": "server/api/whatsappAccount/index.js",
34908     "groupTitle": "Whatsapp_Accounts"
34909   },
34910   {
34911     "type": "put",
34912     "url": "/api/whatsapp/messages/{id}/accept",
34913     "title": "Accepts message",
34914     "examples": [
34915       {
34916         "title": "Example usage:",
34917         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34918         "type": "json"
34919       }
34920     ],
34921     "name": "acceptMessage",
34922     "group": "Whatsapp_Accounts",
34923     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34924     "version": "0.0.0",
34925     "filename": "server/api/whatsappMessage/index.js",
34926     "groupTitle": "Whatsapp_Accounts"
34927   },
34928   {
34929     "type": "post",
34930     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34931     "title": "Creates new canned answer",
34932     "examples": [
34933       {
34934         "title": "Example usage:",
34935         "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",
34936         "type": "json"
34937       }
34938     ],
34939     "name": "addAnswer",
34940     "group": "Whatsapp_Accounts",
34941     "parameter": {
34942       "fields": {
34943         "Body": [
34944           {
34945             "group": "Body",
34946             "type": "String",
34947             "optional": false,
34948             "field": "key",
34949             "description": ""
34950           },
34951           {
34952             "group": "Body",
34953             "type": "Text",
34954             "optional": false,
34955             "field": "value",
34956             "description": ""
34957           },
34958           {
34959             "group": "Body",
34960             "type": "String",
34961             "optional": true,
34962             "field": "description",
34963             "description": ""
34964           },
34965           {
34966             "group": "Body",
34967             "type": "Virtual",
34968             "optional": true,
34969             "field": "name",
34970             "description": ""
34971           }
34972         ]
34973       }
34974     },
34975     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34976     "version": "0.0.0",
34977     "filename": "server/api/whatsappAccount/index.js",
34978     "groupTitle": "Whatsapp_Accounts"
34979   },
34980   {
34981     "type": "post",
34982     "url": "/api/whatsapp/accounts/{id}/applications",
34983     "title": "Creates new applications",
34984     "examples": [
34985       {
34986         "title": "Example usage:",
34987         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34988         "type": "json"
34989       }
34990     ],
34991     "name": "addApplications",
34992     "group": "Whatsapp_Accounts",
34993     "parameter": {
34994       "fields": {
34995         "Body": [
34996           {
34997             "group": "Body",
34998             "type": "Integer",
34999             "optional": false,
35000             "field": "priority",
35001             "description": ""
35002           },
35003           {
35004             "group": "Body",
35005             "type": "String",
35006             "optional": false,
35007             "field": "app",
35008             "description": ""
35009           },
35010           {
35011             "group": "Body",
35012             "type": "Text",
35013             "optional": true,
35014             "field": "appdata",
35015             "description": ""
35016           },
35017           {
35018             "group": "Body",
35019             "type": "String",
35020             "optional": true,
35021             "field": "description",
35022             "description": ""
35023           },
35024           {
35025             "group": "Body",
35026             "type": "String",
35027             "optional": true,
35028             "field": "interval",
35029             "description": ""
35030           }
35031         ]
35032       }
35033     },
35034     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35035     "version": "0.0.0",
35036     "filename": "server/api/whatsappAccount/index.js",
35037     "groupTitle": "Whatsapp_Accounts"
35038   },
35039   {
35040     "type": "post",
35041     "url": "/api/whatsapp/accounts/{id}/dispositions",
35042     "title": "Creates new disposition",
35043     "examples": [
35044       {
35045         "title": "Example usage:",
35046         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35047         "type": "json"
35048       }
35049     ],
35050     "name": "addDisposition",
35051     "group": "Whatsapp_Accounts",
35052     "parameter": {
35053       "fields": {
35054         "Body": [
35055           {
35056             "group": "Body",
35057             "type": "String",
35058             "optional": false,
35059             "field": "name",
35060             "description": ""
35061           },
35062           {
35063             "group": "Body",
35064             "type": "String",
35065             "allowedValues": [
35066               "\"first\"",
35067               "\"second\"",
35068               "\"third\""
35069             ],
35070             "optional": false,
35071             "field": "level",
35072             "description": ""
35073           },
35074           {
35075             "group": "Body",
35076             "type": "String",
35077             "optional": true,
35078             "field": "description",
35079             "description": ""
35080           }
35081         ]
35082       }
35083     },
35084     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35085     "version": "0.0.0",
35086     "filename": "server/api/whatsappAccount/index.js",
35087     "groupTitle": "Whatsapp_Accounts"
35088   },
35089   {
35090     "type": "get",
35091     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35092     "title": "Gets account canned answers",
35093     "examples": [
35094       {
35095         "title": "Example usage:",
35096         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35097         "type": "json"
35098       }
35099     ],
35100     "name": "getAnswers",
35101     "group": "Whatsapp_Accounts",
35102     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35103     "version": "0.0.0",
35104     "filename": "server/api/whatsappAccount/index.js",
35105     "groupTitle": "Whatsapp_Accounts"
35106   },
35107   {
35108     "type": "get",
35109     "url": "/api/whatsapp/accounts/{id}/applications",
35110     "title": "Gets account applications",
35111     "examples": [
35112       {
35113         "title": "Example usage:",
35114         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35115         "type": "json"
35116       }
35117     ],
35118     "name": "getApplications",
35119     "group": "Whatsapp_Accounts",
35120     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35121     "version": "0.0.0",
35122     "filename": "server/api/whatsappAccount/index.js",
35123     "groupTitle": "Whatsapp_Accounts"
35124   },
35125   {
35126     "type": "get",
35127     "url": "/api/whatsapp/accounts/{id}/dispositions",
35128     "title": "Gets account dispositions",
35129     "examples": [
35130       {
35131         "title": "Example usage:",
35132         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35133         "type": "json"
35134       }
35135     ],
35136     "name": "getDispositions",
35137     "group": "Whatsapp_Accounts",
35138     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35139     "version": "0.0.0",
35140     "filename": "server/api/whatsappAccount/index.js",
35141     "groupTitle": "Whatsapp_Accounts"
35142   },
35143   {
35144     "type": "post",
35145     "url": "/api/whatsapp/accounts/{id}/notify",
35146     "title": "Notify new message",
35147     "examples": [
35148       {
35149         "title": "Example usage:",
35150         "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",
35151         "type": "json"
35152       }
35153     ],
35154     "name": "notify",
35155     "group": "Whatsapp_Accounts",
35156     "description": "<p>Motion 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>",
35157     "version": "0.0.0",
35158     "filename": "server/api/whatsappAccount/index.js",
35159     "groupTitle": "Whatsapp_Accounts"
35160   },
35161   {
35162     "type": "put",
35163     "url": "/api/whatsapp/messages/{id}/reject",
35164     "title": "Rejects message",
35165     "examples": [
35166       {
35167         "title": "Example usage:",
35168         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35169         "type": "json"
35170       }
35171     ],
35172     "name": "rejectMessage",
35173     "group": "Whatsapp_Accounts",
35174     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35175     "version": "0.0.0",
35176     "filename": "server/api/whatsappMessage/index.js",
35177     "groupTitle": "Whatsapp_Accounts"
35178   },
35179   {
35180     "type": "post",
35181     "url": "/api/whatsapp/accounts/{id}/send",
35182     "title": "Send new whatsapp message",
35183     "examples": [
35184       {
35185         "title": "Example usage:",
35186         "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",
35187         "type": "json"
35188       }
35189     ],
35190     "name": "sendWhatsapp",
35191     "group": "Whatsapp_Accounts",
35192     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35193     "version": "0.0.0",
35194     "filename": "server/api/whatsappAccount/index.js",
35195     "groupTitle": "Whatsapp_Accounts"
35196   },
35197   {
35198     "type": "post",
35199     "url": "/api/whatsapp/messages/{id}/status",
35200     "title": "Receive message status",
35201     "examples": [
35202       {
35203         "title": "Example usage:",
35204         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35205         "type": "json"
35206       }
35207     ],
35208     "name": "statusMessage",
35209     "group": "Whatsapp_Accounts",
35210     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35211     "version": "0.0.0",
35212     "filename": "server/api/whatsappMessage/index.js",
35213     "groupTitle": "Whatsapp_Accounts"
35214   },
35215   {
35216     "type": "put",
35217     "url": "/api/whatsapp/accounts/{id}",
35218     "title": "Update an existing Account",
35219     "examples": [
35220       {
35221         "title": "Example usage:",
35222         "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",
35223         "type": "json"
35224       }
35225     ],
35226     "name": "updateAccounts",
35227     "group": "Whatsapp_Accounts",
35228     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35229     "version": "0.0.0",
35230     "filename": "server/api/whatsappAccount/index.js",
35231     "groupTitle": "Whatsapp_Accounts"
35232   },
35233   {
35234     "type": "post",
35235     "url": "/api/whatsapp/applications",
35236     "title": "Creates a new Application",
35237     "examples": [
35238       {
35239         "title": "Example usage:",
35240         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35241         "type": "json"
35242       }
35243     ],
35244     "name": "CreateApplications",
35245     "group": "Whatsapp_Applications",
35246     "parameter": {
35247       "fields": {
35248         "Body": [
35249           {
35250             "group": "Body",
35251             "type": "Integer",
35252             "optional": false,
35253             "field": "priority",
35254             "description": ""
35255           },
35256           {
35257             "group": "Body",
35258             "type": "String",
35259             "optional": false,
35260             "field": "app",
35261             "description": ""
35262           },
35263           {
35264             "group": "Body",
35265             "type": "Text",
35266             "optional": true,
35267             "field": "appdata",
35268             "description": ""
35269           },
35270           {
35271             "group": "Body",
35272             "type": "String",
35273             "optional": true,
35274             "field": "description",
35275             "description": ""
35276           },
35277           {
35278             "group": "Body",
35279             "type": "String",
35280             "optional": true,
35281             "field": "interval",
35282             "description": ""
35283           }
35284         ]
35285       }
35286     },
35287     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35288     "version": "0.0.0",
35289     "filename": "server/api/whatsappApplication/index.js",
35290     "groupTitle": "Whatsapp_Applications"
35291   },
35292   {
35293     "type": "delete",
35294     "url": "/api/whatsapp/applications/{id}",
35295     "title": "Deletes a Application",
35296     "examples": [
35297       {
35298         "title": "Example usage:",
35299         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35300         "type": "json"
35301       }
35302     ],
35303     "name": "DeleteApplications",
35304     "group": "Whatsapp_Applications",
35305     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35306     "version": "0.0.0",
35307     "filename": "server/api/whatsappApplication/index.js",
35308     "groupTitle": "Whatsapp_Applications"
35309   },
35310   {
35311     "type": "get",
35312     "url": "/api/whatsapp/applications",
35313     "title": "Gets a list of Applications",
35314     "examples": [
35315       {
35316         "title": "Example usage:",
35317         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35318         "type": "json"
35319       }
35320     ],
35321     "name": "GetApplications",
35322     "group": "Whatsapp_Applications",
35323     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35324     "version": "0.0.0",
35325     "filename": "server/api/whatsappApplication/index.js",
35326     "groupTitle": "Whatsapp_Applications"
35327   },
35328   {
35329     "type": "get",
35330     "url": "/api/whatsapp/applications/{id}",
35331     "title": "Gets a single Application",
35332     "examples": [
35333       {
35334         "title": "Example usage:",
35335         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35336         "type": "json"
35337       }
35338     ],
35339     "name": "ShowApplications",
35340     "group": "Whatsapp_Applications",
35341     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35342     "version": "0.0.0",
35343     "filename": "server/api/whatsappApplication/index.js",
35344     "groupTitle": "Whatsapp_Applications"
35345   },
35346   {
35347     "type": "put",
35348     "url": "/api/whatsapp/applications/{id}",
35349     "title": "Update an existing Application",
35350     "examples": [
35351       {
35352         "title": "Example usage:",
35353         "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",
35354         "type": "json"
35355       }
35356     ],
35357     "name": "updateApplications",
35358     "group": "Whatsapp_Applications",
35359     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35360     "version": "0.0.0",
35361     "filename": "server/api/whatsappApplication/index.js",
35362     "groupTitle": "Whatsapp_Applications"
35363   },
35364   {
35365     "type": "post",
35366     "url": "/api/whatsapp/interactions/{id}/tags",
35367     "title": "Add tags to the interaction",
35368     "examples": [
35369       {
35370         "title": "Example usage:",
35371         "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",
35372         "type": "json"
35373       }
35374     ],
35375     "name": "AddTags",
35376     "group": "Whatsapp_Interactions",
35377     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35378     "version": "0.0.0",
35379     "filename": "server/api/whatsappInteraction/index.js",
35380     "groupTitle": "Whatsapp_Interactions"
35381   },
35382   {
35383     "type": "post",
35384     "url": "/api/whatsapp/interactions",
35385     "title": "Creates a new Interaction",
35386     "examples": [
35387       {
35388         "title": "Example usage:",
35389         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35390         "type": "json"
35391       }
35392     ],
35393     "name": "CreateInteractions",
35394     "group": "Whatsapp_Interactions",
35395     "parameter": {
35396       "fields": {
35397         "Body": [
35398           {
35399             "group": "Body",
35400             "type": "Boolean",
35401             "optional": true,
35402             "field": "closed",
35403             "description": ""
35404           },
35405           {
35406             "group": "Body",
35407             "type": "String",
35408             "optional": true,
35409             "field": "closedAt",
35410             "description": ""
35411           },
35412           {
35413             "group": "Body",
35414             "type": "String",
35415             "optional": true,
35416             "field": "disposition",
35417             "description": ""
35418           },
35419           {
35420             "group": "Body",
35421             "type": "String",
35422             "optional": true,
35423             "field": "secondDisposition",
35424             "description": ""
35425           },
35426           {
35427             "group": "Body",
35428             "type": "String",
35429             "optional": true,
35430             "field": "thirdDisposition",
35431             "description": ""
35432           },
35433           {
35434             "group": "Body",
35435             "type": "String",
35436             "optional": true,
35437             "field": "note",
35438             "description": ""
35439           },
35440           {
35441             "group": "Body",
35442             "type": "String",
35443             "optional": true,
35444             "field": "phone",
35445             "description": ""
35446           },
35447           {
35448             "group": "Body",
35449             "type": "String",
35450             "optional": true,
35451             "field": "read1stAt",
35452             "description": ""
35453           },
35454           {
35455             "group": "Body",
35456             "type": "String",
35457             "allowedValues": [
35458               "\"in\"",
35459               "\"out\""
35460             ],
35461             "optional": false,
35462             "field": "firstMsgDirection",
35463             "description": ""
35464           },
35465           {
35466             "group": "Body",
35467             "type": "String",
35468             "optional": true,
35469             "field": "lastMsgAt",
35470             "description": ""
35471           },
35472           {
35473             "group": "Body",
35474             "type": "String",
35475             "allowedValues": [
35476               "\"in\"",
35477               "\"out\""
35478             ],
35479             "optional": false,
35480             "field": "lastMsgDirection",
35481             "description": ""
35482           },
35483           {
35484             "group": "Body",
35485             "type": "Boolean",
35486             "optional": true,
35487             "field": "autoreplyExecuted",
35488             "description": ""
35489           }
35490         ]
35491       }
35492     },
35493     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35494     "version": "0.0.0",
35495     "filename": "server/api/whatsappInteraction/index.js",
35496     "groupTitle": "Whatsapp_Interactions"
35497   },
35498   {
35499     "type": "delete",
35500     "url": "/api/whatsapp/interactions/{id}",
35501     "title": "Deletes a Interaction",
35502     "examples": [
35503       {
35504         "title": "Example usage:",
35505         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35506         "type": "json"
35507       }
35508     ],
35509     "name": "DeleteInteractions",
35510     "group": "Whatsapp_Interactions",
35511     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35512     "version": "0.0.0",
35513     "filename": "server/api/whatsappInteraction/index.js",
35514     "groupTitle": "Whatsapp_Interactions"
35515   },
35516   {
35517     "type": "get",
35518     "url": "/api/whatsapp/interactions/describe",
35519     "title": "Gets table info about Interactions",
35520     "examples": [
35521       {
35522         "title": "Example usage:",
35523         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35524         "type": "json"
35525       }
35526     ],
35527     "name": "DescribeInteractions",
35528     "group": "Whatsapp_Interactions",
35529     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35530     "version": "0.0.0",
35531     "filename": "server/api/whatsappInteraction/index.js",
35532     "groupTitle": "Whatsapp_Interactions"
35533   },
35534   {
35535     "type": "get",
35536     "url": "/api/whatsapp/interactions",
35537     "title": "Gets a list of Interactions",
35538     "examples": [
35539       {
35540         "title": "Example usage:",
35541         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35542         "type": "json"
35543       }
35544     ],
35545     "name": "GetInteractions",
35546     "group": "Whatsapp_Interactions",
35547     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35548     "version": "0.0.0",
35549     "filename": "server/api/whatsappInteraction/index.js",
35550     "groupTitle": "Whatsapp_Interactions"
35551   },
35552   {
35553     "type": "delete",
35554     "url": "/api/whatsapp/interactions/{id}/tags",
35555     "title": "Removes tags from interaction",
35556     "examples": [
35557       {
35558         "title": "Example usage:",
35559         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35560         "type": "json"
35561       }
35562     ],
35563     "name": "RemoveTags",
35564     "group": "Whatsapp_Interactions",
35565     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35566     "version": "0.0.0",
35567     "filename": "server/api/whatsappInteraction/index.js",
35568     "groupTitle": "Whatsapp_Interactions"
35569   },
35570   {
35571     "type": "get",
35572     "url": "/api/whatsapp/interactions/{id}",
35573     "title": "Gets a single Interaction",
35574     "examples": [
35575       {
35576         "title": "Example usage:",
35577         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35578         "type": "json"
35579       }
35580     ],
35581     "name": "ShowInteractions",
35582     "group": "Whatsapp_Interactions",
35583     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35584     "version": "0.0.0",
35585     "filename": "server/api/whatsappInteraction/index.js",
35586     "groupTitle": "Whatsapp_Interactions"
35587   },
35588   {
35589     "type": "post",
35590     "url": "/api/whatsapp/interactions/{id}/messages",
35591     "title": "Creates new messages",
35592     "examples": [
35593       {
35594         "title": "Example usage:",
35595         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35596         "type": "json"
35597       }
35598     ],
35599     "name": "addMessage",
35600     "group": "Whatsapp_Interactions",
35601     "parameter": {
35602       "fields": {
35603         "Body": [
35604           {
35605             "group": "Body",
35606             "type": "Text",
35607             "optional": false,
35608             "field": "body",
35609             "description": ""
35610           },
35611           {
35612             "group": "Body",
35613             "type": "Boolean",
35614             "optional": true,
35615             "field": "read",
35616             "description": ""
35617           },
35618           {
35619             "group": "Body",
35620             "type": "String",
35621             "allowedValues": [
35622               "\"in\"",
35623               "\"out\""
35624             ],
35625             "optional": false,
35626             "field": "direction",
35627             "description": ""
35628           },
35629           {
35630             "group": "Body",
35631             "type": "String",
35632             "optional": true,
35633             "field": "messageId",
35634             "description": ""
35635           },
35636           {
35637             "group": "Body",
35638             "type": "String",
35639             "optional": true,
35640             "field": "phone",
35641             "description": ""
35642           },
35643           {
35644             "group": "Body",
35645             "type": "String",
35646             "optional": true,
35647             "field": "readAt",
35648             "description": ""
35649           },
35650           {
35651             "group": "Body",
35652             "type": "Boolean",
35653             "optional": true,
35654             "field": "secret",
35655             "description": ""
35656           },
35657           {
35658             "group": "Body",
35659             "type": "String",
35660             "optional": true,
35661             "field": "providerName",
35662             "description": ""
35663           },
35664           {
35665             "group": "Body",
35666             "type": "Text",
35667             "optional": true,
35668             "field": "providerResponse",
35669             "description": ""
35670           }
35671         ]
35672       }
35673     },
35674     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35675     "version": "0.0.0",
35676     "filename": "server/api/whatsappInteraction/index.js",
35677     "groupTitle": "Whatsapp_Interactions"
35678   },
35679   {
35680     "type": "get",
35681     "url": "/api/whatsapp/interactions/{id}/download",
35682     "title": "Gets interaction",
35683     "examples": [
35684       {
35685         "title": "Example usage:",
35686         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35687         "type": "json"
35688       }
35689     ],
35690     "name": "download",
35691     "group": "Whatsapp_Interactions",
35692     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35693     "version": "0.0.0",
35694     "filename": "server/api/whatsappInteraction/index.js",
35695     "groupTitle": "Whatsapp_Interactions"
35696   },
35697   {
35698     "type": "get",
35699     "url": "/api/whatsapp/interactions/{id}/messages",
35700     "title": "Gets interaction messages",
35701     "examples": [
35702       {
35703         "title": "Example usage:",
35704         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35705         "type": "json"
35706       }
35707     ],
35708     "name": "getMessages",
35709     "group": "Whatsapp_Interactions",
35710     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35711     "version": "0.0.0",
35712     "filename": "server/api/whatsappInteraction/index.js",
35713     "groupTitle": "Whatsapp_Interactions"
35714   },
35715   {
35716     "type": "put",
35717     "url": "/api/whatsapp/interactions/{id}",
35718     "title": "Update an existing Interaction",
35719     "examples": [
35720       {
35721         "title": "Example usage:",
35722         "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",
35723         "type": "json"
35724       }
35725     ],
35726     "name": "updateInteractions",
35727     "group": "Whatsapp_Interactions",
35728     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35729     "version": "0.0.0",
35730     "filename": "server/api/whatsappInteraction/index.js",
35731     "groupTitle": "Whatsapp_Interactions"
35732   },
35733   {
35734     "type": "post",
35735     "url": "/api/whatsapp/messages",
35736     "title": "Creates a new Message",
35737     "examples": [
35738       {
35739         "title": "Example usage:",
35740         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35741         "type": "json"
35742       }
35743     ],
35744     "name": "CreateMessages",
35745     "group": "Whatsapp_Messages",
35746     "parameter": {
35747       "fields": {
35748         "Body": [
35749           {
35750             "group": "Body",
35751             "type": "Text",
35752             "optional": false,
35753             "field": "body",
35754             "description": ""
35755           },
35756           {
35757             "group": "Body",
35758             "type": "Boolean",
35759             "optional": true,
35760             "field": "read",
35761             "description": ""
35762           },
35763           {
35764             "group": "Body",
35765             "type": "String",
35766             "allowedValues": [
35767               "\"in\"",
35768               "\"out\""
35769             ],
35770             "optional": false,
35771             "field": "direction",
35772             "description": ""
35773           },
35774           {
35775             "group": "Body",
35776             "type": "String",
35777             "optional": true,
35778             "field": "messageId",
35779             "description": ""
35780           },
35781           {
35782             "group": "Body",
35783             "type": "String",
35784             "optional": true,
35785             "field": "phone",
35786             "description": ""
35787           },
35788           {
35789             "group": "Body",
35790             "type": "String",
35791             "optional": true,
35792             "field": "readAt",
35793             "description": ""
35794           },
35795           {
35796             "group": "Body",
35797             "type": "Boolean",
35798             "optional": true,
35799             "field": "secret",
35800             "description": ""
35801           },
35802           {
35803             "group": "Body",
35804             "type": "String",
35805             "optional": true,
35806             "field": "providerName",
35807             "description": ""
35808           },
35809           {
35810             "group": "Body",
35811             "type": "Text",
35812             "optional": true,
35813             "field": "providerResponse",
35814             "description": ""
35815           }
35816         ]
35817       }
35818     },
35819     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35820     "version": "0.0.0",
35821     "filename": "server/api/whatsappMessage/index.js",
35822     "groupTitle": "Whatsapp_Messages"
35823   },
35824   {
35825     "type": "delete",
35826     "url": "/api/whatsapp/messages/{id}",
35827     "title": "Deletes a Message",
35828     "examples": [
35829       {
35830         "title": "Example usage:",
35831         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35832         "type": "json"
35833       }
35834     ],
35835     "name": "DeleteMessages",
35836     "group": "Whatsapp_Messages",
35837     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35838     "version": "0.0.0",
35839     "filename": "server/api/whatsappMessage/index.js",
35840     "groupTitle": "Whatsapp_Messages"
35841   },
35842   {
35843     "type": "get",
35844     "url": "/api/whatsapp/messages/describe",
35845     "title": "Gets table info about Messages",
35846     "examples": [
35847       {
35848         "title": "Example usage:",
35849         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35850         "type": "json"
35851       }
35852     ],
35853     "name": "DescribeMessages",
35854     "group": "Whatsapp_Messages",
35855     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35856     "version": "0.0.0",
35857     "filename": "server/api/whatsappMessage/index.js",
35858     "groupTitle": "Whatsapp_Messages"
35859   },
35860   {
35861     "type": "get",
35862     "url": "/api/whatsapp/messages",
35863     "title": "Gets a list of Messages",
35864     "examples": [
35865       {
35866         "title": "Example usage:",
35867         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35868         "type": "json"
35869       }
35870     ],
35871     "name": "GetMessages",
35872     "group": "Whatsapp_Messages",
35873     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35874     "version": "0.0.0",
35875     "filename": "server/api/whatsappMessage/index.js",
35876     "groupTitle": "Whatsapp_Messages"
35877   },
35878   {
35879     "type": "get",
35880     "url": "/api/whatsapp/messages/{id}",
35881     "title": "Gets a single Message",
35882     "examples": [
35883       {
35884         "title": "Example usage:",
35885         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35886         "type": "json"
35887       }
35888     ],
35889     "name": "ShowMessages",
35890     "group": "Whatsapp_Messages",
35891     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35892     "version": "0.0.0",
35893     "filename": "server/api/whatsappMessage/index.js",
35894     "groupTitle": "Whatsapp_Messages"
35895   },
35896   {
35897     "type": "put",
35898     "url": "/api/whatsapp/messages/{id}",
35899     "title": "Update an existing Message",
35900     "examples": [
35901       {
35902         "title": "Example usage:",
35903         "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",
35904         "type": "json"
35905       }
35906     ],
35907     "name": "updateMessages",
35908     "group": "Whatsapp_Messages",
35909     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35910     "version": "0.0.0",
35911     "filename": "server/api/whatsappMessage/index.js",
35912     "groupTitle": "Whatsapp_Messages"
35913   },
35914   {
35915     "type": "post",
35916     "url": "/api/whatsapp/reports/queue",
35917     "title": "Creates a new Whatsapp Queue Report",
35918     "examples": [
35919       {
35920         "title": "Example usage:",
35921         "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",
35922         "type": "json"
35923       }
35924     ],
35925     "name": "CreateWhatsapp_Queue_Reports",
35926     "group": "Whatsapp_Queue_Reports",
35927     "parameter": {
35928       "fields": {
35929         "Body": [
35930           {
35931             "group": "Body",
35932             "type": "String",
35933             "optional": false,
35934             "field": "uniqueid",
35935             "description": ""
35936           },
35937           {
35938             "group": "Body",
35939             "type": "String",
35940             "optional": true,
35941             "field": "from",
35942             "description": ""
35943           },
35944           {
35945             "group": "Body",
35946             "type": "String",
35947             "optional": true,
35948             "field": "joinAt",
35949             "description": ""
35950           },
35951           {
35952             "group": "Body",
35953             "type": "String",
35954             "optional": true,
35955             "field": "leaveAt",
35956             "description": ""
35957           },
35958           {
35959             "group": "Body",
35960             "type": "String",
35961             "optional": true,
35962             "field": "acceptAt",
35963             "description": ""
35964           },
35965           {
35966             "group": "Body",
35967             "type": "String",
35968             "optional": true,
35969             "field": "exitAt",
35970             "description": ""
35971           },
35972           {
35973             "group": "Body",
35974             "type": "String",
35975             "optional": true,
35976             "field": "reason",
35977             "description": ""
35978           }
35979         ]
35980       }
35981     },
35982     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35983     "version": "0.0.0",
35984     "filename": "server/api/whatsappQueueReport/index.js",
35985     "groupTitle": "Whatsapp_Queue_Reports"
35986   },
35987   {
35988     "type": "delete",
35989     "url": "/api/whatsapp/reports/queue/{id}",
35990     "title": "Deletes a Whatsapp Queue Report",
35991     "examples": [
35992       {
35993         "title": "Example usage:",
35994         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
35995         "type": "json"
35996       }
35997     ],
35998     "name": "DeleteWhatsapp_Queue_Reports",
35999     "group": "Whatsapp_Queue_Reports",
36000     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36001     "version": "0.0.0",
36002     "filename": "server/api/whatsappQueueReport/index.js",
36003     "groupTitle": "Whatsapp_Queue_Reports"
36004   },
36005   {
36006     "type": "get",
36007     "url": "/api/whatsapp/reports/queue/describe",
36008     "title": "Gets table info about Whatsapp Queue Reports",
36009     "examples": [
36010       {
36011         "title": "Example usage:",
36012         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36013         "type": "json"
36014       }
36015     ],
36016     "name": "DescribeWhatsapp_Queue_Reports",
36017     "group": "Whatsapp_Queue_Reports",
36018     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36019     "version": "0.0.0",
36020     "filename": "server/api/whatsappQueueReport/index.js",
36021     "groupTitle": "Whatsapp_Queue_Reports"
36022   },
36023   {
36024     "type": "get",
36025     "url": "/api/whatsapp/reports/queue",
36026     "title": "Gets a list of Whatsapp Queue Reports",
36027     "examples": [
36028       {
36029         "title": "Example usage:",
36030         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36031         "type": "json"
36032       }
36033     ],
36034     "name": "GetWhatsapp_Queue_Reports",
36035     "group": "Whatsapp_Queue_Reports",
36036     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36037     "version": "0.0.0",
36038     "filename": "server/api/whatsappQueueReport/index.js",
36039     "groupTitle": "Whatsapp_Queue_Reports"
36040   },
36041   {
36042     "type": "get",
36043     "url": "/api/whatsapp/reports/queue/{id}",
36044     "title": "Gets a single Whatsapp Queue Report",
36045     "examples": [
36046       {
36047         "title": "Example usage:",
36048         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36049         "type": "json"
36050       }
36051     ],
36052     "name": "ShowWhatsapp_Queue_Reports",
36053     "group": "Whatsapp_Queue_Reports",
36054     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36055     "version": "0.0.0",
36056     "filename": "server/api/whatsappQueueReport/index.js",
36057     "groupTitle": "Whatsapp_Queue_Reports"
36058   },
36059   {
36060     "type": "put",
36061     "url": "/api/whatsapp/reports/queue/{id}",
36062     "title": "Update an existing Whatsapp Queue Report",
36063     "examples": [
36064       {
36065         "title": "Example usage:",
36066         "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",
36067         "type": "json"
36068       }
36069     ],
36070     "name": "updateWhatsapp_Queue_Reports",
36071     "group": "Whatsapp_Queue_Reports",
36072     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36073     "version": "0.0.0",
36074     "filename": "server/api/whatsappQueueReport/index.js",
36075     "groupTitle": "Whatsapp_Queue_Reports"
36076   },
36077   {
36078     "type": "post",
36079     "url": "/api/whatsapp/queues/{id}/users",
36080     "title": "Add agents to a queue",
36081     "examples": [
36082       {
36083         "title": "Example usage:",
36084         "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",
36085         "type": "json"
36086       }
36087     ],
36088     "name": "AddAgents",
36089     "group": "Whatsapp_Queues",
36090     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36091     "version": "0.0.0",
36092     "filename": "server/api/whatsappQueue/index.js",
36093     "groupTitle": "Whatsapp_Queues"
36094   },
36095   {
36096     "type": "post",
36097     "url": "/api/whatsapp/queues/{id}/teams",
36098     "title": "Add teams to a queue",
36099     "examples": [
36100       {
36101         "title": "Example usage:",
36102         "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",
36103         "type": "json"
36104       }
36105     ],
36106     "name": "AddTeams",
36107     "group": "Whatsapp_Queues",
36108     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36109     "version": "0.0.0",
36110     "filename": "server/api/whatsappQueue/index.js",
36111     "groupTitle": "Whatsapp_Queues"
36112   },
36113   {
36114     "type": "post",
36115     "url": "/api/whatsapp/queues",
36116     "title": "Creates a new Queue",
36117     "examples": [
36118       {
36119         "title": "Example usage:",
36120         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36121         "type": "json"
36122       }
36123     ],
36124     "name": "CreateQueues",
36125     "group": "Whatsapp_Queues",
36126     "parameter": {
36127       "fields": {
36128         "Body": [
36129           {
36130             "group": "Body",
36131             "type": "String",
36132             "optional": true,
36133             "field": "name",
36134             "description": ""
36135           },
36136           {
36137             "group": "Body",
36138             "type": "Integer",
36139             "optional": true,
36140             "field": "timeout",
36141             "description": ""
36142           },
36143           {
36144             "group": "Body",
36145             "type": "String",
36146             "allowedValues": [
36147               "\"rrmemory\"",
36148               "\"beepall\"",
36149               "\"roundrobin\""
36150             ],
36151             "optional": true,
36152             "field": "strategy",
36153             "description": ""
36154           },
36155           {
36156             "group": "Body",
36157             "type": "String",
36158             "optional": true,
36159             "field": "description",
36160             "description": ""
36161           }
36162         ]
36163       }
36164     },
36165     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36166     "version": "0.0.0",
36167     "filename": "server/api/whatsappQueue/index.js",
36168     "groupTitle": "Whatsapp_Queues"
36169   },
36170   {
36171     "type": "delete",
36172     "url": "/api/whatsapp/queues/{id}",
36173     "title": "Deletes a Queue",
36174     "examples": [
36175       {
36176         "title": "Example usage:",
36177         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36178         "type": "json"
36179       }
36180     ],
36181     "name": "DeleteQueues",
36182     "group": "Whatsapp_Queues",
36183     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36184     "version": "0.0.0",
36185     "filename": "server/api/whatsappQueue/index.js",
36186     "groupTitle": "Whatsapp_Queues"
36187   },
36188   {
36189     "type": "get",
36190     "url": "/api/whatsapp/queues/describe",
36191     "title": "Gets table info about Queues",
36192     "examples": [
36193       {
36194         "title": "Example usage:",
36195         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36196         "type": "json"
36197       }
36198     ],
36199     "name": "DescribeQueues",
36200     "group": "Whatsapp_Queues",
36201     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36202     "version": "0.0.0",
36203     "filename": "server/api/whatsappQueue/index.js",
36204     "groupTitle": "Whatsapp_Queues"
36205   },
36206   {
36207     "type": "get",
36208     "url": "/api/whatsapp/queues/{id}/users",
36209     "title": "Gets queue agents",
36210     "examples": [
36211       {
36212         "title": "Example usage:",
36213         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36214         "type": "json"
36215       }
36216     ],
36217     "name": "GetAgents",
36218     "group": "Whatsapp_Queues",
36219     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36220     "version": "0.0.0",
36221     "filename": "server/api/whatsappQueue/index.js",
36222     "groupTitle": "Whatsapp_Queues"
36223   },
36224   {
36225     "type": "get",
36226     "url": "/api/whatsapp/queues/{id}/members",
36227     "title": "GetMembers",
36228     "examples": [
36229       {
36230         "title": "Example usage:",
36231         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
36232         "type": "json"
36233       }
36234     ],
36235     "name": "GetMembers",
36236     "group": "Whatsapp_Queues",
36237     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36238     "version": "0.0.0",
36239     "filename": "server/api/whatsappQueue/index.js",
36240     "groupTitle": "Whatsapp_Queues"
36241   },
36242   {
36243     "type": "get",
36244     "url": "/api/whatsapp/queues",
36245     "title": "Gets a list of Queues",
36246     "examples": [
36247       {
36248         "title": "Example usage:",
36249         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36250         "type": "json"
36251       }
36252     ],
36253     "name": "GetQueues",
36254     "group": "Whatsapp_Queues",
36255     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36256     "version": "0.0.0",
36257     "filename": "server/api/whatsappQueue/index.js",
36258     "groupTitle": "Whatsapp_Queues"
36259   },
36260   {
36261     "type": "get",
36262     "url": "/api/whatsapp/queues/{id}/teams",
36263     "title": "Gets queues list",
36264     "examples": [
36265       {
36266         "title": "Example usage:",
36267         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36268         "type": "json"
36269       }
36270     ],
36271     "name": "GetTeams",
36272     "group": "Whatsapp_Queues",
36273     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36274     "version": "0.0.0",
36275     "filename": "server/api/whatsappQueue/index.js",
36276     "groupTitle": "Whatsapp_Queues"
36277   },
36278   {
36279     "type": "delete",
36280     "url": "/api/whatsapp/queues/{id}/users",
36281     "title": "Removes agents from a queue",
36282     "examples": [
36283       {
36284         "title": "Example usage:",
36285         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36286         "type": "json"
36287       }
36288     ],
36289     "name": "RemoveAgents",
36290     "group": "Whatsapp_Queues",
36291     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36292     "version": "0.0.0",
36293     "filename": "server/api/whatsappQueue/index.js",
36294     "groupTitle": "Whatsapp_Queues"
36295   },
36296   {
36297     "type": "get",
36298     "url": "/api/whatsapp/queues/{id}",
36299     "title": "Gets a single Queue",
36300     "examples": [
36301       {
36302         "title": "Example usage:",
36303         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36304         "type": "json"
36305       }
36306     ],
36307     "name": "ShowQueues",
36308     "group": "Whatsapp_Queues",
36309     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36310     "version": "0.0.0",
36311     "filename": "server/api/whatsappQueue/index.js",
36312     "groupTitle": "Whatsapp_Queues"
36313   },
36314   {
36315     "type": "put",
36316     "url": "/api/whatsapp/queues/{id}",
36317     "title": "Update an existing Queue",
36318     "examples": [
36319       {
36320         "title": "Example usage:",
36321         "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",
36322         "type": "json"
36323       }
36324     ],
36325     "name": "updateQueues",
36326     "group": "Whatsapp_Queues",
36327     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36328     "version": "0.0.0",
36329     "filename": "server/api/whatsappQueue/index.js",
36330     "groupTitle": "Whatsapp_Queues"
36331   },
36332   {
36333     "type": "post",
36334     "url": "/api/whatsapp/reports/transfer",
36335     "title": "Creates a new Whatsapp Transfer Report",
36336     "examples": [
36337       {
36338         "title": "Example usage:",
36339         "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",
36340         "type": "json"
36341       }
36342     ],
36343     "name": "CreateWhatsapp_Transfer_Reports",
36344     "group": "Whatsapp_Transfer_Reports",
36345     "parameter": {
36346       "fields": {
36347         "Body": [
36348           {
36349             "group": "Body",
36350             "type": "String",
36351             "optional": false,
36352             "field": "uniqueid",
36353             "description": ""
36354           },
36355           {
36356             "group": "Body",
36357             "type": "String",
36358             "allowedValues": [
36359               "\"account\"",
36360               "\"agent\"",
36361               "\"queue\""
36362             ],
36363             "optional": false,
36364             "field": "type",
36365             "description": ""
36366           },
36367           {
36368             "group": "Body",
36369             "type": "String",
36370             "optional": true,
36371             "field": "transferredAt",
36372             "description": ""
36373           }
36374         ]
36375       }
36376     },
36377     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36378     "version": "0.0.0",
36379     "filename": "server/api/whatsappTransferReport/index.js",
36380     "groupTitle": "Whatsapp_Transfer_Reports"
36381   },
36382   {
36383     "type": "delete",
36384     "url": "/api/whatsapp/reports/transfer/{id}",
36385     "title": "Deletes a Whatsapp Transfer Report",
36386     "examples": [
36387       {
36388         "title": "Example usage:",
36389         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36390         "type": "json"
36391       }
36392     ],
36393     "name": "DeleteWhatsapp_Transfer_Reports",
36394     "group": "Whatsapp_Transfer_Reports",
36395     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36396     "version": "0.0.0",
36397     "filename": "server/api/whatsappTransferReport/index.js",
36398     "groupTitle": "Whatsapp_Transfer_Reports"
36399   },
36400   {
36401     "type": "get",
36402     "url": "/api/whatsapp/reports/transfer/describe",
36403     "title": "Gets table info about Whatsapp Transfer Reports",
36404     "examples": [
36405       {
36406         "title": "Example usage:",
36407         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36408         "type": "json"
36409       }
36410     ],
36411     "name": "DescribeWhatsapp_Transfer_Reports",
36412     "group": "Whatsapp_Transfer_Reports",
36413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36414     "version": "0.0.0",
36415     "filename": "server/api/whatsappTransferReport/index.js",
36416     "groupTitle": "Whatsapp_Transfer_Reports"
36417   },
36418   {
36419     "type": "get",
36420     "url": "/api/whatsapp/reports/transfer",
36421     "title": "Gets a list of Whatsapp Transfer Reports",
36422     "examples": [
36423       {
36424         "title": "Example usage:",
36425         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36426         "type": "json"
36427       }
36428     ],
36429     "name": "GetWhatsapp_Transfer_Reports",
36430     "group": "Whatsapp_Transfer_Reports",
36431     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36432     "version": "0.0.0",
36433     "filename": "server/api/whatsappTransferReport/index.js",
36434     "groupTitle": "Whatsapp_Transfer_Reports"
36435   },
36436   {
36437     "type": "get",
36438     "url": "/api/whatsapp/reports/transfer/{id}",
36439     "title": "Gets a single Whatsapp Transfer Report",
36440     "examples": [
36441       {
36442         "title": "Example usage:",
36443         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36444         "type": "json"
36445       }
36446     ],
36447     "name": "ShowWhatsapp_Transfer_Reports",
36448     "group": "Whatsapp_Transfer_Reports",
36449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36450     "version": "0.0.0",
36451     "filename": "server/api/whatsappTransferReport/index.js",
36452     "groupTitle": "Whatsapp_Transfer_Reports"
36453   },
36454   {
36455     "type": "put",
36456     "url": "/api/whatsapp/reports/transfer/{id}",
36457     "title": "Update an existing Whatsapp Transfer Report",
36458     "examples": [
36459       {
36460         "title": "Example usage:",
36461         "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",
36462         "type": "json"
36463       }
36464     ],
36465     "name": "updateWhatsapp_Transfer_Reports",
36466     "group": "Whatsapp_Transfer_Reports",
36467     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36468     "version": "0.0.0",
36469     "filename": "server/api/whatsappTransferReport/index.js",
36470     "groupTitle": "Whatsapp_Transfer_Reports"
36471   },
36472   {
36473     "type": "post",
36474     "url": "/api/integrations/zendesk/accounts",
36475     "title": "Creates a new Zendesk Account",
36476     "examples": [
36477       {
36478         "title": "Example usage:",
36479         "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",
36480         "type": "json"
36481       }
36482     ],
36483     "name": "CreateZendesk_Accounts",
36484     "group": "Zendesk_Accounts",
36485     "parameter": {
36486       "fields": {
36487         "Body": [
36488           {
36489             "group": "Body",
36490             "type": "String",
36491             "optional": true,
36492             "field": "name",
36493             "description": ""
36494           },
36495           {
36496             "group": "Body",
36497             "type": "String",
36498             "optional": true,
36499             "field": "description",
36500             "description": ""
36501           },
36502           {
36503             "group": "Body",
36504             "type": "String",
36505             "optional": true,
36506             "field": "username",
36507             "description": ""
36508           },
36509           {
36510             "group": "Body",
36511             "type": "String",
36512             "optional": true,
36513             "field": "password",
36514             "description": ""
36515           },
36516           {
36517             "group": "Body",
36518             "type": "String",
36519             "optional": true,
36520             "field": "token",
36521             "description": ""
36522           },
36523           {
36524             "group": "Body",
36525             "type": "String",
36526             "optional": true,
36527             "field": "remoteUri",
36528             "description": ""
36529           },
36530           {
36531             "group": "Body",
36532             "type": "String",
36533             "allowedValues": [
36534               "\"password\"",
36535               "\"token\""
36536             ],
36537             "optional": true,
36538             "field": "authType",
36539             "description": ""
36540           },
36541           {
36542             "group": "Body",
36543             "type": "String",
36544             "optional": false,
36545             "field": "serverUrl",
36546             "description": ""
36547           },
36548           {
36549             "group": "Body",
36550             "type": "String",
36551             "allowedValues": [
36552               "\"integrationTab\"",
36553               "\"newTab\""
36554             ],
36555             "optional": true,
36556             "field": "type",
36557             "description": ""
36558           }
36559         ]
36560       }
36561     },
36562     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36563     "version": "0.0.0",
36564     "filename": "server/api/intZendeskAccount/index.js",
36565     "groupTitle": "Zendesk_Accounts"
36566   },
36567   {
36568     "type": "delete",
36569     "url": "/api/integrations/zendesk/accounts/{id}",
36570     "title": "Deletes a Zendesk Account",
36571     "examples": [
36572       {
36573         "title": "Example usage:",
36574         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36575         "type": "json"
36576       }
36577     ],
36578     "name": "DeleteZendesk_Accounts",
36579     "group": "Zendesk_Accounts",
36580     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36581     "version": "0.0.0",
36582     "filename": "server/api/intZendeskAccount/index.js",
36583     "groupTitle": "Zendesk_Accounts"
36584   },
36585   {
36586     "type": "get",
36587     "url": "/api/integrations/zendesk/accounts",
36588     "title": "Gets a list of Zendesk Accounts",
36589     "examples": [
36590       {
36591         "title": "Example usage:",
36592         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36593         "type": "json"
36594       }
36595     ],
36596     "name": "GetZendesk_Accounts",
36597     "group": "Zendesk_Accounts",
36598     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36599     "version": "0.0.0",
36600     "filename": "server/api/intZendeskAccount/index.js",
36601     "groupTitle": "Zendesk_Accounts"
36602   },
36603   {
36604     "type": "get",
36605     "url": "/api/integrations/zendesk/accounts/{id}",
36606     "title": "Gets a single Zendesk Account",
36607     "examples": [
36608       {
36609         "title": "Example usage:",
36610         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36611         "type": "json"
36612       }
36613     ],
36614     "name": "ShowZendesk_Accounts",
36615     "group": "Zendesk_Accounts",
36616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36617     "version": "0.0.0",
36618     "filename": "server/api/intZendeskAccount/index.js",
36619     "groupTitle": "Zendesk_Accounts"
36620   },
36621   {
36622     "type": "post",
36623     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36624     "title": "Creates new configuration",
36625     "examples": [
36626       {
36627         "title": "Example usage:",
36628         "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",
36629         "type": "json"
36630       }
36631     ],
36632     "name": "addConfiguration",
36633     "group": "Zendesk_Accounts",
36634     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36635     "version": "0.0.0",
36636     "filename": "server/api/intZendeskAccount/index.js",
36637     "groupTitle": "Zendesk_Accounts"
36638   },
36639   {
36640     "type": "get",
36641     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36642     "title": "Gets account configurations",
36643     "examples": [
36644       {
36645         "title": "Example usage:",
36646         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36647         "type": "json"
36648       }
36649     ],
36650     "name": "getConfigurations",
36651     "group": "Zendesk_Accounts",
36652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36653     "version": "0.0.0",
36654     "filename": "server/api/intZendeskAccount/index.js",
36655     "groupTitle": "Zendesk_Accounts"
36656   },
36657   {
36658     "type": "get",
36659     "url": "/api/integrations/zendesk/accounts/{id}/fields",
36660     "title": "Gets account fields",
36661     "examples": [
36662       {
36663         "title": "Example usage:",
36664         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36665         "type": "json"
36666       }
36667     ],
36668     "name": "getFields",
36669     "group": "Zendesk_Accounts",
36670     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36671     "version": "0.0.0",
36672     "filename": "server/api/intZendeskAccount/index.js",
36673     "groupTitle": "Zendesk_Accounts"
36674   },
36675   {
36676     "type": "put",
36677     "url": "/api/integrations/zendesk/accounts/{id}",
36678     "title": "Update an existing Zendesk Account",
36679     "examples": [
36680       {
36681         "title": "Example usage:",
36682         "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",
36683         "type": "json"
36684       }
36685     ],
36686     "name": "updateZendesk_Accounts",
36687     "group": "Zendesk_Accounts",
36688     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36689     "version": "0.0.0",
36690     "filename": "server/api/intZendeskAccount/index.js",
36691     "groupTitle": "Zendesk_Accounts"
36692   },
36693   {
36694     "type": "post",
36695     "url": "/api/integrations/zendesk/configurations",
36696     "title": "Creates a new Zendesk Configuration",
36697     "examples": [
36698       {
36699         "title": "Example usage:",
36700         "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",
36701         "type": "json"
36702       }
36703     ],
36704     "name": "CreateZendesk_Configurations",
36705     "group": "Zendesk_Configurations",
36706     "parameter": {
36707       "fields": {
36708         "Body": [
36709           {
36710             "group": "Body",
36711             "type": "String",
36712             "optional": true,
36713             "field": "name",
36714             "description": ""
36715           },
36716           {
36717             "group": "Body",
36718             "type": "String",
36719             "optional": true,
36720             "field": "description",
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/intZendeskConfiguration/index.js",
36729     "groupTitle": "Zendesk_Configurations"
36730   },
36731   {
36732     "type": "delete",
36733     "url": "/api/integrations/zendesk/configurations/{id}",
36734     "title": "Deletes a Zendesk Configuration",
36735     "examples": [
36736       {
36737         "title": "Example usage:",
36738         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36739         "type": "json"
36740       }
36741     ],
36742     "name": "DeleteZendesk_Configurations",
36743     "group": "Zendesk_Configurations",
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/intZendeskConfiguration/index.js",
36747     "groupTitle": "Zendesk_Configurations"
36748   },
36749   {
36750     "type": "get",
36751     "url": "/api/integrations/zendesk/configurations",
36752     "title": "Gets a list of Zendesk Configurations",
36753     "examples": [
36754       {
36755         "title": "Example usage:",
36756         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36757         "type": "json"
36758       }
36759     ],
36760     "name": "GetZendesk_Configurations",
36761     "group": "Zendesk_Configurations",
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/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>",
36763     "version": "0.0.0",
36764     "filename": "server/api/intZendeskConfiguration/index.js",
36765     "groupTitle": "Zendesk_Configurations"
36766   },
36767   {
36768     "type": "get",
36769     "url": "/api/integrations/zendesk/configurations/{id}",
36770     "title": "Gets a single Zendesk Configuration",
36771     "examples": [
36772       {
36773         "title": "Example usage:",
36774         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36775         "type": "json"
36776       }
36777     ],
36778     "name": "ShowZendesk_Configurations",
36779     "group": "Zendesk_Configurations",
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/intZendeskConfiguration/index.js",
36783     "groupTitle": "Zendesk_Configurations"
36784   },
36785   {
36786     "type": "get",
36787     "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36788     "title": "Gets configurations descriptions",
36789     "examples": [
36790       {
36791         "title": "Example usage:",
36792         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36793         "type": "json"
36794       }
36795     ],
36796     "name": "getDescriptions",
36797     "group": "Zendesk_Configurations",
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/intZendeskConfiguration/index.js",
36801     "groupTitle": "Zendesk_Configurations"
36802   },
36803   {
36804     "type": "get",
36805     "url": "/api/integrations/zendesk/configurations/{id}/fields",
36806     "title": "Gets configurations fields",
36807     "examples": [
36808       {
36809         "title": "Example usage:",
36810         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36811         "type": "json"
36812       }
36813     ],
36814     "name": "getFields",
36815     "group": "Zendesk_Configurations",
36816     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36817     "version": "0.0.0",
36818     "filename": "server/api/intZendeskConfiguration/index.js",
36819     "groupTitle": "Zendesk_Configurations"
36820   },
36821   {
36822     "type": "get",
36823     "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36824     "title": "Gets configurations subjects",
36825     "examples": [
36826       {
36827         "title": "Example usage:",
36828         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36829         "type": "json"
36830       }
36831     ],
36832     "name": "getSubjects",
36833     "group": "Zendesk_Configurations",
36834     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36835     "version": "0.0.0",
36836     "filename": "server/api/intZendeskConfiguration/index.js",
36837     "groupTitle": "Zendesk_Configurations"
36838   },
36839   {
36840     "type": "get",
36841     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36842     "title": "Gets configurations tags",
36843     "examples": [
36844       {
36845         "title": "Example usage:",
36846         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36847         "type": "json"
36848       }
36849     ],
36850     "name": "getTags",
36851     "group": "Zendesk_Configurations",
36852     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36853     "version": "0.0.0",
36854     "filename": "server/api/intZendeskConfiguration/index.js",
36855     "groupTitle": "Zendesk_Configurations"
36856   },
36857   {
36858     "type": "post",
36859     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36860     "title": "Sets new tags",
36861     "examples": [
36862       {
36863         "title": "Example usage:",
36864         "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",
36865         "type": "json"
36866       }
36867     ],
36868     "name": "setTags",
36869     "group": "Zendesk_Configurations",
36870     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36871     "version": "0.0.0",
36872     "filename": "server/api/intZendeskConfiguration/index.js",
36873     "groupTitle": "Zendesk_Configurations"
36874   },
36875   {
36876     "type": "put",
36877     "url": "/api/integrations/zendesk/configurations/{id}",
36878     "title": "Update an existing Zendesk Configuration",
36879     "examples": [
36880       {
36881         "title": "Example usage:",
36882         "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",
36883         "type": "json"
36884       }
36885     ],
36886     "name": "updateZendesk_Configurations",
36887     "group": "Zendesk_Configurations",
36888     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36889     "version": "0.0.0",
36890     "filename": "server/api/intZendeskConfiguration/index.js",
36891     "groupTitle": "Zendesk_Configurations"
36892   },
36893   {
36894     "type": "post",
36895     "url": "/api/integrations/zendesk/fields",
36896     "title": "Creates a new Zendesk Field",
36897     "examples": [
36898       {
36899         "title": "Example usage:",
36900         "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",
36901         "type": "json"
36902       }
36903     ],
36904     "name": "CreateZendesk_Fields",
36905     "group": "Zendesk_Fields",
36906     "parameter": {
36907       "fields": {
36908         "Body": [
36909           {
36910             "group": "Body",
36911             "type": "String",
36912             "allowedValues": [
36913               "\"string\"",
36914               "\"variable\"",
36915               "\"customVariable\"",
36916               "\"keyValue\"",
36917               "\"picklist\""
36918             ],
36919             "optional": true,
36920             "field": "type",
36921             "description": ""
36922           },
36923           {
36924             "group": "Body",
36925             "type": "String",
36926             "optional": true,
36927             "field": "content",
36928             "description": ""
36929           },
36930           {
36931             "group": "Body",
36932             "type": "String",
36933             "optional": true,
36934             "field": "key",
36935             "description": ""
36936           },
36937           {
36938             "group": "Body",
36939             "type": "String",
36940             "allowedValues": [
36941               "\"string\"",
36942               "\"variable\"",
36943               "\"customVariable\""
36944             ],
36945             "optional": true,
36946             "field": "keyType",
36947             "description": ""
36948           },
36949           {
36950             "group": "Body",
36951             "type": "String",
36952             "optional": true,
36953             "field": "keyContent",
36954             "description": ""
36955           },
36956           {
36957             "group": "Body",
36958             "type": "String",
36959             "optional": true,
36960             "field": "idField",
36961             "description": ""
36962           },
36963           {
36964             "group": "Body",
36965             "type": "String",
36966             "optional": true,
36967             "field": "nameField",
36968             "description": ""
36969           },
36970           {
36971             "group": "Body",
36972             "type": "Boolean",
36973             "optional": true,
36974             "field": "customField",
36975             "description": ""
36976           },
36977           {
36978             "group": "Body",
36979             "type": "String",
36980             "optional": true,
36981             "field": "variableName",
36982             "description": ""
36983           }
36984         ]
36985       }
36986     },
36987     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36988     "version": "0.0.0",
36989     "filename": "server/api/intZendeskField/index.js",
36990     "groupTitle": "Zendesk_Fields"
36991   },
36992   {
36993     "type": "delete",
36994     "url": "/api/integrations/zendesk/fields/{id}",
36995     "title": "Deletes a Zendesk Field",
36996     "examples": [
36997       {
36998         "title": "Example usage:",
36999         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37000         "type": "json"
37001       }
37002     ],
37003     "name": "DeleteZendesk_Fields",
37004     "group": "Zendesk_Fields",
37005     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37006     "version": "0.0.0",
37007     "filename": "server/api/intZendeskField/index.js",
37008     "groupTitle": "Zendesk_Fields"
37009   },
37010   {
37011     "type": "get",
37012     "url": "/api/integrations/zendesk/fields",
37013     "title": "Gets a list of Zendesk Fields",
37014     "examples": [
37015       {
37016         "title": "Example usage:",
37017         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37018         "type": "json"
37019       }
37020     ],
37021     "name": "GetZendesk_Fields",
37022     "group": "Zendesk_Fields",
37023     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37024     "version": "0.0.0",
37025     "filename": "server/api/intZendeskField/index.js",
37026     "groupTitle": "Zendesk_Fields"
37027   },
37028   {
37029     "type": "get",
37030     "url": "/api/integrations/zendesk/fields/{id}",
37031     "title": "Gets a single Zendesk Field",
37032     "examples": [
37033       {
37034         "title": "Example usage:",
37035         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37036         "type": "json"
37037       }
37038     ],
37039     "name": "ShowZendesk_Fields",
37040     "group": "Zendesk_Fields",
37041     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37042     "version": "0.0.0",
37043     "filename": "server/api/intZendeskField/index.js",
37044     "groupTitle": "Zendesk_Fields"
37045   },
37046   {
37047     "type": "put",
37048     "url": "/api/integrations/zendesk/fields/{id}",
37049     "title": "Update an existing Zendesk Field",
37050     "examples": [
37051       {
37052         "title": "Example usage:",
37053         "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",
37054         "type": "json"
37055       }
37056     ],
37057     "name": "updateZendesk_Fields",
37058     "group": "Zendesk_Fields",
37059     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37060     "version": "0.0.0",
37061     "filename": "server/api/intZendeskField/index.js",
37062     "groupTitle": "Zendesk_Fields"
37063   },
37064   {
37065     "type": "post",
37066     "url": "/api/integrations/zoho/accounts",
37067     "title": "Creates a new Zoho Account",
37068     "examples": [
37069       {
37070         "title": "Example usage:",
37071         "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",
37072         "type": "json"
37073       }
37074     ],
37075     "name": "CreateZoho_Accounts",
37076     "group": "Zoho_Accounts",
37077     "parameter": {
37078       "fields": {
37079         "Body": [
37080           {
37081             "group": "Body",
37082             "type": "String",
37083             "optional": true,
37084             "field": "name",
37085             "description": ""
37086           },
37087           {
37088             "group": "Body",
37089             "type": "String",
37090             "optional": true,
37091             "field": "description",
37092             "description": ""
37093           },
37094           {
37095             "group": "Body",
37096             "type": "String",
37097             "optional": true,
37098             "field": "host",
37099             "description": ""
37100           },
37101           {
37102             "group": "Body",
37103             "type": "String",
37104             "optional": true,
37105             "field": "zone",
37106             "description": ""
37107           },
37108           {
37109             "group": "Body",
37110             "type": "String",
37111             "optional": true,
37112             "field": "clientId",
37113             "description": ""
37114           },
37115           {
37116             "group": "Body",
37117             "type": "String",
37118             "optional": true,
37119             "field": "clientSecret",
37120             "description": ""
37121           },
37122           {
37123             "group": "Body",
37124             "type": "String",
37125             "optional": false,
37126             "field": "serverUrl",
37127             "description": ""
37128           },
37129           {
37130             "group": "Body",
37131             "type": "String",
37132             "optional": true,
37133             "field": "code",
37134             "description": ""
37135           },
37136           {
37137             "group": "Body",
37138             "type": "String",
37139             "optional": true,
37140             "field": "refreshToken",
37141             "description": ""
37142           }
37143         ]
37144       }
37145     },
37146     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37147     "version": "0.0.0",
37148     "filename": "server/api/intZohoAccount/index.js",
37149     "groupTitle": "Zoho_Accounts"
37150   },
37151   {
37152     "type": "delete",
37153     "url": "/api/integrations/zoho/accounts/{id}",
37154     "title": "Deletes a Zoho Account",
37155     "examples": [
37156       {
37157         "title": "Example usage:",
37158         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37159         "type": "json"
37160       }
37161     ],
37162     "name": "DeleteZoho_Accounts",
37163     "group": "Zoho_Accounts",
37164     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37165     "version": "0.0.0",
37166     "filename": "server/api/intZohoAccount/index.js",
37167     "groupTitle": "Zoho_Accounts"
37168   },
37169   {
37170     "type": "get",
37171     "url": "/api/integrations/zoho/accounts",
37172     "title": "Gets a list of Zoho Accounts",
37173     "examples": [
37174       {
37175         "title": "Example usage:",
37176         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37177         "type": "json"
37178       }
37179     ],
37180     "name": "GetZoho_Accounts",
37181     "group": "Zoho_Accounts",
37182     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37183     "version": "0.0.0",
37184     "filename": "server/api/intZohoAccount/index.js",
37185     "groupTitle": "Zoho_Accounts"
37186   },
37187   {
37188     "type": "get",
37189     "url": "/api/integrations/zoho/accounts/{id}",
37190     "title": "Gets a single Zoho Account",
37191     "examples": [
37192       {
37193         "title": "Example usage:",
37194         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37195         "type": "json"
37196       }
37197     ],
37198     "name": "ShowZoho_Accounts",
37199     "group": "Zoho_Accounts",
37200     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37201     "version": "0.0.0",
37202     "filename": "server/api/intZohoAccount/index.js",
37203     "groupTitle": "Zoho_Accounts"
37204   },
37205   {
37206     "type": "post",
37207     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37208     "title": "Creates new configuration",
37209     "examples": [
37210       {
37211         "title": "Example usage:",
37212         "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",
37213         "type": "json"
37214       }
37215     ],
37216     "name": "addConfiguration",
37217     "group": "Zoho_Accounts",
37218     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37219     "version": "0.0.0",
37220     "filename": "server/api/intZohoAccount/index.js",
37221     "groupTitle": "Zoho_Accounts"
37222   },
37223   {
37224     "type": "get",
37225     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37226     "title": "Gets account configurations",
37227     "examples": [
37228       {
37229         "title": "Example usage:",
37230         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37231         "type": "json"
37232       }
37233     ],
37234     "name": "getConfigurations",
37235     "group": "Zoho_Accounts",
37236     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37237     "version": "0.0.0",
37238     "filename": "server/api/intZohoAccount/index.js",
37239     "groupTitle": "Zoho_Accounts"
37240   },
37241   {
37242     "type": "get",
37243     "url": "/api/integrations/zoho/accounts/{id}/fields",
37244     "title": "Gets account fields",
37245     "examples": [
37246       {
37247         "title": "Example usage:",
37248         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37249         "type": "json"
37250       }
37251     ],
37252     "name": "getFields",
37253     "group": "Zoho_Accounts",
37254     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37255     "version": "0.0.0",
37256     "filename": "server/api/intZohoAccount/index.js",
37257     "groupTitle": "Zoho_Accounts"
37258   },
37259   {
37260     "type": "put",
37261     "url": "/api/integrations/zoho/accounts/{id}",
37262     "title": "Update an existing Zoho Account",
37263     "examples": [
37264       {
37265         "title": "Example usage:",
37266         "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",
37267         "type": "json"
37268       }
37269     ],
37270     "name": "updateZoho_Accounts",
37271     "group": "Zoho_Accounts",
37272     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37273     "version": "0.0.0",
37274     "filename": "server/api/intZohoAccount/index.js",
37275     "groupTitle": "Zoho_Accounts"
37276   },
37277   {
37278     "type": "post",
37279     "url": "/api/integrations/zoho/configurations",
37280     "title": "Creates a new Zoho Configuration",
37281     "examples": [
37282       {
37283         "title": "Example usage:",
37284         "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",
37285         "type": "json"
37286       }
37287     ],
37288     "name": "CreateZoho_Configurations",
37289     "group": "Zoho_Configurations",
37290     "parameter": {
37291       "fields": {
37292         "Body": [
37293           {
37294             "group": "Body",
37295             "type": "String",
37296             "optional": true,
37297             "field": "name",
37298             "description": ""
37299           },
37300           {
37301             "group": "Body",
37302             "type": "String",
37303             "allowedValues": [
37304               "\"lead\"",
37305               "\"contact\"",
37306               "\"nothing\""
37307             ],
37308             "optional": true,
37309             "field": "moduleCreate",
37310             "description": ""
37311           },
37312           {
37313             "group": "Body",
37314             "type": "String",
37315             "allowedValues": [
37316               "\"contact_lead\"",
37317               "\"contact\"",
37318               "\"lead\""
37319             ],
37320             "optional": true,
37321             "field": "moduleSearch",
37322             "description": ""
37323           },
37324           {
37325             "group": "Body",
37326             "type": "String",
37327             "optional": true,
37328             "field": "description",
37329             "description": ""
37330           }
37331         ]
37332       }
37333     },
37334     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37335     "version": "0.0.0",
37336     "filename": "server/api/intZohoConfiguration/index.js",
37337     "groupTitle": "Zoho_Configurations"
37338   },
37339   {
37340     "type": "delete",
37341     "url": "/api/integrations/zoho/configurations/{id}",
37342     "title": "Deletes a Zoho Configuration",
37343     "examples": [
37344       {
37345         "title": "Example usage:",
37346         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37347         "type": "json"
37348       }
37349     ],
37350     "name": "DeleteZoho_Configurations",
37351     "group": "Zoho_Configurations",
37352     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/intZohoConfiguration/index.js",
37355     "groupTitle": "Zoho_Configurations"
37356   },
37357   {
37358     "type": "get",
37359     "url": "/api/integrations/zoho/configurations",
37360     "title": "Gets a list of Zoho Configurations",
37361     "examples": [
37362       {
37363         "title": "Example usage:",
37364         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37365         "type": "json"
37366       }
37367     ],
37368     "name": "GetZoho_Configurations",
37369     "group": "Zoho_Configurations",
37370     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37371     "version": "0.0.0",
37372     "filename": "server/api/intZohoConfiguration/index.js",
37373     "groupTitle": "Zoho_Configurations"
37374   },
37375   {
37376     "type": "get",
37377     "url": "/api/integrations/zoho/configurations/{id}",
37378     "title": "Gets a single Zoho Configuration",
37379     "examples": [
37380       {
37381         "title": "Example usage:",
37382         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37383         "type": "json"
37384       }
37385     ],
37386     "name": "ShowZoho_Configurations",
37387     "group": "Zoho_Configurations",
37388     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37389     "version": "0.0.0",
37390     "filename": "server/api/intZohoConfiguration/index.js",
37391     "groupTitle": "Zoho_Configurations"
37392   },
37393   {
37394     "type": "get",
37395     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37396     "title": "Gets configurations descriptions",
37397     "examples": [
37398       {
37399         "title": "Example usage:",
37400         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37401         "type": "json"
37402       }
37403     ],
37404     "name": "getDescriptions",
37405     "group": "Zoho_Configurations",
37406     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37407     "version": "0.0.0",
37408     "filename": "server/api/intZohoConfiguration/index.js",
37409     "groupTitle": "Zoho_Configurations"
37410   },
37411   {
37412     "type": "get",
37413     "url": "/api/integrations/zoho/configurations/{id}/fields",
37414     "title": "Gets configurations fields",
37415     "examples": [
37416       {
37417         "title": "Example usage:",
37418         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37419         "type": "json"
37420       }
37421     ],
37422     "name": "getFields",
37423     "group": "Zoho_Configurations",
37424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37425     "version": "0.0.0",
37426     "filename": "server/api/intZohoConfiguration/index.js",
37427     "groupTitle": "Zoho_Configurations"
37428   },
37429   {
37430     "type": "get",
37431     "url": "/api/integrations/zoho/configurations/{id}/subjects",
37432     "title": "Gets configurations subjects",
37433     "examples": [
37434       {
37435         "title": "Example usage:",
37436         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37437         "type": "json"
37438       }
37439     ],
37440     "name": "getSubjects",
37441     "group": "Zoho_Configurations",
37442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37443     "version": "0.0.0",
37444     "filename": "server/api/intZohoConfiguration/index.js",
37445     "groupTitle": "Zoho_Configurations"
37446   },
37447   {
37448     "type": "put",
37449     "url": "/api/integrations/zoho/configurations/{id}",
37450     "title": "Update an existing Zoho Configuration",
37451     "examples": [
37452       {
37453         "title": "Example usage:",
37454         "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",
37455         "type": "json"
37456       }
37457     ],
37458     "name": "updateZoho_Configurations",
37459     "group": "Zoho_Configurations",
37460     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37461     "version": "0.0.0",
37462     "filename": "server/api/intZohoConfiguration/index.js",
37463     "groupTitle": "Zoho_Configurations"
37464   },
37465   {
37466     "type": "post",
37467     "url": "/api/integrations/zoho/fields",
37468     "title": "Creates a new Zoho Field",
37469     "examples": [
37470       {
37471         "title": "Example usage:",
37472         "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",
37473         "type": "json"
37474       }
37475     ],
37476     "name": "CreateZoho_Fields",
37477     "group": "Zoho_Fields",
37478     "parameter": {
37479       "fields": {
37480         "Body": [
37481           {
37482             "group": "Body",
37483             "type": "String",
37484             "allowedValues": [
37485               "\"string\"",
37486               "\"variable\"",
37487               "\"customVariable\"",
37488               "\"keyValue\"",
37489               "\"picklist\""
37490             ],
37491             "optional": true,
37492             "field": "type",
37493             "description": ""
37494           },
37495           {
37496             "group": "Body",
37497             "type": "String",
37498             "optional": true,
37499             "field": "content",
37500             "description": ""
37501           },
37502           {
37503             "group": "Body",
37504             "type": "String",
37505             "optional": true,
37506             "field": "key",
37507             "description": ""
37508           },
37509           {
37510             "group": "Body",
37511             "type": "String",
37512             "allowedValues": [
37513               "\"string\"",
37514               "\"variable\"",
37515               "\"customVariable\""
37516             ],
37517             "optional": true,
37518             "field": "keyType",
37519             "description": ""
37520           },
37521           {
37522             "group": "Body",
37523             "type": "String",
37524             "optional": true,
37525             "field": "keyContent",
37526             "description": ""
37527           },
37528           {
37529             "group": "Body",
37530             "type": "String",
37531             "optional": true,
37532             "field": "idField",
37533             "description": ""
37534           },
37535           {
37536             "group": "Body",
37537             "type": "String",
37538             "optional": true,
37539             "field": "nameField",
37540             "description": ""
37541           },
37542           {
37543             "group": "Body",
37544             "type": "Boolean",
37545             "optional": true,
37546             "field": "customField",
37547             "description": ""
37548           },
37549           {
37550             "group": "Body",
37551             "type": "String",
37552             "optional": true,
37553             "field": "variableName",
37554             "description": ""
37555           }
37556         ]
37557       }
37558     },
37559     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37560     "version": "0.0.0",
37561     "filename": "server/api/intZohoField/index.js",
37562     "groupTitle": "Zoho_Fields"
37563   },
37564   {
37565     "type": "delete",
37566     "url": "/api/integrations/zoho/fields/{id}",
37567     "title": "Deletes a Zoho Field",
37568     "examples": [
37569       {
37570         "title": "Example usage:",
37571         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37572         "type": "json"
37573       }
37574     ],
37575     "name": "DeleteZoho_Fields",
37576     "group": "Zoho_Fields",
37577     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37578     "version": "0.0.0",
37579     "filename": "server/api/intZohoField/index.js",
37580     "groupTitle": "Zoho_Fields"
37581   },
37582   {
37583     "type": "get",
37584     "url": "/api/integrations/zoho/fields",
37585     "title": "Gets a list of Zoho Fields",
37586     "examples": [
37587       {
37588         "title": "Example usage:",
37589         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37590         "type": "json"
37591       }
37592     ],
37593     "name": "GetZoho_Fields",
37594     "group": "Zoho_Fields",
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/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>",
37596     "version": "0.0.0",
37597     "filename": "server/api/intZohoField/index.js",
37598     "groupTitle": "Zoho_Fields"
37599   },
37600   {
37601     "type": "get",
37602     "url": "/api/integrations/zoho/fields/{id}",
37603     "title": "Gets a single Zoho Field",
37604     "examples": [
37605       {
37606         "title": "Example usage:",
37607         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37608         "type": "json"
37609       }
37610     ],
37611     "name": "ShowZoho_Fields",
37612     "group": "Zoho_Fields",
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/intZohoField/index.js",
37616     "groupTitle": "Zoho_Fields"
37617   },
37618   {
37619     "type": "put",
37620     "url": "/api/integrations/zoho/fields/{id}",
37621     "title": "Update an existing Zoho Field",
37622     "examples": [
37623       {
37624         "title": "Example usage:",
37625         "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",
37626         "type": "json"
37627       }
37628     ],
37629     "name": "updateZoho_Fields",
37630     "group": "Zoho_Fields",
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/intZohoField/index.js",
37634     "groupTitle": "Zoho_Fields"
37635   },
37636   {
37637     "type": "post",
37638     "url": "/api/cdr",
37639     "title": "Creates a new Cdr",
37640     "examples": [
37641       {
37642         "title": "Example usage:",
37643         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37644         "type": "json"
37645       }
37646     ],
37647     "name": "CreateCdrs",
37648     "group": "cdr",
37649     "parameter": {
37650       "fields": {
37651         "Body": [
37652           {
37653             "group": "Body",
37654             "type": "String",
37655             "optional": false,
37656             "field": "calldate",
37657             "description": ""
37658           },
37659           {
37660             "group": "Body",
37661             "type": "String",
37662             "optional": true,
37663             "field": "clid",
37664             "description": ""
37665           },
37666           {
37667             "group": "Body",
37668             "type": "String",
37669             "optional": true,
37670             "field": "src",
37671             "description": ""
37672           },
37673           {
37674             "group": "Body",
37675             "type": "String",
37676             "optional": true,
37677             "field": "dst",
37678             "description": ""
37679           },
37680           {
37681             "group": "Body",
37682             "type": "String",
37683             "optional": true,
37684             "field": "dcontext",
37685             "description": ""
37686           },
37687           {
37688             "group": "Body",
37689             "type": "String",
37690             "optional": true,
37691             "field": "channel",
37692             "description": ""
37693           },
37694           {
37695             "group": "Body",
37696             "type": "String",
37697             "optional": true,
37698             "field": "dstchannel",
37699             "description": ""
37700           },
37701           {
37702             "group": "Body",
37703             "type": "String",
37704             "optional": true,
37705             "field": "lastapp",
37706             "description": ""
37707           },
37708           {
37709             "group": "Body",
37710             "type": "String",
37711             "optional": true,
37712             "field": "lastdata",
37713             "description": ""
37714           },
37715           {
37716             "group": "Body",
37717             "type": "Integer",
37718             "optional": false,
37719             "field": "duration",
37720             "description": ""
37721           },
37722           {
37723             "group": "Body",
37724             "type": "Integer",
37725             "optional": false,
37726             "field": "billsec",
37727             "description": ""
37728           },
37729           {
37730             "group": "Body",
37731             "type": "String",
37732             "optional": true,
37733             "field": "disposition",
37734             "description": ""
37735           },
37736           {
37737             "group": "Body",
37738             "type": "Integer",
37739             "optional": false,
37740             "field": "amaflags",
37741             "description": ""
37742           },
37743           {
37744             "group": "Body",
37745             "type": "String",
37746             "optional": true,
37747             "field": "accountcode",
37748             "description": ""
37749           },
37750           {
37751             "group": "Body",
37752             "type": "String",
37753             "optional": true,
37754             "field": "userfield",
37755             "description": ""
37756           },
37757           {
37758             "group": "Body",
37759             "type": "String",
37760             "optional": true,
37761             "field": "uniqueid",
37762             "description": ""
37763           },
37764           {
37765             "group": "Body",
37766             "type": "String",
37767             "optional": true,
37768             "field": "linkedid",
37769             "description": ""
37770           },
37771           {
37772             "group": "Body",
37773             "type": "String",
37774             "optional": true,
37775             "field": "sequence",
37776             "description": ""
37777           },
37778           {
37779             "group": "Body",
37780             "type": "String",
37781             "optional": true,
37782             "field": "peeraccount",
37783             "description": ""
37784           },
37785           {
37786             "group": "Body",
37787             "type": "String",
37788             "optional": true,
37789             "field": "type",
37790             "description": ""
37791           },
37792           {
37793             "group": "Body",
37794             "type": "String",
37795             "optional": true,
37796             "field": "tag",
37797             "description": ""
37798           }
37799         ]
37800       }
37801     },
37802     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37803     "version": "0.0.0",
37804     "filename": "server/api/cdr/index.js",
37805     "groupTitle": "cdr"
37806   },
37807   {
37808     "type": "delete",
37809     "url": "/api/cdr/{id}",
37810     "title": "Deletes a Cdr",
37811     "examples": [
37812       {
37813         "title": "Example usage:",
37814         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37815         "type": "json"
37816       }
37817     ],
37818     "name": "DeleteCdrs",
37819     "group": "cdr",
37820     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37821     "version": "0.0.0",
37822     "filename": "server/api/cdr/index.js",
37823     "groupTitle": "cdr"
37824   },
37825   {
37826     "type": "get",
37827     "url": "/api/cdr/describe",
37828     "title": "Gets table info about Cdrs",
37829     "examples": [
37830       {
37831         "title": "Example usage:",
37832         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37833         "type": "json"
37834       }
37835     ],
37836     "name": "DescribeCdrs",
37837     "group": "cdr",
37838     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37839     "version": "0.0.0",
37840     "filename": "server/api/cdr/index.js",
37841     "groupTitle": "cdr"
37842   },
37843   {
37844     "type": "get",
37845     "url": "/api/cdr",
37846     "title": "Gets a list of Cdrs",
37847     "examples": [
37848       {
37849         "title": "Example usage:",
37850         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37851         "type": "json"
37852       }
37853     ],
37854     "name": "GetCdrs",
37855     "group": "cdr",
37856     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37857     "version": "0.0.0",
37858     "filename": "server/api/cdr/index.js",
37859     "groupTitle": "cdr"
37860   },
37861   {
37862     "type": "get",
37863     "url": "/api/cdr/{id}",
37864     "title": "Gets a single Cdr",
37865     "examples": [
37866       {
37867         "title": "Example usage:",
37868         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37869         "type": "json"
37870       }
37871     ],
37872     "name": "ShowCdrs",
37873     "group": "cdr",
37874     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37875     "version": "0.0.0",
37876     "filename": "server/api/cdr/index.js",
37877     "groupTitle": "cdr"
37878   },
37879   {
37880     "type": "put",
37881     "url": "/api/cdr/{id}",
37882     "title": "Update an existing Cdr",
37883     "examples": [
37884       {
37885         "title": "Example usage:",
37886         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37887         "type": "json"
37888       }
37889     ],
37890     "name": "updateCdrs",
37891     "group": "cdr",
37892     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37893     "version": "0.0.0",
37894     "filename": "server/api/cdr/index.js",
37895     "groupTitle": "cdr"
37896   },
37897   {
37898     "type": "post",
37899     "url": "/api/voiceQueuesLog",
37900     "title": "Creates a new VoiceQueuesLog",
37901     "examples": [
37902       {
37903         "title": "Example usage:",
37904         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37905         "type": "json"
37906       }
37907     ],
37908     "name": "CreateVoiceQueuesLogs",
37909     "group": "voiceQueuesLog",
37910     "parameter": {
37911       "fields": {
37912         "Body": [
37913           {
37914             "group": "Body",
37915             "type": "String",
37916             "optional": true,
37917             "field": "time",
37918             "description": ""
37919           },
37920           {
37921             "group": "Body",
37922             "type": "String",
37923             "optional": false,
37924             "field": "callid",
37925             "description": ""
37926           },
37927           {
37928             "group": "Body",
37929             "type": "String",
37930             "optional": false,
37931             "field": "queuename",
37932             "description": ""
37933           },
37934           {
37935             "group": "Body",
37936             "type": "String",
37937             "optional": false,
37938             "field": "agent",
37939             "description": ""
37940           },
37941           {
37942             "group": "Body",
37943             "type": "String",
37944             "optional": false,
37945             "field": "event",
37946             "description": ""
37947           },
37948           {
37949             "group": "Body",
37950             "type": "String",
37951             "optional": false,
37952             "field": "data",
37953             "description": ""
37954           },
37955           {
37956             "group": "Body",
37957             "type": "String",
37958             "optional": false,
37959             "field": "data1",
37960             "description": ""
37961           },
37962           {
37963             "group": "Body",
37964             "type": "String",
37965             "optional": false,
37966             "field": "data2",
37967             "description": ""
37968           },
37969           {
37970             "group": "Body",
37971             "type": "String",
37972             "optional": false,
37973             "field": "data3",
37974             "description": ""
37975           },
37976           {
37977             "group": "Body",
37978             "type": "String",
37979             "optional": false,
37980             "field": "data4",
37981             "description": ""
37982           },
37983           {
37984             "group": "Body",
37985             "type": "String",
37986             "optional": false,
37987             "field": "data5",
37988             "description": ""
37989           },
37990           {
37991             "group": "Body",
37992             "type": "String",
37993             "optional": false,
37994             "field": "dtm",
37995             "description": ""
37996           }
37997         ]
37998       }
37999     },
38000     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38001     "version": "0.0.0",
38002     "filename": "server/api/voiceQueuesLog/index.js",
38003     "groupTitle": "voiceQueuesLog"
38004   },
38005   {
38006     "type": "delete",
38007     "url": "/api/voiceQueuesLog/{id}",
38008     "title": "Deletes a VoiceQueuesLog",
38009     "examples": [
38010       {
38011         "title": "Example usage:",
38012         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38013         "type": "json"
38014       }
38015     ],
38016     "name": "DeleteVoiceQueuesLogs",
38017     "group": "voiceQueuesLog",
38018     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38019     "version": "0.0.0",
38020     "filename": "server/api/voiceQueuesLog/index.js",
38021     "groupTitle": "voiceQueuesLog"
38022   },
38023   {
38024     "type": "get",
38025     "url": "/api/voiceQueuesLog",
38026     "title": "Gets a list of VoiceQueuesLogs",
38027     "examples": [
38028       {
38029         "title": "Example usage:",
38030         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38031         "type": "json"
38032       }
38033     ],
38034     "name": "GetVoiceQueuesLogs",
38035     "group": "voiceQueuesLog",
38036     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38037     "version": "0.0.0",
38038     "filename": "server/api/voiceQueuesLog/index.js",
38039     "groupTitle": "voiceQueuesLog"
38040   },
38041   {
38042     "type": "get",
38043     "url": "/api/voiceQueuesLog/{id}",
38044     "title": "Gets a single VoiceQueuesLog",
38045     "examples": [
38046       {
38047         "title": "Example usage:",
38048         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38049         "type": "json"
38050       }
38051     ],
38052     "name": "ShowVoiceQueuesLogs",
38053     "group": "voiceQueuesLog",
38054     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38055     "version": "0.0.0",
38056     "filename": "server/api/voiceQueuesLog/index.js",
38057     "groupTitle": "voiceQueuesLog"
38058   },
38059   {
38060     "type": "put",
38061     "url": "/api/voiceQueuesLog/{id}",
38062     "title": "Update an existing VoiceQueuesLog",
38063     "examples": [
38064       {
38065         "title": "Example usage:",
38066         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38067         "type": "json"
38068       }
38069     ],
38070     "name": "updateVoiceQueuesLogs",
38071     "group": "voiceQueuesLog",
38072     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38073     "version": "0.0.0",
38074     "filename": "server/api/voiceQueuesLog/index.js",
38075     "groupTitle": "voiceQueuesLog"
38076   }
38077 ]