apidoc/api_data.json

   1 [
   2   {
   3     "type": "delete",
   4     "url": "/api/actions/{id}",
   5     "title": "Deletes a Action",
   6     "examples": [
   7       {
   8         "title": "Example usage:",
   9         "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
  10         "type": "json"
  11       }
  12     ],
  13     "name": "DeleteActions",
  14     "group": "Actions",
  15     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  16     "version": "0.0.0",
  17     "filename": "server/api/action/index.js",
  18     "groupTitle": "Actions"
  19   },
  20   {
  21     "type": "put",
  22     "url": "/api/actions/{id}",
  23     "title": "Update an existing Action",
  24     "examples": [
  25       {
  26         "title": "Example usage:",
  27         "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
  28         "type": "json"
  29       }
  30     ],
  31     "name": "updateActions",
  32     "group": "Actions",
  33     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  34     "version": "0.0.0",
  35     "filename": "server/api/action/index.js",
  36     "groupTitle": "Actions"
  37   },
  38   {
  39     "type": "post",
  40     "url": "/api/analytics/custom_reports",
  41     "title": "Creates a new Analytic Custom Report",
  42     "examples": [
  43       {
  44         "title": "Example usage:",
  45         "content": "curl https://{domain}/api/analytics/custom_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
  46         "type": "json"
  47       }
  48     ],
  49     "name": "CreateAnalytic_Custom_Reports",
  50     "group": "Analytic_Custom_Reports",
  51     "parameter": {
  52       "fields": {
  53         "Body": [
  54           {
  55             "group": "Body",
  56             "type": "String",
  57             "optional": false,
  58             "field": "name",
  59             "description": ""
  60           },
  61           {
  62             "group": "Body",
  63             "type": "String",
  64             "optional": true,
  65             "field": "description",
  66             "description": ""
  67           },
  68           {
  69             "group": "Body",
  70             "type": "String",
  71             "optional": true,
  72             "field": "parent",
  73             "description": ""
  74           },
  75           {
  76             "group": "Body",
  77             "type": "String",
  78             "optional": true,
  79             "field": "table",
  80             "description": ""
  81           },
  82           {
  83             "group": "Body",
  84             "type": "Text",
  85             "optional": true,
  86             "field": "conditions",
  87             "description": ""
  88           },
  89           {
  90             "group": "Body",
  91             "type": "Text",
  92             "optional": true,
  93             "field": "joins",
  94             "description": ""
  95           }
  96         ]
  97       }
  98     },
  99     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 100     "version": "0.0.0",
 101     "filename": "server/api/analyticCustomReport/index.js",
 102     "groupTitle": "Analytic_Custom_Reports"
 103   },
 104   {
 105     "type": "delete",
 106     "url": "/api/analytics/custom_reports/{id}",
 107     "title": "Deletes a Analytic Custom Report",
 108     "examples": [
 109       {
 110         "title": "Example usage:",
 111         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
 112         "type": "json"
 113       }
 114     ],
 115     "name": "DeleteAnalytic_Custom_Reports",
 116     "group": "Analytic_Custom_Reports",
 117     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 118     "version": "0.0.0",
 119     "filename": "server/api/analyticCustomReport/index.js",
 120     "groupTitle": "Analytic_Custom_Reports"
 121   },
 122   {
 123     "type": "get",
 124     "url": "/api/analytics/custom_reports",
 125     "title": "Gets a list of Analytic Custom Reports",
 126     "examples": [
 127       {
 128         "title": "Example usage:",
 129         "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
 130         "type": "json"
 131       }
 132     ],
 133     "name": "GetAnalytic_Custom_Reports",
 134     "group": "Analytic_Custom_Reports",
 135     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/custom_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/custom_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/custom_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/custom_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/custom_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 136     "version": "0.0.0",
 137     "filename": "server/api/analyticCustomReport/index.js",
 138     "groupTitle": "Analytic_Custom_Reports"
 139   },
 140   {
 141     "type": "get",
 142     "url": "/api/analytics/custom_reports/{id}",
 143     "title": "Gets a single Analytic Custom Report",
 144     "examples": [
 145       {
 146         "title": "Example usage:",
 147         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
 148         "type": "json"
 149       }
 150     ],
 151     "name": "ShowAnalytic_Custom_Reports",
 152     "group": "Analytic_Custom_Reports",
 153     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 154     "version": "0.0.0",
 155     "filename": "server/api/analyticCustomReport/index.js",
 156     "groupTitle": "Analytic_Custom_Reports"
 157   },
 158   {
 159     "type": "get",
 160     "url": "/api/analytics/custom_reports/{id}/preview",
 161     "title": "Report Preview",
 162     "examples": [
 163       {
 164         "title": "Example usage:",
 165         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
 166         "type": "json"
 167       }
 168     ],
 169     "name": "preview",
 170     "group": "Analytic_Custom_Reports",
 171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 172     "version": "0.0.0",
 173     "filename": "server/api/analyticCustomReport/index.js",
 174     "groupTitle": "Analytic_Custom_Reports"
 175   },
 176   {
 177     "type": "get",
 178     "url": "/api/analytics/custom_reports/{id}/query",
 179     "title": "Report Query SQL",
 180     "examples": [
 181       {
 182         "title": "Example usage:",
 183         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
 184         "type": "json"
 185       }
 186     ],
 187     "name": "query",
 188     "group": "Analytic_Custom_Reports",
 189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 190     "version": "0.0.0",
 191     "filename": "server/api/analyticCustomReport/index.js",
 192     "groupTitle": "Analytic_Custom_Reports"
 193   },
 194   {
 195     "type": "get",
 196     "url": "/api/analytics/custom_reports/{id}/run",
 197     "title": "Report Run",
 198     "examples": [
 199       {
 200         "title": "Example usage:",
 201         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
 202         "type": "json"
 203       }
 204     ],
 205     "name": "run",
 206     "group": "Analytic_Custom_Reports",
 207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 208     "version": "0.0.0",
 209     "filename": "server/api/analyticCustomReport/index.js",
 210     "groupTitle": "Analytic_Custom_Reports"
 211   },
 212   {
 213     "type": "put",
 214     "url": "/api/analytics/custom_reports/{id}",
 215     "title": "Update an existing Analytic Custom Report",
 216     "examples": [
 217       {
 218         "title": "Example usage:",
 219         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 220         "type": "json"
 221       }
 222     ],
 223     "name": "updateAnalytic_Custom_Reports",
 224     "group": "Analytic_Custom_Reports",
 225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 226     "version": "0.0.0",
 227     "filename": "server/api/analyticCustomReport/index.js",
 228     "groupTitle": "Analytic_Custom_Reports"
 229   },
 230   {
 231     "type": "post",
 232     "url": "/api/analytics/default_reports",
 233     "title": "Creates a new Analytic Default Report",
 234     "examples": [
 235       {
 236         "title": "Example usage:",
 237         "content": "curl https://{domain}/api/analytics/default_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 238         "type": "json"
 239       }
 240     ],
 241     "name": "CreateAnalytic_Default_Reports",
 242     "group": "Analytic_Default_Reports",
 243     "parameter": {
 244       "fields": {
 245         "Body": [
 246           {
 247             "group": "Body",
 248             "type": "String",
 249             "optional": false,
 250             "field": "name",
 251             "description": ""
 252           },
 253           {
 254             "group": "Body",
 255             "type": "String",
 256             "optional": true,
 257             "field": "description",
 258             "description": ""
 259           },
 260           {
 261             "group": "Body",
 262             "type": "String",
 263             "optional": true,
 264             "field": "parent",
 265             "description": ""
 266           },
 267           {
 268             "group": "Body",
 269             "type": "String",
 270             "optional": true,
 271             "field": "table",
 272             "description": ""
 273           },
 274           {
 275             "group": "Body",
 276             "type": "Text",
 277             "optional": true,
 278             "field": "conditions",
 279             "description": ""
 280           },
 281           {
 282             "group": "Body",
 283             "type": "Text",
 284             "optional": true,
 285             "field": "joins",
 286             "description": ""
 287           }
 288         ]
 289       }
 290     },
 291     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 292     "version": "0.0.0",
 293     "filename": "server/api/analyticDefaultReport/index.js",
 294     "groupTitle": "Analytic_Default_Reports"
 295   },
 296   {
 297     "type": "delete",
 298     "url": "/api/analytics/default_reports/{id}",
 299     "title": "Deletes a Analytic Default Report",
 300     "examples": [
 301       {
 302         "title": "Example usage:",
 303         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
 304         "type": "json"
 305       }
 306     ],
 307     "name": "DeleteAnalytic_Default_Reports",
 308     "group": "Analytic_Default_Reports",
 309     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 310     "version": "0.0.0",
 311     "filename": "server/api/analyticDefaultReport/index.js",
 312     "groupTitle": "Analytic_Default_Reports"
 313   },
 314   {
 315     "type": "get",
 316     "url": "/api/analytics/default_reports",
 317     "title": "Gets a list of Analytic Default Reports",
 318     "examples": [
 319       {
 320         "title": "Example usage:",
 321         "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
 322         "type": "json"
 323       }
 324     ],
 325     "name": "GetAnalytic_Default_Reports",
 326     "group": "Analytic_Default_Reports",
 327     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/default_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/default_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/default_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/default_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/default_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 328     "version": "0.0.0",
 329     "filename": "server/api/analyticDefaultReport/index.js",
 330     "groupTitle": "Analytic_Default_Reports"
 331   },
 332   {
 333     "type": "get",
 334     "url": "/api/analytics/default_reports/{id}",
 335     "title": "Gets a single Analytic Default Report",
 336     "examples": [
 337       {
 338         "title": "Example usage:",
 339         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
 340         "type": "json"
 341       }
 342     ],
 343     "name": "ShowAnalytic_Default_Reports",
 344     "group": "Analytic_Default_Reports",
 345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 346     "version": "0.0.0",
 347     "filename": "server/api/analyticDefaultReport/index.js",
 348     "groupTitle": "Analytic_Default_Reports"
 349   },
 350   {
 351     "type": "get",
 352     "url": "/api/analytics/default_reports/{id}/preview",
 353     "title": "Report Preview",
 354     "examples": [
 355       {
 356         "title": "Example usage:",
 357         "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
 358         "type": "json"
 359       }
 360     ],
 361     "name": "preview",
 362     "group": "Analytic_Default_Reports",
 363     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 364     "version": "0.0.0",
 365     "filename": "server/api/analyticDefaultReport/index.js",
 366     "groupTitle": "Analytic_Default_Reports"
 367   },
 368   {
 369     "type": "get",
 370     "url": "/api/analytics/default_reports/{id}/query",
 371     "title": "Report Query SQL",
 372     "examples": [
 373       {
 374         "title": "Example usage:",
 375         "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
 376         "type": "json"
 377       }
 378     ],
 379     "name": "query",
 380     "group": "Analytic_Default_Reports",
 381     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 382     "version": "0.0.0",
 383     "filename": "server/api/analyticDefaultReport/index.js",
 384     "groupTitle": "Analytic_Default_Reports"
 385   },
 386   {
 387     "type": "get",
 388     "url": "/api/analytics/default_reports/{id}/run",
 389     "title": "Report Run",
 390     "examples": [
 391       {
 392         "title": "Example usage:",
 393         "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
 394         "type": "json"
 395       }
 396     ],
 397     "name": "run",
 398     "group": "Analytic_Default_Reports",
 399     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 400     "version": "0.0.0",
 401     "filename": "server/api/analyticDefaultReport/index.js",
 402     "groupTitle": "Analytic_Default_Reports"
 403   },
 404   {
 405     "type": "put",
 406     "url": "/api/analytics/default_reports/{id}",
 407     "title": "Update an existing Analytic Default Report",
 408     "examples": [
 409       {
 410         "title": "Example usage:",
 411         "content": "curl https://{domain}/api/analytics/default_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 412         "type": "json"
 413       }
 414     ],
 415     "name": "updateAnalytic_Default_Reports",
 416     "group": "Analytic_Default_Reports",
 417     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 418     "version": "0.0.0",
 419     "filename": "server/api/analyticDefaultReport/index.js",
 420     "groupTitle": "Analytic_Default_Reports"
 421   },
 422   {
 423     "type": "post",
 424     "url": "/api/analytics/extracted_reports",
 425     "title": "Creates a new Analytic Extracted Report",
 426     "examples": [
 427       {
 428         "title": "Example usage:",
 429         "content": "curl https://{domain}/api/analytics/extracted_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 430         "type": "json"
 431       }
 432     ],
 433     "name": "CreateAnalytic_Extacted_Reports",
 434     "group": "Analytic_Extracted_Reports",
 435     "parameter": {
 436       "fields": {
 437         "Body": [
 438           {
 439             "group": "Body",
 440             "type": "String",
 441             "optional": false,
 442             "field": "name",
 443             "description": ""
 444           },
 445           {
 446             "group": "Body",
 447             "type": "String",
 448             "optional": false,
 449             "field": "basename",
 450             "description": ""
 451           },
 452           {
 453             "group": "Body",
 454             "type": "String",
 455             "allowedValues": [
 456               "\"csv\"",
 457               "\"pdf\"",
 458               "\"xlsx\""
 459             ],
 460             "optional": false,
 461             "field": "output",
 462             "description": ""
 463           },
 464           {
 465             "group": "Body",
 466             "type": "String",
 467             "optional": false,
 468             "field": "savename",
 469             "description": ""
 470           },
 471           {
 472             "group": "Body",
 473             "type": "String",
 474             "optional": true,
 475             "field": "startDate",
 476             "description": ""
 477           },
 478           {
 479             "group": "Body",
 480             "type": "String",
 481             "optional": true,
 482             "field": "endDate",
 483             "description": ""
 484           },
 485           {
 486             "group": "Body",
 487             "type": "String",
 488             "optional": true,
 489             "field": "status",
 490             "description": ""
 491           },
 492           {
 493             "group": "Body",
 494             "type": "String",
 495             "allowedValues": [
 496               "\"manual\"",
 497               "\"scheduled\""
 498             ],
 499             "optional": false,
 500             "field": "type",
 501             "description": ""
 502           },
 503           {
 504             "group": "Body",
 505             "type": "Integer",
 506             "optional": true,
 507             "field": "reportId",
 508             "description": ""
 509           },
 510           {
 511             "group": "Body",
 512             "type": "String",
 513             "optional": true,
 514             "field": "reportType",
 515             "description": ""
 516           }
 517         ]
 518       }
 519     },
 520     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 521     "version": "0.0.0",
 522     "filename": "server/api/analyticExtractedReport/index.js",
 523     "groupTitle": "Analytic_Extracted_Reports"
 524   },
 525   {
 526     "type": "delete",
 527     "url": "/api/analytics/extracted_reports/{id}",
 528     "title": "Deletes a Analytic Extracted Report",
 529     "examples": [
 530       {
 531         "title": "Example usage:",
 532         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
 533         "type": "json"
 534       }
 535     ],
 536     "name": "DeleteAnalytic_Extacted_Reports",
 537     "group": "Analytic_Extracted_Reports",
 538     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 539     "version": "0.0.0",
 540     "filename": "server/api/analyticExtractedReport/index.js",
 541     "groupTitle": "Analytic_Extracted_Reports"
 542   },
 543   {
 544     "type": "get",
 545     "url": "/api/analytics/extracted_reports",
 546     "title": "Gets a list of Analytic Extacted Reports",
 547     "examples": [
 548       {
 549         "title": "Example usage:",
 550         "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
 551         "type": "json"
 552       }
 553     ],
 554     "name": "GetAnalytic_Extacted_Reports",
 555     "group": "Analytic_Extracted_Reports",
 556     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/extracted_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/extracted_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/extracted_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/extracted_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/extracted_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 557     "version": "0.0.0",
 558     "filename": "server/api/analyticExtractedReport/index.js",
 559     "groupTitle": "Analytic_Extracted_Reports"
 560   },
 561   {
 562     "type": "get",
 563     "url": "/api/analytics/extracted_reports/{id}",
 564     "title": "Gets a single Analytic Extracted Report",
 565     "examples": [
 566       {
 567         "title": "Example usage:",
 568         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
 569         "type": "json"
 570       }
 571     ],
 572     "name": "ShowAnalytic_Extacted_Reports",
 573     "group": "Analytic_Extracted_Reports",
 574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 575     "version": "0.0.0",
 576     "filename": "server/api/analyticExtractedReport/index.js",
 577     "groupTitle": "Analytic_Extracted_Reports"
 578   },
 579   {
 580     "type": "get",
 581     "url": "/api/analytics/extracted_reports/{id}/download",
 582     "title": "Download Extracted Report",
 583     "examples": [
 584       {
 585         "title": "Example usage:",
 586         "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
 587         "type": "json"
 588       }
 589     ],
 590     "name": "download",
 591     "group": "Analytic_Extracted_Reports",
 592     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 593     "version": "0.0.0",
 594     "filename": "server/api/analyticExtractedReport/index.js",
 595     "groupTitle": "Analytic_Extracted_Reports"
 596   },
 597   {
 598     "type": "put",
 599     "url": "/api/analytics/extracted_reports/{id}",
 600     "title": "Update an existing Analytic Extracted Report",
 601     "examples": [
 602       {
 603         "title": "Example usage:",
 604         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 605         "type": "json"
 606       }
 607     ],
 608     "name": "updateAnalytic_Extacted_Reports",
 609     "group": "Analytic_Extracted_Reports",
 610     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 611     "version": "0.0.0",
 612     "filename": "server/api/analyticExtractedReport/index.js",
 613     "groupTitle": "Analytic_Extracted_Reports"
 614   },
 615   {
 616     "type": "post",
 617     "url": "/api/analytics/field_reports/create_many",
 618     "title": "Creates many Analytic Field Reports",
 619     "examples": [
 620       {
 621         "title": "Example usage:",
 622         "content": "curl https://{domain}/api/analytics/field_reports/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 623         "type": "json"
 624       }
 625     ],
 626     "name": "BulkCreateAnalytic_Field_Reports",
 627     "group": "Analytic_Field_Reports",
 628     "parameter": {
 629       "fields": {
 630         "Body": [
 631           {
 632             "group": "Body",
 633             "type": "Text",
 634             "optional": true,
 635             "field": "field",
 636             "description": ""
 637           },
 638           {
 639             "group": "Body",
 640             "type": "String",
 641             "optional": true,
 642             "field": "alias",
 643             "description": ""
 644           },
 645           {
 646             "group": "Body",
 647             "type": "String",
 648             "optional": true,
 649             "field": "function",
 650             "description": ""
 651           },
 652           {
 653             "group": "Body",
 654             "type": "String",
 655             "optional": true,
 656             "field": "format",
 657             "description": ""
 658           },
 659           {
 660             "group": "Body",
 661             "type": "Boolean",
 662             "optional": true,
 663             "field": "groupBy",
 664             "description": ""
 665           },
 666           {
 667             "group": "Body",
 668             "type": "String",
 669             "optional": true,
 670             "field": "orderBy",
 671             "description": ""
 672           },
 673           {
 674             "group": "Body",
 675             "type": "Boolean",
 676             "optional": true,
 677             "field": "custom",
 678             "description": ""
 679           }
 680         ]
 681       }
 682     },
 683     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 684     "version": "0.0.0",
 685     "filename": "server/api/analyticFieldReport/index.js",
 686     "groupTitle": "Analytic_Field_Reports"
 687   },
 688   {
 689     "type": "delete",
 690     "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
 691     "title": "Deletes many Analytic Field Reports",
 692     "examples": [
 693       {
 694         "title": "Example usage:",
 695         "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
 696         "type": "json"
 697       }
 698     ],
 699     "name": "BulkDeleteAnalytic_Field_Reports",
 700     "group": "Analytic_Field_Reports",
 701     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 702     "version": "0.0.0",
 703     "filename": "server/api/analyticFieldReport/index.js",
 704     "groupTitle": "Analytic_Field_Reports"
 705   },
 706   {
 707     "type": "post",
 708     "url": "/api/analytics/field_reports",
 709     "title": "Creates a new Analytic Field Report",
 710     "examples": [
 711       {
 712         "title": "Example usage:",
 713         "content": "curl https://{domain}/api/analytics/field_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 714         "type": "json"
 715       }
 716     ],
 717     "name": "CreateAnalytic_Field_Reports",
 718     "group": "Analytic_Field_Reports",
 719     "parameter": {
 720       "fields": {
 721         "Body": [
 722           {
 723             "group": "Body",
 724             "type": "Text",
 725             "optional": true,
 726             "field": "field",
 727             "description": ""
 728           },
 729           {
 730             "group": "Body",
 731             "type": "String",
 732             "optional": true,
 733             "field": "alias",
 734             "description": ""
 735           },
 736           {
 737             "group": "Body",
 738             "type": "String",
 739             "optional": true,
 740             "field": "function",
 741             "description": ""
 742           },
 743           {
 744             "group": "Body",
 745             "type": "String",
 746             "optional": true,
 747             "field": "format",
 748             "description": ""
 749           },
 750           {
 751             "group": "Body",
 752             "type": "Boolean",
 753             "optional": true,
 754             "field": "groupBy",
 755             "description": ""
 756           },
 757           {
 758             "group": "Body",
 759             "type": "String",
 760             "optional": true,
 761             "field": "orderBy",
 762             "description": ""
 763           },
 764           {
 765             "group": "Body",
 766             "type": "Boolean",
 767             "optional": true,
 768             "field": "custom",
 769             "description": ""
 770           }
 771         ]
 772       }
 773     },
 774     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 775     "version": "0.0.0",
 776     "filename": "server/api/analyticFieldReport/index.js",
 777     "groupTitle": "Analytic_Field_Reports"
 778   },
 779   {
 780     "type": "delete",
 781     "url": "/api/analytics/field_reports/{id}",
 782     "title": "Deletes a Analytic Field Report",
 783     "examples": [
 784       {
 785         "title": "Example usage:",
 786         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
 787         "type": "json"
 788       }
 789     ],
 790     "name": "DeleteAnalytic_Field_Reports",
 791     "group": "Analytic_Field_Reports",
 792     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 793     "version": "0.0.0",
 794     "filename": "server/api/analyticFieldReport/index.js",
 795     "groupTitle": "Analytic_Field_Reports"
 796   },
 797   {
 798     "type": "get",
 799     "url": "/api/analytics/field_reports",
 800     "title": "Gets a list of Analytic Field Reports",
 801     "examples": [
 802       {
 803         "title": "Example usage:",
 804         "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
 805         "type": "json"
 806       }
 807     ],
 808     "name": "GetAnalytic_Field_Reports",
 809     "group": "Analytic_Field_Reports",
 810     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/field_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/field_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/field_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/field_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/field_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 811     "version": "0.0.0",
 812     "filename": "server/api/analyticFieldReport/index.js",
 813     "groupTitle": "Analytic_Field_Reports"
 814   },
 815   {
 816     "type": "get",
 817     "url": "/api/analytics/field_reports/{id}",
 818     "title": "Gets a single Analytic Field Report",
 819     "examples": [
 820       {
 821         "title": "Example usage:",
 822         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
 823         "type": "json"
 824       }
 825     ],
 826     "name": "ShowAnalytic_Field_Reports",
 827     "group": "Analytic_Field_Reports",
 828     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 829     "version": "0.0.0",
 830     "filename": "server/api/analyticFieldReport/index.js",
 831     "groupTitle": "Analytic_Field_Reports"
 832   },
 833   {
 834     "type": "post",
 835     "url": "/api/analytics/field_reports/{id}/create_many",
 836     "title": "Rewrite fields set",
 837     "examples": [
 838       {
 839         "title": "Example usage:",
 840         "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
 841         "type": "json"
 842       }
 843     ],
 844     "name": "addFields",
 845     "group": "Analytic_Field_Reports",
 846     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 847     "version": "0.0.0",
 848     "filename": "server/api/analyticFieldReport/index.js",
 849     "groupTitle": "Analytic_Field_Reports"
 850   },
 851   {
 852     "type": "put",
 853     "url": "/api/analytics/field_reports/{id}",
 854     "title": "Update an existing Analytic Field Report",
 855     "examples": [
 856       {
 857         "title": "Example usage:",
 858         "content": "curl https://{domain}/api/analytics/field_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 859         "type": "json"
 860       }
 861     ],
 862     "name": "updateAnalytic_Field_Reports",
 863     "group": "Analytic_Field_Reports",
 864     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 865     "version": "0.0.0",
 866     "filename": "server/api/analyticFieldReport/index.js",
 867     "groupTitle": "Analytic_Field_Reports"
 868   },
 869   {
 870     "type": "post",
 871     "url": "/api/analytics/metrics",
 872     "title": "Creates a new Analytic Metrics",
 873     "examples": [
 874       {
 875         "title": "Example usage:",
 876         "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 877         "type": "json"
 878       }
 879     ],
 880     "name": "CreateAnalytic_Metric",
 881     "group": "Analytic_Metrics",
 882     "parameter": {
 883       "fields": {
 884         "Body": [
 885           {
 886             "group": "Body",
 887             "type": "String",
 888             "optional": false,
 889             "field": "name",
 890             "description": ""
 891           },
 892           {
 893             "group": "Body",
 894             "type": "String",
 895             "optional": true,
 896             "field": "table",
 897             "description": ""
 898           },
 899           {
 900             "group": "Body",
 901             "type": "Text",
 902             "optional": true,
 903             "field": "metric",
 904             "description": ""
 905           },
 906           {
 907             "group": "Body",
 908             "type": "String",
 909             "optional": true,
 910             "field": "description",
 911             "description": ""
 912           }
 913         ]
 914       }
 915     },
 916     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 917     "version": "0.0.0",
 918     "filename": "server/api/analyticMetric/index.js",
 919     "groupTitle": "Analytic_Metrics"
 920   },
 921   {
 922     "type": "delete",
 923     "url": "/api/analytics/metrics/{id}",
 924     "title": "Deletes a Analytic Metrics",
 925     "examples": [
 926       {
 927         "title": "Example usage:",
 928         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
 929         "type": "json"
 930       }
 931     ],
 932     "name": "DeleteAnalytic_Metric",
 933     "group": "Analytic_Metrics",
 934     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 935     "version": "0.0.0",
 936     "filename": "server/api/analyticMetric/index.js",
 937     "groupTitle": "Analytic_Metrics"
 938   },
 939   {
 940     "type": "get",
 941     "url": "/api/analytics/metrics",
 942     "title": "Gets a list of Analytic Metric",
 943     "examples": [
 944       {
 945         "title": "Example usage:",
 946         "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
 947         "type": "json"
 948       }
 949     ],
 950     "name": "GetAnalytic_Metric",
 951     "group": "Analytic_Metrics",
 952     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/metrics?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/metrics?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/metrics?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/metrics?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/metrics?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 953     "version": "0.0.0",
 954     "filename": "server/api/analyticMetric/index.js",
 955     "groupTitle": "Analytic_Metrics"
 956   },
 957   {
 958     "type": "get",
 959     "url": "/api/analytics/metrics/{id}",
 960     "title": "Gets a single Analytic Metrics",
 961     "examples": [
 962       {
 963         "title": "Example usage:",
 964         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
 965         "type": "json"
 966       }
 967     ],
 968     "name": "ShowAnalytic_Metric",
 969     "group": "Analytic_Metrics",
 970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 971     "version": "0.0.0",
 972     "filename": "server/api/analyticMetric/index.js",
 973     "groupTitle": "Analytic_Metrics"
 974   },
 975   {
 976     "type": "put",
 977     "url": "/api/analytics/metrics/{id}",
 978     "title": "Update an existing Analytic Metrics",
 979     "examples": [
 980       {
 981         "title": "Example usage:",
 982         "content": "curl https://{domain}/api/analytics/metrics/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 983         "type": "json"
 984       }
 985     ],
 986     "name": "updateAnalytic_Metric",
 987     "group": "Analytic_Metrics",
 988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 989     "version": "0.0.0",
 990     "filename": "server/api/analyticMetric/index.js",
 991     "groupTitle": "Analytic_Metrics"
 992   },
 993   {
 994     "type": "post",
 995     "url": "/api/analytics/tree_reports",
 996     "title": "Creates a new Analytic Tree Report",
 997     "examples": [
 998       {
 999         "title": "Example usage:",
1000         "content": "curl https://{domain}/api/analytics/tree_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1001         "type": "json"
1002       }
1003     ],
1004     "name": "CreateAnalytic_Tree_Reports",
1005     "group": "Analytic_Tree_Reports",
1006     "parameter": {
1007       "fields": {
1008         "Body": [
1009           {
1010             "group": "Body",
1011             "type": "Text",
1012             "optional": false,
1013             "field": "tree",
1014             "description": ""
1015           }
1016         ]
1017       }
1018     },
1019     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1020     "version": "0.0.0",
1021     "filename": "server/api/analyticTreeReport/index.js",
1022     "groupTitle": "Analytic_Tree_Reports"
1023   },
1024   {
1025     "type": "delete",
1026     "url": "/api/analytics/tree_reports/{id}",
1027     "title": "Deletes a Analytic Tree Report",
1028     "examples": [
1029       {
1030         "title": "Example usage:",
1031         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1032         "type": "json"
1033       }
1034     ],
1035     "name": "DeleteAnalytic_Tree_Reports",
1036     "group": "Analytic_Tree_Reports",
1037     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1038     "version": "0.0.0",
1039     "filename": "server/api/analyticTreeReport/index.js",
1040     "groupTitle": "Analytic_Tree_Reports"
1041   },
1042   {
1043     "type": "get",
1044     "url": "/api/analytics/tree_reports",
1045     "title": "Gets a list of Analytic Tree Reports",
1046     "examples": [
1047       {
1048         "title": "Example usage:",
1049         "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1050         "type": "json"
1051       }
1052     ],
1053     "name": "GetAnalytic_Tree_Reports",
1054     "group": "Analytic_Tree_Reports",
1055     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/tree_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/tree_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/tree_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/tree_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/tree_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1056     "version": "0.0.0",
1057     "filename": "server/api/analyticTreeReport/index.js",
1058     "groupTitle": "Analytic_Tree_Reports"
1059   },
1060   {
1061     "type": "get",
1062     "url": "/api/analytics/tree_reports/{id}",
1063     "title": "Gets a single Analytic Tree Report",
1064     "examples": [
1065       {
1066         "title": "Example usage:",
1067         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1068         "type": "json"
1069       }
1070     ],
1071     "name": "ShowAnalytic_Tree_Reports",
1072     "group": "Analytic_Tree_Reports",
1073     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1074     "version": "0.0.0",
1075     "filename": "server/api/analyticTreeReport/index.js",
1076     "groupTitle": "Analytic_Tree_Reports"
1077   },
1078   {
1079     "type": "put",
1080     "url": "/api/analytics/tree_reports/{id}",
1081     "title": "Update an existing Analytic Tree Report",
1082     "examples": [
1083       {
1084         "title": "Example usage:",
1085         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1086         "type": "json"
1087       }
1088     ],
1089     "name": "updateAnalytic_Tree_Reports",
1090     "group": "Analytic_Tree_Reports",
1091     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1092     "version": "0.0.0",
1093     "filename": "server/api/analyticTreeReport/index.js",
1094     "groupTitle": "Analytic_Tree_Reports"
1095   },
1096   {
1097     "type": "post",
1098     "url": "/api/attachments/clone",
1099     "title": "Clone an existing Attachment",
1100     "examples": [
1101       {
1102         "title": "Example usage:",
1103         "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1104         "type": "json"
1105       }
1106     ],
1107     "name": "CloneAttachments",
1108     "group": "Attachments",
1109     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1110     "version": "0.0.0",
1111     "filename": "server/api/attachment/index.js",
1112     "groupTitle": "Attachments"
1113   },
1114   {
1115     "type": "delete",
1116     "url": "/api/attachments/{id}",
1117     "title": "Deletes a Attachment",
1118     "examples": [
1119       {
1120         "title": "Example usage:",
1121         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1122         "type": "json"
1123       }
1124     ],
1125     "name": "DeleteAttachments",
1126     "group": "Attachments",
1127     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1128     "version": "0.0.0",
1129     "filename": "server/api/attachment/index.js",
1130     "groupTitle": "Attachments"
1131   },
1132   {
1133     "type": "get",
1134     "url": "/api/attachments",
1135     "title": "Gets a list of Attachments",
1136     "examples": [
1137       {
1138         "title": "Example usage:",
1139         "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1140         "type": "json"
1141       }
1142     ],
1143     "name": "GetAttachments",
1144     "group": "Attachments",
1145     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/attachments?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/attachments?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/attachments?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/attachments?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/attachments?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1146     "version": "0.0.0",
1147     "filename": "server/api/attachment/index.js",
1148     "groupTitle": "Attachments"
1149   },
1150   {
1151     "type": "get",
1152     "url": "/api/attachments/{id}",
1153     "title": "Gets a single Attachment",
1154     "examples": [
1155       {
1156         "title": "Example usage:",
1157         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1158         "type": "json"
1159       }
1160     ],
1161     "name": "ShowAttachments",
1162     "group": "Attachments",
1163     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1164     "version": "0.0.0",
1165     "filename": "server/api/attachment/index.js",
1166     "groupTitle": "Attachments"
1167   },
1168   {
1169     "type": "post",
1170     "url": "/api/attachments",
1171     "title": "Add attachment",
1172     "examples": [
1173       {
1174         "title": "Example usage:",
1175         "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1176         "type": "json"
1177       }
1178     ],
1179     "name": "create",
1180     "group": "Attachments",
1181     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1182     "version": "0.0.0",
1183     "filename": "server/api/attachment/index.js",
1184     "groupTitle": "Attachments"
1185   },
1186   {
1187     "type": "get",
1188     "url": "/api/attachments/:id/download",
1189     "title": "Download attachment",
1190     "examples": [
1191       {
1192         "title": "Example usage:",
1193         "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1194         "type": "json"
1195       }
1196     ],
1197     "name": "download",
1198     "group": "Attachments",
1199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1200     "version": "0.0.0",
1201     "filename": "server/api/attachment/index.js",
1202     "groupTitle": "Attachments"
1203   },
1204   {
1205     "type": "get",
1206     "url": "/api/chat/interactions/{id}/attachment_download",
1207     "title": "Download attachment",
1208     "examples": [
1209       {
1210         "title": "Example usage:",
1211         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1212         "type": "json"
1213       }
1214     ],
1215     "name": "show",
1216     "group": "Attachments",
1217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1218     "version": "0.0.0",
1219     "filename": "server/api/chatInteraction/index.js",
1220     "groupTitle": "Attachments"
1221   },
1222   {
1223     "type": "put",
1224     "url": "/api/attachments/{id}",
1225     "title": "Update an existing Attachment",
1226     "examples": [
1227       {
1228         "title": "Example usage:",
1229         "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1230         "type": "json"
1231       }
1232     ],
1233     "name": "updateAttachments",
1234     "group": "Attachments",
1235     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1236     "version": "0.0.0",
1237     "filename": "server/api/attachment/index.js",
1238     "groupTitle": "Attachments"
1239   },
1240   {
1241     "type": "post",
1242     "url": "/api/auth/local/forgot",
1243     "title": "Creates a new password reset token",
1244     "examples": [
1245       {
1246         "title": "Example usage:",
1247         "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1248         "type": "json"
1249       }
1250     ],
1251     "name": "Local_Forgot_Password",
1252     "group": "Authentication",
1253     "parameter": {
1254       "fields": {
1255         "Body": [
1256           {
1257             "group": "Body",
1258             "type": "String",
1259             "optional": false,
1260             "field": "email",
1261             "description": ""
1262           }
1263         ]
1264       }
1265     },
1266     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1267     "version": "0.0.0",
1268     "filename": "server/api/authLocal/index.js",
1269     "groupTitle": "Authentication"
1270   },
1271   {
1272     "type": "post",
1273     "url": "/api/auth/local/reset/:token",
1274     "title": "Reset user password",
1275     "examples": [
1276       {
1277         "title": "Example usage:",
1278         "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1279         "type": "json"
1280       }
1281     ],
1282     "name": "Local_Reset_Password",
1283     "group": "Authentication",
1284     "parameter": {
1285       "fields": {
1286         "Body": [
1287           {
1288             "group": "Body",
1289             "type": "String",
1290             "optional": false,
1291             "field": "password",
1292             "description": ""
1293           }
1294         ]
1295       }
1296     },
1297     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1298     "version": "0.0.0",
1299     "filename": "server/api/authLocal/index.js",
1300     "groupTitle": "Authentication"
1301   },
1302   {
1303     "type": "post",
1304     "url": "/api/auth/google",
1305     "title": "Creates a new User token",
1306     "examples": [
1307       {
1308         "title": "Example usage:",
1309         "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1310         "type": "json"
1311       }
1312     ],
1313     "name": "Local_login",
1314     "group": "Authentication",
1315     "parameter": {
1316       "fields": {
1317         "Body": [
1318           {
1319             "group": "Body",
1320             "type": "String",
1321             "optional": false,
1322             "field": "name",
1323             "description": ""
1324           },
1325           {
1326             "group": "Body",
1327             "type": "String",
1328             "optional": false,
1329             "field": "password",
1330             "description": ""
1331           }
1332         ]
1333       }
1334     },
1335     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1336     "version": "0.0.0",
1337     "filename": "server/api/authGoogle/index.js",
1338     "groupTitle": "Authentication"
1339   },
1340   {
1341     "type": "post",
1342     "url": "/api/auth/local",
1343     "title": "Creates a new User token",
1344     "examples": [
1345       {
1346         "title": "Example usage:",
1347         "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1348         "type": "json"
1349       }
1350     ],
1351     "name": "Local_login",
1352     "group": "Authentication",
1353     "parameter": {
1354       "fields": {
1355         "Body": [
1356           {
1357             "group": "Body",
1358             "type": "String",
1359             "optional": false,
1360             "field": "name",
1361             "description": ""
1362           },
1363           {
1364             "group": "Body",
1365             "type": "String",
1366             "optional": false,
1367             "field": "password",
1368             "description": ""
1369           }
1370         ]
1371       }
1372     },
1373     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1374     "version": "0.0.0",
1375     "filename": "server/api/authLocal/index.js",
1376     "groupTitle": "Authentication"
1377   },
1378   {
1379     "type": "post",
1380     "url": "/api/automations",
1381     "title": "Creates a new Automation",
1382     "examples": [
1383       {
1384         "title": "Example usage:",
1385         "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1386         "type": "json"
1387       }
1388     ],
1389     "name": "CreateAutomations",
1390     "group": "Automations",
1391     "parameter": {
1392       "fields": {
1393         "Body": [
1394           {
1395             "group": "Body",
1396             "type": "String",
1397             "optional": false,
1398             "field": "name",
1399             "description": ""
1400           },
1401           {
1402             "group": "Body",
1403             "type": "String",
1404             "optional": true,
1405             "field": "channel",
1406             "description": ""
1407           },
1408           {
1409             "group": "Body",
1410             "type": "String",
1411             "optional": true,
1412             "field": "description",
1413             "description": ""
1414           },
1415           {
1416             "group": "Body",
1417             "type": "Boolean",
1418             "optional": true,
1419             "field": "status",
1420             "description": ""
1421           },
1422           {
1423             "group": "Body",
1424             "type": "Integer",
1425             "optional": true,
1426             "field": "timeout",
1427             "description": ""
1428           }
1429         ]
1430       }
1431     },
1432     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1433     "version": "0.0.0",
1434     "filename": "server/api/automation/index.js",
1435     "groupTitle": "Automations"
1436   },
1437   {
1438     "type": "delete",
1439     "url": "/api/automations/{id}",
1440     "title": "Deletes a Automation",
1441     "examples": [
1442       {
1443         "title": "Example usage:",
1444         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1445         "type": "json"
1446       }
1447     ],
1448     "name": "DeleteAutomations",
1449     "group": "Automations",
1450     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1451     "version": "0.0.0",
1452     "filename": "server/api/automation/index.js",
1453     "groupTitle": "Automations"
1454   },
1455   {
1456     "type": "get",
1457     "url": "/api/automations",
1458     "title": "Gets a list of Automations",
1459     "examples": [
1460       {
1461         "title": "Example usage:",
1462         "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1463         "type": "json"
1464       }
1465     ],
1466     "name": "GetAutomations",
1467     "group": "Automations",
1468     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/automations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/automations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/automations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/automations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/automations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1469     "version": "0.0.0",
1470     "filename": "server/api/automation/index.js",
1471     "groupTitle": "Automations"
1472   },
1473   {
1474     "type": "get",
1475     "url": "/api/automations/{id}",
1476     "title": "Gets a single Automation",
1477     "examples": [
1478       {
1479         "title": "Example usage:",
1480         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1481         "type": "json"
1482       }
1483     ],
1484     "name": "ShowAutomations",
1485     "group": "Automations",
1486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1487     "version": "0.0.0",
1488     "filename": "server/api/automation/index.js",
1489     "groupTitle": "Automations"
1490   },
1491   {
1492     "type": "post",
1493     "url": "/api/automations/{id}/actions",
1494     "title": "Creates new actions",
1495     "examples": [
1496       {
1497         "title": "Example usage:",
1498         "content": "curl https://{domain}/api/automations/{id}/actions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1499         "type": "json"
1500       }
1501     ],
1502     "name": "addActions",
1503     "group": "Automations",
1504     "parameter": {
1505       "fields": {
1506         "Body": [
1507           {
1508             "group": "Body",
1509             "type": "Virtual",
1510             "optional": true,
1511             "field": "name",
1512             "description": ""
1513           },
1514           {
1515             "group": "Body",
1516             "type": "String",
1517             "optional": false,
1518             "field": "action",
1519             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1520           },
1521           {
1522             "group": "Body",
1523             "type": "String",
1524             "optional": true,
1525             "field": "data1",
1526             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1527           },
1528           {
1529             "group": "Body",
1530             "type": "String",
1531             "optional": true,
1532             "field": "data2",
1533             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1534           },
1535           {
1536             "group": "Body",
1537             "type": "String",
1538             "optional": true,
1539             "field": "data3",
1540             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1541           },
1542           {
1543             "group": "Body",
1544             "type": "String",
1545             "optional": true,
1546             "field": "data4",
1547             "description": ""
1548           },
1549           {
1550             "group": "Body",
1551             "type": "String",
1552             "optional": true,
1553             "field": "data5",
1554             "description": ""
1555           },
1556           {
1557             "group": "Body",
1558             "type": "String",
1559             "optional": true,
1560             "field": "data6",
1561             "description": ""
1562           },
1563           {
1564             "group": "Body",
1565             "type": "Text",
1566             "optional": true,
1567             "field": "data7",
1568             "description": ""
1569           }
1570         ]
1571       }
1572     },
1573     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1574     "version": "0.0.0",
1575     "filename": "server/api/automation/index.js",
1576     "groupTitle": "Automations"
1577   },
1578   {
1579     "type": "post",
1580     "url": "/api/automations/{id}/conditions",
1581     "title": "Creates new conditions",
1582     "examples": [
1583       {
1584         "title": "Example usage:",
1585         "content": "curl https://{domain}/api/automations/{id}/conditions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1586         "type": "json"
1587       }
1588     ],
1589     "name": "addConditions",
1590     "group": "Automations",
1591     "parameter": {
1592       "fields": {
1593         "Body": [
1594           {
1595             "group": "Body",
1596             "type": "Virtual",
1597             "optional": true,
1598             "field": "name",
1599             "description": ""
1600           },
1601           {
1602             "group": "Body",
1603             "type": "String",
1604             "optional": false,
1605             "field": "field",
1606             "description": ""
1607           },
1608           {
1609             "group": "Body",
1610             "type": "String",
1611             "optional": false,
1612             "field": "operator",
1613             "description": ""
1614           },
1615           {
1616             "group": "Body",
1617             "type": "String",
1618             "optional": false,
1619             "field": "value",
1620             "description": ""
1621           }
1622         ]
1623       }
1624     },
1625     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1626     "version": "0.0.0",
1627     "filename": "server/api/automation/index.js",
1628     "groupTitle": "Automations"
1629   },
1630   {
1631     "type": "get",
1632     "url": "/api/automations/{id}/actions",
1633     "title": "Gets Automation Actions",
1634     "examples": [
1635       {
1636         "title": "Example usage:",
1637         "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1638         "type": "json"
1639       }
1640     ],
1641     "name": "getActions",
1642     "group": "Automations",
1643     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1644     "version": "0.0.0",
1645     "filename": "server/api/automation/index.js",
1646     "groupTitle": "Automations"
1647   },
1648   {
1649     "type": "get",
1650     "url": "/api/automations/{id}/conditions",
1651     "title": "Gets Automation Conditions",
1652     "examples": [
1653       {
1654         "title": "Example usage:",
1655         "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1656         "type": "json"
1657       }
1658     ],
1659     "name": "getConditions",
1660     "group": "Automations",
1661     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1662     "version": "0.0.0",
1663     "filename": "server/api/automation/index.js",
1664     "groupTitle": "Automations"
1665   },
1666   {
1667     "type": "put",
1668     "url": "/api/automations/{id}",
1669     "title": "Update an existing Automation",
1670     "examples": [
1671       {
1672         "title": "Example usage:",
1673         "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1674         "type": "json"
1675       }
1676     ],
1677     "name": "updateAutomations",
1678     "group": "Automations",
1679     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1680     "version": "0.0.0",
1681     "filename": "server/api/automation/index.js",
1682     "groupTitle": "Automations"
1683   },
1684   {
1685     "type": "post",
1686     "url": "/api/canned_answers",
1687     "title": "Create a new canned answer",
1688     "examples": [
1689       {
1690         "title": "Example usage:",
1691         "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1692         "type": "json"
1693       }
1694     ],
1695     "name": "Create",
1696     "group": "Canned_Answers",
1697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1698     "version": "0.0.0",
1699     "filename": "server/api/cannedAnswer/index.js",
1700     "groupTitle": "Canned_Answers"
1701   },
1702   {
1703     "type": "delete",
1704     "url": "/api/canned_answers/{id}",
1705     "title": "Deletes a Canned Answer",
1706     "examples": [
1707       {
1708         "title": "Example usage:",
1709         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1710         "type": "json"
1711       }
1712     ],
1713     "name": "DeleteCanned_Answers",
1714     "group": "Canned_Answers",
1715     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1716     "version": "0.0.0",
1717     "filename": "server/api/cannedAnswer/index.js",
1718     "groupTitle": "Canned_Answers"
1719   },
1720   {
1721     "type": "get",
1722     "url": "/api/canned_answers",
1723     "title": "Gets a list of Canned Answers",
1724     "examples": [
1725       {
1726         "title": "Example usage:",
1727         "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1728         "type": "json"
1729       }
1730     ],
1731     "name": "GetCanned_Answers",
1732     "group": "Canned_Answers",
1733     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/canned_answers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/canned_answers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/canned_answers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/canned_answers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/canned_answers?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1734     "version": "0.0.0",
1735     "filename": "server/api/cannedAnswer/index.js",
1736     "groupTitle": "Canned_Answers"
1737   },
1738   {
1739     "type": "get",
1740     "url": "/api/canned_answers/{id}",
1741     "title": "Gets a single Canned Answer",
1742     "examples": [
1743       {
1744         "title": "Example usage:",
1745         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1746         "type": "json"
1747       }
1748     ],
1749     "name": "ShowCanned_Answers",
1750     "group": "Canned_Answers",
1751     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1752     "version": "0.0.0",
1753     "filename": "server/api/cannedAnswer/index.js",
1754     "groupTitle": "Canned_Answers"
1755   },
1756   {
1757     "type": "put",
1758     "url": "/api/canned_answers/{id}",
1759     "title": "Update an existing Canned Answer",
1760     "examples": [
1761       {
1762         "title": "Example usage:",
1763         "content": "curl https://{domain}/api/canned_answers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1764         "type": "json"
1765       }
1766     ],
1767     "name": "updateCanned_Answers",
1768     "group": "Canned_Answers",
1769     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1770     "version": "0.0.0",
1771     "filename": "server/api/cannedAnswer/index.js",
1772     "groupTitle": "Canned_Answers"
1773   },
1774   {
1775     "type": "get",
1776     "url": "/chat/internal/users",
1777     "title": "Gets Users Last Messages",
1778     "examples": [
1779       {
1780         "title": "Example usage:",
1781         "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password}  -X GET",
1782         "type": "json"
1783       }
1784     ],
1785     "name": "getLastUsersMessages",
1786     "group": "ChatInternalMessage",
1787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1788     "version": "0.0.0",
1789     "filename": "server/api/chatInternalMessage/index.js",
1790     "groupTitle": "ChatInternalMessage"
1791   },
1792   {
1793     "type": "delete",
1794     "url": "/api/chat/applications/{id}",
1795     "title": "Deletes a Application",
1796     "examples": [
1797       {
1798         "title": "Example usage:",
1799         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1800         "type": "json"
1801       }
1802     ],
1803     "name": "DeleteApplications",
1804     "group": "Chat_Applications",
1805     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1806     "version": "0.0.0",
1807     "filename": "server/api/chatApplication/index.js",
1808     "groupTitle": "Chat_Applications"
1809   },
1810   {
1811     "type": "get",
1812     "url": "/api/chat/applications/{id}",
1813     "title": "Gets a single Application",
1814     "examples": [
1815       {
1816         "title": "Example usage:",
1817         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1818         "type": "json"
1819       }
1820     ],
1821     "name": "ShowApplications",
1822     "group": "Chat_Applications",
1823     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1824     "version": "0.0.0",
1825     "filename": "server/api/chatApplication/index.js",
1826     "groupTitle": "Chat_Applications"
1827   },
1828   {
1829     "type": "put",
1830     "url": "/api/chat/applications/{id}",
1831     "title": "Update an existing Application",
1832     "examples": [
1833       {
1834         "title": "Example usage:",
1835         "content": "curl https://{domain}/api/chat/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1836         "type": "json"
1837       }
1838     ],
1839     "name": "updateApplications",
1840     "group": "Chat_Applications",
1841     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1842     "version": "0.0.0",
1843     "filename": "server/api/chatApplication/index.js",
1844     "groupTitle": "Chat_Applications"
1845   },
1846   {
1847     "type": "post",
1848     "url": "/api/chat/groups",
1849     "title": "Creates a new Group",
1850     "examples": [
1851       {
1852         "title": "Example usage:",
1853         "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1854         "type": "json"
1855       }
1856     ],
1857     "name": "CreateGroups",
1858     "group": "Chat_Groups",
1859     "parameter": {
1860       "fields": {
1861         "Body": [
1862           {
1863             "group": "Body",
1864             "type": "String",
1865             "optional": false,
1866             "field": "name",
1867             "description": ""
1868           },
1869           {
1870             "group": "Body",
1871             "type": "String",
1872             "optional": true,
1873             "field": "description",
1874             "description": ""
1875           },
1876           {
1877             "group": "Body",
1878             "type": "Boolean",
1879             "optional": true,
1880             "field": "write",
1881             "description": ""
1882           }
1883         ]
1884       }
1885     },
1886     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1887     "version": "0.0.0",
1888     "filename": "server/api/chatGroup/index.js",
1889     "groupTitle": "Chat_Groups"
1890   },
1891   {
1892     "type": "delete",
1893     "url": "/api/chat/groups/{id}",
1894     "title": "Deletes a Group",
1895     "examples": [
1896       {
1897         "title": "Example usage:",
1898         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1899         "type": "json"
1900       }
1901     ],
1902     "name": "DeleteGroups",
1903     "group": "Chat_Groups",
1904     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1905     "version": "0.0.0",
1906     "filename": "server/api/chatGroup/index.js",
1907     "groupTitle": "Chat_Groups"
1908   },
1909   {
1910     "type": "get",
1911     "url": "/api/chat/groups/describe",
1912     "title": "Gets table info about Groups",
1913     "examples": [
1914       {
1915         "title": "Example usage:",
1916         "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1917         "type": "json"
1918       }
1919     ],
1920     "name": "DescribeGroups",
1921     "group": "Chat_Groups",
1922     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1923     "version": "0.0.0",
1924     "filename": "server/api/chatGroup/index.js",
1925     "groupTitle": "Chat_Groups"
1926   },
1927   {
1928     "type": "get",
1929     "url": "/api/chat/groups",
1930     "title": "Gets a list of Groups",
1931     "examples": [
1932       {
1933         "title": "Example usage:",
1934         "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1935         "type": "json"
1936       }
1937     ],
1938     "name": "GetGroups",
1939     "group": "Chat_Groups",
1940     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/groups?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/groups?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/groups?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/groups?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/groups?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1941     "version": "0.0.0",
1942     "filename": "server/api/chatGroup/index.js",
1943     "groupTitle": "Chat_Groups"
1944   },
1945   {
1946     "type": "delete",
1947     "url": "/api/chat/groups/{id}/members",
1948     "title": "Removes members from a group",
1949     "examples": [
1950       {
1951         "title": "Example usage:",
1952         "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
1953         "type": "json"
1954       }
1955     ],
1956     "name": "RemoveMembers",
1957     "group": "Chat_Groups",
1958     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1959     "version": "0.0.0",
1960     "filename": "server/api/chatGroup/index.js",
1961     "groupTitle": "Chat_Groups"
1962   },
1963   {
1964     "type": "get",
1965     "url": "/api/chat/groups/{id}",
1966     "title": "Gets a single Group",
1967     "examples": [
1968       {
1969         "title": "Example usage:",
1970         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
1971         "type": "json"
1972       }
1973     ],
1974     "name": "ShowGroups",
1975     "group": "Chat_Groups",
1976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1977     "version": "0.0.0",
1978     "filename": "server/api/chatGroup/index.js",
1979     "groupTitle": "Chat_Groups"
1980   },
1981   {
1982     "type": "post",
1983     "url": "/api/chat/groups/{id}/members",
1984     "title": "Add members to chat group",
1985     "examples": [
1986       {
1987         "title": "Example usage:",
1988         "content": "curl https://{domain}/api/chat/groups/{id}/members -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1989         "type": "json"
1990       }
1991     ],
1992     "name": "addMembers",
1993     "group": "Chat_Groups",
1994     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1995     "version": "0.0.0",
1996     "filename": "server/api/chatGroup/index.js",
1997     "groupTitle": "Chat_Groups"
1998   },
1999   {
2000     "type": "post",
2001     "url": "/api/chat/groups/{id}/messages",
2002     "title": "Creates a new group message",
2003     "examples": [
2004       {
2005         "title": "Example usage:",
2006         "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2007         "type": "json"
2008       }
2009     ],
2010     "name": "addMessage",
2011     "group": "Chat_Groups",
2012     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2013     "version": "0.0.0",
2014     "filename": "server/api/chatGroup/index.js",
2015     "groupTitle": "Chat_Groups"
2016   },
2017   {
2018     "type": "get",
2019     "url": "/api/chat/groups/{id}/members",
2020     "title": "Gets Members",
2021     "examples": [
2022       {
2023         "title": "Example usage:",
2024         "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2025         "type": "json"
2026       }
2027     ],
2028     "name": "getMembers",
2029     "group": "Chat_Groups",
2030     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2031     "version": "0.0.0",
2032     "filename": "server/api/chatGroup/index.js",
2033     "groupTitle": "Chat_Groups"
2034   },
2035   {
2036     "type": "get",
2037     "url": "/api/chat/groups/{id}/messages",
2038     "title": "Gets Messages",
2039     "examples": [
2040       {
2041         "title": "Example usage:",
2042         "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2043         "type": "json"
2044       }
2045     ],
2046     "name": "getMessages",
2047     "group": "Chat_Groups",
2048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2049     "version": "0.0.0",
2050     "filename": "server/api/chatGroup/index.js",
2051     "groupTitle": "Chat_Groups"
2052   },
2053   {
2054     "type": "get",
2055     "url": "/api/chat/groups/{id}/unread",
2056     "title": "Get unread chat group messages",
2057     "examples": [
2058       {
2059         "title": "Example usage:",
2060         "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2061         "type": "json"
2062       }
2063     ],
2064     "name": "getUread",
2065     "group": "Chat_Groups",
2066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2067     "version": "0.0.0",
2068     "filename": "server/api/chatGroup/index.js",
2069     "groupTitle": "Chat_Groups"
2070   },
2071   {
2072     "type": "put",
2073     "url": "/api/chat/groups/{id}",
2074     "title": "Update an existing Group",
2075     "examples": [
2076       {
2077         "title": "Example usage:",
2078         "content": "curl https://{domain}/api/chat/groups/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2079         "type": "json"
2080       }
2081     ],
2082     "name": "updateGroups",
2083     "group": "Chat_Groups",
2084     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2085     "version": "0.0.0",
2086     "filename": "server/api/chatGroup/index.js",
2087     "groupTitle": "Chat_Groups"
2088   },
2089   {
2090     "type": "post",
2091     "url": "/api/chat/interactions/{id}/tags",
2092     "title": "Add tags to the interaction",
2093     "examples": [
2094       {
2095         "title": "Example usage:",
2096         "content": "curl https://{domain}/api/chat/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2097         "type": "json"
2098       }
2099     ],
2100     "name": "AddTags",
2101     "group": "Chat_Interactions",
2102     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2103     "version": "0.0.0",
2104     "filename": "server/api/chatInteraction/index.js",
2105     "groupTitle": "Chat_Interactions"
2106   },
2107   {
2108     "type": "post",
2109     "url": "/api/chat/interactions",
2110     "title": "Creates a new Interaction",
2111     "examples": [
2112       {
2113         "title": "Example usage:",
2114         "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2115         "type": "json"
2116       }
2117     ],
2118     "name": "CreateInteractions",
2119     "group": "Chat_Interactions",
2120     "parameter": {
2121       "fields": {
2122         "Body": [
2123           {
2124             "group": "Body",
2125             "type": "Boolean",
2126             "optional": true,
2127             "field": "closed",
2128             "description": ""
2129           },
2130           {
2131             "group": "Body",
2132             "type": "Integer",
2133             "optional": true,
2134             "field": "ratingValue",
2135             "description": ""
2136           },
2137           {
2138             "group": "Body",
2139             "type": "String",
2140             "allowedValues": [
2141               "\"star\"",
2142               "\"thumb\""
2143             ],
2144             "optional": true,
2145             "field": "ratingType",
2146             "description": ""
2147           },
2148           {
2149             "group": "Body",
2150             "type": "Text",
2151             "optional": true,
2152             "field": "ratingMessage",
2153             "description": ""
2154           },
2155           {
2156             "group": "Body",
2157             "type": "Text",
2158             "optional": true,
2159             "field": "pathTranscript",
2160             "description": ""
2161           },
2162           {
2163             "group": "Body",
2164             "type": "String",
2165             "optional": true,
2166             "field": "mailTranscript",
2167             "description": ""
2168           },
2169           {
2170             "group": "Body",
2171             "type": "String",
2172             "optional": true,
2173             "field": "closedAt",
2174             "description": ""
2175           },
2176           {
2177             "group": "Body",
2178             "type": "String",
2179             "optional": true,
2180             "field": "disposition",
2181             "description": ""
2182           },
2183           {
2184             "group": "Body",
2185             "type": "String",
2186             "optional": true,
2187             "field": "secondDisposition",
2188             "description": ""
2189           },
2190           {
2191             "group": "Body",
2192             "type": "String",
2193             "optional": true,
2194             "field": "thirdDisposition",
2195             "description": ""
2196           },
2197           {
2198             "group": "Body",
2199             "type": "String",
2200             "optional": true,
2201             "field": "note",
2202             "description": ""
2203           },
2204           {
2205             "group": "Body",
2206             "type": "String",
2207             "optional": true,
2208             "field": "browserName",
2209             "description": ""
2210           },
2211           {
2212             "group": "Body",
2213             "type": "String",
2214             "optional": true,
2215             "field": "browserVersion",
2216             "description": ""
2217           },
2218           {
2219             "group": "Body",
2220             "type": "String",
2221             "optional": true,
2222             "field": "osName",
2223             "description": ""
2224           },
2225           {
2226             "group": "Body",
2227             "type": "String",
2228             "optional": true,
2229             "field": "osVersion",
2230             "description": ""
2231           },
2232           {
2233             "group": "Body",
2234             "type": "String",
2235             "optional": true,
2236             "field": "deviceModel",
2237             "description": ""
2238           },
2239           {
2240             "group": "Body",
2241             "type": "String",
2242             "optional": true,
2243             "field": "deviceVendor",
2244             "description": ""
2245           },
2246           {
2247             "group": "Body",
2248             "type": "String",
2249             "optional": true,
2250             "field": "deviceType",
2251             "description": ""
2252           },
2253           {
2254             "group": "Body",
2255             "type": "Text",
2256             "optional": true,
2257             "field": "referer",
2258             "description": ""
2259           },
2260           {
2261             "group": "Body",
2262             "type": "String",
2263             "optional": true,
2264             "field": "customerIp",
2265             "description": ""
2266           },
2267           {
2268             "group": "Body",
2269             "type": "Text",
2270             "optional": true,
2271             "field": "formData",
2272             "description": ""
2273           },
2274           {
2275             "group": "Body",
2276             "type": "String",
2277             "optional": true,
2278             "field": "read1stAt",
2279             "description": ""
2280           },
2281           {
2282             "group": "Body",
2283             "type": "String",
2284             "optional": true,
2285             "field": "lastMsgAt",
2286             "description": ""
2287           },
2288           {
2289             "group": "Body",
2290             "type": "String",
2291             "allowedValues": [
2292               "\"in\"",
2293               "\"out\""
2294             ],
2295             "optional": false,
2296             "field": "lastMsgDirection",
2297             "description": ""
2298           },
2299           {
2300             "group": "Body",
2301             "type": "String",
2302             "optional": true,
2303             "field": "closeReason",
2304             "description": ""
2305           },
2306           {
2307             "group": "Body",
2308             "type": "String",
2309             "optional": true,
2310             "field": "customerPort",
2311             "description": ""
2312           },
2313           {
2314             "group": "Body",
2315             "type": "Text",
2316             "optional": true,
2317             "field": "vidaooSessionId",
2318             "description": ""
2319           }
2320         ]
2321       }
2322     },
2323     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2324     "version": "0.0.0",
2325     "filename": "server/api/chatInteraction/index.js",
2326     "groupTitle": "Chat_Interactions"
2327   },
2328   {
2329     "type": "delete",
2330     "url": "/api/chat/interactions/{id}",
2331     "title": "Deletes a Interaction",
2332     "examples": [
2333       {
2334         "title": "Example usage:",
2335         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2336         "type": "json"
2337       }
2338     ],
2339     "name": "DeleteInteractions",
2340     "group": "Chat_Interactions",
2341     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2342     "version": "0.0.0",
2343     "filename": "server/api/chatInteraction/index.js",
2344     "groupTitle": "Chat_Interactions"
2345   },
2346   {
2347     "type": "get",
2348     "url": "/api/chat/interactions/describe",
2349     "title": "Gets table info about Interactions",
2350     "examples": [
2351       {
2352         "title": "Example usage:",
2353         "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2354         "type": "json"
2355       }
2356     ],
2357     "name": "DescribeInteractions",
2358     "group": "Chat_Interactions",
2359     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2360     "version": "0.0.0",
2361     "filename": "server/api/chatInteraction/index.js",
2362     "groupTitle": "Chat_Interactions"
2363   },
2364   {
2365     "type": "get",
2366     "url": "/api/chat/interactions",
2367     "title": "Gets a list of Interactions",
2368     "examples": [
2369       {
2370         "title": "Example usage:",
2371         "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2372         "type": "json"
2373       }
2374     ],
2375     "name": "GetInteractions",
2376     "group": "Chat_Interactions",
2377     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2378     "version": "0.0.0",
2379     "filename": "server/api/chatInteraction/index.js",
2380     "groupTitle": "Chat_Interactions"
2381   },
2382   {
2383     "type": "delete",
2384     "url": "/api/chat/interactions/{id}/tags",
2385     "title": "Removes tags from interaction",
2386     "examples": [
2387       {
2388         "title": "Example usage:",
2389         "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2390         "type": "json"
2391       }
2392     ],
2393     "name": "RemoveTags",
2394     "group": "Chat_Interactions",
2395     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2396     "version": "0.0.0",
2397     "filename": "server/api/chatInteraction/index.js",
2398     "groupTitle": "Chat_Interactions"
2399   },
2400   {
2401     "type": "get",
2402     "url": "/api/chat/interactions/{id}",
2403     "title": "Gets a single Interaction",
2404     "examples": [
2405       {
2406         "title": "Example usage:",
2407         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2408         "type": "json"
2409       }
2410     ],
2411     "name": "ShowInteractions",
2412     "group": "Chat_Interactions",
2413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2414     "version": "0.0.0",
2415     "filename": "server/api/chatInteraction/index.js",
2416     "groupTitle": "Chat_Interactions"
2417   },
2418   {
2419     "type": "put",
2420     "url": "/api/chat/interactions/{id}/abandon",
2421     "title": "Abandon interaction",
2422     "examples": [
2423       {
2424         "title": "Example usage:",
2425         "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2426         "type": "json"
2427       }
2428     ],
2429     "name": "abandon",
2430     "group": "Chat_Interactions",
2431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to set as abandon an interaction and stop the routing.</p>",
2432     "version": "0.0.0",
2433     "filename": "server/api/chatInteraction/index.js",
2434     "groupTitle": "Chat_Interactions"
2435   },
2436   {
2437     "type": "post",
2438     "url": "/api/chat/interactions/{id}/messages",
2439     "title": "Creates new messages",
2440     "examples": [
2441       {
2442         "title": "Example usage:",
2443         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2444         "type": "json"
2445       }
2446     ],
2447     "name": "addMessage",
2448     "group": "Chat_Interactions",
2449     "parameter": {
2450       "fields": {
2451         "Body": [
2452           {
2453             "group": "Body",
2454             "type": "Text",
2455             "optional": false,
2456             "field": "body",
2457             "description": ""
2458           },
2459           {
2460             "group": "Body",
2461             "type": "Boolean",
2462             "optional": true,
2463             "field": "read",
2464             "description": ""
2465           },
2466           {
2467             "group": "Body",
2468             "type": "Boolean",
2469             "optional": true,
2470             "field": "secret",
2471             "description": ""
2472           },
2473           {
2474             "group": "Body",
2475             "type": "String",
2476             "allowedValues": [
2477               "\"in\"",
2478               "\"out\""
2479             ],
2480             "optional": false,
2481             "field": "direction",
2482             "description": ""
2483           },
2484           {
2485             "group": "Body",
2486             "type": "String",
2487             "optional": true,
2488             "field": "readAt",
2489             "description": ""
2490           },
2491           {
2492             "group": "Body",
2493             "type": "String",
2494             "optional": true,
2495             "field": "providerName",
2496             "description": ""
2497           },
2498           {
2499             "group": "Body",
2500             "type": "Text",
2501             "optional": true,
2502             "field": "providerResponse",
2503             "description": ""
2504           }
2505         ]
2506       }
2507     },
2508     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2509     "version": "0.0.0",
2510     "filename": "server/api/chatInteraction/index.js",
2511     "groupTitle": "Chat_Interactions"
2512   },
2513   {
2514     "type": "put",
2515     "url": "/api/chat/interactions/{id}/close",
2516     "title": "Close Interaction",
2517     "examples": [
2518       {
2519         "title": "Example usage:",
2520         "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2521         "type": "json"
2522       }
2523     ],
2524     "name": "addMessage",
2525     "group": "Chat_Interactions",
2526     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2527     "version": "0.0.0",
2528     "filename": "server/api/chatInteraction/index.js",
2529     "groupTitle": "Chat_Interactions"
2530   },
2531   {
2532     "type": "post",
2533     "url": "/api/chat/interactions/{id}/attachment_upload",
2534     "title": "Add attachment",
2535     "examples": [
2536       {
2537         "title": "Example usage:",
2538         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
2539         "type": "json"
2540       }
2541     ],
2542     "name": "attachmentUpload",
2543     "group": "Chat_Interactions",
2544     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2545     "version": "0.0.0",
2546     "filename": "server/api/chatInteraction/index.js",
2547     "groupTitle": "Chat_Interactions"
2548   },
2549   {
2550     "type": "post",
2551     "url": "/api/chat/interactions/{id}/vidaoo",
2552     "title": "Create Vidaoo Session",
2553     "examples": [
2554       {
2555         "title": "Example usage:",
2556         "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo  -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2557         "type": "json"
2558       }
2559     ],
2560     "name": "createVidaooSession",
2561     "group": "Chat_Interactions",
2562     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2563     "version": "0.0.0",
2564     "filename": "server/api/chatInteraction/index.js",
2565     "groupTitle": "Chat_Interactions"
2566   },
2567   {
2568     "type": "put",
2569     "url": "/api/chat/interactions/{id}/custom_update",
2570     "title": "Update interaction",
2571     "examples": [
2572       {
2573         "title": "Example usage:",
2574         "content": "curl https://{domain}/api/chat/interactions/{id}/custom_update -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2575         "type": "json"
2576       }
2577     ],
2578     "name": "customUpdate",
2579     "group": "Chat_Interactions",
2580     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to update an interaction.</p>",
2581     "version": "0.0.0",
2582     "filename": "server/api/chatInteraction/index.js",
2583     "groupTitle": "Chat_Interactions"
2584   },
2585   {
2586     "type": "get",
2587     "url": "/api/chat/interactions/{id}/download",
2588     "title": "Gets interaction",
2589     "examples": [
2590       {
2591         "title": "Example usage:",
2592         "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2593         "type": "json"
2594       }
2595     ],
2596     "name": "download",
2597     "group": "Chat_Interactions",
2598     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2599     "version": "0.0.0",
2600     "filename": "server/api/chatInteraction/index.js",
2601     "groupTitle": "Chat_Interactions"
2602   },
2603   {
2604     "type": "get",
2605     "url": "/api/chat/interactions/{id}/messages",
2606     "title": "Gets interaction messages",
2607     "examples": [
2608       {
2609         "title": "Example usage:",
2610         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2611         "type": "json"
2612       }
2613     ],
2614     "name": "getMessages",
2615     "group": "Chat_Interactions",
2616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2617     "version": "0.0.0",
2618     "filename": "server/api/chatInteraction/index.js",
2619     "groupTitle": "Chat_Interactions"
2620   },
2621   {
2622     "type": "get",
2623     "url": "/api/chat/interactions/{id}/my_messages",
2624     "title": "Gets interaction messages",
2625     "examples": [
2626       {
2627         "title": "Example usage:",
2628         "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2629         "type": "json"
2630       }
2631     ],
2632     "name": "getMyMessages",
2633     "group": "Chat_Interactions",
2634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2635     "version": "0.0.0",
2636     "filename": "server/api/chatInteraction/index.js",
2637     "groupTitle": "Chat_Interactions"
2638   },
2639   {
2640     "type": "put",
2641     "url": "/api/chat/interactions/{id}",
2642     "title": "Update an existing Interaction",
2643     "examples": [
2644       {
2645         "title": "Example usage:",
2646         "content": "curl https://{domain}/api/chat/interactions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2647         "type": "json"
2648       }
2649     ],
2650     "name": "updateInteractions",
2651     "group": "Chat_Interactions",
2652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2653     "version": "0.0.0",
2654     "filename": "server/api/chatInteraction/index.js",
2655     "groupTitle": "Chat_Interactions"
2656   },
2657   {
2658     "type": "post",
2659     "url": "/api/chat/internal/messages",
2660     "title": "Creates a new Message",
2661     "examples": [
2662       {
2663         "title": "Example usage:",
2664         "content": "curl https://{domain}/api/chat/internal/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2665         "type": "json"
2666       }
2667     ],
2668     "name": "CreateMessages",
2669     "group": "Chat_Internal_Messages",
2670     "parameter": {
2671       "fields": {
2672         "Body": [
2673           {
2674             "group": "Body",
2675             "type": "Text",
2676             "optional": false,
2677             "field": "body",
2678             "description": ""
2679           },
2680           {
2681             "group": "Body",
2682             "type": "Boolean",
2683             "optional": true,
2684             "field": "read",
2685             "description": ""
2686           },
2687           {
2688             "group": "Body",
2689             "type": "Integer",
2690             "optional": true,
2691             "field": "ChatInternalMessageId",
2692             "description": ""
2693           }
2694         ]
2695       }
2696     },
2697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2698     "version": "0.0.0",
2699     "filename": "server/api/chatInternalMessage/index.js",
2700     "groupTitle": "Chat_Internal_Messages"
2701   },
2702   {
2703     "type": "delete",
2704     "url": "/api/chat/internal/messages/{id}",
2705     "title": "Deletes a Message",
2706     "examples": [
2707       {
2708         "title": "Example usage:",
2709         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2710         "type": "json"
2711       }
2712     ],
2713     "name": "DeleteMessages",
2714     "group": "Chat_Internal_Messages",
2715     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2716     "version": "0.0.0",
2717     "filename": "server/api/chatInternalMessage/index.js",
2718     "groupTitle": "Chat_Internal_Messages"
2719   },
2720   {
2721     "type": "get",
2722     "url": "/api/chat/internal/messages/describe",
2723     "title": "Gets table info about Messages",
2724     "examples": [
2725       {
2726         "title": "Example usage:",
2727         "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2728         "type": "json"
2729       }
2730     ],
2731     "name": "DescribeMessages",
2732     "group": "Chat_Internal_Messages",
2733     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2734     "version": "0.0.0",
2735     "filename": "server/api/chatInternalMessage/index.js",
2736     "groupTitle": "Chat_Internal_Messages"
2737   },
2738   {
2739     "type": "get",
2740     "url": "/api/chat/internal/messages",
2741     "title": "Gets a list of Messages",
2742     "examples": [
2743       {
2744         "title": "Example usage:",
2745         "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2746         "type": "json"
2747       }
2748     ],
2749     "name": "GetMessages",
2750     "group": "Chat_Internal_Messages",
2751     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/internal/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/internal/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/internal/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/internal/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/internal/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2752     "version": "0.0.0",
2753     "filename": "server/api/chatInternalMessage/index.js",
2754     "groupTitle": "Chat_Internal_Messages"
2755   },
2756   {
2757     "type": "get",
2758     "url": "/api/chat/internal/messages/{id}",
2759     "title": "Gets a single Message",
2760     "examples": [
2761       {
2762         "title": "Example usage:",
2763         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2764         "type": "json"
2765       }
2766     ],
2767     "name": "ShowMessages",
2768     "group": "Chat_Internal_Messages",
2769     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2770     "version": "0.0.0",
2771     "filename": "server/api/chatInternalMessage/index.js",
2772     "groupTitle": "Chat_Internal_Messages"
2773   },
2774   {
2775     "type": "put",
2776     "url": "/api/chat/internal/messages/{id}",
2777     "title": "Update an existing Message",
2778     "examples": [
2779       {
2780         "title": "Example usage:",
2781         "content": "curl https://{domain}/api/chat/internal/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2782         "type": "json"
2783       }
2784     ],
2785     "name": "updateMessages",
2786     "group": "Chat_Internal_Messages",
2787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2788     "version": "0.0.0",
2789     "filename": "server/api/chatInternalMessage/index.js",
2790     "groupTitle": "Chat_Internal_Messages"
2791   },
2792   {
2793     "type": "post",
2794     "url": "/api/chat/messages",
2795     "title": "Creates a new Message",
2796     "examples": [
2797       {
2798         "title": "Example usage:",
2799         "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2800         "type": "json"
2801       }
2802     ],
2803     "name": "CreateMessages",
2804     "group": "Chat_Messages",
2805     "parameter": {
2806       "fields": {
2807         "Body": [
2808           {
2809             "group": "Body",
2810             "type": "Text",
2811             "optional": false,
2812             "field": "body",
2813             "description": ""
2814           },
2815           {
2816             "group": "Body",
2817             "type": "Boolean",
2818             "optional": true,
2819             "field": "read",
2820             "description": ""
2821           },
2822           {
2823             "group": "Body",
2824             "type": "Boolean",
2825             "optional": true,
2826             "field": "secret",
2827             "description": ""
2828           },
2829           {
2830             "group": "Body",
2831             "type": "String",
2832             "allowedValues": [
2833               "\"in\"",
2834               "\"out\""
2835             ],
2836             "optional": false,
2837             "field": "direction",
2838             "description": ""
2839           },
2840           {
2841             "group": "Body",
2842             "type": "String",
2843             "optional": true,
2844             "field": "readAt",
2845             "description": ""
2846           },
2847           {
2848             "group": "Body",
2849             "type": "String",
2850             "optional": true,
2851             "field": "providerName",
2852             "description": ""
2853           },
2854           {
2855             "group": "Body",
2856             "type": "Text",
2857             "optional": true,
2858             "field": "providerResponse",
2859             "description": ""
2860           }
2861         ]
2862       }
2863     },
2864     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2865     "version": "0.0.0",
2866     "filename": "server/api/chatMessage/index.js",
2867     "groupTitle": "Chat_Messages"
2868   },
2869   {
2870     "type": "delete",
2871     "url": "/api/chat/messages/{id}",
2872     "title": "Deletes a Message",
2873     "examples": [
2874       {
2875         "title": "Example usage:",
2876         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2877         "type": "json"
2878       }
2879     ],
2880     "name": "DeleteMessages",
2881     "group": "Chat_Messages",
2882     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2883     "version": "0.0.0",
2884     "filename": "server/api/chatMessage/index.js",
2885     "groupTitle": "Chat_Messages"
2886   },
2887   {
2888     "type": "get",
2889     "url": "/api/chat/messages/describe",
2890     "title": "Gets table info about Messages",
2891     "examples": [
2892       {
2893         "title": "Example usage:",
2894         "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2895         "type": "json"
2896       }
2897     ],
2898     "name": "DescribeMessages",
2899     "group": "Chat_Messages",
2900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2901     "version": "0.0.0",
2902     "filename": "server/api/chatMessage/index.js",
2903     "groupTitle": "Chat_Messages"
2904   },
2905   {
2906     "type": "get",
2907     "url": "/api/chat/messages",
2908     "title": "Gets a list of Messages",
2909     "examples": [
2910       {
2911         "title": "Example usage:",
2912         "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2913         "type": "json"
2914       }
2915     ],
2916     "name": "GetMessages",
2917     "group": "Chat_Messages",
2918     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2919     "version": "0.0.0",
2920     "filename": "server/api/chatMessage/index.js",
2921     "groupTitle": "Chat_Messages"
2922   },
2923   {
2924     "type": "get",
2925     "url": "/api/chat/messages/{id}",
2926     "title": "Gets a single Message",
2927     "examples": [
2928       {
2929         "title": "Example usage:",
2930         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2931         "type": "json"
2932       }
2933     ],
2934     "name": "ShowMessages",
2935     "group": "Chat_Messages",
2936     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2937     "version": "0.0.0",
2938     "filename": "server/api/chatMessage/index.js",
2939     "groupTitle": "Chat_Messages"
2940   },
2941   {
2942     "type": "put",
2943     "url": "/api/chat/messages/{id}",
2944     "title": "Update an existing Message",
2945     "examples": [
2946       {
2947         "title": "Example usage:",
2948         "content": "curl https://{domain}/api/chat/messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2949         "type": "json"
2950       }
2951     ],
2952     "name": "updateMessages",
2953     "group": "Chat_Messages",
2954     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2955     "version": "0.0.0",
2956     "filename": "server/api/chatMessage/index.js",
2957     "groupTitle": "Chat_Messages"
2958   },
2959   {
2960     "type": "post",
2961     "url": "/api/chat/offline_messages",
2962     "title": "Creates a new OfflineMessage",
2963     "examples": [
2964       {
2965         "title": "Example usage:",
2966         "content": "curl https://{domain}/api/chat/offline_messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2967         "type": "json"
2968       }
2969     ],
2970     "name": "CreateOfflineMessages",
2971     "group": "Chat_Offline_Messages",
2972     "parameter": {
2973       "fields": {
2974         "Body": [
2975           {
2976             "group": "Body",
2977             "type": "Text",
2978             "optional": false,
2979             "field": "body",
2980             "description": ""
2981           }
2982         ]
2983       }
2984     },
2985     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2986     "version": "0.0.0",
2987     "filename": "server/api/chatOfflineMessage/index.js",
2988     "groupTitle": "Chat_Offline_Messages"
2989   },
2990   {
2991     "type": "delete",
2992     "url": "/api/chat/offline_messages/{id}",
2993     "title": "Deletes a OfflineMessage",
2994     "examples": [
2995       {
2996         "title": "Example usage:",
2997         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
2998         "type": "json"
2999       }
3000     ],
3001     "name": "DeleteOfflineMessages",
3002     "group": "Chat_Offline_Messages",
3003     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3004     "version": "0.0.0",
3005     "filename": "server/api/chatOfflineMessage/index.js",
3006     "groupTitle": "Chat_Offline_Messages"
3007   },
3008   {
3009     "type": "get",
3010     "url": "/api/chat/offline_messages/describe",
3011     "title": "Gets table info about OfflineMessages",
3012     "examples": [
3013       {
3014         "title": "Example usage:",
3015         "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
3016         "type": "json"
3017       }
3018     ],
3019     "name": "DescribeOfflineMessages",
3020     "group": "Chat_Offline_Messages",
3021     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3022     "version": "0.0.0",
3023     "filename": "server/api/chatOfflineMessage/index.js",
3024     "groupTitle": "Chat_Offline_Messages"
3025   },
3026   {
3027     "type": "get",
3028     "url": "/api/chat/offline_messages",
3029     "title": "Gets a list of OfflineMessages",
3030     "examples": [
3031       {
3032         "title": "Example usage:",
3033         "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3034         "type": "json"
3035       }
3036     ],
3037     "name": "GetOfflineMessages",
3038     "group": "Chat_Offline_Messages",
3039     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/offline_messages?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/offline_messages?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/offline_messages?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/offline_messages?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/offline_messages?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3040     "version": "0.0.0",
3041     "filename": "server/api/chatOfflineMessage/index.js",
3042     "groupTitle": "Chat_Offline_Messages"
3043   },
3044   {
3045     "type": "get",
3046     "url": "/api/chat/offline_messages/{id}",
3047     "title": "Gets a single OfflineMessage",
3048     "examples": [
3049       {
3050         "title": "Example usage:",
3051         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3052         "type": "json"
3053       }
3054     ],
3055     "name": "ShowOfflineMessages",
3056     "group": "Chat_Offline_Messages",
3057     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3058     "version": "0.0.0",
3059     "filename": "server/api/chatOfflineMessage/index.js",
3060     "groupTitle": "Chat_Offline_Messages"
3061   },
3062   {
3063     "type": "put",
3064     "url": "/api/chat/offline_messages/{id}",
3065     "title": "Update an existing OfflineMessage",
3066     "examples": [
3067       {
3068         "title": "Example usage:",
3069         "content": "curl https://{domain}/api/chat/offline_messages/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3070         "type": "json"
3071       }
3072     ],
3073     "name": "updateOfflineMessages",
3074     "group": "Chat_Offline_Messages",
3075     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3076     "version": "0.0.0",
3077     "filename": "server/api/chatOfflineMessage/index.js",
3078     "groupTitle": "Chat_Offline_Messages"
3079   },
3080   {
3081     "type": "post",
3082     "url": "/api/chat/proactive_actions",
3083     "title": "Creates a new Proactive Action",
3084     "examples": [
3085       {
3086         "title": "Example usage:",
3087         "content": "curl https://{domain}/api/chat/proactive_actions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3088         "type": "json"
3089       }
3090     ],
3091     "name": "CreateProactive_Actions",
3092     "group": "Chat_Proactive_Actions",
3093     "parameter": {
3094       "fields": {
3095         "Body": [
3096           {
3097             "group": "Body",
3098             "type": "String",
3099             "optional": false,
3100             "field": "name",
3101             "description": ""
3102           },
3103           {
3104             "group": "Body",
3105             "type": "String",
3106             "allowedValues": [
3107               "\"mouseOver\"",
3108               "\"timeout\""
3109             ],
3110             "optional": true,
3111             "field": "type",
3112             "description": ""
3113           },
3114           {
3115             "group": "Body",
3116             "type": "String",
3117             "optional": true,
3118             "field": "selector",
3119             "description": ""
3120           },
3121           {
3122             "group": "Body",
3123             "type": "Integer",
3124             "optional": true,
3125             "field": "timeout",
3126             "description": ""
3127           }
3128         ]
3129       }
3130     },
3131     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3132     "version": "0.0.0",
3133     "filename": "server/api/chatProactiveAction/index.js",
3134     "groupTitle": "Chat_Proactive_Actions"
3135   },
3136   {
3137     "type": "delete",
3138     "url": "/api/chat/proactive_actions/{id}",
3139     "title": "Deletes a Proactive Action",
3140     "examples": [
3141       {
3142         "title": "Example usage:",
3143         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3144         "type": "json"
3145       }
3146     ],
3147     "name": "DeleteProactive_Actions",
3148     "group": "Chat_Proactive_Actions",
3149     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3150     "version": "0.0.0",
3151     "filename": "server/api/chatProactiveAction/index.js",
3152     "groupTitle": "Chat_Proactive_Actions"
3153   },
3154   {
3155     "type": "get",
3156     "url": "/api/chat/proactive_actions/{id}",
3157     "title": "Gets a single Proactive Action",
3158     "examples": [
3159       {
3160         "title": "Example usage:",
3161         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3162         "type": "json"
3163       }
3164     ],
3165     "name": "ShowProactive_Actions",
3166     "group": "Chat_Proactive_Actions",
3167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3168     "version": "0.0.0",
3169     "filename": "server/api/chatProactiveAction/index.js",
3170     "groupTitle": "Chat_Proactive_Actions"
3171   },
3172   {
3173     "type": "put",
3174     "url": "/api/chat/proactive_actions/{id}",
3175     "title": "Update an existing Proactive Action",
3176     "examples": [
3177       {
3178         "title": "Example usage:",
3179         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3180         "type": "json"
3181       }
3182     ],
3183     "name": "updateProactive_Actions",
3184     "group": "Chat_Proactive_Actions",
3185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3186     "version": "0.0.0",
3187     "filename": "server/api/chatProactiveAction/index.js",
3188     "groupTitle": "Chat_Proactive_Actions"
3189   },
3190   {
3191     "type": "post",
3192     "url": "/api/chat/reports/queue",
3193     "title": "Creates a new Chat Queue Report",
3194     "examples": [
3195       {
3196         "title": "Example usage:",
3197         "content": "curl https://{domain}/api/chat/reports/queue -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3198         "type": "json"
3199       }
3200     ],
3201     "name": "CreateChat_Queue_Reports",
3202     "group": "Chat_Queue_Reports",
3203     "parameter": {
3204       "fields": {
3205         "Body": [
3206           {
3207             "group": "Body",
3208             "type": "String",
3209             "optional": false,
3210             "field": "uniqueid",
3211             "description": ""
3212           },
3213           {
3214             "group": "Body",
3215             "type": "String",
3216             "optional": true,
3217             "field": "from",
3218             "description": ""
3219           },
3220           {
3221             "group": "Body",
3222             "type": "String",
3223             "optional": true,
3224             "field": "joinAt",
3225             "description": ""
3226           },
3227           {
3228             "group": "Body",
3229             "type": "String",
3230             "optional": true,
3231             "field": "leaveAt",
3232             "description": ""
3233           },
3234           {
3235             "group": "Body",
3236             "type": "String",
3237             "optional": true,
3238             "field": "acceptAt",
3239             "description": ""
3240           },
3241           {
3242             "group": "Body",
3243             "type": "String",
3244             "optional": true,
3245             "field": "exitAt",
3246             "description": ""
3247           },
3248           {
3249             "group": "Body",
3250             "type": "String",
3251             "optional": true,
3252             "field": "reason",
3253             "description": ""
3254           }
3255         ]
3256       }
3257     },
3258     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3259     "version": "0.0.0",
3260     "filename": "server/api/chatQueueReport/index.js",
3261     "groupTitle": "Chat_Queue_Reports"
3262   },
3263   {
3264     "type": "delete",
3265     "url": "/api/chat/reports/queue/{id}",
3266     "title": "Deletes a Chat Queue Report",
3267     "examples": [
3268       {
3269         "title": "Example usage:",
3270         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3271         "type": "json"
3272       }
3273     ],
3274     "name": "DeleteChat_Queue_Reports",
3275     "group": "Chat_Queue_Reports",
3276     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3277     "version": "0.0.0",
3278     "filename": "server/api/chatQueueReport/index.js",
3279     "groupTitle": "Chat_Queue_Reports"
3280   },
3281   {
3282     "type": "get",
3283     "url": "/api/chat/reports/queue/describe",
3284     "title": "Gets table info about Chat Queue Reports",
3285     "examples": [
3286       {
3287         "title": "Example usage:",
3288         "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3289         "type": "json"
3290       }
3291     ],
3292     "name": "DescribeChat_Queue_Reports",
3293     "group": "Chat_Queue_Reports",
3294     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3295     "version": "0.0.0",
3296     "filename": "server/api/chatQueueReport/index.js",
3297     "groupTitle": "Chat_Queue_Reports"
3298   },
3299   {
3300     "type": "get",
3301     "url": "/api/chat/reports/queue",
3302     "title": "Gets a list of Chat Queue Reports",
3303     "examples": [
3304       {
3305         "title": "Example usage:",
3306         "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3307         "type": "json"
3308       }
3309     ],
3310     "name": "GetChat_Queue_Reports",
3311     "group": "Chat_Queue_Reports",
3312     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/queue?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/queue?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/queue?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/queue?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/queue?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3313     "version": "0.0.0",
3314     "filename": "server/api/chatQueueReport/index.js",
3315     "groupTitle": "Chat_Queue_Reports"
3316   },
3317   {
3318     "type": "get",
3319     "url": "/api/chat/reports/queue/{id}",
3320     "title": "Gets a single Chat Queue Report",
3321     "examples": [
3322       {
3323         "title": "Example usage:",
3324         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3325         "type": "json"
3326       }
3327     ],
3328     "name": "ShowChat_Queue_Reports",
3329     "group": "Chat_Queue_Reports",
3330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3331     "version": "0.0.0",
3332     "filename": "server/api/chatQueueReport/index.js",
3333     "groupTitle": "Chat_Queue_Reports"
3334   },
3335   {
3336     "type": "put",
3337     "url": "/api/chat/reports/queue/{id}",
3338     "title": "Update an existing Chat Queue Report",
3339     "examples": [
3340       {
3341         "title": "Example usage:",
3342         "content": "curl https://{domain}/api/chat/reports/queue/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3343         "type": "json"
3344       }
3345     ],
3346     "name": "updateChat_Queue_Reports",
3347     "group": "Chat_Queue_Reports",
3348     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3349     "version": "0.0.0",
3350     "filename": "server/api/chatQueueReport/index.js",
3351     "groupTitle": "Chat_Queue_Reports"
3352   },
3353   {
3354     "type": "post",
3355     "url": "/api/chat/queues/{id}/users",
3356     "title": "Add agents to a queue",
3357     "examples": [
3358       {
3359         "title": "Example usage:",
3360         "content": "curl https://{domain}/api/chat/queues/{id}/users -d '{\"ids\": [1,2], \"penalty\": 2}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3361         "type": "json"
3362       }
3363     ],
3364     "name": "AddAgents",
3365     "group": "Chat_Queues",
3366     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3367     "version": "0.0.0",
3368     "filename": "server/api/chatQueue/index.js",
3369     "groupTitle": "Chat_Queues"
3370   },
3371   {
3372     "type": "post",
3373     "url": "/api/chat/queues/{id}/teams",
3374     "title": "Add teams to a queue",
3375     "examples": [
3376       {
3377         "title": "Example usage:",
3378         "content": "curl https://{domain}/api/chat/queues/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3379         "type": "json"
3380       }
3381     ],
3382     "name": "AddTeams",
3383     "group": "Chat_Queues",
3384     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3385     "version": "0.0.0",
3386     "filename": "server/api/chatQueue/index.js",
3387     "groupTitle": "Chat_Queues"
3388   },
3389   {
3390     "type": "post",
3391     "url": "/api/chat/queues",
3392     "title": "Creates a new Queue",
3393     "examples": [
3394       {
3395         "title": "Example usage:",
3396         "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3397         "type": "json"
3398       }
3399     ],
3400     "name": "CreateQueues",
3401     "group": "Chat_Queues",
3402     "parameter": {
3403       "fields": {
3404         "Body": [
3405           {
3406             "group": "Body",
3407             "type": "String",
3408             "optional": false,
3409             "field": "name",
3410             "description": ""
3411           },
3412           {
3413             "group": "Body",
3414             "type": "String",
3415             "optional": true,
3416             "field": "description",
3417             "description": ""
3418           },
3419           {
3420             "group": "Body",
3421             "type": "Integer",
3422             "optional": true,
3423             "field": "timeout",
3424             "description": ""
3425           },
3426           {
3427             "group": "Body",
3428             "type": "String",
3429             "allowedValues": [
3430               "\"rrmemory\"",
3431               "\"beepall\"",
3432               "\"roundrobin\""
3433             ],
3434             "optional": true,
3435             "field": "strategy",
3436             "description": ""
3437           }
3438         ]
3439       }
3440     },
3441     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3442     "version": "0.0.0",
3443     "filename": "server/api/chatQueue/index.js",
3444     "groupTitle": "Chat_Queues"
3445   },
3446   {
3447     "type": "delete",
3448     "url": "/api/chat/queues/{id}",
3449     "title": "Deletes a Queue",
3450     "examples": [
3451       {
3452         "title": "Example usage:",
3453         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3454         "type": "json"
3455       }
3456     ],
3457     "name": "DeleteQueues",
3458     "group": "Chat_Queues",
3459     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3460     "version": "0.0.0",
3461     "filename": "server/api/chatQueue/index.js",
3462     "groupTitle": "Chat_Queues"
3463   },
3464   {
3465     "type": "get",
3466     "url": "/api/chat/queues/describe",
3467     "title": "Gets table info about Queues",
3468     "examples": [
3469       {
3470         "title": "Example usage:",
3471         "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3472         "type": "json"
3473       }
3474     ],
3475     "name": "DescribeQueues",
3476     "group": "Chat_Queues",
3477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3478     "version": "0.0.0",
3479     "filename": "server/api/chatQueue/index.js",
3480     "groupTitle": "Chat_Queues"
3481   },
3482   {
3483     "type": "get",
3484     "url": "/api/chat/queues/{id}/users",
3485     "title": "Gets queue agents",
3486     "examples": [
3487       {
3488         "title": "Example usage:",
3489         "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3490         "type": "json"
3491       }
3492     ],
3493     "name": "GetAgents",
3494     "group": "Chat_Queues",
3495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3496     "version": "0.0.0",
3497     "filename": "server/api/chatQueue/index.js",
3498     "groupTitle": "Chat_Queues"
3499   },
3500   {
3501     "type": "get",
3502     "url": "/api/chat/queues/{id}/members",
3503     "title": "GetMembers",
3504     "examples": [
3505       {
3506         "title": "Example usage:",
3507         "content": "curl https://{domain}/api/chat/queues/{id}/members  -v -u {name}:{password}",
3508         "type": "json"
3509       }
3510     ],
3511     "name": "GetMembers",
3512     "group": "Chat_Queues",
3513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3514     "version": "0.0.0",
3515     "filename": "server/api/chatQueue/index.js",
3516     "groupTitle": "Chat_Queues"
3517   },
3518   {
3519     "type": "get",
3520     "url": "/api/chat/queues",
3521     "title": "Gets a list of Queues",
3522     "examples": [
3523       {
3524         "title": "Example usage:",
3525         "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3526         "type": "json"
3527       }
3528     ],
3529     "name": "GetQueues",
3530     "group": "Chat_Queues",
3531     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/queues?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/queues?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/queues?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/queues?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/queues?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3532     "version": "0.0.0",
3533     "filename": "server/api/chatQueue/index.js",
3534     "groupTitle": "Chat_Queues"
3535   },
3536   {
3537     "type": "get",
3538     "url": "/api/chat/queues/{id}/teams",
3539     "title": "Gets queues list",
3540     "examples": [
3541       {
3542         "title": "Example usage:",
3543         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3544         "type": "json"
3545       }
3546     ],
3547     "name": "GetTeams",
3548     "group": "Chat_Queues",
3549     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3550     "version": "0.0.0",
3551     "filename": "server/api/chatQueue/index.js",
3552     "groupTitle": "Chat_Queues"
3553   },
3554   {
3555     "type": "delete",
3556     "url": "/api/chat/queues/{id}/users",
3557     "title": "Removes agents from a queue",
3558     "examples": [
3559       {
3560         "title": "Example usage:",
3561         "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3562         "type": "json"
3563       }
3564     ],
3565     "name": "RemoveAgents",
3566     "group": "Chat_Queues",
3567     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3568     "version": "0.0.0",
3569     "filename": "server/api/chatQueue/index.js",
3570     "groupTitle": "Chat_Queues"
3571   },
3572   {
3573     "type": "get",
3574     "url": "/api/chat/queues/{id}",
3575     "title": "Gets a single Queue",
3576     "examples": [
3577       {
3578         "title": "Example usage:",
3579         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3580         "type": "json"
3581       }
3582     ],
3583     "name": "ShowQueues",
3584     "group": "Chat_Queues",
3585     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3586     "version": "0.0.0",
3587     "filename": "server/api/chatQueue/index.js",
3588     "groupTitle": "Chat_Queues"
3589   },
3590   {
3591     "type": "put",
3592     "url": "/api/chat/queues/{id}",
3593     "title": "Update an existing Queue",
3594     "examples": [
3595       {
3596         "title": "Example usage:",
3597         "content": "curl https://{domain}/api/chat/queues/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3598         "type": "json"
3599       }
3600     ],
3601     "name": "updateQueues",
3602     "group": "Chat_Queues",
3603     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3604     "version": "0.0.0",
3605     "filename": "server/api/chatQueue/index.js",
3606     "groupTitle": "Chat_Queues"
3607   },
3608   {
3609     "type": "post",
3610     "url": "/api/chat/reports/transfer",
3611     "title": "Creates a new Chat Transfer Report",
3612     "examples": [
3613       {
3614         "title": "Example usage:",
3615         "content": "curl https://{domain}/api/chat/reports/transfer -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3616         "type": "json"
3617       }
3618     ],
3619     "name": "CreateChat_Transfer_Reports",
3620     "group": "Chat_Transfer_Reports",
3621     "parameter": {
3622       "fields": {
3623         "Body": [
3624           {
3625             "group": "Body",
3626             "type": "String",
3627             "optional": false,
3628             "field": "uniqueid",
3629             "description": ""
3630           },
3631           {
3632             "group": "Body",
3633             "type": "String",
3634             "allowedValues": [
3635               "\"account\"",
3636               "\"agent\"",
3637               "\"queue\""
3638             ],
3639             "optional": false,
3640             "field": "type",
3641             "description": ""
3642           },
3643           {
3644             "group": "Body",
3645             "type": "String",
3646             "optional": false,
3647             "field": "transferredAt",
3648             "description": ""
3649           }
3650         ]
3651       }
3652     },
3653     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3654     "version": "0.0.0",
3655     "filename": "server/api/chatTransferReport/index.js",
3656     "groupTitle": "Chat_Transfer_Reports"
3657   },
3658   {
3659     "type": "delete",
3660     "url": "/api/chat/reports/transfer/{id}",
3661     "title": "Deletes a Chat Transfer Report",
3662     "examples": [
3663       {
3664         "title": "Example usage:",
3665         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3666         "type": "json"
3667       }
3668     ],
3669     "name": "DeleteChat_Transfer_Reports",
3670     "group": "Chat_Transfer_Reports",
3671     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3672     "version": "0.0.0",
3673     "filename": "server/api/chatTransferReport/index.js",
3674     "groupTitle": "Chat_Transfer_Reports"
3675   },
3676   {
3677     "type": "get",
3678     "url": "/api/chat/reports/transfer/describe",
3679     "title": "Gets table info about Chat Transfer Reports",
3680     "examples": [
3681       {
3682         "title": "Example usage:",
3683         "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3684         "type": "json"
3685       }
3686     ],
3687     "name": "DescribeChat_Transfer_Reports",
3688     "group": "Chat_Transfer_Reports",
3689     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3690     "version": "0.0.0",
3691     "filename": "server/api/chatTransferReport/index.js",
3692     "groupTitle": "Chat_Transfer_Reports"
3693   },
3694   {
3695     "type": "get",
3696     "url": "/api/chat/reports/transfer",
3697     "title": "Gets a list of Chat Transfer Reports",
3698     "examples": [
3699       {
3700         "title": "Example usage:",
3701         "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3702         "type": "json"
3703       }
3704     ],
3705     "name": "GetChat_Transfer_Reports",
3706     "group": "Chat_Transfer_Reports",
3707     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/reports/transfer?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/reports/transfer?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/reports/transfer?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/reports/transfer?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/reports/transfer?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
3708     "version": "0.0.0",
3709     "filename": "server/api/chatTransferReport/index.js",
3710     "groupTitle": "Chat_Transfer_Reports"
3711   },
3712   {
3713     "type": "get",
3714     "url": "/api/chat/reports/transfer/{id}",
3715     "title": "Gets a single Chat Transfer Report",
3716     "examples": [
3717       {
3718         "title": "Example usage:",
3719         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3720         "type": "json"
3721       }
3722     ],
3723     "name": "ShowChat_Transfer_Reports",
3724     "group": "Chat_Transfer_Reports",
3725     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3726     "version": "0.0.0",
3727     "filename": "server/api/chatTransferReport/index.js",
3728     "groupTitle": "Chat_Transfer_Reports"
3729   },
3730   {
3731     "type": "put",
3732     "url": "/api/chat/reports/transfer/{id}",
3733     "title": "Update an existing Chat Transfer Report",
3734     "examples": [
3735       {
3736         "title": "Example usage:",
3737         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
3738         "type": "json"
3739       }
3740     ],
3741     "name": "updateChat_Transfer_Reports",
3742     "group": "Chat_Transfer_Reports",
3743     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3744     "version": "0.0.0",
3745     "filename": "server/api/chatTransferReport/index.js",
3746     "groupTitle": "Chat_Transfer_Reports"
3747   },
3748   {
3749     "type": "post",
3750     "url": "/api/chat/websites/{id}/users",
3751     "title": "Add agents to a website",
3752     "examples": [
3753       {
3754         "title": "Example usage:",
3755         "content": "curl https://{domain}/api/chat/websites/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
3756         "type": "json"
3757       }
3758     ],
3759     "name": "AddAgents",
3760     "group": "Chat_Websites",
3761     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3762     "version": "0.0.0",
3763     "filename": "server/api/chatWebsite/index.js",
3764     "groupTitle": "Chat_Websites"
3765   },
3766   {
3767     "type": "post",
3768     "url": "/api/chat/websites",
3769     "title": "Creates a new Website",
3770     "examples": [
3771       {
3772         "title": "Example usage:",
3773         "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3774         "type": "json"
3775       }
3776     ],
3777     "name": "CreateWebsites",
3778     "group": "Chat_Websites",
3779     "parameter": {
3780       "fields": {
3781         "Body": [
3782           {
3783             "group": "Body",
3784             "type": "String",
3785             "optional": false,
3786             "field": "name",
3787             "description": ""
3788           },
3789           {
3790             "group": "Body",
3791             "type": "String",
3792             "optional": false,
3793             "field": "address",
3794             "description": ""
3795           },
3796           {
3797             "group": "Body",
3798             "type": "String",
3799             "optional": true,
3800             "field": "description",
3801             "description": ""
3802           },
3803           {
3804             "group": "Body",
3805             "type": "String",
3806             "optional": true,
3807             "field": "mapKey",
3808             "description": ""
3809           },
3810           {
3811             "group": "Body",
3812             "type": "String",
3813             "optional": true,
3814             "field": "mapKeyOffline",
3815             "description": ""
3816           },
3817           {
3818             "group": "Body",
3819             "type": "String",
3820             "optional": false,
3821             "field": "key",
3822             "description": ""
3823           },
3824           {
3825             "group": "Body",
3826             "type": "String",
3827             "optional": true,
3828             "field": "agentAlias",
3829             "description": ""
3830           },
3831           {
3832             "group": "Body",
3833             "type": "String",
3834             "optional": true,
3835             "field": "customerAlias",
3836             "description": ""
3837           },
3838           {
3839             "group": "Body",
3840             "type": "String",
3841             "optional": false,
3842             "field": "color",
3843             "description": ""
3844           },
3845           {
3846             "group": "Body",
3847             "type": "String",
3848             "optional": false,
3849             "field": "color_button",
3850             "description": ""
3851           },
3852           {
3853             "group": "Body",
3854             "type": "String",
3855             "optional": false,
3856             "field": "textColor",
3857             "description": ""
3858           },
3859           {
3860             "group": "Body",
3861             "type": "Integer",
3862             "optional": true,
3863             "field": "fontSize",
3864             "description": ""
3865           },
3866           {
3867             "group": "Body",
3868             "type": "String",
3869             "optional": true,
3870             "field": "remote",
3871             "description": ""
3872           },
3873           {
3874             "group": "Body",
3875             "type": "Boolean",
3876             "optional": true,
3877             "field": "animation",
3878             "description": ""
3879           },
3880           {
3881             "group": "Body",
3882             "type": "String",
3883             "allowedValues": [
3884               "\"rounded\"",
3885               "\"squared\""
3886             ],
3887             "optional": true,
3888             "field": "header_shape",
3889             "description": ""
3890           },
3891           {
3892             "group": "Body",
3893             "type": "String",
3894             "optional": true,
3895             "field": "header_online",
3896             "description": ""
3897           },
3898           {
3899             "group": "Body",
3900             "type": "String",
3901             "optional": true,
3902             "field": "start_chat_button",
3903             "description": ""
3904           },
3905           {
3906             "group": "Body",
3907             "type": "String",
3908             "optional": true,
3909             "field": "offline_chat_button",
3910             "description": ""
3911           },
3912           {
3913             "group": "Body",
3914             "type": "String",
3915             "optional": true,
3916             "field": "header_offline",
3917             "description": ""
3918           },
3919           {
3920             "group": "Body",
3921             "type": "Boolean",
3922             "optional": true,
3923             "field": "download_transcript",
3924             "description": ""
3925           },
3926           {
3927             "group": "Body",
3928             "type": "Integer",
3929             "optional": true,
3930             "field": "timeout",
3931             "description": ""
3932           },
3933           {
3934             "group": "Body",
3935             "type": "String",
3936             "optional": true,
3937             "field": "whiteLabel",
3938             "description": ""
3939           },
3940           {
3941             "group": "Body",
3942             "type": "Boolean",
3943             "optional": true,
3944             "field": "defaultWhiteLabel",
3945             "description": ""
3946           },
3947           {
3948             "group": "Body",
3949             "type": "Text",
3950             "optional": true,
3951             "field": "sitepic",
3952             "description": ""
3953           },
3954           {
3955             "group": "Body",
3956             "type": "String",
3957             "optional": true,
3958             "field": "closingQuestion",
3959             "description": ""
3960           },
3961           {
3962             "group": "Body",
3963             "type": "String",
3964             "optional": true,
3965             "field": "formSubmitSuccessMessage",
3966             "description": ""
3967           },
3968           {
3969             "group": "Body",
3970             "type": "String",
3971             "optional": true,
3972             "field": "formSubmitFailureMessage",
3973             "description": ""
3974           },
3975           {
3976             "group": "Body",
3977             "type": "String",
3978             "optional": true,
3979             "field": "noteTitle",
3980             "description": ""
3981           },
3982           {
3983             "group": "Body",
3984             "type": "String",
3985             "optional": true,
3986             "field": "placeholderMessage",
3987             "description": ""
3988           },
3989           {
3990             "group": "Body",
3991             "type": "String",
3992             "optional": true,
3993             "field": "closingMessage",
3994             "description": ""
3995           },
3996           {
3997             "group": "Body",
3998             "type": "String",
3999             "optional": true,
4000             "field": "closingMessageButton",
4001             "description": ""
4002           },
4003           {
4004             "group": "Body",
4005             "type": "String",
4006             "optional": true,
4007             "field": "skipMessageButton",
4008             "description": ""
4009           },
4010           {
4011             "group": "Body",
4012             "type": "Boolean",
4013             "optional": true,
4014             "field": "conditionAgreement",
4015             "description": ""
4016           },
4017           {
4018             "group": "Body",
4019             "type": "Boolean",
4020             "optional": true,
4021             "field": "enableRating",
4022             "description": ""
4023           },
4024           {
4025             "group": "Body",
4026             "type": "Boolean",
4027             "optional": true,
4028             "field": "enableFeedback",
4029             "description": ""
4030           },
4031           {
4032             "group": "Body",
4033             "type": "Boolean",
4034             "optional": true,
4035             "field": "enableSendButton",
4036             "description": ""
4037           },
4038           {
4039             "group": "Body",
4040             "type": "String",
4041             "optional": true,
4042             "field": "feedbackTitle",
4043             "description": ""
4044           },
4045           {
4046             "group": "Body",
4047             "type": "String",
4048             "allowedValues": [
4049               "\"star\"",
4050               "\"thumb\""
4051             ],
4052             "optional": true,
4053             "field": "ratingType",
4054             "description": ""
4055           },
4056           {
4057             "group": "Body",
4058             "type": "Integer",
4059             "optional": true,
4060             "field": "ratingStarsNumber",
4061             "description": ""
4062           },
4063           {
4064             "group": "Body",
4065             "type": "Text",
4066             "optional": true,
4067             "field": "onlineForm",
4068             "description": ""
4069           },
4070           {
4071             "group": "Body",
4072             "type": "Text",
4073             "optional": true,
4074             "field": "offlineForm",
4075             "description": ""
4076           },
4077           {
4078             "group": "Body",
4079             "type": "String",
4080             "optional": true,
4081             "field": "token",
4082             "description": ""
4083           },
4084           {
4085             "group": "Body",
4086             "type": "Boolean",
4087             "optional": true,
4088             "field": "autoclose",
4089             "description": ""
4090           },
4091           {
4092             "group": "Body",
4093             "type": "Boolean",
4094             "optional": true,
4095             "field": "enableCustomerWriting",
4096             "description": ""
4097           },
4098           {
4099             "group": "Body",
4100             "type": "Boolean",
4101             "optional": true,
4102             "field": "forwardTranscript",
4103             "description": ""
4104           },
4105           {
4106             "group": "Body",
4107             "type": "String",
4108             "optional": true,
4109             "field": "forwardTranscriptMessage",
4110             "description": ""
4111           },
4112           {
4113             "group": "Body",
4114             "type": "Boolean",
4115             "optional": true,
4116             "field": "forwardOffline",
4117             "description": ""
4118           },
4119           {
4120             "group": "Body",
4121             "type": "String",
4122             "optional": true,
4123             "field": "forwardOfflineAddress",
4124             "description": ""
4125           },
4126           {
4127             "group": "Body",
4128             "type": "String",
4129             "optional": true,
4130             "field": "waitingTitle",
4131             "description": ""
4132           },
4133           {
4134             "group": "Body",
4135             "type": "String",
4136             "optional": true,
4137             "field": "waitingMessage",
4138             "description": ""
4139           },
4140           {
4141             "group": "Body",
4142             "type": "String",
4143             "optional": true,
4144             "field": "offlineMessageSubject",
4145             "description": ""
4146           },
4147           {
4148             "group": "Body",
4149             "type": "String",
4150             "optional": true,
4151             "field": "offlineMessageBody",
4152             "description": ""
4153           },
4154           {
4155             "group": "Body",
4156             "type": "Boolean",
4157             "optional": true,
4158             "field": "enableUnmanagedNote",
4159             "description": ""
4160           },
4161           {
4162             "group": "Body",
4163             "type": "String",
4164             "optional": true,
4165             "field": "unmanagedMessage",
4166             "description": ""
4167           },
4168           {
4169             "group": "Body",
4170             "type": "String",
4171             "optional": true,
4172             "field": "skipUnmanaged",
4173             "description": ""
4174           },
4175           {
4176             "group": "Body",
4177             "type": "String",
4178             "optional": true,
4179             "field": "sendUnmanaged",
4180             "description": ""
4181           },
4182           {
4183             "group": "Body",
4184             "type": "Boolean",
4185             "optional": true,
4186             "field": "enableCustomerAttachment",
4187             "description": ""
4188           },
4189           {
4190             "group": "Body",
4191             "type": "Boolean",
4192             "optional": true,
4193             "field": "enableCustomerCheckmarks",
4194             "description": ""
4195           },
4196           {
4197             "group": "Body",
4198             "type": "Text",
4199             "optional": true,
4200             "field": "agentAvatar",
4201             "description": ""
4202           },
4203           {
4204             "group": "Body",
4205             "type": "Boolean",
4206             "optional": true,
4207             "field": "showAgentAvatar",
4208             "description": ""
4209           },
4210           {
4211             "group": "Body",
4212             "type": "String",
4213             "optional": true,
4214             "field": "timezone",
4215             "description": ""
4216           },
4217           {
4218             "group": "Body",
4219             "type": "Text",
4220             "optional": true,
4221             "field": "notificationTemplate",
4222             "description": ""
4223           },
4224           {
4225             "group": "Body",
4226             "type": "Boolean",
4227             "optional": true,
4228             "field": "notificationSound",
4229             "description": ""
4230           },
4231           {
4232             "group": "Body",
4233             "type": "Boolean",
4234             "optional": true,
4235             "field": "notificationShake",
4236             "description": ""
4237           },
4238           {
4239             "group": "Body",
4240             "type": "Boolean",
4241             "optional": true,
4242             "field": "hideWhenOffline",
4243             "description": ""
4244           },
4245           {
4246             "group": "Body",
4247             "type": "String",
4248             "optional": true,
4249             "field": "agentIdentifier",
4250             "description": ""
4251           },
4252           {
4253             "group": "Body",
4254             "type": "Integer",
4255             "optional": true,
4256             "field": "waitForTheAssignedAgent",
4257             "description": ""
4258           },
4259           {
4260             "group": "Body",
4261             "type": "String",
4262             "optional": true,
4263             "field": "alignment",
4264             "description": ""
4265           },
4266           {
4267             "group": "Body",
4268             "type": "Integer",
4269             "optional": true,
4270             "field": "verticalAlignment",
4271             "description": ""
4272           },
4273           {
4274             "group": "Body",
4275             "type": "String",
4276             "optional": true,
4277             "field": "messagesAlignment",
4278             "description": ""
4279           },
4280           {
4281             "group": "Body",
4282             "type": "String",
4283             "optional": true,
4284             "field": "defaultTitle",
4285             "description": ""
4286           },
4287           {
4288             "group": "Body",
4289             "type": "Text",
4290             "optional": true,
4291             "field": "customerAvatar",
4292             "description": ""
4293           },
4294           {
4295             "group": "Body",
4296             "type": "Boolean",
4297             "optional": true,
4298             "field": "showCustomerAvatar",
4299             "description": ""
4300           },
4301           {
4302             "group": "Body",
4303             "type": "Integer",
4304             "optional": true,
4305             "field": "messageFontSize",
4306             "description": ""
4307           },
4308           {
4309             "group": "Body",
4310             "type": "String",
4311             "optional": false,
4312             "field": "backgroundColor",
4313             "description": ""
4314           },
4315           {
4316             "group": "Body",
4317             "type": "Boolean",
4318             "optional": true,
4319             "field": "queueTransfer",
4320             "description": ""
4321           },
4322           {
4323             "group": "Body",
4324             "type": "Integer",
4325             "optional": true,
4326             "field": "queueTransferTimeout",
4327             "description": ""
4328           },
4329           {
4330             "group": "Body",
4331             "type": "Boolean",
4332             "optional": true,
4333             "field": "agentTransfer",
4334             "description": ""
4335           },
4336           {
4337             "group": "Body",
4338             "type": "Integer",
4339             "optional": true,
4340             "field": "agentTransferTimeout",
4341             "description": ""
4342           },
4343           {
4344             "group": "Body",
4345             "type": "String",
4346             "optional": true,
4347             "field": "systemAlias",
4348             "description": ""
4349           },
4350           {
4351             "group": "Body",
4352             "type": "Text",
4353             "optional": true,
4354             "field": "systemAvatar",
4355             "description": ""
4356           },
4357           {
4358             "group": "Body",
4359             "type": "Integer",
4360             "optional": true,
4361             "field": "mandatoryDispositionPauseId",
4362             "description": "<p>Status to put when mandatory disposition is enabled</p>"
4363           },
4364           {
4365             "group": "Body",
4366             "type": "Boolean",
4367             "optional": true,
4368             "field": "mandatoryDisposition",
4369             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4370           },
4371           {
4372             "group": "Body",
4373             "type": "Boolean",
4374             "optional": true,
4375             "field": "vidaooEscalation",
4376             "description": ""
4377           },
4378           {
4379             "group": "Body",
4380             "type": "String",
4381             "optional": true,
4382             "field": "vidaooApiKey",
4383             "description": ""
4384           },
4385           {
4386             "group": "Body",
4387             "type": "String",
4388             "optional": false,
4389             "field": "vidaooTopic",
4390             "description": ""
4391           },
4392           {
4393             "group": "Body",
4394             "type": "String",
4395             "optional": true,
4396             "field": "vidaooNote",
4397             "description": ""
4398           },
4399           {
4400             "group": "Body",
4401             "type": "Text",
4402             "optional": true,
4403             "field": "vidaooMetadata",
4404             "description": ""
4405           },
4406           {
4407             "group": "Body",
4408             "type": "Boolean",
4409             "optional": true,
4410             "field": "openNewInteraction",
4411             "description": ""
4412           },
4413           {
4414             "group": "Body",
4415             "type": "Text",
4416             "optional": true,
4417             "field": "subjectOffline",
4418             "description": ""
4419           }
4420         ]
4421       }
4422     },
4423     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4424     "version": "0.0.0",
4425     "filename": "server/api/chatWebsite/index.js",
4426     "groupTitle": "Chat_Websites"
4427   },
4428   {
4429     "type": "delete",
4430     "url": "/api/chat/websites/{id}",
4431     "title": "Deletes a Website",
4432     "examples": [
4433       {
4434         "title": "Example usage:",
4435         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4436         "type": "json"
4437       }
4438     ],
4439     "name": "DeleteWebsites",
4440     "group": "Chat_Websites",
4441     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4442     "version": "0.0.0",
4443     "filename": "server/api/chatWebsite/index.js",
4444     "groupTitle": "Chat_Websites"
4445   },
4446   {
4447     "type": "get",
4448     "url": "/api/chat/websites/describe",
4449     "title": "Gets table info about Websites",
4450     "examples": [
4451       {
4452         "title": "Example usage:",
4453         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4454         "type": "json"
4455       }
4456     ],
4457     "name": "DescribeWebsites",
4458     "group": "Chat_Websites",
4459     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4460     "version": "0.0.0",
4461     "filename": "server/api/chatWebsite/index.js",
4462     "groupTitle": "Chat_Websites"
4463   },
4464   {
4465     "type": "get",
4466     "url": "/api/chat/websites/{id}/users",
4467     "title": "Gets agents from website",
4468     "examples": [
4469       {
4470         "title": "Example usage:",
4471         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4472         "type": "json"
4473       }
4474     ],
4475     "name": "GetAgents",
4476     "group": "Chat_Websites",
4477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4478     "version": "0.0.0",
4479     "filename": "server/api/chatWebsite/index.js",
4480     "groupTitle": "Chat_Websites"
4481   },
4482   {
4483     "type": "get",
4484     "url": "/api/chat/websites",
4485     "title": "Gets a list of Websites",
4486     "examples": [
4487       {
4488         "title": "Example usage:",
4489         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4490         "type": "json"
4491       }
4492     ],
4493     "name": "GetWebsites",
4494     "group": "Chat_Websites",
4495     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4496     "version": "0.0.0",
4497     "filename": "server/api/chatWebsite/index.js",
4498     "groupTitle": "Chat_Websites"
4499   },
4500   {
4501     "type": "delete",
4502     "url": "/api/chat/websites/{id}/users",
4503     "title": "Removes agents from a website",
4504     "examples": [
4505       {
4506         "title": "Example usage:",
4507         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4508         "type": "json"
4509       }
4510     ],
4511     "name": "RemoveAgents",
4512     "group": "Chat_Websites",
4513     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4514     "version": "0.0.0",
4515     "filename": "server/api/chatWebsite/index.js",
4516     "groupTitle": "Chat_Websites"
4517   },
4518   {
4519     "type": "delete",
4520     "url": "/api/chat/websites/{id}/canned_answers",
4521     "title": "Removes canned answers from account",
4522     "examples": [
4523       {
4524         "title": "Example usage:",
4525         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4526         "type": "json"
4527       }
4528     ],
4529     "name": "RemoveAnswers",
4530     "group": "Chat_Websites",
4531     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4532     "version": "0.0.0",
4533     "filename": "server/api/chatWebsite/index.js",
4534     "groupTitle": "Chat_Websites"
4535   },
4536   {
4537     "type": "delete",
4538     "url": "/api/chat/websites/{id}/dispositions",
4539     "title": "Removes canned answers from account",
4540     "examples": [
4541       {
4542         "title": "Example usage:",
4543         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4544         "type": "json"
4545       }
4546     ],
4547     "name": "RemoveDispositions",
4548     "group": "Chat_Websites",
4549     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4550     "version": "0.0.0",
4551     "filename": "server/api/chatWebsite/index.js",
4552     "groupTitle": "Chat_Websites"
4553   },
4554   {
4555     "type": "get",
4556     "url": "/api/chat/websites/{id}",
4557     "title": "Gets a single Website",
4558     "examples": [
4559       {
4560         "title": "Example usage:",
4561         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4562         "type": "json"
4563       }
4564     ],
4565     "name": "ShowWebsites",
4566     "group": "Chat_Websites",
4567     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4568     "version": "0.0.0",
4569     "filename": "server/api/chatWebsite/index.js",
4570     "groupTitle": "Chat_Websites"
4571   },
4572   {
4573     "type": "put",
4574     "url": "/api/chat/messages/{id}/accept",
4575     "title": "Accepts message",
4576     "examples": [
4577       {
4578         "title": "Example usage:",
4579         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4580         "type": "json"
4581       }
4582     ],
4583     "name": "acceptMessage",
4584     "group": "Chat_Websites",
4585     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4586     "version": "0.0.0",
4587     "filename": "server/api/chatMessage/index.js",
4588     "groupTitle": "Chat_Websites"
4589   },
4590   {
4591     "type": "post",
4592     "url": "/api/chat/websites/{id}/canned_answers",
4593     "title": "Creates new canned answer",
4594     "examples": [
4595       {
4596         "title": "Example usage:",
4597         "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",
4598         "type": "json"
4599       }
4600     ],
4601     "name": "addAnswer",
4602     "group": "Chat_Websites",
4603     "parameter": {
4604       "fields": {
4605         "Body": [
4606           {
4607             "group": "Body",
4608             "type": "String",
4609             "optional": false,
4610             "field": "key",
4611             "description": ""
4612           },
4613           {
4614             "group": "Body",
4615             "type": "Text",
4616             "optional": false,
4617             "field": "value",
4618             "description": ""
4619           },
4620           {
4621             "group": "Body",
4622             "type": "String",
4623             "optional": true,
4624             "field": "description",
4625             "description": ""
4626           },
4627           {
4628             "group": "Body",
4629             "type": "Virtual",
4630             "optional": true,
4631             "field": "name",
4632             "description": ""
4633           }
4634         ]
4635       }
4636     },
4637     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4638     "version": "0.0.0",
4639     "filename": "server/api/chatWebsite/index.js",
4640     "groupTitle": "Chat_Websites"
4641   },
4642   {
4643     "type": "post",
4644     "url": "/api/chat/websites/{id}/applications",
4645     "title": "Creates new applications",
4646     "examples": [
4647       {
4648         "title": "Example usage:",
4649         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4650         "type": "json"
4651       }
4652     ],
4653     "name": "addApplications",
4654     "group": "Chat_Websites",
4655     "parameter": {
4656       "fields": {
4657         "Body": [
4658           {
4659             "group": "Body",
4660             "type": "Integer",
4661             "optional": false,
4662             "field": "priority",
4663             "description": ""
4664           },
4665           {
4666             "group": "Body",
4667             "type": "String",
4668             "optional": false,
4669             "field": "app",
4670             "description": ""
4671           },
4672           {
4673             "group": "Body",
4674             "type": "Text",
4675             "optional": true,
4676             "field": "appdata",
4677             "description": ""
4678           },
4679           {
4680             "group": "Body",
4681             "type": "String",
4682             "optional": true,
4683             "field": "description",
4684             "description": ""
4685           },
4686           {
4687             "group": "Body",
4688             "type": "String",
4689             "optional": true,
4690             "field": "interval",
4691             "description": ""
4692           }
4693         ]
4694       }
4695     },
4696     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4697     "version": "0.0.0",
4698     "filename": "server/api/chatWebsite/index.js",
4699     "groupTitle": "Chat_Websites"
4700   },
4701   {
4702     "type": "post",
4703     "url": "/api/chat/websites/{id}/avatar",
4704     "title": "Add avatar",
4705     "examples": [
4706       {
4707         "title": "Example usage:",
4708         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4709         "type": "json"
4710       }
4711     ],
4712     "name": "addAvatar",
4713     "group": "Chat_Websites",
4714     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4715     "version": "0.0.0",
4716     "filename": "server/api/chatWebsite/index.js",
4717     "groupTitle": "Chat_Websites"
4718   },
4719   {
4720     "type": "post",
4721     "url": "/api/chat/websites/{id}/customer_avatar",
4722     "title": "Add customer avatar",
4723     "examples": [
4724       {
4725         "title": "Example usage:",
4726         "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",
4727         "type": "json"
4728       }
4729     ],
4730     "name": "addCustomerAvatar",
4731     "group": "Chat_Websites",
4732     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4733     "version": "0.0.0",
4734     "filename": "server/api/chatWebsite/index.js",
4735     "groupTitle": "Chat_Websites"
4736   },
4737   {
4738     "type": "post",
4739     "url": "/api/chat/websites/{id}/dispositions",
4740     "title": "Creates new disposition",
4741     "examples": [
4742       {
4743         "title": "Example usage:",
4744         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4745         "type": "json"
4746       }
4747     ],
4748     "name": "addDisposition",
4749     "group": "Chat_Websites",
4750     "parameter": {
4751       "fields": {
4752         "Body": [
4753           {
4754             "group": "Body",
4755             "type": "String",
4756             "optional": false,
4757             "field": "name",
4758             "description": ""
4759           },
4760           {
4761             "group": "Body",
4762             "type": "String",
4763             "allowedValues": [
4764               "\"first\"",
4765               "\"second\"",
4766               "\"third\""
4767             ],
4768             "optional": false,
4769             "field": "level",
4770             "description": ""
4771           },
4772           {
4773             "group": "Body",
4774             "type": "String",
4775             "optional": true,
4776             "field": "description",
4777             "description": ""
4778           }
4779         ]
4780       }
4781     },
4782     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4783     "version": "0.0.0",
4784     "filename": "server/api/chatWebsite/index.js",
4785     "groupTitle": "Chat_Websites"
4786   },
4787   {
4788     "type": "post",
4789     "url": "/api/chat/accounts/{id}/interactions",
4790     "title": "Creates new interactions",
4791     "examples": [
4792       {
4793         "title": "Example usage:",
4794         "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",
4795         "type": "json"
4796       }
4797     ],
4798     "name": "addInteraction",
4799     "group": "Chat_Websites",
4800     "parameter": {
4801       "fields": {
4802         "Body": [
4803           {
4804             "group": "Body",
4805             "type": "Boolean",
4806             "optional": true,
4807             "field": "closed",
4808             "description": ""
4809           },
4810           {
4811             "group": "Body",
4812             "type": "Integer",
4813             "optional": true,
4814             "field": "ratingValue",
4815             "description": ""
4816           },
4817           {
4818             "group": "Body",
4819             "type": "String",
4820             "allowedValues": [
4821               "\"star\"",
4822               "\"thumb\""
4823             ],
4824             "optional": true,
4825             "field": "ratingType",
4826             "description": ""
4827           },
4828           {
4829             "group": "Body",
4830             "type": "Text",
4831             "optional": true,
4832             "field": "ratingMessage",
4833             "description": ""
4834           },
4835           {
4836             "group": "Body",
4837             "type": "Text",
4838             "optional": true,
4839             "field": "pathTranscript",
4840             "description": ""
4841           },
4842           {
4843             "group": "Body",
4844             "type": "String",
4845             "optional": true,
4846             "field": "mailTranscript",
4847             "description": ""
4848           },
4849           {
4850             "group": "Body",
4851             "type": "String",
4852             "optional": true,
4853             "field": "closedAt",
4854             "description": ""
4855           },
4856           {
4857             "group": "Body",
4858             "type": "String",
4859             "optional": true,
4860             "field": "disposition",
4861             "description": ""
4862           },
4863           {
4864             "group": "Body",
4865             "type": "String",
4866             "optional": true,
4867             "field": "secondDisposition",
4868             "description": ""
4869           },
4870           {
4871             "group": "Body",
4872             "type": "String",
4873             "optional": true,
4874             "field": "thirdDisposition",
4875             "description": ""
4876           },
4877           {
4878             "group": "Body",
4879             "type": "String",
4880             "optional": true,
4881             "field": "note",
4882             "description": ""
4883           },
4884           {
4885             "group": "Body",
4886             "type": "String",
4887             "optional": true,
4888             "field": "browserName",
4889             "description": ""
4890           },
4891           {
4892             "group": "Body",
4893             "type": "String",
4894             "optional": true,
4895             "field": "browserVersion",
4896             "description": ""
4897           },
4898           {
4899             "group": "Body",
4900             "type": "String",
4901             "optional": true,
4902             "field": "osName",
4903             "description": ""
4904           },
4905           {
4906             "group": "Body",
4907             "type": "String",
4908             "optional": true,
4909             "field": "osVersion",
4910             "description": ""
4911           },
4912           {
4913             "group": "Body",
4914             "type": "String",
4915             "optional": true,
4916             "field": "deviceModel",
4917             "description": ""
4918           },
4919           {
4920             "group": "Body",
4921             "type": "String",
4922             "optional": true,
4923             "field": "deviceVendor",
4924             "description": ""
4925           },
4926           {
4927             "group": "Body",
4928             "type": "String",
4929             "optional": true,
4930             "field": "deviceType",
4931             "description": ""
4932           },
4933           {
4934             "group": "Body",
4935             "type": "Text",
4936             "optional": true,
4937             "field": "referer",
4938             "description": ""
4939           },
4940           {
4941             "group": "Body",
4942             "type": "String",
4943             "optional": true,
4944             "field": "customerIp",
4945             "description": ""
4946           },
4947           {
4948             "group": "Body",
4949             "type": "Text",
4950             "optional": true,
4951             "field": "formData",
4952             "description": ""
4953           },
4954           {
4955             "group": "Body",
4956             "type": "String",
4957             "optional": true,
4958             "field": "read1stAt",
4959             "description": ""
4960           },
4961           {
4962             "group": "Body",
4963             "type": "String",
4964             "optional": true,
4965             "field": "lastMsgAt",
4966             "description": ""
4967           },
4968           {
4969             "group": "Body",
4970             "type": "String",
4971             "allowedValues": [
4972               "\"in\"",
4973               "\"out\""
4974             ],
4975             "optional": false,
4976             "field": "lastMsgDirection",
4977             "description": ""
4978           },
4979           {
4980             "group": "Body",
4981             "type": "String",
4982             "optional": true,
4983             "field": "closeReason",
4984             "description": ""
4985           },
4986           {
4987             "group": "Body",
4988             "type": "String",
4989             "optional": true,
4990             "field": "customerPort",
4991             "description": ""
4992           },
4993           {
4994             "group": "Body",
4995             "type": "Text",
4996             "optional": true,
4997             "field": "vidaooSessionId",
4998             "description": ""
4999           }
5000         ]
5001       }
5002     },
5003     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5004     "version": "0.0.0",
5005     "filename": "server/api/chatWebsite/index.js",
5006     "groupTitle": "Chat_Websites"
5007   },
5008   {
5009     "type": "post",
5010     "url": "/api/chat/websites/{id}/logo",
5011     "title": "Add logo",
5012     "examples": [
5013       {
5014         "title": "Example usage:",
5015         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
5016         "type": "json"
5017       }
5018     ],
5019     "name": "addLogo",
5020     "group": "Chat_Websites",
5021     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5022     "version": "0.0.0",
5023     "filename": "server/api/chatWebsite/index.js",
5024     "groupTitle": "Chat_Websites"
5025   },
5026   {
5027     "type": "post",
5028     "url": "/api/chat/websites/{id}/proactive_actions",
5029     "title": "Creates new Proactive Actions",
5030     "examples": [
5031       {
5032         "title": "Example usage:",
5033         "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",
5034         "type": "json"
5035       }
5036     ],
5037     "name": "addProactiveActions",
5038     "group": "Chat_Websites",
5039     "parameter": {
5040       "fields": {
5041         "Body": [
5042           {
5043             "group": "Body",
5044             "type": "String",
5045             "optional": false,
5046             "field": "name",
5047             "description": ""
5048           },
5049           {
5050             "group": "Body",
5051             "type": "String",
5052             "allowedValues": [
5053               "\"mouseOver\"",
5054               "\"timeout\""
5055             ],
5056             "optional": true,
5057             "field": "type",
5058             "description": ""
5059           },
5060           {
5061             "group": "Body",
5062             "type": "String",
5063             "optional": true,
5064             "field": "selector",
5065             "description": ""
5066           },
5067           {
5068             "group": "Body",
5069             "type": "Integer",
5070             "optional": true,
5071             "field": "timeout",
5072             "description": ""
5073           }
5074         ]
5075       }
5076     },
5077     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5078     "version": "0.0.0",
5079     "filename": "server/api/chatWebsite/index.js",
5080     "groupTitle": "Chat_Websites"
5081   },
5082   {
5083     "type": "post",
5084     "url": "/api/chat/websites/{id}/system_avatar",
5085     "title": "Add system avatar",
5086     "examples": [
5087       {
5088         "title": "Example usage:",
5089         "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",
5090         "type": "json"
5091       }
5092     ],
5093     "name": "addSystemAvatar",
5094     "group": "Chat_Websites",
5095     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5096     "version": "0.0.0",
5097     "filename": "server/api/chatWebsite/index.js",
5098     "groupTitle": "Chat_Websites"
5099   },
5100   {
5101     "type": "get",
5102     "url": "/api/chat/websites/{id}/canned_answers",
5103     "title": "Gets account canned answers",
5104     "examples": [
5105       {
5106         "title": "Example usage:",
5107         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5108         "type": "json"
5109       }
5110     ],
5111     "name": "getAnswers",
5112     "group": "Chat_Websites",
5113     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5114     "version": "0.0.0",
5115     "filename": "server/api/chatWebsite/index.js",
5116     "groupTitle": "Chat_Websites"
5117   },
5118   {
5119     "type": "get",
5120     "url": "/api/chat/websites/{id}/applications",
5121     "title": "Gets Website Applications",
5122     "examples": [
5123       {
5124         "title": "Example usage:",
5125         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5126         "type": "json"
5127       }
5128     ],
5129     "name": "getApplications",
5130     "group": "Chat_Websites",
5131     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5132     "version": "0.0.0",
5133     "filename": "server/api/chatWebsite/index.js",
5134     "groupTitle": "Chat_Websites"
5135   },
5136   {
5137     "type": "get",
5138     "url": "/api/chat/websites/{id}/avatar",
5139     "title": "Get avatar",
5140     "examples": [
5141       {
5142         "title": "Example usage:",
5143         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5144         "type": "json"
5145       }
5146     ],
5147     "name": "getAvatar",
5148     "group": "Chat_Websites",
5149     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5150     "version": "0.0.0",
5151     "filename": "server/api/chatWebsite/index.js",
5152     "groupTitle": "Chat_Websites"
5153   },
5154   {
5155     "type": "get",
5156     "url": "/api/chat/websites/{id}/customer_avatar",
5157     "title": "Get Customer Avatar",
5158     "examples": [
5159       {
5160         "title": "Example usage:",
5161         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5162         "type": "json"
5163       }
5164     ],
5165     "name": "getCustomerAvatar",
5166     "group": "Chat_Websites",
5167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5168     "version": "0.0.0",
5169     "filename": "server/api/chatWebsite/index.js",
5170     "groupTitle": "Chat_Websites"
5171   },
5172   {
5173     "type": "get",
5174     "url": "/api/chat/websites/{id}/dispositions",
5175     "title": "Gets account dispositions",
5176     "examples": [
5177       {
5178         "title": "Example usage:",
5179         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5180         "type": "json"
5181       }
5182     ],
5183     "name": "getDispositions",
5184     "group": "Chat_Websites",
5185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5186     "version": "0.0.0",
5187     "filename": "server/api/chatWebsite/index.js",
5188     "groupTitle": "Chat_Websites"
5189   },
5190   {
5191     "type": "get",
5192     "url": "/api/chat/websites/{id}/fields",
5193     "title": "Gets Website Fields",
5194     "examples": [
5195       {
5196         "title": "Example usage:",
5197         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5198         "type": "json"
5199       }
5200     ],
5201     "name": "getFields",
5202     "group": "Chat_Websites",
5203     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5204     "version": "0.0.0",
5205     "filename": "server/api/chatWebsite/index.js",
5206     "groupTitle": "Chat_Websites"
5207   },
5208   {
5209     "type": "get",
5210     "url": "/api/chat/websites/{id}/interactions",
5211     "title": "Gets Website Interactions",
5212     "examples": [
5213       {
5214         "title": "Example usage:",
5215         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5216         "type": "json"
5217       }
5218     ],
5219     "name": "getInteraction",
5220     "group": "Chat_Websites",
5221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5222     "version": "0.0.0",
5223     "filename": "server/api/chatWebsite/index.js",
5224     "groupTitle": "Chat_Websites"
5225   },
5226   {
5227     "type": "get",
5228     "url": "/api/chat/websites/{id}/logo",
5229     "title": "Get logo",
5230     "examples": [
5231       {
5232         "title": "Example usage:",
5233         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5234         "type": "json"
5235       }
5236     ],
5237     "name": "getLogo",
5238     "group": "Chat_Websites",
5239     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5240     "version": "0.0.0",
5241     "filename": "server/api/chatWebsite/index.js",
5242     "groupTitle": "Chat_Websites"
5243   },
5244   {
5245     "type": "get",
5246     "url": "/api/chat/websites/{id}/offline_messages",
5247     "title": "Gets Website Offline Messages",
5248     "examples": [
5249       {
5250         "title": "Example usage:",
5251         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5252         "type": "json"
5253       }
5254     ],
5255     "name": "getOfflineMessages",
5256     "group": "Chat_Websites",
5257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5258     "version": "0.0.0",
5259     "filename": "server/api/chatWebsite/index.js",
5260     "groupTitle": "Chat_Websites"
5261   },
5262   {
5263     "type": "get",
5264     "url": "/api/chat/websites/{id}/proactive_actions",
5265     "title": "Gets Website Proactive Actions",
5266     "examples": [
5267       {
5268         "title": "Example usage:",
5269         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5270         "type": "json"
5271       }
5272     ],
5273     "name": "getProactiveActions",
5274     "group": "Chat_Websites",
5275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5276     "version": "0.0.0",
5277     "filename": "server/api/chatWebsite/index.js",
5278     "groupTitle": "Chat_Websites"
5279   },
5280   {
5281     "type": "get",
5282     "url": "/api/chat/websites/{id}/snippet",
5283     "title": "Gets Website Snippet",
5284     "examples": [
5285       {
5286         "title": "Example usage:",
5287         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5288         "type": "json"
5289       }
5290     ],
5291     "name": "getSnippet",
5292     "group": "Chat_Websites",
5293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5294     "version": "0.0.0",
5295     "filename": "server/api/chatWebsite/index.js",
5296     "groupTitle": "Chat_Websites"
5297   },
5298   {
5299     "type": "get",
5300     "url": "/api/chat/websites/{id}/system_avatar",
5301     "title": "Get System Avatar",
5302     "examples": [
5303       {
5304         "title": "Example usage:",
5305         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5306         "type": "json"
5307       }
5308     ],
5309     "name": "getSystemAvatar",
5310     "group": "Chat_Websites",
5311     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5312     "version": "0.0.0",
5313     "filename": "server/api/chatWebsite/index.js",
5314     "groupTitle": "Chat_Websites"
5315   },
5316   {
5317     "type": "post",
5318     "url": "/api/chat/websites/{id}/notify",
5319     "title": "Notify new message",
5320     "examples": [
5321       {
5322         "title": "Example usage:",
5323         "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",
5324         "type": "json"
5325       }
5326     ],
5327     "name": "notify",
5328     "group": "Chat_Websites",
5329     "description": "<p>Motion 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>",
5330     "version": "0.0.0",
5331     "filename": "server/api/chatWebsite/index.js",
5332     "groupTitle": "Chat_Websites"
5333   },
5334   {
5335     "type": "post",
5336     "url": "/api/chat/websites/{id}/offline",
5337     "title": "Offline message",
5338     "examples": [
5339       {
5340         "title": "Example usage:",
5341         "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",
5342         "type": "json"
5343       }
5344     ],
5345     "name": "offline",
5346     "group": "Chat_Websites",
5347     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5348     "version": "0.0.0",
5349     "filename": "server/api/chatWebsite/index.js",
5350     "groupTitle": "Chat_Websites"
5351   },
5352   {
5353     "type": "put",
5354     "url": "/api/chat/messages/{id}/reject",
5355     "title": "Rejects message",
5356     "examples": [
5357       {
5358         "title": "Example usage:",
5359         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5360         "type": "json"
5361       }
5362     ],
5363     "name": "rejectMessage",
5364     "group": "Chat_Websites",
5365     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5366     "version": "0.0.0",
5367     "filename": "server/api/chatMessage/index.js",
5368     "groupTitle": "Chat_Websites"
5369   },
5370   {
5371     "type": "put",
5372     "url": "/api/chat/websites/{id}",
5373     "title": "Update an existing Website",
5374     "examples": [
5375       {
5376         "title": "Example usage:",
5377         "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",
5378         "type": "json"
5379       }
5380     ],
5381     "name": "updateWebsites",
5382     "group": "Chat_Websites",
5383     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5384     "version": "0.0.0",
5385     "filename": "server/api/chatWebsite/index.js",
5386     "groupTitle": "Chat_Websites"
5387   },
5388   {
5389     "type": "post",
5390     "url": "/api/cloudProviders",
5391     "title": "Creates a new CloudProvider",
5392     "examples": [
5393       {
5394         "title": "Example usage:",
5395         "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5396         "type": "json"
5397       }
5398     ],
5399     "name": "CreateCloudProviders",
5400     "group": "CloudProviders",
5401     "parameter": {
5402       "fields": {
5403         "Body": [
5404           {
5405             "group": "Body",
5406             "type": "String",
5407             "optional": false,
5408             "field": "name",
5409             "description": ""
5410           },
5411           {
5412             "group": "Body",
5413             "type": "String",
5414             "allowedValues": [
5415               "\"AmazonAWS\"",
5416               "\"Google\""
5417             ],
5418             "optional": false,
5419             "field": "service",
5420             "description": ""
5421           },
5422           {
5423             "group": "Body",
5424             "type": "String",
5425             "optional": true,
5426             "field": "data1",
5427             "description": ""
5428           },
5429           {
5430             "group": "Body",
5431             "type": "String",
5432             "optional": true,
5433             "field": "data2",
5434             "description": ""
5435           }
5436         ]
5437       }
5438     },
5439     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5440     "version": "0.0.0",
5441     "filename": "server/api/cloudProvider/index.js",
5442     "groupTitle": "CloudProviders"
5443   },
5444   {
5445     "type": "delete",
5446     "url": "/api/cloudProviders/{id}",
5447     "title": "Deletes a CloudProvider",
5448     "examples": [
5449       {
5450         "title": "Example usage:",
5451         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5452         "type": "json"
5453       }
5454     ],
5455     "name": "DeleteCloudProviders",
5456     "group": "CloudProviders",
5457     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5458     "version": "0.0.0",
5459     "filename": "server/api/cloudProvider/index.js",
5460     "groupTitle": "CloudProviders"
5461   },
5462   {
5463     "type": "get",
5464     "url": "/api/cloudProviders",
5465     "title": "Gets a list of CloudProviders",
5466     "examples": [
5467       {
5468         "title": "Example usage:",
5469         "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5470         "type": "json"
5471       }
5472     ],
5473     "name": "GetCloudProviders",
5474     "group": "CloudProviders",
5475     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5476     "version": "0.0.0",
5477     "filename": "server/api/cloudProvider/index.js",
5478     "groupTitle": "CloudProviders"
5479   },
5480   {
5481     "type": "get",
5482     "url": "/api/cloudProviders/{id}",
5483     "title": "Gets a single CloudProvider",
5484     "examples": [
5485       {
5486         "title": "Example usage:",
5487         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5488         "type": "json"
5489       }
5490     ],
5491     "name": "ShowCloudProviders",
5492     "group": "CloudProviders",
5493     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5494     "version": "0.0.0",
5495     "filename": "server/api/cloudProvider/index.js",
5496     "groupTitle": "CloudProviders"
5497   },
5498   {
5499     "type": "put",
5500     "url": "/api/cloudProviders/{id}",
5501     "title": "Update an existing CloudProvider",
5502     "examples": [
5503       {
5504         "title": "Example usage:",
5505         "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5506         "type": "json"
5507       }
5508     ],
5509     "name": "updateCloudProviders",
5510     "group": "CloudProviders",
5511     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5512     "version": "0.0.0",
5513     "filename": "server/api/cloudProvider/index.js",
5514     "groupTitle": "CloudProviders"
5515   },
5516   {
5517     "type": "post",
5518     "url": "/api/cm_contact_has_items",
5519     "title": "Creates a new CmContactHasItem",
5520     "examples": [
5521       {
5522         "title": "Example usage:",
5523         "content": "curl https://{domain}/api/cm_contact_has_items -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5524         "type": "json"
5525       }
5526     ],
5527     "name": "CreateCmContactHasItems",
5528     "group": "CmContactHasItems",
5529     "parameter": {
5530       "fields": {
5531         "Body": [
5532           {
5533             "group": "Body",
5534             "type": "Integer",
5535             "optional": true,
5536             "field": "CmContactId",
5537             "description": ""
5538           },
5539           {
5540             "group": "Body",
5541             "type": "String",
5542             "optional": true,
5543             "field": "item",
5544             "description": ""
5545           },
5546           {
5547             "group": "Body",
5548             "type": "Integer",
5549             "optional": true,
5550             "field": "ItemTypeId",
5551             "description": ""
5552           },
5553           {
5554             "group": "Body",
5555             "type": "String",
5556             "optional": true,
5557             "field": "ItemClass",
5558             "description": ""
5559           },
5560           {
5561             "group": "Body",
5562             "type": "Integer",
5563             "optional": true,
5564             "field": "OrderBy",
5565             "description": ""
5566           },
5567           {
5568             "group": "Body",
5569             "type": "String",
5570             "optional": true,
5571             "field": "description",
5572             "description": ""
5573           }
5574         ]
5575       }
5576     },
5577     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5578     "version": "0.0.0",
5579     "filename": "server/api/cmContactHasItem/index.js",
5580     "groupTitle": "CmContactHasItems"
5581   },
5582   {
5583     "type": "delete",
5584     "url": "/api/cm_contact_has_items/{id}",
5585     "title": "Deletes a CmContactHasItem",
5586     "examples": [
5587       {
5588         "title": "Example usage:",
5589         "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password} -X DELETE",
5590         "type": "json"
5591       }
5592     ],
5593     "name": "DeleteCmContactHasItems",
5594     "group": "CmContactHasItems",
5595     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5596     "version": "0.0.0",
5597     "filename": "server/api/cmContactHasItem/index.js",
5598     "groupTitle": "CmContactHasItems"
5599   },
5600   {
5601     "type": "get",
5602     "url": "/api/cm_contact_has_items",
5603     "title": "Gets a list of CmContactHasItems",
5604     "examples": [
5605       {
5606         "title": "Example usage:",
5607         "content": "curl https://{domain}/api/cm_contact_has_items -v -u {name}:{password}",
5608         "type": "json"
5609       }
5610     ],
5611     "name": "GetCmContactHasItems",
5612     "group": "CmContactHasItems",
5613     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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_contact_has_items?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning 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_contact_has_items?name=john.doe,jane.miller</code></p> <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_contact_has_items?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A 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_contact_has_items?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result 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_contact_has_items?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5614     "version": "0.0.0",
5615     "filename": "server/api/cmContactHasItem/index.js",
5616     "groupTitle": "CmContactHasItems"
5617   },
5618   {
5619     "type": "get",
5620     "url": "/api/cm_contact_has_items/{id}",
5621     "title": "Gets a single CmContactHasItem",
5622     "examples": [
5623       {
5624         "title": "Example usage:",
5625         "content": "curl https://{domain}/api/cm_contact_has_items/{id} -v -u {name}:{password}",
5626         "type": "json"
5627       }
5628     ],
5629     "name": "ShowCmContactHasItems",
5630     "group": "CmContactHasItems",
5631     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5632     "version": "0.0.0",
5633     "filename": "server/api/cmContactHasItem/index.js",
5634     "groupTitle": "CmContactHasItems"
5635   },
5636   {
5637     "type": "put",
5638     "url": "/api/cm_contact_has_items/{id}",
5639     "title": "Update an existing CmContactHasItem",
5640     "examples": [
5641       {
5642         "title": "Example usage:",
5643         "content": "curl https://{domain}/api/cm_contact_has_items/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5644         "type": "json"
5645       }
5646     ],
5647     "name": "updateCmContactHasItems",
5648     "group": "CmContactHasItems",
5649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5650     "version": "0.0.0",
5651     "filename": "server/api/cmContactHasItem/index.js",
5652     "groupTitle": "CmContactHasItems"
5653   },
5654   {
5655     "type": "post",
5656     "url": "/api/cm_hopper_additional_phones",
5657     "title": "Creates a new CmHopperAdditionalPhone",
5658     "examples": [
5659       {
5660         "title": "Example usage:",
5661         "content": "curl https://{domain}/api/cm_hopper_additional_phones -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5662         "type": "json"
5663       }
5664     ],
5665     "name": "CreateCmHopperAdditionalPhones",
5666     "group": "CmHopperAdditionalPhones",
5667     "parameter": {
5668       "fields": {
5669         "Body": [
5670           {
5671             "group": "Body",
5672             "type": "Integer",
5673             "optional": true,
5674             "field": "CmHopperId",
5675             "description": ""
5676           },
5677           {
5678             "group": "Body",
5679             "type": "String",
5680             "optional": false,
5681             "field": "phone",
5682             "description": ""
5683           },
5684           {
5685             "group": "Body",
5686             "type": "Integer",
5687             "optional": true,
5688             "field": "OrderBy",
5689             "description": ""
5690           },
5691           {
5692             "group": "Body",
5693             "type": "String",
5694             "optional": true,
5695             "field": "scheduledat",
5696             "description": ""
5697           },
5698           {
5699             "group": "Body",
5700             "type": "Integer",
5701             "optional": true,
5702             "field": "countbusyretry",
5703             "description": ""
5704           },
5705           {
5706             "group": "Body",
5707             "type": "Integer",
5708             "optional": true,
5709             "field": "countcongestionretry",
5710             "description": ""
5711           },
5712           {
5713             "group": "Body",
5714             "type": "Integer",
5715             "optional": true,
5716             "field": "countnoanswerretry",
5717             "description": ""
5718           },
5719           {
5720             "group": "Body",
5721             "type": "Integer",
5722             "optional": true,
5723             "field": "countnosuchnumberretry",
5724             "description": ""
5725           },
5726           {
5727             "group": "Body",
5728             "type": "Integer",
5729             "optional": true,
5730             "field": "countdropretry",
5731             "description": ""
5732           },
5733           {
5734             "group": "Body",
5735             "type": "Integer",
5736             "optional": true,
5737             "field": "countabandonedretry",
5738             "description": ""
5739           },
5740           {
5741             "group": "Body",
5742             "type": "Integer",
5743             "optional": true,
5744             "field": "countmachineretry",
5745             "description": ""
5746           },
5747           {
5748             "group": "Body",
5749             "type": "Integer",
5750             "optional": true,
5751             "field": "countagentrejectretry",
5752             "description": ""
5753           }
5754         ]
5755       }
5756     },
5757     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5758     "version": "0.0.0",
5759     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5760     "groupTitle": "CmHopperAdditionalPhones"
5761   },
5762   {
5763     "type": "delete",
5764     "url": "/api/cm_hopper_additional_phones/{id}",
5765     "title": "Deletes a CmHopperAdditionalPhone",
5766     "examples": [
5767       {
5768         "title": "Example usage:",
5769         "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password} -X DELETE",
5770         "type": "json"
5771       }
5772     ],
5773     "name": "DeleteCmHopperAdditionalPhones",
5774     "group": "CmHopperAdditionalPhones",
5775     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5776     "version": "0.0.0",
5777     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5778     "groupTitle": "CmHopperAdditionalPhones"
5779   },
5780   {
5781     "type": "get",
5782     "url": "/api/cm_hopper_additional_phones",
5783     "title": "Gets a list of CmHopperAdditionalPhones",
5784     "examples": [
5785       {
5786         "title": "Example usage:",
5787         "content": "curl https://{domain}/api/cm_hopper_additional_phones -v -u {name}:{password}",
5788         "type": "json"
5789       }
5790     ],
5791     "name": "GetCmHopperAdditionalPhones",
5792     "group": "CmHopperAdditionalPhones",
5793     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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_additional_phones?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning 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_additional_phones?name=john.doe,jane.miller</code></p> <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_additional_phones?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A 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_additional_phones?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result 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_additional_phones?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
5794     "version": "0.0.0",
5795     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5796     "groupTitle": "CmHopperAdditionalPhones"
5797   },
5798   {
5799     "type": "get",
5800     "url": "/api/cm_hopper_additional_phones/{id}",
5801     "title": "Gets a single CmHopperAdditionalPhone",
5802     "examples": [
5803       {
5804         "title": "Example usage:",
5805         "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -v -u {name}:{password}",
5806         "type": "json"
5807       }
5808     ],
5809     "name": "ShowCmHopperAdditionalPhones",
5810     "group": "CmHopperAdditionalPhones",
5811     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5812     "version": "0.0.0",
5813     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5814     "groupTitle": "CmHopperAdditionalPhones"
5815   },
5816   {
5817     "type": "put",
5818     "url": "/api/cm_hopper_additional_phones/{id}",
5819     "title": "Update an existing CmHopperAdditionalPhone",
5820     "examples": [
5821       {
5822         "title": "Example usage:",
5823         "content": "curl https://{domain}/api/cm_hopper_additional_phones/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5824         "type": "json"
5825       }
5826     ],
5827     "name": "updateCmHopperAdditionalPhones",
5828     "group": "CmHopperAdditionalPhones",
5829     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5830     "version": "0.0.0",
5831     "filename": "server/api/cmHopperAdditionalPhone/index.js",
5832     "groupTitle": "CmHopperAdditionalPhones"
5833   },
5834   {
5835     "type": "post",
5836     "url": "/api/cm/companies",
5837     "title": "Creates a new Company",
5838     "examples": [
5839       {
5840         "title": "Example usage:",
5841         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5842         "type": "json"
5843       }
5844     ],
5845     "name": "CreateCompanies",
5846     "group": "Cm_Companies",
5847     "parameter": {
5848       "fields": {
5849         "Body": [
5850           {
5851             "group": "Body",
5852             "type": "String",
5853             "optional": false,
5854             "field": "name",
5855             "description": ""
5856           },
5857           {
5858             "group": "Body",
5859             "type": "String",
5860             "optional": true,
5861             "field": "vat",
5862             "description": ""
5863           },
5864           {
5865             "group": "Body",
5866             "type": "String",
5867             "optional": true,
5868             "field": "companyId",
5869             "description": ""
5870           },
5871           {
5872             "group": "Body",
5873             "type": "String",
5874             "optional": true,
5875             "field": "website",
5876             "description": ""
5877           },
5878           {
5879             "group": "Body",
5880             "type": "String",
5881             "optional": true,
5882             "field": "phone",
5883             "description": ""
5884           },
5885           {
5886             "group": "Body",
5887             "type": "String",
5888             "optional": true,
5889             "field": "fax",
5890             "description": ""
5891           },
5892           {
5893             "group": "Body",
5894             "type": "String",
5895             "optional": true,
5896             "field": "type",
5897             "description": ""
5898           },
5899           {
5900             "group": "Body",
5901             "type": "String",
5902             "optional": true,
5903             "field": "street",
5904             "description": ""
5905           },
5906           {
5907             "group": "Body",
5908             "type": "String",
5909             "optional": true,
5910             "field": "postalCode",
5911             "description": ""
5912           },
5913           {
5914             "group": "Body",
5915             "type": "String",
5916             "optional": true,
5917             "field": "city",
5918             "description": ""
5919           },
5920           {
5921             "group": "Body",
5922             "type": "String",
5923             "optional": true,
5924             "field": "country",
5925             "description": ""
5926           },
5927           {
5928             "group": "Body",
5929             "type": "String",
5930             "optional": true,
5931             "field": "email",
5932             "description": ""
5933           },
5934           {
5935             "group": "Body",
5936             "type": "String",
5937             "optional": true,
5938             "field": "emailDomain",
5939             "description": ""
5940           },
5941           {
5942             "group": "Body",
5943             "type": "String",
5944             "optional": true,
5945             "field": "sStreet",
5946             "description": ""
5947           },
5948           {
5949             "group": "Body",
5950             "type": "String",
5951             "optional": true,
5952             "field": "sPostalCode",
5953             "description": ""
5954           },
5955           {
5956             "group": "Body",
5957             "type": "String",
5958             "optional": true,
5959             "field": "sCity",
5960             "description": ""
5961           },
5962           {
5963             "group": "Body",
5964             "type": "String",
5965             "optional": true,
5966             "field": "sCountry",
5967             "description": ""
5968           },
5969           {
5970             "group": "Body",
5971             "type": "String",
5972             "optional": true,
5973             "field": "description",
5974             "description": ""
5975           }
5976         ]
5977       }
5978     },
5979     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5980     "version": "0.0.0",
5981     "filename": "server/api/cmCompany/index.js",
5982     "groupTitle": "Cm_Companies"
5983   },
5984   {
5985     "type": "delete",
5986     "url": "/api/cm/companies/{id}",
5987     "title": "Deletes a Company",
5988     "examples": [
5989       {
5990         "title": "Example usage:",
5991         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5992         "type": "json"
5993       }
5994     ],
5995     "name": "DeleteCompanies",
5996     "group": "Cm_Companies",
5997     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5998     "version": "0.0.0",
5999     "filename": "server/api/cmCompany/index.js",
6000     "groupTitle": "Cm_Companies"
6001   },
6002   {
6003     "type": "get",
6004     "url": "/api/cm/companies/describe",
6005     "title": "Gets table info about Companies",
6006     "examples": [
6007       {
6008         "title": "Example usage:",
6009         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
6010         "type": "json"
6011       }
6012     ],
6013     "name": "DescribeCompanies",
6014     "group": "Cm_Companies",
6015     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6016     "version": "0.0.0",
6017     "filename": "server/api/cmCompany/index.js",
6018     "groupTitle": "Cm_Companies"
6019   },
6020   {
6021     "type": "get",
6022     "url": "/api/cm/companies",
6023     "title": "Gets a list of Companies",
6024     "examples": [
6025       {
6026         "title": "Example usage:",
6027         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
6028         "type": "json"
6029       }
6030     ],
6031     "name": "GetCompanies",
6032     "group": "Cm_Companies",
6033     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6034     "version": "0.0.0",
6035     "filename": "server/api/cmCompany/index.js",
6036     "groupTitle": "Cm_Companies"
6037   },
6038   {
6039     "type": "get",
6040     "url": "/api/cm/companies/{id}",
6041     "title": "Gets a single Company",
6042     "examples": [
6043       {
6044         "title": "Example usage:",
6045         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
6046         "type": "json"
6047       }
6048     ],
6049     "name": "ShowCompanies",
6050     "group": "Cm_Companies",
6051     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6052     "version": "0.0.0",
6053     "filename": "server/api/cmCompany/index.js",
6054     "groupTitle": "Cm_Companies"
6055   },
6056   {
6057     "type": "post",
6058     "url": "/api/cm/companies/{id}/contacts",
6059     "title": "Creates new contacts",
6060     "examples": [
6061       {
6062         "title": "Example usage:",
6063         "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",
6064         "type": "json"
6065       }
6066     ],
6067     "name": "addContacts",
6068     "group": "Cm_Companies",
6069     "parameter": {
6070       "fields": {
6071         "Body": [
6072           {
6073             "group": "Body",
6074             "type": "String",
6075             "optional": false,
6076             "field": "firstName",
6077             "description": ""
6078           },
6079           {
6080             "group": "Body",
6081             "type": "String",
6082             "optional": true,
6083             "field": "lastName",
6084             "description": ""
6085           },
6086           {
6087             "group": "Body",
6088             "type": "String",
6089             "optional": true,
6090             "field": "street",
6091             "description": ""
6092           },
6093           {
6094             "group": "Body",
6095             "type": "String",
6096             "optional": true,
6097             "field": "postalCode",
6098             "description": ""
6099           },
6100           {
6101             "group": "Body",
6102             "type": "String",
6103             "optional": true,
6104             "field": "city",
6105             "description": ""
6106           },
6107           {
6108             "group": "Body",
6109             "type": "String",
6110             "optional": true,
6111             "field": "country",
6112             "description": ""
6113           },
6114           {
6115             "group": "Body",
6116             "type": "String",
6117             "optional": true,
6118             "field": "dateOfBirth",
6119             "description": ""
6120           },
6121           {
6122             "group": "Body",
6123             "type": "Text",
6124             "optional": true,
6125             "field": "description",
6126             "description": ""
6127           },
6128           {
6129             "group": "Body",
6130             "type": "String",
6131             "optional": true,
6132             "field": "phone",
6133             "description": ""
6134           },
6135           {
6136             "group": "Body",
6137             "type": "String",
6138             "optional": true,
6139             "field": "mobile",
6140             "description": ""
6141           },
6142           {
6143             "group": "Body",
6144             "type": "String",
6145             "optional": true,
6146             "field": "fax",
6147             "description": ""
6148           },
6149           {
6150             "group": "Body",
6151             "type": "String",
6152             "optional": true,
6153             "field": "email",
6154             "description": ""
6155           },
6156           {
6157             "group": "Body",
6158             "type": "String",
6159             "optional": true,
6160             "field": "url",
6161             "description": ""
6162           },
6163           {
6164             "group": "Body",
6165             "type": "String",
6166             "optional": true,
6167             "field": "facebook",
6168             "description": ""
6169           },
6170           {
6171             "group": "Body",
6172             "type": "String",
6173             "optional": true,
6174             "field": "fb_data",
6175             "description": ""
6176           },
6177           {
6178             "group": "Body",
6179             "type": "String",
6180             "optional": true,
6181             "field": "twitter",
6182             "description": ""
6183           },
6184           {
6185             "group": "Body",
6186             "type": "String",
6187             "optional": true,
6188             "field": "skype",
6189             "description": ""
6190           },
6191           {
6192             "group": "Body",
6193             "type": "String",
6194             "optional": true,
6195             "field": "teams",
6196             "description": ""
6197           },
6198           {
6199             "group": "Body",
6200             "type": "String",
6201             "optional": true,
6202             "field": "viber",
6203             "description": ""
6204           },
6205           {
6206             "group": "Body",
6207             "type": "String",
6208             "optional": true,
6209             "field": "line",
6210             "description": ""
6211           },
6212           {
6213             "group": "Body",
6214             "type": "String",
6215             "optional": true,
6216             "field": "wechat",
6217             "description": ""
6218           },
6219           {
6220             "group": "Body",
6221             "type": "String",
6222             "optional": true,
6223             "field": "telegram",
6224             "description": ""
6225           },
6226           {
6227             "group": "Body",
6228             "type": "Integer",
6229             "optional": true,
6230             "field": "UserId",
6231             "description": ""
6232           },
6233           {
6234             "group": "Body",
6235             "type": "String",
6236             "optional": true,
6237             "field": "AdditionalPhones",
6238             "description": ""
6239           },
6240           {
6241             "group": "Body",
6242             "type": "Integer",
6243             "optional": true,
6244             "field": "priority",
6245             "description": ""
6246           },
6247           {
6248             "group": "Body",
6249             "type": "String",
6250             "optional": true,
6251             "field": "scheduledat",
6252             "description": ""
6253           }
6254         ]
6255       }
6256     },
6257     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6258     "version": "0.0.0",
6259     "filename": "server/api/cmCompany/index.js",
6260     "groupTitle": "Cm_Companies"
6261   },
6262   {
6263     "type": "get",
6264     "url": "/api/cm/companies/{id}/contacts",
6265     "title": "Gets List Contacts",
6266     "examples": [
6267       {
6268         "title": "Example usage:",
6269         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
6270         "type": "json"
6271       }
6272     ],
6273     "name": "getContacts",
6274     "group": "Cm_Companies",
6275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6276     "version": "0.0.0",
6277     "filename": "server/api/cmCompany/index.js",
6278     "groupTitle": "Cm_Companies"
6279   },
6280   {
6281     "type": "put",
6282     "url": "/api/cm/companies/{id}",
6283     "title": "Update an existing Company",
6284     "examples": [
6285       {
6286         "title": "Example usage:",
6287         "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",
6288         "type": "json"
6289       }
6290     ],
6291     "name": "updateCompanies",
6292     "group": "Cm_Companies",
6293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6294     "version": "0.0.0",
6295     "filename": "server/api/cmCompany/index.js",
6296     "groupTitle": "Cm_Companies"
6297   },
6298   {
6299     "type": "delete",
6300     "url": "/api/cm/contacts/{id}",
6301     "title": "Deletes a Contact",
6302     "examples": [
6303       {
6304         "title": "Example usage:",
6305         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
6306         "type": "json"
6307       }
6308     ],
6309     "name": "DeleteContacts",
6310     "group": "Cm_Contacts",
6311     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6312     "version": "0.0.0",
6313     "filename": "server/api/cmContact/index.js",
6314     "groupTitle": "Cm_Contacts"
6315   },
6316   {
6317     "type": "get",
6318     "url": "/api/cm/contacts/describe",
6319     "title": "Gets table info about Contacts",
6320     "examples": [
6321       {
6322         "title": "Example usage:",
6323         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
6324         "type": "json"
6325       }
6326     ],
6327     "name": "DescribeContacts",
6328     "group": "Cm_Contacts",
6329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6330     "version": "0.0.0",
6331     "filename": "server/api/cmContact/index.js",
6332     "groupTitle": "Cm_Contacts"
6333   },
6334   {
6335     "type": "get",
6336     "url": "/api/cm/contacts",
6337     "title": "Gets a list of Contacts",
6338     "examples": [
6339       {
6340         "title": "Example usage:",
6341         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
6342         "type": "json"
6343       }
6344     ],
6345     "name": "GetContacts",
6346     "group": "Cm_Contacts",
6347     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6348     "version": "0.0.0",
6349     "filename": "server/api/cmContact/index.js",
6350     "groupTitle": "Cm_Contacts"
6351   },
6352   {
6353     "type": "get",
6354     "url": "/api/cm/contacts/{id}/finals",
6355     "title": "Gets contact hopper finals",
6356     "examples": [
6357       {
6358         "title": "Example usage:",
6359         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
6360         "type": "json"
6361       }
6362     ],
6363     "name": "GetHopperFinals",
6364     "group": "Cm_Contacts",
6365     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6366     "version": "0.0.0",
6367     "filename": "server/api/cmContact/index.js",
6368     "groupTitle": "Cm_Contacts"
6369   },
6370   {
6371     "type": "get",
6372     "url": "/api/cm/contacts/{id}/hopper_histories",
6373     "title": "Gets contact hopper histories",
6374     "examples": [
6375       {
6376         "title": "Example usage:",
6377         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
6378         "type": "json"
6379       }
6380     ],
6381     "name": "GetHopperHistories",
6382     "group": "Cm_Contacts",
6383     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6384     "version": "0.0.0",
6385     "filename": "server/api/cmContact/index.js",
6386     "groupTitle": "Cm_Contacts"
6387   },
6388   {
6389     "type": "get",
6390     "url": "/api/cm/contacts/{id}/hoppers",
6391     "title": "Gets contact hoppers",
6392     "examples": [
6393       {
6394         "title": "Example usage:",
6395         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6396         "type": "json"
6397       }
6398     ],
6399     "name": "GetHoppers",
6400     "group": "Cm_Contacts",
6401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6402     "version": "0.0.0",
6403     "filename": "server/api/cmContact/index.js",
6404     "groupTitle": "Cm_Contacts"
6405   },
6406   {
6407     "type": "post",
6408     "url": "/api/cm/contacts/create_many",
6409     "title": "Create Contacts",
6410     "examples": [
6411       {
6412         "title": "Example usage:",
6413         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6414         "type": "json"
6415       }
6416     ],
6417     "name": "bulkCreate",
6418     "group": "Cm_Contacts",
6419     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6420     "version": "0.0.0",
6421     "filename": "server/api/cmContact/index.js",
6422     "groupTitle": "Cm_Contacts"
6423   },
6424   {
6425     "type": "post",
6426     "url": "/api/cm/contacts",
6427     "title": "Create Contact",
6428     "examples": [
6429       {
6430         "title": "Example usage:",
6431         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6432         "type": "json"
6433       }
6434     ],
6435     "name": "create",
6436     "group": "Cm_Contacts",
6437     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6438     "version": "0.0.0",
6439     "filename": "server/api/cmContact/index.js",
6440     "groupTitle": "Cm_Contacts"
6441   },
6442   {
6443     "type": "post",
6444     "url": "/api/cm/contacts/{id}/duplicatePhones",
6445     "title": "Sets new contact additional phones",
6446     "examples": [
6447       {
6448         "title": "Example usage:",
6449         "content": "curl https://{domain}/api/cm/contacts/{id}/duplicateAdditionalPhones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6450         "type": "json"
6451       }
6452     ],
6453     "name": "duplicateAdditionalPhones",
6454     "group": "Cm_Contacts",
6455     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6456     "version": "0.0.0",
6457     "filename": "server/api/cmContact/index.js",
6458     "groupTitle": "Cm_Contacts"
6459   },
6460   {
6461     "type": "get",
6462     "url": "/api/cm/contacts/{id}/phones",
6463     "title": "Gets contact phones",
6464     "examples": [
6465       {
6466         "title": "Example usage:",
6467         "content": "curl https://{domain}/api/cm/contacts/{id}/phones -v -u {name}:{password} -X GET",
6468         "type": "json"
6469       }
6470     ],
6471     "name": "getAdditionalPhones",
6472     "group": "Cm_Contacts",
6473     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6474     "version": "0.0.0",
6475     "filename": "server/api/cmContact/index.js",
6476     "groupTitle": "Cm_Contacts"
6477   },
6478   {
6479     "type": "get",
6480     "url": "/api/cm/contacts/{id}/journey",
6481     "title": "Gets customer journey",
6482     "examples": [
6483       {
6484         "title": "Example usage:",
6485         "content": "curl https://{domain}/api/cm/contacts/{id}/journey -v -u {name}:{password}  -X GET",
6486         "type": "json"
6487       }
6488     ],
6489     "name": "getJourney",
6490     "group": "Cm_Contacts",
6491     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6492     "version": "0.0.0",
6493     "filename": "server/api/cmContact/index.js",
6494     "groupTitle": "Cm_Contacts"
6495   },
6496   {
6497     "type": "get",
6498     "url": "/api/cm/contacts/{id}/jscripty_sessions",
6499     "title": "Gets contact hopper blacks",
6500     "examples": [
6501       {
6502         "title": "Example usage:",
6503         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
6504         "type": "json"
6505       }
6506     ],
6507     "name": "getJscriptySessions",
6508     "group": "Cm_Contacts",
6509     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6510     "version": "0.0.0",
6511     "filename": "server/api/cmContact/index.js",
6512     "groupTitle": "Cm_Contacts"
6513   },
6514   {
6515     "type": "get",
6516     "url": "/api/cm/contacts/{id}/tags",
6517     "title": "Gets configurations tags",
6518     "examples": [
6519       {
6520         "title": "Example usage:",
6521         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6522         "type": "json"
6523       }
6524     ],
6525     "name": "getTags",
6526     "group": "Cm_Contacts",
6527     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6528     "version": "0.0.0",
6529     "filename": "server/api/cmContact/index.js",
6530     "groupTitle": "Cm_Contacts"
6531   },
6532   {
6533     "type": "post",
6534     "url": "/api/cm/contacts/merge",
6535     "title": "Merge Contact",
6536     "examples": [
6537       {
6538         "title": "Example usage:",
6539         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6540         "type": "json"
6541       }
6542     ],
6543     "name": "merge",
6544     "group": "Cm_Contacts",
6545     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6546     "version": "0.0.0",
6547     "filename": "server/api/cmContact/index.js",
6548     "groupTitle": "Cm_Contacts"
6549   },
6550   {
6551     "type": "post",
6552     "url": "/api/cm/contacts/{id}/rescheduleAdditionalPhones",
6553     "title": "Sets new contact additional phones",
6554     "examples": [
6555       {
6556         "title": "Example usage:",
6557         "content": "curl https://{domain}/api/cm/contacts/{id}/rescheduleAdditionalPhones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6558         "type": "json"
6559       }
6560     ],
6561     "name": "rescheduleAdditionalPhones",
6562     "group": "Cm_Contacts",
6563     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6564     "version": "0.0.0",
6565     "filename": "server/api/cmContact/index.js",
6566     "groupTitle": "Cm_Contacts"
6567   },
6568   {
6569     "type": "post",
6570     "url": "/api/cm/contacts/{id}/phones",
6571     "title": "Sets new contact phones",
6572     "examples": [
6573       {
6574         "title": "Example usage:",
6575         "content": "curl https://{domain}/api/cm/contacts/{id}/phones -d '{\"phones\": [p1,p2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6576         "type": "json"
6577       }
6578     ],
6579     "name": "setAdditionalPhones",
6580     "group": "Cm_Contacts",
6581     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6582     "version": "0.0.0",
6583     "filename": "server/api/cmContact/index.js",
6584     "groupTitle": "Cm_Contacts"
6585   },
6586   {
6587     "type": "post",
6588     "url": "/api/cm/contacts/{id}/tags",
6589     "title": "Sets new tags",
6590     "examples": [
6591       {
6592         "title": "Example usage:",
6593         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6594         "type": "json"
6595       }
6596     ],
6597     "name": "setTags",
6598     "group": "Cm_Contacts",
6599     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6600     "version": "0.0.0",
6601     "filename": "server/api/cmContact/index.js",
6602     "groupTitle": "Cm_Contacts"
6603   },
6604   {
6605     "type": "get",
6606     "url": "/api/cm/contacts/{id}",
6607     "title": "Gets a single Contact",
6608     "examples": [
6609       {
6610         "title": "Example usage:",
6611         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6612         "type": "json"
6613       }
6614     ],
6615     "name": "show",
6616     "group": "Cm_Contacts",
6617     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6618     "version": "0.0.0",
6619     "filename": "server/api/cmContact/index.js",
6620     "groupTitle": "Cm_Contacts"
6621   },
6622   {
6623     "type": "put",
6624     "url": "/api/cm/contacts/{id}",
6625     "title": "Update a single Contact",
6626     "examples": [
6627       {
6628         "title": "Example usage:",
6629         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6630         "type": "json"
6631       }
6632     ],
6633     "name": "update",
6634     "group": "Cm_Contacts",
6635     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6636     "version": "0.0.0",
6637     "filename": "server/api/cmContact/index.js",
6638     "groupTitle": "Cm_Contacts"
6639   },
6640   {
6641     "type": "delete",
6642     "url": "/api/cm/custom_fields/{id}",
6643     "title": "Deletes a Custom Field",
6644     "examples": [
6645       {
6646         "title": "Example usage:",
6647         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6648         "type": "json"
6649       }
6650     ],
6651     "name": "DeleteCustom_Fields",
6652     "group": "Cm_Custom_Fields",
6653     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6654     "version": "0.0.0",
6655     "filename": "server/api/cmCustomField/index.js",
6656     "groupTitle": "Cm_Custom_Fields"
6657   },
6658   {
6659     "type": "get",
6660     "url": "/api/cm/custom_fields",
6661     "title": "Gets a list of Custom Fields",
6662     "examples": [
6663       {
6664         "title": "Example usage:",
6665         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6666         "type": "json"
6667       }
6668     ],
6669     "name": "GetCustom_Fields",
6670     "group": "Cm_Custom_Fields",
6671     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6672     "version": "0.0.0",
6673     "filename": "server/api/cmCustomField/index.js",
6674     "groupTitle": "Cm_Custom_Fields"
6675   },
6676   {
6677     "type": "get",
6678     "url": "/api/cm/custom_fields/{id}",
6679     "title": "Gets a single Custom Field",
6680     "examples": [
6681       {
6682         "title": "Example usage:",
6683         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6684         "type": "json"
6685       }
6686     ],
6687     "name": "ShowCustom_Fields",
6688     "group": "Cm_Custom_Fields",
6689     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6690     "version": "0.0.0",
6691     "filename": "server/api/cmCustomField/index.js",
6692     "groupTitle": "Cm_Custom_Fields"
6693   },
6694   {
6695     "type": "put",
6696     "url": "/api/cm/custom_fields/{id}",
6697     "title": "Update an existing Custom Field",
6698     "examples": [
6699       {
6700         "title": "Example usage:",
6701         "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",
6702         "type": "json"
6703       }
6704     ],
6705     "name": "updateCustom_Fields",
6706     "group": "Cm_Custom_Fields",
6707     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6708     "version": "0.0.0",
6709     "filename": "server/api/cmCustomField/index.js",
6710     "groupTitle": "Cm_Custom_Fields"
6711   },
6712   {
6713     "type": "post",
6714     "url": "/api/cm/hopper",
6715     "title": "Creates a new Hopper",
6716     "examples": [
6717       {
6718         "title": "Example usage:",
6719         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6720         "type": "json"
6721       }
6722     ],
6723     "name": "CreateHopper",
6724     "group": "Cm_Hopper",
6725     "parameter": {
6726       "fields": {
6727         "Body": [
6728           {
6729             "group": "Body",
6730             "type": "String",
6731             "optional": false,
6732             "field": "phone",
6733             "description": ""
6734           },
6735           {
6736             "group": "Body",
6737             "type": "Boolean",
6738             "optional": true,
6739             "field": "active",
6740             "description": ""
6741           },
6742           {
6743             "group": "Body",
6744             "type": "String",
6745             "optional": true,
6746             "field": "scheduledat",
6747             "description": ""
6748           },
6749           {
6750             "group": "Body",
6751             "type": "Integer",
6752             "optional": true,
6753             "field": "countbusyretry",
6754             "description": ""
6755           },
6756           {
6757             "group": "Body",
6758             "type": "Integer",
6759             "optional": true,
6760             "field": "countcongestionretry",
6761             "description": ""
6762           },
6763           {
6764             "group": "Body",
6765             "type": "Integer",
6766             "optional": true,
6767             "field": "countnoanswerretry",
6768             "description": ""
6769           },
6770           {
6771             "group": "Body",
6772             "type": "Boolean",
6773             "optional": true,
6774             "field": "callback",
6775             "description": ""
6776           },
6777           {
6778             "group": "Body",
6779             "type": "String",
6780             "optional": true,
6781             "field": "callbackuniqueid",
6782             "description": ""
6783           },
6784           {
6785             "group": "Body",
6786             "type": "String",
6787             "optional": true,
6788             "field": "callbackat",
6789             "description": ""
6790           },
6791           {
6792             "group": "Body",
6793             "type": "Integer",
6794             "optional": true,
6795             "field": "priority",
6796             "description": ""
6797           },
6798           {
6799             "group": "Body",
6800             "type": "Boolean",
6801             "optional": true,
6802             "field": "recallme",
6803             "description": ""
6804           },
6805           {
6806             "group": "Body",
6807             "type": "Integer",
6808             "optional": true,
6809             "field": "ContactId",
6810             "description": ""
6811           },
6812           {
6813             "group": "Body",
6814             "type": "Integer",
6815             "optional": true,
6816             "field": "ListId",
6817             "description": ""
6818           },
6819           {
6820             "group": "Body",
6821             "type": "Integer",
6822             "optional": true,
6823             "field": "UserId",
6824             "description": ""
6825           },
6826           {
6827             "group": "Body",
6828             "type": "Integer",
6829             "optional": true,
6830             "field": "VoiceQueueId",
6831             "description": ""
6832           },
6833           {
6834             "group": "Body",
6835             "type": "Integer",
6836             "optional": true,
6837             "field": "CampaignId",
6838             "description": ""
6839           },
6840           {
6841             "group": "Body",
6842             "type": "Integer",
6843             "optional": true,
6844             "field": "countnosuchnumberretry",
6845             "description": ""
6846           },
6847           {
6848             "group": "Body",
6849             "type": "Integer",
6850             "optional": true,
6851             "field": "countdropretry",
6852             "description": ""
6853           },
6854           {
6855             "group": "Body",
6856             "type": "Integer",
6857             "optional": true,
6858             "field": "countabandonedretry",
6859             "description": ""
6860           },
6861           {
6862             "group": "Body",
6863             "type": "Integer",
6864             "optional": true,
6865             "field": "countmachineretry",
6866             "description": ""
6867           },
6868           {
6869             "group": "Body",
6870             "type": "Integer",
6871             "optional": true,
6872             "field": "countagentrejectretry",
6873             "description": ""
6874           },
6875           {
6876             "group": "Body",
6877             "type": "Integer",
6878             "optional": true,
6879             "field": "OrderBy",
6880             "description": ""
6881           }
6882         ]
6883       }
6884     },
6885     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6886     "version": "0.0.0",
6887     "filename": "server/api/cmHopper/index.js",
6888     "groupTitle": "Cm_Hopper"
6889   },
6890   {
6891     "type": "get",
6892     "url": "/api/cm/hopper/describe",
6893     "title": "Gets table info about Hopper",
6894     "examples": [
6895       {
6896         "title": "Example usage:",
6897         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6898         "type": "json"
6899       }
6900     ],
6901     "name": "DescribeHopper",
6902     "group": "Cm_Hopper",
6903     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6904     "version": "0.0.0",
6905     "filename": "server/api/cmHopper/index.js",
6906     "groupTitle": "Cm_Hopper"
6907   },
6908   {
6909     "type": "get",
6910     "url": "/api/cm/hopper",
6911     "title": "Gets a list of Hopper",
6912     "examples": [
6913       {
6914         "title": "Example usage:",
6915         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6916         "type": "json"
6917       }
6918     ],
6919     "name": "GetHopper",
6920     "group": "Cm_Hopper",
6921     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6922     "version": "0.0.0",
6923     "filename": "server/api/cmHopper/index.js",
6924     "groupTitle": "Cm_Hopper"
6925   },
6926   {
6927     "type": "get",
6928     "url": "/api/cm/hopper/{id}",
6929     "title": "Gets a single Hopper",
6930     "examples": [
6931       {
6932         "title": "Example usage:",
6933         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6934         "type": "json"
6935       }
6936     ],
6937     "name": "ShowHopper",
6938     "group": "Cm_Hopper",
6939     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6940     "version": "0.0.0",
6941     "filename": "server/api/cmHopper/index.js",
6942     "groupTitle": "Cm_Hopper"
6943   },
6944   {
6945     "type": "delete",
6946     "url": "/api/cm/hopper_black/{id}",
6947     "title": "Deletes a Hopper Black",
6948     "examples": [
6949       {
6950         "title": "Example usage:",
6951         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6952         "type": "json"
6953       }
6954     ],
6955     "name": "DeleteHopper_Black",
6956     "group": "Cm_Hopper_Black",
6957     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6958     "version": "0.0.0",
6959     "filename": "server/api/cmHopperBlack/index.js",
6960     "groupTitle": "Cm_Hopper_Black"
6961   },
6962   {
6963     "type": "get",
6964     "url": "/api/cm/hopper_black/describe",
6965     "title": "Gets table info about Hopper Black",
6966     "examples": [
6967       {
6968         "title": "Example usage:",
6969         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6970         "type": "json"
6971       }
6972     ],
6973     "name": "DescribeHopper_Black",
6974     "group": "Cm_Hopper_Black",
6975     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6976     "version": "0.0.0",
6977     "filename": "server/api/cmHopperBlack/index.js",
6978     "groupTitle": "Cm_Hopper_Black"
6979   },
6980   {
6981     "type": "get",
6982     "url": "/api/cm/hopper_black",
6983     "title": "Gets a list of Hopper Black",
6984     "examples": [
6985       {
6986         "title": "Example usage:",
6987         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6988         "type": "json"
6989       }
6990     ],
6991     "name": "GetHopper_Black",
6992     "group": "Cm_Hopper_Black",
6993     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6994     "version": "0.0.0",
6995     "filename": "server/api/cmHopperBlack/index.js",
6996     "groupTitle": "Cm_Hopper_Black"
6997   },
6998   {
6999     "type": "get",
7000     "url": "/api/cm/hopper_black/{id}",
7001     "title": "Gets a single Hopper Black",
7002     "examples": [
7003       {
7004         "title": "Example usage:",
7005         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
7006         "type": "json"
7007       }
7008     ],
7009     "name": "ShowHopper_Black",
7010     "group": "Cm_Hopper_Black",
7011     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7012     "version": "0.0.0",
7013     "filename": "server/api/cmHopperBlack/index.js",
7014     "groupTitle": "Cm_Hopper_Black"
7015   },
7016   {
7017     "type": "put",
7018     "url": "/api/cm/hopper_black/{id}",
7019     "title": "Update an existing Hopper Black",
7020     "examples": [
7021       {
7022         "title": "Example usage:",
7023         "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",
7024         "type": "json"
7025       }
7026     ],
7027     "name": "updateHopper_Black",
7028     "group": "Cm_Hopper_Black",
7029     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7030     "version": "0.0.0",
7031     "filename": "server/api/cmHopperBlack/index.js",
7032     "groupTitle": "Cm_Hopper_Black"
7033   },
7034   {
7035     "type": "post",
7036     "url": "/api/cm/hopper_final/checkContactHopper",
7037     "title": "Check if contact is in hopper",
7038     "examples": [
7039       {
7040         "title": "Example usage:",
7041         "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",
7042         "type": "json"
7043       }
7044     ],
7045     "name": "/checkContactHopper",
7046     "group": "Cm_Hopper_Final",
7047     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7048     "version": "0.0.0",
7049     "filename": "server/api/cmHopperFinal/index.js",
7050     "groupTitle": "Cm_Hopper_Final"
7051   },
7052   {
7053     "type": "get",
7054     "url": "/api/cm/hopper_final/describe",
7055     "title": "Gets table info about HopperFinal",
7056     "examples": [
7057       {
7058         "title": "Example usage:",
7059         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
7060         "type": "json"
7061       }
7062     ],
7063     "name": "DescribeHopperFinal",
7064     "group": "Cm_Hopper_Final",
7065     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7066     "version": "0.0.0",
7067     "filename": "server/api/cmHopperFinal/index.js",
7068     "groupTitle": "Cm_Hopper_Final"
7069   },
7070   {
7071     "type": "get",
7072     "url": "/api/cm/hopper_final",
7073     "title": "Gets a list of HopperFinal",
7074     "examples": [
7075       {
7076         "title": "Example usage:",
7077         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
7078         "type": "json"
7079       }
7080     ],
7081     "name": "GetHopperFinal",
7082     "group": "Cm_Hopper_Final",
7083     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7084     "version": "0.0.0",
7085     "filename": "server/api/cmHopperFinal/index.js",
7086     "groupTitle": "Cm_Hopper_Final"
7087   },
7088   {
7089     "type": "get",
7090     "url": "/api/cm/hopper_final/{id}",
7091     "title": "Gets a single HopperFinal",
7092     "examples": [
7093       {
7094         "title": "Example usage:",
7095         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
7096         "type": "json"
7097       }
7098     ],
7099     "name": "ShowHopperFinal",
7100     "group": "Cm_Hopper_Final",
7101     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7102     "version": "0.0.0",
7103     "filename": "server/api/cmHopperFinal/index.js",
7104     "groupTitle": "Cm_Hopper_Final"
7105   },
7106   {
7107     "type": "get",
7108     "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
7109     "title": "Return number contacts for attributes",
7110     "examples": [
7111       {
7112         "title": "Example usage:",
7113         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7114         "type": "json"
7115       }
7116     ],
7117     "name": "countContactsIvrCampaignHopperFinal",
7118     "group": "Cm_Hopper_Final",
7119     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7120     "version": "0.0.0",
7121     "filename": "server/api/cmHopperFinal/index.js",
7122     "groupTitle": "Cm_Hopper_Final"
7123   },
7124   {
7125     "type": "get",
7126     "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
7127     "title": "Return number contacts for attributes",
7128     "examples": [
7129       {
7130         "title": "Example usage:",
7131         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
7132         "type": "json"
7133       }
7134     ],
7135     "name": "countContactsQueueCampaignHopperFinal",
7136     "group": "Cm_Hopper_Final",
7137     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7138     "version": "0.0.0",
7139     "filename": "server/api/cmHopperFinal/index.js",
7140     "groupTitle": "Cm_Hopper_Final"
7141   },
7142   {
7143     "type": "post",
7144     "url": "/api/cm/hopper_final/campaign/{id}",
7145     "title": "Move contacts in hopper",
7146     "examples": [
7147       {
7148         "title": "Example usage:",
7149         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7150         "type": "json"
7151       }
7152     ],
7153     "name": "moveContactsIvrCampaignHopperFinal",
7154     "group": "Cm_Hopper_Final",
7155     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7156     "version": "0.0.0",
7157     "filename": "server/api/cmHopperFinal/index.js",
7158     "groupTitle": "Cm_Hopper_Final"
7159   },
7160   {
7161     "type": "post",
7162     "url": "/api/cm/hopper_final/voice/queue/{id}",
7163     "title": "Move contacts in hopper",
7164     "examples": [
7165       {
7166         "title": "Example usage:",
7167         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
7168         "type": "json"
7169       }
7170     ],
7171     "name": "moveContactsQueueCampaignHopperFinal",
7172     "group": "Cm_Hopper_Final",
7173     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7174     "version": "0.0.0",
7175     "filename": "server/api/cmHopperFinal/index.js",
7176     "groupTitle": "Cm_Hopper_Final"
7177   },
7178   {
7179     "type": "put",
7180     "url": "/api/cm/hopper_final/{id}",
7181     "title": "Update a single hopper final",
7182     "examples": [
7183       {
7184         "title": "Example usage:",
7185         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7186         "type": "json"
7187       }
7188     ],
7189     "name": "update",
7190     "group": "Cm_Hopper_Final",
7191     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7192     "version": "0.0.0",
7193     "filename": "server/api/cmHopperFinal/index.js",
7194     "groupTitle": "Cm_Hopper_Final"
7195   },
7196   {
7197     "type": "post",
7198     "url": "/api/cm/hopper_history",
7199     "title": "Creates a new HopperHistory",
7200     "examples": [
7201       {
7202         "title": "Example usage:",
7203         "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",
7204         "type": "json"
7205       }
7206     ],
7207     "name": "CreateHopperHistory",
7208     "group": "Cm_Hopper_History",
7209     "parameter": {
7210       "fields": {
7211         "Body": [
7212           {
7213             "group": "Body",
7214             "type": "Integer",
7215             "optional": true,
7216             "field": "state",
7217             "description": ""
7218           },
7219           {
7220             "group": "Body",
7221             "type": "String",
7222             "optional": true,
7223             "field": "statedesc",
7224             "description": ""
7225           },
7226           {
7227             "group": "Body",
7228             "type": "String",
7229             "optional": true,
7230             "field": "scheduledat",
7231             "description": ""
7232           },
7233           {
7234             "group": "Body",
7235             "type": "Integer",
7236             "optional": true,
7237             "field": "countbusyretry",
7238             "description": ""
7239           },
7240           {
7241             "group": "Body",
7242             "type": "Integer",
7243             "optional": true,
7244             "field": "countcongestionretry",
7245             "description": ""
7246           },
7247           {
7248             "group": "Body",
7249             "type": "Integer",
7250             "optional": true,
7251             "field": "countnoanswerretry",
7252             "description": ""
7253           },
7254           {
7255             "group": "Body",
7256             "type": "Integer",
7257             "optional": true,
7258             "field": "countglobal",
7259             "description": ""
7260           },
7261           {
7262             "group": "Body",
7263             "type": "String",
7264             "optional": true,
7265             "field": "uniqueid",
7266             "description": ""
7267           },
7268           {
7269             "group": "Body",
7270             "type": "String",
7271             "optional": true,
7272             "field": "originatecalleridnum",
7273             "description": ""
7274           },
7275           {
7276             "group": "Body",
7277             "type": "String",
7278             "optional": true,
7279             "field": "originatecalleridname",
7280             "description": ""
7281           },
7282           {
7283             "group": "Body",
7284             "type": "String",
7285             "optional": true,
7286             "field": "calleridnum",
7287             "description": ""
7288           },
7289           {
7290             "group": "Body",
7291             "type": "String",
7292             "optional": true,
7293             "field": "calleridname",
7294             "description": ""
7295           },
7296           {
7297             "group": "Body",
7298             "type": "String",
7299             "optional": true,
7300             "field": "starttime",
7301             "description": ""
7302           },
7303           {
7304             "group": "Body",
7305             "type": "String",
7306             "optional": true,
7307             "field": "responsetime",
7308             "description": ""
7309           },
7310           {
7311             "group": "Body",
7312             "type": "String",
7313             "optional": true,
7314             "field": "answertime",
7315             "description": ""
7316           },
7317           {
7318             "group": "Body",
7319             "type": "String",
7320             "optional": true,
7321             "field": "droptime",
7322             "description": ""
7323           },
7324           {
7325             "group": "Body",
7326             "type": "String",
7327             "optional": true,
7328             "field": "endtime",
7329             "description": ""
7330           },
7331           {
7332             "group": "Body",
7333             "type": "Integer",
7334             "optional": true,
7335             "field": "ringtime",
7336             "description": ""
7337           },
7338           {
7339             "group": "Body",
7340             "type": "Integer",
7341             "optional": true,
7342             "field": "holdtime",
7343             "description": ""
7344           },
7345           {
7346             "group": "Body",
7347             "type": "Integer",
7348             "optional": true,
7349             "field": "talktime",
7350             "description": ""
7351           },
7352           {
7353             "group": "Body",
7354             "type": "Integer",
7355             "optional": true,
7356             "field": "followuptime",
7357             "description": ""
7358           },
7359           {
7360             "group": "Body",
7361             "type": "String",
7362             "optional": true,
7363             "field": "dropreason",
7364             "description": ""
7365           },
7366           {
7367             "group": "Body",
7368             "type": "String",
7369             "optional": true,
7370             "field": "campaign",
7371             "description": ""
7372           },
7373           {
7374             "group": "Body",
7375             "type": "String",
7376             "optional": true,
7377             "field": "campaigntype",
7378             "description": ""
7379           },
7380           {
7381             "group": "Body",
7382             "type": "String",
7383             "optional": true,
7384             "field": "membername",
7385             "description": ""
7386           },
7387           {
7388             "group": "Body",
7389             "type": "String",
7390             "optional": true,
7391             "field": "reason",
7392             "description": ""
7393           },
7394           {
7395             "group": "Body",
7396             "type": "Boolean",
7397             "optional": true,
7398             "field": "amd",
7399             "description": ""
7400           },
7401           {
7402             "group": "Body",
7403             "type": "Boolean",
7404             "optional": true,
7405             "field": "fax",
7406             "description": ""
7407           },
7408           {
7409             "group": "Body",
7410             "type": "Boolean",
7411             "optional": true,
7412             "field": "callback",
7413             "description": ""
7414           },
7415           {
7416             "group": "Body",
7417             "type": "String",
7418             "optional": true,
7419             "field": "callbackuniqueid",
7420             "description": ""
7421           },
7422           {
7423             "group": "Body",
7424             "type": "String",
7425             "optional": true,
7426             "field": "callbackat",
7427             "description": ""
7428           },
7429           {
7430             "group": "Body",
7431             "type": "Boolean",
7432             "optional": true,
7433             "field": "recallme",
7434             "description": ""
7435           },
7436           {
7437             "group": "Body",
7438             "type": "String",
7439             "optional": true,
7440             "field": "editedat",
7441             "description": ""
7442           },
7443           {
7444             "group": "Body",
7445             "type": "Boolean",
7446             "optional": true,
7447             "field": "edited",
7448             "description": ""
7449           },
7450           {
7451             "group": "Body",
7452             "type": "Integer",
7453             "optional": true,
7454             "field": "countnosuchnumberretry",
7455             "description": ""
7456           },
7457           {
7458             "group": "Body",
7459             "type": "Integer",
7460             "optional": true,
7461             "field": "countdropretry",
7462             "description": ""
7463           },
7464           {
7465             "group": "Body",
7466             "type": "Integer",
7467             "optional": true,
7468             "field": "countabandonedretry",
7469             "description": ""
7470           },
7471           {
7472             "group": "Body",
7473             "type": "Integer",
7474             "optional": true,
7475             "field": "countmachineretry",
7476             "description": ""
7477           },
7478           {
7479             "group": "Body",
7480             "type": "Integer",
7481             "optional": true,
7482             "field": "countagentrejectretry",
7483             "description": ""
7484           }
7485         ]
7486       }
7487     },
7488     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7489     "version": "0.0.0",
7490     "filename": "server/api/cmHopperHistory/index.js",
7491     "groupTitle": "Cm_Hopper_History"
7492   },
7493   {
7494     "type": "get",
7495     "url": "/api/cm/hopper_history/describe",
7496     "title": "Gets table info about HopperHistory",
7497     "examples": [
7498       {
7499         "title": "Example usage:",
7500         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7501         "type": "json"
7502       }
7503     ],
7504     "name": "DescribeHopperHistory",
7505     "group": "Cm_Hopper_History",
7506     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7507     "version": "0.0.0",
7508     "filename": "server/api/cmHopperHistory/index.js",
7509     "groupTitle": "Cm_Hopper_History"
7510   },
7511   {
7512     "type": "get",
7513     "url": "/api/cm/hopper_history",
7514     "title": "Gets a list of HopperHistory",
7515     "examples": [
7516       {
7517         "title": "Example usage:",
7518         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7519         "type": "json"
7520       }
7521     ],
7522     "name": "GetHopperHistory",
7523     "group": "Cm_Hopper_History",
7524     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7525     "version": "0.0.0",
7526     "filename": "server/api/cmHopperHistory/index.js",
7527     "groupTitle": "Cm_Hopper_History"
7528   },
7529   {
7530     "type": "get",
7531     "url": "/api/cm/hopper_history/{id}",
7532     "title": "Gets a single HopperHistory",
7533     "examples": [
7534       {
7535         "title": "Example usage:",
7536         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7537         "type": "json"
7538       }
7539     ],
7540     "name": "ShowHopperHistory",
7541     "group": "Cm_Hopper_History",
7542     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7543     "version": "0.0.0",
7544     "filename": "server/api/cmHopperHistory/index.js",
7545     "groupTitle": "Cm_Hopper_History"
7546   },
7547   {
7548     "type": "put",
7549     "url": "/api/cm/hopper_history/{id}",
7550     "title": "Update a single hopper history",
7551     "examples": [
7552       {
7553         "title": "Example usage:",
7554         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7555         "type": "json"
7556       }
7557     ],
7558     "name": "update",
7559     "group": "Cm_Hopper_History",
7560     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7561     "version": "0.0.0",
7562     "filename": "server/api/cmHopperHistory/index.js",
7563     "groupTitle": "Cm_Hopper_History"
7564   },
7565   {
7566     "type": "delete",
7567     "url": "/api/cm/hopper/{id}",
7568     "title": "Delete Hopper",
7569     "examples": [
7570       {
7571         "title": "Example usage:",
7572         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7573         "type": "json"
7574       }
7575     ],
7576     "name": "destroy",
7577     "group": "Cm_Hopper",
7578     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7579     "version": "0.0.0",
7580     "filename": "server/api/cmHopper/index.js",
7581     "groupTitle": "Cm_Hopper"
7582   },
7583   {
7584     "type": "get",
7585     "url": "/api/cm/hopper/opencontacts",
7586     "title": "Gets Open Contacts",
7587     "examples": [
7588       {
7589         "title": "Example usage:",
7590         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7591         "type": "json"
7592       }
7593     ],
7594     "name": "getOpenContacts",
7595     "group": "Cm_Hopper",
7596     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7597     "version": "0.0.0",
7598     "filename": "server/api/cmHopper/index.js",
7599     "groupTitle": "Cm_Hopper"
7600   },
7601   {
7602     "type": "post",
7603     "url": "/api/cm/hopper/preview",
7604     "title": "Gets Preview Dialer Contacts",
7605     "examples": [
7606       {
7607         "title": "Example usage:",
7608         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7609         "type": "json"
7610       }
7611     ],
7612     "name": "getPreview",
7613     "group": "Cm_Hopper",
7614     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7615     "version": "0.0.0",
7616     "filename": "server/api/cmHopper/index.js",
7617     "groupTitle": "Cm_Hopper"
7618   },
7619   {
7620     "type": "put",
7621     "url": "/api/cm/hopper/{id}",
7622     "title": "Update an existing Hopper",
7623     "examples": [
7624       {
7625         "title": "Example usage:",
7626         "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",
7627         "type": "json"
7628       }
7629     ],
7630     "name": "updateHopper",
7631     "group": "Cm_Hopper",
7632     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7633     "version": "0.0.0",
7634     "filename": "server/api/cmHopper/index.js",
7635     "groupTitle": "Cm_Hopper"
7636   },
7637   {
7638     "type": "post",
7639     "url": "/api/cm/lists",
7640     "title": "Creates a new List",
7641     "examples": [
7642       {
7643         "title": "Example usage:",
7644         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7645         "type": "json"
7646       }
7647     ],
7648     "name": "CreateLists",
7649     "group": "Cm_Lists",
7650     "parameter": {
7651       "fields": {
7652         "Body": [
7653           {
7654             "group": "Body",
7655             "type": "String",
7656             "optional": false,
7657             "field": "name",
7658             "description": ""
7659           },
7660           {
7661             "group": "Body",
7662             "type": "String",
7663             "optional": true,
7664             "field": "description",
7665             "description": ""
7666           },
7667           {
7668             "group": "Body",
7669             "type": "String",
7670             "optional": true,
7671             "field": "dialPrefix",
7672             "description": ""
7673           }
7674         ]
7675       }
7676     },
7677     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7678     "version": "0.0.0",
7679     "filename": "server/api/cmList/index.js",
7680     "groupTitle": "Cm_Lists"
7681   },
7682   {
7683     "type": "delete",
7684     "url": "/api/cm/lists/{id}",
7685     "title": "Deletes a List",
7686     "examples": [
7687       {
7688         "title": "Example usage:",
7689         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7690         "type": "json"
7691       }
7692     ],
7693     "name": "DeleteLists",
7694     "group": "Cm_Lists",
7695     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7696     "version": "0.0.0",
7697     "filename": "server/api/cmList/index.js",
7698     "groupTitle": "Cm_Lists"
7699   },
7700   {
7701     "type": "get",
7702     "url": "/api/cm/lists/describe",
7703     "title": "Gets table info about Lists",
7704     "examples": [
7705       {
7706         "title": "Example usage:",
7707         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7708         "type": "json"
7709       }
7710     ],
7711     "name": "DescribeLists",
7712     "group": "Cm_Lists",
7713     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7714     "version": "0.0.0",
7715     "filename": "server/api/cmList/index.js",
7716     "groupTitle": "Cm_Lists"
7717   },
7718   {
7719     "type": "get",
7720     "url": "/api/cm/lists/{id}/users",
7721     "title": "Gets agents from list",
7722     "examples": [
7723       {
7724         "title": "Example usage:",
7725         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7726         "type": "json"
7727       }
7728     ],
7729     "name": "GetAgents",
7730     "group": "Cm_Lists",
7731     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7732     "version": "0.0.0",
7733     "filename": "server/api/cmList/index.js",
7734     "groupTitle": "Cm_Lists"
7735   },
7736   {
7737     "type": "get",
7738     "url": "/api/cm/lists",
7739     "title": "Gets a list of Lists",
7740     "examples": [
7741       {
7742         "title": "Example usage:",
7743         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7744         "type": "json"
7745       }
7746     ],
7747     "name": "GetLists",
7748     "group": "Cm_Lists",
7749     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7750     "version": "0.0.0",
7751     "filename": "server/api/cmList/index.js",
7752     "groupTitle": "Cm_Lists"
7753   },
7754   {
7755     "type": "delete",
7756     "url": "/api/cm/lists/{id}/users",
7757     "title": "Removes agents from a list",
7758     "examples": [
7759       {
7760         "title": "Example usage:",
7761         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7762         "type": "json"
7763       }
7764     ],
7765     "name": "RemoveAgents",
7766     "group": "Cm_Lists",
7767     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7768     "version": "0.0.0",
7769     "filename": "server/api/cmList/index.js",
7770     "groupTitle": "Cm_Lists"
7771   },
7772   {
7773     "type": "delete",
7774     "url": "/api/cm/lists/{id}/dispositions",
7775     "title": "Removes dispositions from account",
7776     "examples": [
7777       {
7778         "title": "Example usage:",
7779         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7780         "type": "json"
7781       }
7782     ],
7783     "name": "RemoveDispositions",
7784     "group": "Cm_Lists",
7785     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7786     "version": "0.0.0",
7787     "filename": "server/api/cmList/index.js",
7788     "groupTitle": "Cm_Lists"
7789   },
7790   {
7791     "type": "get",
7792     "url": "/api/cm/lists/{id}",
7793     "title": "Gets a single List",
7794     "examples": [
7795       {
7796         "title": "Example usage:",
7797         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7798         "type": "json"
7799       }
7800     ],
7801     "name": "ShowLists",
7802     "group": "Cm_Lists",
7803     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7804     "version": "0.0.0",
7805     "filename": "server/api/cmList/index.js",
7806     "groupTitle": "Cm_Lists"
7807   },
7808   {
7809     "type": "post",
7810     "url": "/api/cm/lists/{id}/users",
7811     "title": "Adds agents to a list",
7812     "examples": [
7813       {
7814         "title": "Example usage:",
7815         "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",
7816         "type": "json"
7817       }
7818     ],
7819     "name": "addAgents",
7820     "group": "Cm_Lists",
7821     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7822     "version": "0.0.0",
7823     "filename": "server/api/cmList/index.js",
7824     "groupTitle": "Cm_Lists"
7825   },
7826   {
7827     "type": "post",
7828     "url": "/api/cm/lists/{id}/contacts",
7829     "title": "Creates new contacts",
7830     "examples": [
7831       {
7832         "title": "Example usage:",
7833         "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",
7834         "type": "json"
7835       }
7836     ],
7837     "name": "addContacts",
7838     "group": "Cm_Lists",
7839     "parameter": {
7840       "fields": {
7841         "Body": [
7842           {
7843             "group": "Body",
7844             "type": "String",
7845             "optional": false,
7846             "field": "firstName",
7847             "description": ""
7848           },
7849           {
7850             "group": "Body",
7851             "type": "String",
7852             "optional": true,
7853             "field": "lastName",
7854             "description": ""
7855           },
7856           {
7857             "group": "Body",
7858             "type": "String",
7859             "optional": true,
7860             "field": "street",
7861             "description": ""
7862           },
7863           {
7864             "group": "Body",
7865             "type": "String",
7866             "optional": true,
7867             "field": "postalCode",
7868             "description": ""
7869           },
7870           {
7871             "group": "Body",
7872             "type": "String",
7873             "optional": true,
7874             "field": "city",
7875             "description": ""
7876           },
7877           {
7878             "group": "Body",
7879             "type": "String",
7880             "optional": true,
7881             "field": "country",
7882             "description": ""
7883           },
7884           {
7885             "group": "Body",
7886             "type": "String",
7887             "optional": true,
7888             "field": "dateOfBirth",
7889             "description": ""
7890           },
7891           {
7892             "group": "Body",
7893             "type": "Text",
7894             "optional": true,
7895             "field": "description",
7896             "description": ""
7897           },
7898           {
7899             "group": "Body",
7900             "type": "String",
7901             "optional": true,
7902             "field": "phone",
7903             "description": ""
7904           },
7905           {
7906             "group": "Body",
7907             "type": "String",
7908             "optional": true,
7909             "field": "mobile",
7910             "description": ""
7911           },
7912           {
7913             "group": "Body",
7914             "type": "String",
7915             "optional": true,
7916             "field": "fax",
7917             "description": ""
7918           },
7919           {
7920             "group": "Body",
7921             "type": "String",
7922             "optional": true,
7923             "field": "email",
7924             "description": ""
7925           },
7926           {
7927             "group": "Body",
7928             "type": "String",
7929             "optional": true,
7930             "field": "url",
7931             "description": ""
7932           },
7933           {
7934             "group": "Body",
7935             "type": "String",
7936             "optional": true,
7937             "field": "facebook",
7938             "description": ""
7939           },
7940           {
7941             "group": "Body",
7942             "type": "String",
7943             "optional": true,
7944             "field": "fb_data",
7945             "description": ""
7946           },
7947           {
7948             "group": "Body",
7949             "type": "String",
7950             "optional": true,
7951             "field": "twitter",
7952             "description": ""
7953           },
7954           {
7955             "group": "Body",
7956             "type": "String",
7957             "optional": true,
7958             "field": "skype",
7959             "description": ""
7960           },
7961           {
7962             "group": "Body",
7963             "type": "String",
7964             "optional": true,
7965             "field": "teams",
7966             "description": ""
7967           },
7968           {
7969             "group": "Body",
7970             "type": "String",
7971             "optional": true,
7972             "field": "viber",
7973             "description": ""
7974           },
7975           {
7976             "group": "Body",
7977             "type": "String",
7978             "optional": true,
7979             "field": "line",
7980             "description": ""
7981           },
7982           {
7983             "group": "Body",
7984             "type": "String",
7985             "optional": true,
7986             "field": "wechat",
7987             "description": ""
7988           },
7989           {
7990             "group": "Body",
7991             "type": "String",
7992             "optional": true,
7993             "field": "telegram",
7994             "description": ""
7995           },
7996           {
7997             "group": "Body",
7998             "type": "Integer",
7999             "optional": true,
8000             "field": "UserId",
8001             "description": ""
8002           },
8003           {
8004             "group": "Body",
8005             "type": "String",
8006             "optional": true,
8007             "field": "AdditionalPhones",
8008             "description": ""
8009           },
8010           {
8011             "group": "Body",
8012             "type": "Integer",
8013             "optional": true,
8014             "field": "priority",
8015             "description": ""
8016           },
8017           {
8018             "group": "Body",
8019             "type": "String",
8020             "optional": true,
8021             "field": "scheduledat",
8022             "description": ""
8023           }
8024         ]
8025       }
8026     },
8027     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8028     "version": "0.0.0",
8029     "filename": "server/api/cmList/index.js",
8030     "groupTitle": "Cm_Lists"
8031   },
8032   {
8033     "type": "post",
8034     "url": "/api/cm/lists/{id}/fields",
8035     "title": "Creates a new custom field",
8036     "examples": [
8037       {
8038         "title": "Example usage:",
8039         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8040         "type": "json"
8041       }
8042     ],
8043     "name": "addCustomField",
8044     "group": "Cm_Lists",
8045     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8046     "version": "0.0.0",
8047     "filename": "server/api/cmList/index.js",
8048     "groupTitle": "Cm_Lists"
8049   },
8050   {
8051     "type": "post",
8052     "url": "/api/cm/lists/{id}/dispositions",
8053     "title": "Creates new disposition",
8054     "examples": [
8055       {
8056         "title": "Example usage:",
8057         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8058         "type": "json"
8059       }
8060     ],
8061     "name": "addDisposition",
8062     "group": "Cm_Lists",
8063     "parameter": {
8064       "fields": {
8065         "Body": [
8066           {
8067             "group": "Body",
8068             "type": "String",
8069             "optional": false,
8070             "field": "name",
8071             "description": ""
8072           },
8073           {
8074             "group": "Body",
8075             "type": "String",
8076             "allowedValues": [
8077               "\"first\"",
8078               "\"second\"",
8079               "\"third\""
8080             ],
8081             "optional": false,
8082             "field": "level",
8083             "description": ""
8084           },
8085           {
8086             "group": "Body",
8087             "type": "String",
8088             "optional": true,
8089             "field": "description",
8090             "description": ""
8091           }
8092         ]
8093       }
8094     },
8095     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8096     "version": "0.0.0",
8097     "filename": "server/api/cmList/index.js",
8098     "groupTitle": "Cm_Lists"
8099   },
8100   {
8101     "type": "get",
8102     "url": "/api/cm/lists/{id}/contacts",
8103     "title": "Gets List Contacts",
8104     "examples": [
8105       {
8106         "title": "Example usage:",
8107         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
8108         "type": "json"
8109       }
8110     ],
8111     "name": "getContacts",
8112     "group": "Cm_Lists",
8113     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8114     "version": "0.0.0",
8115     "filename": "server/api/cmList/index.js",
8116     "groupTitle": "Cm_Lists"
8117   },
8118   {
8119     "type": "get",
8120     "url": "/api/cm/lists/{id}/fields",
8121     "title": "Gets Custom Fields",
8122     "examples": [
8123       {
8124         "title": "Example usage:",
8125         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
8126         "type": "json"
8127       }
8128     ],
8129     "name": "getCustomFields",
8130     "group": "Cm_Lists",
8131     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8132     "version": "0.0.0",
8133     "filename": "server/api/cmList/index.js",
8134     "groupTitle": "Cm_Lists"
8135   },
8136   {
8137     "type": "get",
8138     "url": "/api/cm/lists/{id}/dispositions",
8139     "title": "Gets list dispositions",
8140     "examples": [
8141       {
8142         "title": "Example usage:",
8143         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
8144         "type": "json"
8145       }
8146     ],
8147     "name": "getDispositions",
8148     "group": "Cm_Lists",
8149     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8150     "version": "0.0.0",
8151     "filename": "server/api/cmList/index.js",
8152     "groupTitle": "Cm_Lists"
8153   },
8154   {
8155     "type": "get",
8156     "url": "/api/cm/lists/{id}/contacts/csv",
8157     "title": "Gets CSV List Contacts",
8158     "examples": [
8159       {
8160         "title": "Example usage:",
8161         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
8162         "type": "json"
8163       }
8164     ],
8165     "name": "grunt",
8166     "group": "Cm_Lists",
8167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8168     "version": "0.0.0",
8169     "filename": "server/api/cmList/index.js",
8170     "groupTitle": "Cm_Lists"
8171   },
8172   {
8173     "type": "put",
8174     "url": "/api/cm/lists/{id}",
8175     "title": "Update an existing List",
8176     "examples": [
8177       {
8178         "title": "Example usage:",
8179         "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",
8180         "type": "json"
8181       }
8182     ],
8183     "name": "updateLists",
8184     "group": "Cm_Lists",
8185     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8186     "version": "0.0.0",
8187     "filename": "server/api/cmList/index.js",
8188     "groupTitle": "Cm_Lists"
8189   },
8190   {
8191     "type": "post",
8192     "url": "/api/cm/contacts/upload/:id",
8193     "title": "Import new contacts by csv",
8194     "examples": [
8195       {
8196         "title": "Example usage:",
8197         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
8198         "type": "json"
8199       }
8200     ],
8201     "name": "import",
8202     "group": "Cm_contacts",
8203     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8204     "version": "0.0.0",
8205     "filename": "server/api/cmContact/index.js",
8206     "groupTitle": "Cm_contacts"
8207   },
8208   {
8209     "type": "post",
8210     "url": "/api/cm/contacts/uploadUpdates/:id",
8211     "title": "Import existing contacts by csv",
8212     "examples": [
8213       {
8214         "title": "Example usage:",
8215         "content": "curl https://{domain}/api/cm/contacts/uploadUpdates/:id -v -u {name}:{password} -X POST",
8216         "type": "json"
8217       }
8218     ],
8219     "name": "importUpdates",
8220     "group": "Cm_contacts",
8221     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8222     "version": "0.0.0",
8223     "filename": "server/api/cmContact/index.js",
8224     "groupTitle": "Cm_contacts"
8225   },
8226   {
8227     "type": "post",
8228     "url": "/api/cm/contacts/upload",
8229     "title": "Upload csv",
8230     "examples": [
8231       {
8232         "title": "Example usage:",
8233         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8234         "type": "json"
8235       }
8236     ],
8237     "name": "upload",
8238     "group": "Cm_contacts",
8239     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8240     "version": "0.0.0",
8241     "filename": "server/api/cmContact/index.js",
8242     "groupTitle": "Cm_contacts"
8243   },
8244   {
8245     "type": "post",
8246     "url": "/api/cm/contacts/csv",
8247     "title": "Create new contacts by csv",
8248     "examples": [
8249       {
8250         "title": "Example usage:",
8251         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
8252         "type": "json"
8253       }
8254     ],
8255     "name": "uploadCsv",
8256     "group": "Cm_contacts",
8257     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8258     "version": "0.0.0",
8259     "filename": "server/api/cmContact/index.js",
8260     "groupTitle": "Cm_contacts"
8261   },
8262   {
8263     "type": "delete",
8264     "url": "/api/conditions/{id}",
8265     "title": "Deletes a Condition",
8266     "examples": [
8267       {
8268         "title": "Example usage:",
8269         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
8270         "type": "json"
8271       }
8272     ],
8273     "name": "DeleteConditions",
8274     "group": "Conditions",
8275     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8276     "version": "0.0.0",
8277     "filename": "server/api/condition/index.js",
8278     "groupTitle": "Conditions"
8279   },
8280   {
8281     "type": "put",
8282     "url": "/api/conditions/{id}",
8283     "title": "Update an existing Condition",
8284     "examples": [
8285       {
8286         "title": "Example usage:",
8287         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8288         "type": "json"
8289       }
8290     ],
8291     "name": "updateConditions",
8292     "group": "Conditions",
8293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8294     "version": "0.0.0",
8295     "filename": "server/api/condition/index.js",
8296     "groupTitle": "Conditions"
8297   },
8298   {
8299     "type": "post",
8300     "url": "/api/contact_item_types",
8301     "title": "Creates a new ContactItemType",
8302     "examples": [
8303       {
8304         "title": "Example usage:",
8305         "content": "curl https://{domain}/api/contact_item_types -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8306         "type": "json"
8307       }
8308     ],
8309     "name": "CreateContactItemTypes",
8310     "group": "ContactItemType",
8311     "parameter": {
8312       "fields": {
8313         "Body": [
8314           {
8315             "group": "Body",
8316             "type": "String",
8317             "optional": false,
8318             "field": "name",
8319             "description": ""
8320           },
8321           {
8322             "group": "Body",
8323             "type": "Integer",
8324             "optional": true,
8325             "field": "OrderBy",
8326             "description": ""
8327           },
8328           {
8329             "group": "Body",
8330             "type": "String",
8331             "optional": true,
8332             "field": "rgbBackgroundColor",
8333             "description": ""
8334           }
8335         ]
8336       }
8337     },
8338     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8339     "version": "0.0.0",
8340     "filename": "server/api/contactItemType/index.js",
8341     "groupTitle": "ContactItemType"
8342   },
8343   {
8344     "type": "delete",
8345     "url": "/api/contact_item_types/{id}",
8346     "title": "Deletes a ContactItemType",
8347     "examples": [
8348       {
8349         "title": "Example usage:",
8350         "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password} -X DELETE",
8351         "type": "json"
8352       }
8353     ],
8354     "name": "DeleteContactItemTypes",
8355     "group": "ContactItemType",
8356     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8357     "version": "0.0.0",
8358     "filename": "server/api/contactItemType/index.js",
8359     "groupTitle": "ContactItemType"
8360   },
8361   {
8362     "type": "get",
8363     "url": "/api/contact_item_types",
8364     "title": "Gets a list of ContactItemTypes",
8365     "examples": [
8366       {
8367         "title": "Example usage:",
8368         "content": "curl https://{domain}/api/contact_item_types -v -u {name}:{password}",
8369         "type": "json"
8370       }
8371     ],
8372     "name": "GetContactItemTypes",
8373     "group": "ContactItemType",
8374     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/contact_item_types?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/contact_item_types?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/contact_item_types?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/contact_item_types?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/contact_item_types?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
8375     "version": "0.0.0",
8376     "filename": "server/api/contactItemType/index.js",
8377     "groupTitle": "ContactItemType"
8378   },
8379   {
8380     "type": "get",
8381     "url": "/api/contact_item_types/{id}",
8382     "title": "Gets a single ContactItemType",
8383     "examples": [
8384       {
8385         "title": "Example usage:",
8386         "content": "curl https://{domain}/api/contact_item_types/{id} -v -u {name}:{password}",
8387         "type": "json"
8388       }
8389     ],
8390     "name": "ShowContactItemTypes",
8391     "group": "ContactItemType",
8392     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8393     "version": "0.0.0",
8394     "filename": "server/api/contactItemType/index.js",
8395     "groupTitle": "ContactItemType"
8396   },
8397   {
8398     "type": "put",
8399     "url": "/api/contact_item_types/{id}",
8400     "title": "Update an existing ContactItemType",
8401     "examples": [
8402       {
8403         "title": "Example usage:",
8404         "content": "curl https://{domain}/api/contact_item_types/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8405         "type": "json"
8406       }
8407     ],
8408     "name": "updateContactItemTypes",
8409     "group": "ContactItemType",
8410     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8411     "version": "0.0.0",
8412     "filename": "server/api/contactItemType/index.js",
8413     "groupTitle": "ContactItemType"
8414   },
8415   {
8416     "type": "post",
8417     "url": "/api/cm/custom_field",
8418     "title": "Create a new custom field",
8419     "examples": [
8420       {
8421         "title": "Example usage:",
8422         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8423         "type": "json"
8424       }
8425     ],
8426     "name": "CreateCustomField",
8427     "group": "Custom_Fields",
8428     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8429     "version": "0.0.0",
8430     "filename": "server/api/cmCustomField/index.js",
8431     "groupTitle": "Custom_Fields"
8432   },
8433   {
8434     "type": "post",
8435     "url": "/api/dashboards/items",
8436     "title": "Create dasboard item",
8437     "examples": [
8438       {
8439         "title": "Example usage:",
8440         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
8441         "type": "json"
8442       }
8443     ],
8444     "name": "Create",
8445     "group": "Dashboard_Items",
8446     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8447     "version": "0.0.0",
8448     "filename": "server/api/dashboardItem/index.js",
8449     "groupTitle": "Dashboard_Items"
8450   },
8451   {
8452     "type": "delete",
8453     "url": "/api/dashboards/items/{id}",
8454     "title": "Deletes a Dashboard Item",
8455     "examples": [
8456       {
8457         "title": "Example usage:",
8458         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
8459         "type": "json"
8460       }
8461     ],
8462     "name": "DeleteDashboard_Items",
8463     "group": "Dashboard_Items",
8464     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8465     "version": "0.0.0",
8466     "filename": "server/api/dashboardItem/index.js",
8467     "groupTitle": "Dashboard_Items"
8468   },
8469   {
8470     "type": "get",
8471     "url": "/api/dashboards/items/{id}",
8472     "title": "Gets a single Dashboard Item",
8473     "examples": [
8474       {
8475         "title": "Example usage:",
8476         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
8477         "type": "json"
8478       }
8479     ],
8480     "name": "ShowDashboard_Items",
8481     "group": "Dashboard_Items",
8482     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8483     "version": "0.0.0",
8484     "filename": "server/api/dashboardItem/index.js",
8485     "groupTitle": "Dashboard_Items"
8486   },
8487   {
8488     "type": "put",
8489     "url": "/api/dashboards/items/{id}",
8490     "title": "Update an existing item",
8491     "examples": [
8492       {
8493         "title": "Example usage:",
8494         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
8495         "type": "json"
8496       }
8497     ],
8498     "name": "Update",
8499     "group": "Dashboard_Items",
8500     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8501     "version": "0.0.0",
8502     "filename": "server/api/dashboardItem/index.js",
8503     "groupTitle": "Dashboard_Items"
8504   },
8505   {
8506     "type": "post",
8507     "url": "/api/dashboards/clone",
8508     "title": "Clone an existing Dashboard",
8509     "examples": [
8510       {
8511         "title": "Example usage:",
8512         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8513         "type": "json"
8514       }
8515     ],
8516     "name": "CloneDashboards",
8517     "group": "Dashboards",
8518     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8519     "version": "0.0.0",
8520     "filename": "server/api/dashboard/index.js",
8521     "groupTitle": "Dashboards"
8522   },
8523   {
8524     "type": "post",
8525     "url": "/api/dashboards",
8526     "title": "Creates a new Dashboard",
8527     "examples": [
8528       {
8529         "title": "Example usage:",
8530         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8531         "type": "json"
8532       }
8533     ],
8534     "name": "CreateDashboards",
8535     "group": "Dashboards",
8536     "parameter": {
8537       "fields": {
8538         "Body": [
8539           {
8540             "group": "Body",
8541             "type": "String",
8542             "optional": false,
8543             "field": "name",
8544             "description": ""
8545           },
8546           {
8547             "group": "Body",
8548             "type": "String",
8549             "optional": true,
8550             "field": "description",
8551             "description": ""
8552           }
8553         ]
8554       }
8555     },
8556     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8557     "version": "0.0.0",
8558     "filename": "server/api/dashboard/index.js",
8559     "groupTitle": "Dashboards"
8560   },
8561   {
8562     "type": "delete",
8563     "url": "/api/dashboards/{id}",
8564     "title": "Deletes a Dashboard",
8565     "examples": [
8566       {
8567         "title": "Example usage:",
8568         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
8569         "type": "json"
8570       }
8571     ],
8572     "name": "DeleteDashboards",
8573     "group": "Dashboards",
8574     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8575     "version": "0.0.0",
8576     "filename": "server/api/dashboard/index.js",
8577     "groupTitle": "Dashboards"
8578   },
8579   {
8580     "type": "get",
8581     "url": "/api/dashboards",
8582     "title": "Gets a list of Dashboards",
8583     "examples": [
8584       {
8585         "title": "Example usage:",
8586         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
8587         "type": "json"
8588       }
8589     ],
8590     "name": "GetDashboards",
8591     "group": "Dashboards",
8592     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8593     "version": "0.0.0",
8594     "filename": "server/api/dashboard/index.js",
8595     "groupTitle": "Dashboards"
8596   },
8597   {
8598     "type": "get",
8599     "url": "/api/dashboards/{id}",
8600     "title": "Gets a single Dashboard",
8601     "examples": [
8602       {
8603         "title": "Example usage:",
8604         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
8605         "type": "json"
8606       }
8607     ],
8608     "name": "ShowDashboards",
8609     "group": "Dashboards",
8610     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8611     "version": "0.0.0",
8612     "filename": "server/api/dashboard/index.js",
8613     "groupTitle": "Dashboards"
8614   },
8615   {
8616     "type": "post",
8617     "url": "/api/dashboards/{id}/items",
8618     "title": "Creates new item",
8619     "examples": [
8620       {
8621         "title": "Example usage:",
8622         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
8623         "type": "json"
8624       }
8625     ],
8626     "name": "addItem",
8627     "group": "Dashboards",
8628     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8629     "version": "0.0.0",
8630     "filename": "server/api/dashboard/index.js",
8631     "groupTitle": "Dashboards"
8632   },
8633   {
8634     "type": "get",
8635     "url": "/api/dashboards/{id}/items",
8636     "title": "Gets items",
8637     "examples": [
8638       {
8639         "title": "Example usage:",
8640         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8641         "type": "json"
8642       }
8643     ],
8644     "name": "getItems",
8645     "group": "Dashboards",
8646     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8647     "version": "0.0.0",
8648     "filename": "server/api/dashboard/index.js",
8649     "groupTitle": "Dashboards"
8650   },
8651   {
8652     "type": "put",
8653     "url": "/api/dashboards/{id}",
8654     "title": "Update an existing Dashboard",
8655     "examples": [
8656       {
8657         "title": "Example usage:",
8658         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8659         "type": "json"
8660       }
8661     ],
8662     "name": "updateDashboards",
8663     "group": "Dashboards",
8664     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8665     "version": "0.0.0",
8666     "filename": "server/api/dashboard/index.js",
8667     "groupTitle": "Dashboards"
8668   },
8669   {
8670     "type": "post",
8671     "url": "/api/integrations/desk/accounts",
8672     "title": "Creates a new Desk Account",
8673     "examples": [
8674       {
8675         "title": "Example usage:",
8676         "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",
8677         "type": "json"
8678       }
8679     ],
8680     "name": "CreateDesk_Accounts",
8681     "group": "Desk_Accounts",
8682     "parameter": {
8683       "fields": {
8684         "Body": [
8685           {
8686             "group": "Body",
8687             "type": "String",
8688             "optional": true,
8689             "field": "name",
8690             "description": ""
8691           },
8692           {
8693             "group": "Body",
8694             "type": "String",
8695             "optional": true,
8696             "field": "description",
8697             "description": ""
8698           },
8699           {
8700             "group": "Body",
8701             "type": "String",
8702             "optional": true,
8703             "field": "username",
8704             "description": ""
8705           },
8706           {
8707             "group": "Body",
8708             "type": "String",
8709             "optional": true,
8710             "field": "remoteUri",
8711             "description": ""
8712           },
8713           {
8714             "group": "Body",
8715             "type": "String",
8716             "allowedValues": [
8717               "\"basic\""
8718             ],
8719             "optional": true,
8720             "field": "authType",
8721             "description": ""
8722           },
8723           {
8724             "group": "Body",
8725             "type": "String",
8726             "optional": true,
8727             "field": "password",
8728             "description": ""
8729           },
8730           {
8731             "group": "Body",
8732             "type": "String",
8733             "optional": true,
8734             "field": "consumerKey",
8735             "description": ""
8736           },
8737           {
8738             "group": "Body",
8739             "type": "String",
8740             "optional": true,
8741             "field": "consumerSecret",
8742             "description": ""
8743           },
8744           {
8745             "group": "Body",
8746             "type": "String",
8747             "optional": true,
8748             "field": "token",
8749             "description": ""
8750           },
8751           {
8752             "group": "Body",
8753             "type": "String",
8754             "optional": true,
8755             "field": "tokenSecret",
8756             "description": ""
8757           },
8758           {
8759             "group": "Body",
8760             "type": "String",
8761             "optional": false,
8762             "field": "serverUrl",
8763             "description": ""
8764           },
8765           {
8766             "group": "Body",
8767             "type": "String",
8768             "allowedValues": [
8769               "\"integrationTab\"",
8770               "\"newTab\""
8771             ],
8772             "optional": true,
8773             "field": "type",
8774             "description": ""
8775           }
8776         ]
8777       }
8778     },
8779     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8780     "version": "0.0.0",
8781     "filename": "server/api/intDeskAccount/index.js",
8782     "groupTitle": "Desk_Accounts"
8783   },
8784   {
8785     "type": "delete",
8786     "url": "/api/integrations/desk/accounts/{id}",
8787     "title": "Deletes a Desk Account",
8788     "examples": [
8789       {
8790         "title": "Example usage:",
8791         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8792         "type": "json"
8793       }
8794     ],
8795     "name": "DeleteDesk_Accounts",
8796     "group": "Desk_Accounts",
8797     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8798     "version": "0.0.0",
8799     "filename": "server/api/intDeskAccount/index.js",
8800     "groupTitle": "Desk_Accounts"
8801   },
8802   {
8803     "type": "get",
8804     "url": "/api/integrations/desk/accounts",
8805     "title": "Gets a list of Desk Accounts",
8806     "examples": [
8807       {
8808         "title": "Example usage:",
8809         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8810         "type": "json"
8811       }
8812     ],
8813     "name": "GetDesk_Accounts",
8814     "group": "Desk_Accounts",
8815     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8816     "version": "0.0.0",
8817     "filename": "server/api/intDeskAccount/index.js",
8818     "groupTitle": "Desk_Accounts"
8819   },
8820   {
8821     "type": "get",
8822     "url": "/api/integrations/desk/accounts/{id}",
8823     "title": "Gets a single Desk Account",
8824     "examples": [
8825       {
8826         "title": "Example usage:",
8827         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8828         "type": "json"
8829       }
8830     ],
8831     "name": "ShowDesk_Accounts",
8832     "group": "Desk_Accounts",
8833     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8834     "version": "0.0.0",
8835     "filename": "server/api/intDeskAccount/index.js",
8836     "groupTitle": "Desk_Accounts"
8837   },
8838   {
8839     "type": "post",
8840     "url": "/api/integrations/desk/accounts/{id}/configurations",
8841     "title": "Creates new configuration",
8842     "examples": [
8843       {
8844         "title": "Example usage:",
8845         "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",
8846         "type": "json"
8847       }
8848     ],
8849     "name": "addConfiguration",
8850     "group": "Desk_Accounts",
8851     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8852     "version": "0.0.0",
8853     "filename": "server/api/intDeskAccount/index.js",
8854     "groupTitle": "Desk_Accounts"
8855   },
8856   {
8857     "type": "get",
8858     "url": "/api/integrations/desk/accounts/{id}/configurations",
8859     "title": "Gets account configurations",
8860     "examples": [
8861       {
8862         "title": "Example usage:",
8863         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8864         "type": "json"
8865       }
8866     ],
8867     "name": "getConfigurations",
8868     "group": "Desk_Accounts",
8869     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8870     "version": "0.0.0",
8871     "filename": "server/api/intDeskAccount/index.js",
8872     "groupTitle": "Desk_Accounts"
8873   },
8874   {
8875     "type": "get",
8876     "url": "/api/integrations/desk/accounts/{id}/fields",
8877     "title": "Gets account fields",
8878     "examples": [
8879       {
8880         "title": "Example usage:",
8881         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8882         "type": "json"
8883       }
8884     ],
8885     "name": "getFields",
8886     "group": "Desk_Accounts",
8887     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8888     "version": "0.0.0",
8889     "filename": "server/api/intDeskAccount/index.js",
8890     "groupTitle": "Desk_Accounts"
8891   },
8892   {
8893     "type": "put",
8894     "url": "/api/integrations/desk/accounts/{id}",
8895     "title": "Update an existing Desk Account",
8896     "examples": [
8897       {
8898         "title": "Example usage:",
8899         "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",
8900         "type": "json"
8901       }
8902     ],
8903     "name": "updateDesk_Accounts",
8904     "group": "Desk_Accounts",
8905     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8906     "version": "0.0.0",
8907     "filename": "server/api/intDeskAccount/index.js",
8908     "groupTitle": "Desk_Accounts"
8909   },
8910   {
8911     "type": "post",
8912     "url": "/api/integrations/desk/configurations",
8913     "title": "Creates a new Desk Configuration",
8914     "examples": [
8915       {
8916         "title": "Example usage:",
8917         "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",
8918         "type": "json"
8919       }
8920     ],
8921     "name": "CreateDesk_Configurations",
8922     "group": "Desk_Configurations",
8923     "parameter": {
8924       "fields": {
8925         "Body": [
8926           {
8927             "group": "Body",
8928             "type": "String",
8929             "optional": true,
8930             "field": "name",
8931             "description": ""
8932           },
8933           {
8934             "group": "Body",
8935             "type": "String",
8936             "optional": true,
8937             "field": "description",
8938             "description": ""
8939           }
8940         ]
8941       }
8942     },
8943     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8944     "version": "0.0.0",
8945     "filename": "server/api/intDeskConfiguration/index.js",
8946     "groupTitle": "Desk_Configurations"
8947   },
8948   {
8949     "type": "delete",
8950     "url": "/api/integrations/desk/configurations/{id}",
8951     "title": "Deletes a Desk Configuration",
8952     "examples": [
8953       {
8954         "title": "Example usage:",
8955         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8956         "type": "json"
8957       }
8958     ],
8959     "name": "DeleteDesk_Configurations",
8960     "group": "Desk_Configurations",
8961     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8962     "version": "0.0.0",
8963     "filename": "server/api/intDeskConfiguration/index.js",
8964     "groupTitle": "Desk_Configurations"
8965   },
8966   {
8967     "type": "get",
8968     "url": "/api/integrations/desk/configurations",
8969     "title": "Gets a list of Desk Configurations",
8970     "examples": [
8971       {
8972         "title": "Example usage:",
8973         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8974         "type": "json"
8975       }
8976     ],
8977     "name": "GetDesk_Configurations",
8978     "group": "Desk_Configurations",
8979     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8980     "version": "0.0.0",
8981     "filename": "server/api/intDeskConfiguration/index.js",
8982     "groupTitle": "Desk_Configurations"
8983   },
8984   {
8985     "type": "get",
8986     "url": "/api/integrations/desk/configurations/{id}",
8987     "title": "Gets a single Desk Configuration",
8988     "examples": [
8989       {
8990         "title": "Example usage:",
8991         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8992         "type": "json"
8993       }
8994     ],
8995     "name": "ShowDesk_Configurations",
8996     "group": "Desk_Configurations",
8997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8998     "version": "0.0.0",
8999     "filename": "server/api/intDeskConfiguration/index.js",
9000     "groupTitle": "Desk_Configurations"
9001   },
9002   {
9003     "type": "get",
9004     "url": "/api/integrations/desk/configurations/{id}/descriptions",
9005     "title": "Gets configurations descriptions",
9006     "examples": [
9007       {
9008         "title": "Example usage:",
9009         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9010         "type": "json"
9011       }
9012     ],
9013     "name": "getDescriptions",
9014     "group": "Desk_Configurations",
9015     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9016     "version": "0.0.0",
9017     "filename": "server/api/intDeskConfiguration/index.js",
9018     "groupTitle": "Desk_Configurations"
9019   },
9020   {
9021     "type": "get",
9022     "url": "/api/integrations/desk/configurations/{id}/fields",
9023     "title": "Gets configurations fields",
9024     "examples": [
9025       {
9026         "title": "Example usage:",
9027         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
9028         "type": "json"
9029       }
9030     ],
9031     "name": "getFields",
9032     "group": "Desk_Configurations",
9033     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9034     "version": "0.0.0",
9035     "filename": "server/api/intDeskConfiguration/index.js",
9036     "groupTitle": "Desk_Configurations"
9037   },
9038   {
9039     "type": "get",
9040     "url": "/api/integrations/desk/configurations/{id}/subjects",
9041     "title": "Gets configurations subjects",
9042     "examples": [
9043       {
9044         "title": "Example usage:",
9045         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9046         "type": "json"
9047       }
9048     ],
9049     "name": "getSubjects",
9050     "group": "Desk_Configurations",
9051     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9052     "version": "0.0.0",
9053     "filename": "server/api/intDeskConfiguration/index.js",
9054     "groupTitle": "Desk_Configurations"
9055   },
9056   {
9057     "type": "get",
9058     "url": "/api/integrations/desk/configurations/{id}/tags",
9059     "title": "Gets configurations tags",
9060     "examples": [
9061       {
9062         "title": "Example usage:",
9063         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
9064         "type": "json"
9065       }
9066     ],
9067     "name": "getTags",
9068     "group": "Desk_Configurations",
9069     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9070     "version": "0.0.0",
9071     "filename": "server/api/intDeskConfiguration/index.js",
9072     "groupTitle": "Desk_Configurations"
9073   },
9074   {
9075     "type": "post",
9076     "url": "/api/integrations/desk/configurations/{id}/tags",
9077     "title": "Sets new tags",
9078     "examples": [
9079       {
9080         "title": "Example usage:",
9081         "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",
9082         "type": "json"
9083       }
9084     ],
9085     "name": "setTags",
9086     "group": "Desk_Configurations",
9087     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9088     "version": "0.0.0",
9089     "filename": "server/api/intDeskConfiguration/index.js",
9090     "groupTitle": "Desk_Configurations"
9091   },
9092   {
9093     "type": "put",
9094     "url": "/api/integrations/desk/configurations/{id}",
9095     "title": "Update an existing Desk Configuration",
9096     "examples": [
9097       {
9098         "title": "Example usage:",
9099         "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",
9100         "type": "json"
9101       }
9102     ],
9103     "name": "updateDesk_Configurations",
9104     "group": "Desk_Configurations",
9105     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9106     "version": "0.0.0",
9107     "filename": "server/api/intDeskConfiguration/index.js",
9108     "groupTitle": "Desk_Configurations"
9109   },
9110   {
9111     "type": "post",
9112     "url": "/api/integrations/desk/fields",
9113     "title": "Creates a new Desk Field",
9114     "examples": [
9115       {
9116         "title": "Example usage:",
9117         "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",
9118         "type": "json"
9119       }
9120     ],
9121     "name": "CreateDesk_Fields",
9122     "group": "Desk_Fields",
9123     "parameter": {
9124       "fields": {
9125         "Body": [
9126           {
9127             "group": "Body",
9128             "type": "String",
9129             "allowedValues": [
9130               "\"string\"",
9131               "\"variable\"",
9132               "\"customVariable\"",
9133               "\"keyValue\"",
9134               "\"picklist\""
9135             ],
9136             "optional": true,
9137             "field": "type",
9138             "description": ""
9139           },
9140           {
9141             "group": "Body",
9142             "type": "String",
9143             "optional": true,
9144             "field": "content",
9145             "description": ""
9146           },
9147           {
9148             "group": "Body",
9149             "type": "String",
9150             "optional": true,
9151             "field": "key",
9152             "description": ""
9153           },
9154           {
9155             "group": "Body",
9156             "type": "String",
9157             "allowedValues": [
9158               "\"string\"",
9159               "\"variable\"",
9160               "\"customVariable\""
9161             ],
9162             "optional": true,
9163             "field": "keyType",
9164             "description": ""
9165           },
9166           {
9167             "group": "Body",
9168             "type": "String",
9169             "optional": true,
9170             "field": "keyContent",
9171             "description": ""
9172           },
9173           {
9174             "group": "Body",
9175             "type": "String",
9176             "optional": true,
9177             "field": "idField",
9178             "description": ""
9179           },
9180           {
9181             "group": "Body",
9182             "type": "String",
9183             "optional": true,
9184             "field": "nameField",
9185             "description": ""
9186           },
9187           {
9188             "group": "Body",
9189             "type": "Boolean",
9190             "optional": true,
9191             "field": "customField",
9192             "description": ""
9193           },
9194           {
9195             "group": "Body",
9196             "type": "String",
9197             "optional": true,
9198             "field": "variableName",
9199             "description": ""
9200           }
9201         ]
9202       }
9203     },
9204     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9205     "version": "0.0.0",
9206     "filename": "server/api/intDeskField/index.js",
9207     "groupTitle": "Desk_Fields"
9208   },
9209   {
9210     "type": "delete",
9211     "url": "/api/integrations/desk/fields/{id}",
9212     "title": "Deletes a Desk Field",
9213     "examples": [
9214       {
9215         "title": "Example usage:",
9216         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
9217         "type": "json"
9218       }
9219     ],
9220     "name": "DeleteDesk_Fields",
9221     "group": "Desk_Fields",
9222     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9223     "version": "0.0.0",
9224     "filename": "server/api/intDeskField/index.js",
9225     "groupTitle": "Desk_Fields"
9226   },
9227   {
9228     "type": "get",
9229     "url": "/api/integrations/desk/fields",
9230     "title": "Gets a list of Desk Fields",
9231     "examples": [
9232       {
9233         "title": "Example usage:",
9234         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
9235         "type": "json"
9236       }
9237     ],
9238     "name": "GetDesk_Fields",
9239     "group": "Desk_Fields",
9240     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9241     "version": "0.0.0",
9242     "filename": "server/api/intDeskField/index.js",
9243     "groupTitle": "Desk_Fields"
9244   },
9245   {
9246     "type": "get",
9247     "url": "/api/integrations/desk/fields/{id}",
9248     "title": "Gets a single Desk Field",
9249     "examples": [
9250       {
9251         "title": "Example usage:",
9252         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
9253         "type": "json"
9254       }
9255     ],
9256     "name": "ShowDesk_Fields",
9257     "group": "Desk_Fields",
9258     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9259     "version": "0.0.0",
9260     "filename": "server/api/intDeskField/index.js",
9261     "groupTitle": "Desk_Fields"
9262   },
9263   {
9264     "type": "put",
9265     "url": "/api/integrations/desk/fields/{id}",
9266     "title": "Update an existing Desk Field",
9267     "examples": [
9268       {
9269         "title": "Example usage:",
9270         "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",
9271         "type": "json"
9272       }
9273     ],
9274     "name": "updateDesk_Fields",
9275     "group": "Desk_Fields",
9276     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9277     "version": "0.0.0",
9278     "filename": "server/api/intDeskField/index.js",
9279     "groupTitle": "Desk_Fields"
9280   },
9281   {
9282     "type": "post",
9283     "url": "/api/dispositions",
9284     "title": "Creates a new Disposition",
9285     "examples": [
9286       {
9287         "title": "Example usage:",
9288         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9289         "type": "json"
9290       }
9291     ],
9292     "name": "CreateDispositions",
9293     "group": "Dispositions",
9294     "parameter": {
9295       "fields": {
9296         "Body": [
9297           {
9298             "group": "Body",
9299             "type": "String",
9300             "optional": false,
9301             "field": "name",
9302             "description": ""
9303           },
9304           {
9305             "group": "Body",
9306             "type": "String",
9307             "allowedValues": [
9308               "\"first\"",
9309               "\"second\"",
9310               "\"third\""
9311             ],
9312             "optional": false,
9313             "field": "level",
9314             "description": ""
9315           },
9316           {
9317             "group": "Body",
9318             "type": "String",
9319             "optional": true,
9320             "field": "description",
9321             "description": ""
9322           }
9323         ]
9324       }
9325     },
9326     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9327     "version": "0.0.0",
9328     "filename": "server/api/disposition/index.js",
9329     "groupTitle": "Dispositions"
9330   },
9331   {
9332     "type": "delete",
9333     "url": "/api/dispositions/{id}",
9334     "title": "Deletes a Disposition",
9335     "examples": [
9336       {
9337         "title": "Example usage:",
9338         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
9339         "type": "json"
9340       }
9341     ],
9342     "name": "DeleteDispositions",
9343     "group": "Dispositions",
9344     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9345     "version": "0.0.0",
9346     "filename": "server/api/disposition/index.js",
9347     "groupTitle": "Dispositions"
9348   },
9349   {
9350     "type": "get",
9351     "url": "/api/dispositions",
9352     "title": "Gets a list of Dispositions",
9353     "examples": [
9354       {
9355         "title": "Example usage:",
9356         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
9357         "type": "json"
9358       }
9359     ],
9360     "name": "GetDispositions",
9361     "group": "Dispositions",
9362     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9363     "version": "0.0.0",
9364     "filename": "server/api/disposition/index.js",
9365     "groupTitle": "Dispositions"
9366   },
9367   {
9368     "type": "get",
9369     "url": "/api/dispositions/{id}",
9370     "title": "Gets a single Disposition",
9371     "examples": [
9372       {
9373         "title": "Example usage:",
9374         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
9375         "type": "json"
9376       }
9377     ],
9378     "name": "ShowDispositions",
9379     "group": "Dispositions",
9380     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9381     "version": "0.0.0",
9382     "filename": "server/api/disposition/index.js",
9383     "groupTitle": "Dispositions"
9384   },
9385   {
9386     "type": "put",
9387     "url": "/api/dispositions/{id}",
9388     "title": "Update an existing Disposition",
9389     "examples": [
9390       {
9391         "title": "Example usage:",
9392         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
9393         "type": "json"
9394       }
9395     ],
9396     "name": "updateDispositions",
9397     "group": "Dispositions",
9398     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9399     "version": "0.0.0",
9400     "filename": "server/api/disposition/index.js",
9401     "groupTitle": "Dispositions"
9402   },
9403   {
9404     "type": "post",
9405     "url": "/api/integrations/dynamics365/accounts",
9406     "title": "Creates a new Dynamics365 Account",
9407     "examples": [
9408       {
9409         "title": "Example usage:",
9410         "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",
9411         "type": "json"
9412       }
9413     ],
9414     "name": "CreateDynamics365_Accounts",
9415     "group": "Dynamics365_Accounts",
9416     "parameter": {
9417       "fields": {
9418         "Body": [
9419           {
9420             "group": "Body",
9421             "type": "String",
9422             "optional": true,
9423             "field": "name",
9424             "description": ""
9425           },
9426           {
9427             "group": "Body",
9428             "type": "String",
9429             "optional": true,
9430             "field": "username",
9431             "description": ""
9432           },
9433           {
9434             "group": "Body",
9435             "type": "String",
9436             "optional": true,
9437             "field": "password",
9438             "description": ""
9439           },
9440           {
9441             "group": "Body",
9442             "type": "String",
9443             "optional": true,
9444             "field": "remoteUri",
9445             "description": ""
9446           },
9447           {
9448             "group": "Body",
9449             "type": "String",
9450             "optional": true,
9451             "field": "tenantId",
9452             "description": ""
9453           },
9454           {
9455             "group": "Body",
9456             "type": "String",
9457             "optional": true,
9458             "field": "clientId",
9459             "description": ""
9460           },
9461           {
9462             "group": "Body",
9463             "type": "String",
9464             "optional": true,
9465             "field": "clientSecret",
9466             "description": ""
9467           },
9468           {
9469             "group": "Body",
9470             "type": "String",
9471             "optional": false,
9472             "field": "serverUrl",
9473             "description": ""
9474           },
9475           {
9476             "group": "Body",
9477             "type": "String",
9478             "optional": true,
9479             "field": "description",
9480             "description": ""
9481           }
9482         ]
9483       }
9484     },
9485     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9486     "version": "0.0.0",
9487     "filename": "server/api/intDynamics365Account/index.js",
9488     "groupTitle": "Dynamics365_Accounts"
9489   },
9490   {
9491     "type": "delete",
9492     "url": "/api/integrations/dynamics365/accounts/{id}",
9493     "title": "Deletes a Dynamics365 Account",
9494     "examples": [
9495       {
9496         "title": "Example usage:",
9497         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
9498         "type": "json"
9499       }
9500     ],
9501     "name": "DeleteDynamics365_Accounts",
9502     "group": "Dynamics365_Accounts",
9503     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9504     "version": "0.0.0",
9505     "filename": "server/api/intDynamics365Account/index.js",
9506     "groupTitle": "Dynamics365_Accounts"
9507   },
9508   {
9509     "type": "get",
9510     "url": "/api/integrations/dynamics365/accounts",
9511     "title": "Gets a list of Dynamics365 Accounts",
9512     "examples": [
9513       {
9514         "title": "Example usage:",
9515         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
9516         "type": "json"
9517       }
9518     ],
9519     "name": "GetDynamics365_Accounts",
9520     "group": "Dynamics365_Accounts",
9521     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9522     "version": "0.0.0",
9523     "filename": "server/api/intDynamics365Account/index.js",
9524     "groupTitle": "Dynamics365_Accounts"
9525   },
9526   {
9527     "type": "get",
9528     "url": "/api/integrations/dynamics365/accounts/{id}",
9529     "title": "Gets a single Dynamics365 Account",
9530     "examples": [
9531       {
9532         "title": "Example usage:",
9533         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
9534         "type": "json"
9535       }
9536     ],
9537     "name": "ShowDynamics365_Accounts",
9538     "group": "Dynamics365_Accounts",
9539     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9540     "version": "0.0.0",
9541     "filename": "server/api/intDynamics365Account/index.js",
9542     "groupTitle": "Dynamics365_Accounts"
9543   },
9544   {
9545     "type": "post",
9546     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9547     "title": "Creates new configuration",
9548     "examples": [
9549       {
9550         "title": "Example usage:",
9551         "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",
9552         "type": "json"
9553       }
9554     ],
9555     "name": "addConfiguration",
9556     "group": "Dynamics365_Accounts",
9557     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9558     "version": "0.0.0",
9559     "filename": "server/api/intDynamics365Account/index.js",
9560     "groupTitle": "Dynamics365_Accounts"
9561   },
9562   {
9563     "type": "get",
9564     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
9565     "title": "Gets account configurations",
9566     "examples": [
9567       {
9568         "title": "Example usage:",
9569         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
9570         "type": "json"
9571       }
9572     ],
9573     "name": "getConfigurations",
9574     "group": "Dynamics365_Accounts",
9575     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9576     "version": "0.0.0",
9577     "filename": "server/api/intDynamics365Account/index.js",
9578     "groupTitle": "Dynamics365_Accounts"
9579   },
9580   {
9581     "type": "get",
9582     "url": "/api/integrations/dynamics365/accounts/{id}/fields",
9583     "title": "Gets account fields",
9584     "examples": [
9585       {
9586         "title": "Example usage:",
9587         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
9588         "type": "json"
9589       }
9590     ],
9591     "name": "getFields",
9592     "group": "Dynamics365_Accounts",
9593     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9594     "version": "0.0.0",
9595     "filename": "server/api/intDynamics365Account/index.js",
9596     "groupTitle": "Dynamics365_Accounts"
9597   },
9598   {
9599     "type": "put",
9600     "url": "/api/integrations/dynamics365/accounts/{id}",
9601     "title": "Update an existing Dynamics365 Account",
9602     "examples": [
9603       {
9604         "title": "Example usage:",
9605         "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",
9606         "type": "json"
9607       }
9608     ],
9609     "name": "updateDynamics365_Accounts",
9610     "group": "Dynamics365_Accounts",
9611     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9612     "version": "0.0.0",
9613     "filename": "server/api/intDynamics365Account/index.js",
9614     "groupTitle": "Dynamics365_Accounts"
9615   },
9616   {
9617     "type": "post",
9618     "url": "/api/integrations/dynamics365/configurations",
9619     "title": "Creates a new Dynamics365 Configuration",
9620     "examples": [
9621       {
9622         "title": "Example usage:",
9623         "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",
9624         "type": "json"
9625       }
9626     ],
9627     "name": "CreateDynamics365_Configurations",
9628     "group": "Dynamics365_Configurations",
9629     "parameter": {
9630       "fields": {
9631         "Body": [
9632           {
9633             "group": "Body",
9634             "type": "String",
9635             "optional": true,
9636             "field": "name",
9637             "description": ""
9638           },
9639           {
9640             "group": "Body",
9641             "type": "String",
9642             "optional": true,
9643             "field": "description",
9644             "description": ""
9645           },
9646           {
9647             "group": "Body",
9648             "type": "String",
9649             "allowedValues": [
9650               "\"incident\"",
9651               "\"phonecall\""
9652             ],
9653             "optional": true,
9654             "field": "ticketType",
9655             "description": ""
9656           }
9657         ]
9658       }
9659     },
9660     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9661     "version": "0.0.0",
9662     "filename": "server/api/intDynamics365Configuration/index.js",
9663     "groupTitle": "Dynamics365_Configurations"
9664   },
9665   {
9666     "type": "delete",
9667     "url": "/api/integrations/dynamics365/configurations/{id}",
9668     "title": "Deletes a Dynamics365 Configuration",
9669     "examples": [
9670       {
9671         "title": "Example usage:",
9672         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9673         "type": "json"
9674       }
9675     ],
9676     "name": "DeleteDynamics365_Configurations",
9677     "group": "Dynamics365_Configurations",
9678     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9679     "version": "0.0.0",
9680     "filename": "server/api/intDynamics365Configuration/index.js",
9681     "groupTitle": "Dynamics365_Configurations"
9682   },
9683   {
9684     "type": "get",
9685     "url": "/api/integrations/dynamics365/configurations",
9686     "title": "Gets a list of Dynamics365 Configurations",
9687     "examples": [
9688       {
9689         "title": "Example usage:",
9690         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9691         "type": "json"
9692       }
9693     ],
9694     "name": "GetDynamics365_Configurations",
9695     "group": "Dynamics365_Configurations",
9696     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9697     "version": "0.0.0",
9698     "filename": "server/api/intDynamics365Configuration/index.js",
9699     "groupTitle": "Dynamics365_Configurations"
9700   },
9701   {
9702     "type": "get",
9703     "url": "/api/integrations/dynamics365/configurations/{id}",
9704     "title": "Gets a single Dynamics365 Configuration",
9705     "examples": [
9706       {
9707         "title": "Example usage:",
9708         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9709         "type": "json"
9710       }
9711     ],
9712     "name": "ShowDynamics365_Configurations",
9713     "group": "Dynamics365_Configurations",
9714     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9715     "version": "0.0.0",
9716     "filename": "server/api/intDynamics365Configuration/index.js",
9717     "groupTitle": "Dynamics365_Configurations"
9718   },
9719   {
9720     "type": "get",
9721     "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9722     "title": "Gets configurations descriptions",
9723     "examples": [
9724       {
9725         "title": "Example usage:",
9726         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9727         "type": "json"
9728       }
9729     ],
9730     "name": "getDescriptions",
9731     "group": "Dynamics365_Configurations",
9732     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9733     "version": "0.0.0",
9734     "filename": "server/api/intDynamics365Configuration/index.js",
9735     "groupTitle": "Dynamics365_Configurations"
9736   },
9737   {
9738     "type": "get",
9739     "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9740     "title": "Gets configurations fields",
9741     "examples": [
9742       {
9743         "title": "Example usage:",
9744         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9745         "type": "json"
9746       }
9747     ],
9748     "name": "getFields",
9749     "group": "Dynamics365_Configurations",
9750     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9751     "version": "0.0.0",
9752     "filename": "server/api/intDynamics365Configuration/index.js",
9753     "groupTitle": "Dynamics365_Configurations"
9754   },
9755   {
9756     "type": "get",
9757     "url": "/api/integrations/zoho/configurations/{id}/subjects",
9758     "title": "Gets configurations subjects",
9759     "examples": [
9760       {
9761         "title": "Example usage:",
9762         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9763         "type": "json"
9764       }
9765     ],
9766     "name": "getSubjects",
9767     "group": "Dynamics365_Configurations",
9768     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9769     "version": "0.0.0",
9770     "filename": "server/api/intDynamics365Configuration/index.js",
9771     "groupTitle": "Dynamics365_Configurations"
9772   },
9773   {
9774     "type": "put",
9775     "url": "/api/integrations/dynamics365/configurations/{id}",
9776     "title": "Update an existing Dynamics365 Configuration",
9777     "examples": [
9778       {
9779         "title": "Example usage:",
9780         "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",
9781         "type": "json"
9782       }
9783     ],
9784     "name": "updateDynamics365_Configurations",
9785     "group": "Dynamics365_Configurations",
9786     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9787     "version": "0.0.0",
9788     "filename": "server/api/intDynamics365Configuration/index.js",
9789     "groupTitle": "Dynamics365_Configurations"
9790   },
9791   {
9792     "type": "post",
9793     "url": "/api/integrations/dynamics365/fields",
9794     "title": "Creates a new Dynamics365 Field",
9795     "examples": [
9796       {
9797         "title": "Example usage:",
9798         "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",
9799         "type": "json"
9800       }
9801     ],
9802     "name": "CreateDynamics365_Fields",
9803     "group": "Dynamics365_Fields",
9804     "parameter": {
9805       "fields": {
9806         "Body": [
9807           {
9808             "group": "Body",
9809             "type": "String",
9810             "allowedValues": [
9811               "\"string\"",
9812               "\"variable\"",
9813               "\"customVariable\"",
9814               "\"keyValue\"",
9815               "\"picklist\""
9816             ],
9817             "optional": true,
9818             "field": "type",
9819             "description": ""
9820           },
9821           {
9822             "group": "Body",
9823             "type": "String",
9824             "optional": true,
9825             "field": "content",
9826             "description": ""
9827           },
9828           {
9829             "group": "Body",
9830             "type": "String",
9831             "optional": true,
9832             "field": "key",
9833             "description": ""
9834           },
9835           {
9836             "group": "Body",
9837             "type": "String",
9838             "allowedValues": [
9839               "\"string\"",
9840               "\"variable\"",
9841               "\"customVariable\""
9842             ],
9843             "optional": true,
9844             "field": "keyType",
9845             "description": ""
9846           },
9847           {
9848             "group": "Body",
9849             "type": "String",
9850             "optional": true,
9851             "field": "keyContent",
9852             "description": ""
9853           },
9854           {
9855             "group": "Body",
9856             "type": "String",
9857             "optional": true,
9858             "field": "idField",
9859             "description": ""
9860           },
9861           {
9862             "group": "Body",
9863             "type": "String",
9864             "optional": true,
9865             "field": "nameField",
9866             "description": ""
9867           },
9868           {
9869             "group": "Body",
9870             "type": "Boolean",
9871             "optional": true,
9872             "field": "customField",
9873             "description": ""
9874           },
9875           {
9876             "group": "Body",
9877             "type": "String",
9878             "optional": true,
9879             "field": "variableName",
9880             "description": ""
9881           }
9882         ]
9883       }
9884     },
9885     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9886     "version": "0.0.0",
9887     "filename": "server/api/intDynamics365Field/index.js",
9888     "groupTitle": "Dynamics365_Fields"
9889   },
9890   {
9891     "type": "delete",
9892     "url": "/api/integrations/dynamics365/fields/{id}",
9893     "title": "Deletes a Dynamics365 Field",
9894     "examples": [
9895       {
9896         "title": "Example usage:",
9897         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9898         "type": "json"
9899       }
9900     ],
9901     "name": "DeleteDynamics365_Fields",
9902     "group": "Dynamics365_Fields",
9903     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9904     "version": "0.0.0",
9905     "filename": "server/api/intDynamics365Field/index.js",
9906     "groupTitle": "Dynamics365_Fields"
9907   },
9908   {
9909     "type": "get",
9910     "url": "/api/integrations/dynamics365/fields",
9911     "title": "Gets a list of Dynamics365 Fields",
9912     "examples": [
9913       {
9914         "title": "Example usage:",
9915         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9916         "type": "json"
9917       }
9918     ],
9919     "name": "GetDynamics365_Fields",
9920     "group": "Dynamics365_Fields",
9921     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9922     "version": "0.0.0",
9923     "filename": "server/api/intDynamics365Field/index.js",
9924     "groupTitle": "Dynamics365_Fields"
9925   },
9926   {
9927     "type": "get",
9928     "url": "/api/integrations/dynamics365/fields/{id}",
9929     "title": "Gets a single Dynamics365 Field",
9930     "examples": [
9931       {
9932         "title": "Example usage:",
9933         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9934         "type": "json"
9935       }
9936     ],
9937     "name": "ShowDynamics365_Fields",
9938     "group": "Dynamics365_Fields",
9939     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9940     "version": "0.0.0",
9941     "filename": "server/api/intDynamics365Field/index.js",
9942     "groupTitle": "Dynamics365_Fields"
9943   },
9944   {
9945     "type": "put",
9946     "url": "/api/integrations/dynamics365/fields/{id}",
9947     "title": "Update an existing Dynamics365 Field",
9948     "examples": [
9949       {
9950         "title": "Example usage:",
9951         "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",
9952         "type": "json"
9953       }
9954     ],
9955     "name": "updateDynamics365_Fields",
9956     "group": "Dynamics365_Fields",
9957     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9958     "version": "0.0.0",
9959     "filename": "server/api/intDynamics365Field/index.js",
9960     "groupTitle": "Dynamics365_Fields"
9961   },
9962   {
9963     "type": "post",
9964     "url": "/api/fax/accounts/{id}/users",
9965     "title": "Add agents to a fax account",
9966     "examples": [
9967       {
9968         "title": "Example usage:",
9969         "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",
9970         "type": "json"
9971       }
9972     ],
9973     "name": "AddAgents",
9974     "group": "Fax_Accounts",
9975     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9976     "version": "0.0.0",
9977     "filename": "server/api/faxAccount/index.js",
9978     "groupTitle": "Fax_Accounts"
9979   },
9980   {
9981     "type": "post",
9982     "url": "/api/fax/accounts",
9983     "title": "Creates a new Account",
9984     "examples": [
9985       {
9986         "title": "Example usage:",
9987         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9988         "type": "json"
9989       }
9990     ],
9991     "name": "CreateAccounts",
9992     "group": "Fax_Accounts",
9993     "parameter": {
9994       "fields": {
9995         "Body": [
9996           {
9997             "group": "Body",
9998             "type": "String",
9999             "optional": false,
10000             "field": "name",
10001             "description": ""
10002           },
10003           {
10004             "group": "Body",
10005             "type": "String",
10006             "optional": true,
10007             "field": "description",
10008             "description": ""
10009           },
10010           {
10011             "group": "Body",
10012             "type": "String",
10013             "allowedValues": [
10014               "\"yes\"",
10015               "\"no\""
10016             ],
10017             "optional": true,
10018             "field": "ecm",
10019             "description": ""
10020           },
10021           {
10022             "group": "Body",
10023             "type": "String",
10024             "optional": true,
10025             "field": "headerinfo",
10026             "description": ""
10027           },
10028           {
10029             "group": "Body",
10030             "type": "String",
10031             "optional": true,
10032             "field": "localstationid",
10033             "description": ""
10034           },
10035           {
10036             "group": "Body",
10037             "type": "String",
10038             "allowedValues": [
10039               "\"2400\"",
10040               "\"4800\"",
10041               "\"7200\"",
10042               "\"9600\"",
10043               "\"12000\"",
10044               "\"14400\""
10045             ],
10046             "optional": true,
10047             "field": "minrate",
10048             "description": ""
10049           },
10050           {
10051             "group": "Body",
10052             "type": "String",
10053             "allowedValues": [
10054               "\"2400\"",
10055               "\"4800\"",
10056               "\"7200\"",
10057               "\"9600\"",
10058               "\"12000\"",
10059               "\"14400\""
10060             ],
10061             "optional": true,
10062             "field": "maxrate",
10063             "description": ""
10064           },
10065           {
10066             "group": "Body",
10067             "type": "String",
10068             "optional": true,
10069             "field": "modem",
10070             "description": ""
10071           },
10072           {
10073             "group": "Body",
10074             "type": "String",
10075             "optional": true,
10076             "field": "gateway",
10077             "description": ""
10078           },
10079           {
10080             "group": "Body",
10081             "type": "String",
10082             "optional": true,
10083             "field": "faxdetect",
10084             "description": ""
10085           },
10086           {
10087             "group": "Body",
10088             "type": "Integer",
10089             "optional": true,
10090             "field": "t38timeout",
10091             "description": ""
10092           },
10093           {
10094             "group": "Body",
10095             "type": "String",
10096             "allowedValues": [
10097               "\"SIP\"",
10098               "\"IAX\"",
10099               "\"DADHI\"",
10100               "\"KHOMP\""
10101             ],
10102             "optional": true,
10103             "field": "tech",
10104             "description": ""
10105           },
10106           {
10107             "group": "Body",
10108             "type": "String",
10109             "optional": false,
10110             "field": "key",
10111             "description": ""
10112           },
10113           {
10114             "group": "Body",
10115             "type": "Text",
10116             "optional": true,
10117             "field": "notificationTemplate",
10118             "description": ""
10119           },
10120           {
10121             "group": "Body",
10122             "type": "Boolean",
10123             "optional": true,
10124             "field": "notificationSound",
10125             "description": ""
10126           },
10127           {
10128             "group": "Body",
10129             "type": "Boolean",
10130             "optional": true,
10131             "field": "notificationShake",
10132             "description": ""
10133           },
10134           {
10135             "group": "Body",
10136             "type": "Integer",
10137             "optional": true,
10138             "field": "waitForTheAssignedAgent",
10139             "description": ""
10140           },
10141           {
10142             "group": "Body",
10143             "type": "Boolean",
10144             "optional": true,
10145             "field": "queueTransfer",
10146             "description": ""
10147           },
10148           {
10149             "group": "Body",
10150             "type": "Integer",
10151             "optional": true,
10152             "field": "queueTransferTimeout",
10153             "description": ""
10154           },
10155           {
10156             "group": "Body",
10157             "type": "Boolean",
10158             "optional": true,
10159             "field": "agentTransfer",
10160             "description": ""
10161           },
10162           {
10163             "group": "Body",
10164             "type": "Integer",
10165             "optional": true,
10166             "field": "agentTransferTimeout",
10167             "description": ""
10168           },
10169           {
10170             "group": "Body",
10171             "type": "Integer",
10172             "optional": true,
10173             "field": "mandatoryDispositionPauseId",
10174             "description": "<p>Status to put when mandatory disposition is enabled</p>"
10175           },
10176           {
10177             "group": "Body",
10178             "type": "Boolean",
10179             "optional": true,
10180             "field": "mandatoryDisposition",
10181             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
10182           }
10183         ]
10184       }
10185     },
10186     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10187     "version": "0.0.0",
10188     "filename": "server/api/faxAccount/index.js",
10189     "groupTitle": "Fax_Accounts"
10190   },
10191   {
10192     "type": "delete",
10193     "url": "/api/fax/accounts/{id}",
10194     "title": "Deletes a Account",
10195     "examples": [
10196       {
10197         "title": "Example usage:",
10198         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
10199         "type": "json"
10200       }
10201     ],
10202     "name": "DeleteAccounts",
10203     "group": "Fax_Accounts",
10204     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10205     "version": "0.0.0",
10206     "filename": "server/api/faxAccount/index.js",
10207     "groupTitle": "Fax_Accounts"
10208   },
10209   {
10210     "type": "get",
10211     "url": "/api/fax/accounts/describe",
10212     "title": "Gets table info about Accounts",
10213     "examples": [
10214       {
10215         "title": "Example usage:",
10216         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
10217         "type": "json"
10218       }
10219     ],
10220     "name": "DescribeAccounts",
10221     "group": "Fax_Accounts",
10222     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10223     "version": "0.0.0",
10224     "filename": "server/api/faxAccount/index.js",
10225     "groupTitle": "Fax_Accounts"
10226   },
10227   {
10228     "type": "get",
10229     "url": "/api/fax/accounts",
10230     "title": "Gets a list of Accounts",
10231     "examples": [
10232       {
10233         "title": "Example usage:",
10234         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
10235         "type": "json"
10236       }
10237     ],
10238     "name": "GetAccounts",
10239     "group": "Fax_Accounts",
10240     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10241     "version": "0.0.0",
10242     "filename": "server/api/faxAccount/index.js",
10243     "groupTitle": "Fax_Accounts"
10244   },
10245   {
10246     "type": "get",
10247     "url": "/api/fax/accounts/{id}/users",
10248     "title": "Gets agents from fax account",
10249     "examples": [
10250       {
10251         "title": "Example usage:",
10252         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
10253         "type": "json"
10254       }
10255     ],
10256     "name": "GetAgents",
10257     "group": "Fax_Accounts",
10258     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10259     "version": "0.0.0",
10260     "filename": "server/api/faxAccount/index.js",
10261     "groupTitle": "Fax_Accounts"
10262   },
10263   {
10264     "type": "delete",
10265     "url": "/api/fax/accounts/{id}/users",
10266     "title": "Removes agents from a fax account",
10267     "examples": [
10268       {
10269         "title": "Example usage:",
10270         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10271         "type": "json"
10272       }
10273     ],
10274     "name": "RemoveAgents",
10275     "group": "Fax_Accounts",
10276     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10277     "version": "0.0.0",
10278     "filename": "server/api/faxAccount/index.js",
10279     "groupTitle": "Fax_Accounts"
10280   },
10281   {
10282     "type": "delete",
10283     "url": "/api/fax/accounts/{id}/canned_answers",
10284     "title": "Removes canned answers from account",
10285     "examples": [
10286       {
10287         "title": "Example usage:",
10288         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10289         "type": "json"
10290       }
10291     ],
10292     "name": "RemoveAnswers",
10293     "group": "Fax_Accounts",
10294     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10295     "version": "0.0.0",
10296     "filename": "server/api/faxAccount/index.js",
10297     "groupTitle": "Fax_Accounts"
10298   },
10299   {
10300     "type": "delete",
10301     "url": "/api/fax/accounts/{id}/dispositions",
10302     "title": "Removes dispositions from account",
10303     "examples": [
10304       {
10305         "title": "Example usage:",
10306         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10307         "type": "json"
10308       }
10309     ],
10310     "name": "RemoveDispositions",
10311     "group": "Fax_Accounts",
10312     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10313     "version": "0.0.0",
10314     "filename": "server/api/faxAccount/index.js",
10315     "groupTitle": "Fax_Accounts"
10316   },
10317   {
10318     "type": "get",
10319     "url": "/api/fax/accounts/{id}",
10320     "title": "Gets a single Account",
10321     "examples": [
10322       {
10323         "title": "Example usage:",
10324         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
10325         "type": "json"
10326       }
10327     ],
10328     "name": "ShowAccounts",
10329     "group": "Fax_Accounts",
10330     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10331     "version": "0.0.0",
10332     "filename": "server/api/faxAccount/index.js",
10333     "groupTitle": "Fax_Accounts"
10334   },
10335   {
10336     "type": "post",
10337     "url": "/api/fax/accounts/{id}/canned_answers",
10338     "title": "Creates new canned answer",
10339     "examples": [
10340       {
10341         "title": "Example usage:",
10342         "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",
10343         "type": "json"
10344       }
10345     ],
10346     "name": "addAnswer",
10347     "group": "Fax_Accounts",
10348     "parameter": {
10349       "fields": {
10350         "Body": [
10351           {
10352             "group": "Body",
10353             "type": "String",
10354             "optional": false,
10355             "field": "key",
10356             "description": ""
10357           },
10358           {
10359             "group": "Body",
10360             "type": "Text",
10361             "optional": false,
10362             "field": "value",
10363             "description": ""
10364           },
10365           {
10366             "group": "Body",
10367             "type": "String",
10368             "optional": true,
10369             "field": "description",
10370             "description": ""
10371           },
10372           {
10373             "group": "Body",
10374             "type": "Virtual",
10375             "optional": true,
10376             "field": "name",
10377             "description": ""
10378           }
10379         ]
10380       }
10381     },
10382     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10383     "version": "0.0.0",
10384     "filename": "server/api/faxAccount/index.js",
10385     "groupTitle": "Fax_Accounts"
10386   },
10387   {
10388     "type": "post",
10389     "url": "/api/fax/accounts/addaccountapplications",
10390     "title": "Creates new account and applications",
10391     "examples": [
10392       {
10393         "title": "Example usage:",
10394         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10395         "type": "json"
10396       }
10397     ],
10398     "name": "addApplications",
10399     "group": "Fax_Accounts",
10400     "parameter": {
10401       "fields": {
10402         "Body": [
10403           {
10404             "group": "Body",
10405             "type": "Integer",
10406             "optional": false,
10407             "field": "priority",
10408             "description": ""
10409           },
10410           {
10411             "group": "Body",
10412             "type": "String",
10413             "optional": false,
10414             "field": "app",
10415             "description": ""
10416           },
10417           {
10418             "group": "Body",
10419             "type": "Text",
10420             "optional": true,
10421             "field": "appdata",
10422             "description": ""
10423           },
10424           {
10425             "group": "Body",
10426             "type": "String",
10427             "optional": true,
10428             "field": "description",
10429             "description": ""
10430           },
10431           {
10432             "group": "Body",
10433             "type": "String",
10434             "optional": true,
10435             "field": "interval",
10436             "description": ""
10437           }
10438         ]
10439       }
10440     },
10441     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10442     "version": "0.0.0",
10443     "filename": "server/api/faxAccount/index.js",
10444     "groupTitle": "Fax_Accounts"
10445   },
10446   {
10447     "type": "post",
10448     "url": "/api/fax/accounts/{id}/applications",
10449     "title": "Creates new applications",
10450     "examples": [
10451       {
10452         "title": "Example usage:",
10453         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10454         "type": "json"
10455       }
10456     ],
10457     "name": "addApplications",
10458     "group": "Fax_Accounts",
10459     "parameter": {
10460       "fields": {
10461         "Body": [
10462           {
10463             "group": "Body",
10464             "type": "Integer",
10465             "optional": false,
10466             "field": "priority",
10467             "description": ""
10468           },
10469           {
10470             "group": "Body",
10471             "type": "String",
10472             "optional": false,
10473             "field": "app",
10474             "description": ""
10475           },
10476           {
10477             "group": "Body",
10478             "type": "Text",
10479             "optional": true,
10480             "field": "appdata",
10481             "description": ""
10482           },
10483           {
10484             "group": "Body",
10485             "type": "String",
10486             "optional": true,
10487             "field": "description",
10488             "description": ""
10489           },
10490           {
10491             "group": "Body",
10492             "type": "String",
10493             "optional": true,
10494             "field": "interval",
10495             "description": ""
10496           }
10497         ]
10498       }
10499     },
10500     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10501     "version": "0.0.0",
10502     "filename": "server/api/faxAccount/index.js",
10503     "groupTitle": "Fax_Accounts"
10504   },
10505   {
10506     "type": "post",
10507     "url": "/api/fax/accounts/{id}/dispositions",
10508     "title": "Creates new disposition",
10509     "examples": [
10510       {
10511         "title": "Example usage:",
10512         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10513         "type": "json"
10514       }
10515     ],
10516     "name": "addDisposition",
10517     "group": "Fax_Accounts",
10518     "parameter": {
10519       "fields": {
10520         "Body": [
10521           {
10522             "group": "Body",
10523             "type": "String",
10524             "optional": false,
10525             "field": "name",
10526             "description": ""
10527           },
10528           {
10529             "group": "Body",
10530             "type": "String",
10531             "allowedValues": [
10532               "\"first\"",
10533               "\"second\"",
10534               "\"third\""
10535             ],
10536             "optional": false,
10537             "field": "level",
10538             "description": ""
10539           },
10540           {
10541             "group": "Body",
10542             "type": "String",
10543             "optional": true,
10544             "field": "description",
10545             "description": ""
10546           }
10547         ]
10548       }
10549     },
10550     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10551     "version": "0.0.0",
10552     "filename": "server/api/faxAccount/index.js",
10553     "groupTitle": "Fax_Accounts"
10554   },
10555   {
10556     "type": "post",
10557     "url": "/api/fax/accounts/{id}/interactions",
10558     "title": "Creates new interactions",
10559     "examples": [
10560       {
10561         "title": "Example usage:",
10562         "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",
10563         "type": "json"
10564       }
10565     ],
10566     "name": "addInteraction",
10567     "group": "Fax_Accounts",
10568     "parameter": {
10569       "fields": {
10570         "Body": [
10571           {
10572             "group": "Body",
10573             "type": "Boolean",
10574             "optional": true,
10575             "field": "closed",
10576             "description": ""
10577           },
10578           {
10579             "group": "Body",
10580             "type": "String",
10581             "optional": true,
10582             "field": "closedAt",
10583             "description": ""
10584           },
10585           {
10586             "group": "Body",
10587             "type": "String",
10588             "optional": true,
10589             "field": "disposition",
10590             "description": ""
10591           },
10592           {
10593             "group": "Body",
10594             "type": "String",
10595             "optional": true,
10596             "field": "secondDisposition",
10597             "description": ""
10598           },
10599           {
10600             "group": "Body",
10601             "type": "String",
10602             "optional": true,
10603             "field": "thirdDisposition",
10604             "description": ""
10605           },
10606           {
10607             "group": "Body",
10608             "type": "String",
10609             "optional": true,
10610             "field": "note",
10611             "description": ""
10612           },
10613           {
10614             "group": "Body",
10615             "type": "String",
10616             "optional": true,
10617             "field": "read1stAt",
10618             "description": ""
10619           },
10620           {
10621             "group": "Body",
10622             "type": "String",
10623             "optional": true,
10624             "field": "fax",
10625             "description": ""
10626           },
10627           {
10628             "group": "Body",
10629             "type": "String",
10630             "allowedValues": [
10631               "\"in\"",
10632               "\"out\""
10633             ],
10634             "optional": false,
10635             "field": "firstMsgDirection",
10636             "description": ""
10637           },
10638           {
10639             "group": "Body",
10640             "type": "String",
10641             "optional": true,
10642             "field": "lastMsgAt",
10643             "description": ""
10644           },
10645           {
10646             "group": "Body",
10647             "type": "String",
10648             "allowedValues": [
10649               "\"in\"",
10650               "\"out\""
10651             ],
10652             "optional": false,
10653             "field": "lastMsgDirection",
10654             "description": ""
10655           }
10656         ]
10657       }
10658     },
10659     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10660     "version": "0.0.0",
10661     "filename": "server/api/faxAccount/index.js",
10662     "groupTitle": "Fax_Accounts"
10663   },
10664   {
10665     "type": "get",
10666     "url": "/api/fax/accounts/{id}/canned_answers",
10667     "title": "Gets account canned answers",
10668     "examples": [
10669       {
10670         "title": "Example usage:",
10671         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10672         "type": "json"
10673       }
10674     ],
10675     "name": "getAnswers",
10676     "group": "Fax_Accounts",
10677     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10678     "version": "0.0.0",
10679     "filename": "server/api/faxAccount/index.js",
10680     "groupTitle": "Fax_Accounts"
10681   },
10682   {
10683     "type": "get",
10684     "url": "/api/fax/accounts/{id}/applications",
10685     "title": "Gets account pplications",
10686     "examples": [
10687       {
10688         "title": "Example usage:",
10689         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10690         "type": "json"
10691       }
10692     ],
10693     "name": "getApplications",
10694     "group": "Fax_Accounts",
10695     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10696     "version": "0.0.0",
10697     "filename": "server/api/faxAccount/index.js",
10698     "groupTitle": "Fax_Accounts"
10699   },
10700   {
10701     "type": "get",
10702     "url": "/api/fax/accounts/{id}/dispositions",
10703     "title": "Gets account dispositions",
10704     "examples": [
10705       {
10706         "title": "Example usage:",
10707         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10708         "type": "json"
10709       }
10710     ],
10711     "name": "getDispositions",
10712     "group": "Fax_Accounts",
10713     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10714     "version": "0.0.0",
10715     "filename": "server/api/faxAccount/index.js",
10716     "groupTitle": "Fax_Accounts"
10717   },
10718   {
10719     "type": "get",
10720     "url": "/api/fax/accounts/{id}/interactions",
10721     "title": "Gets account interactions",
10722     "examples": [
10723       {
10724         "title": "Example usage:",
10725         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10726         "type": "json"
10727       }
10728     ],
10729     "name": "getInteraction",
10730     "group": "Fax_Accounts",
10731     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10732     "version": "0.0.0",
10733     "filename": "server/api/faxAccount/index.js",
10734     "groupTitle": "Fax_Accounts"
10735   },
10736   {
10737     "type": "get",
10738     "url": "/api/fax/accounts/{id}/messages",
10739     "title": "Gets account messages",
10740     "examples": [
10741       {
10742         "title": "Example usage:",
10743         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10744         "type": "json"
10745       }
10746     ],
10747     "name": "getMessages",
10748     "group": "Fax_Accounts",
10749     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10750     "version": "0.0.0",
10751     "filename": "server/api/faxAccount/index.js",
10752     "groupTitle": "Fax_Accounts"
10753   },
10754   {
10755     "type": "post",
10756     "url": "/api/fax/accounts/{id}/send",
10757     "title": "Send new fax",
10758     "examples": [
10759       {
10760         "title": "Example usage:",
10761         "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",
10762         "type": "json"
10763       }
10764     ],
10765     "name": "sendFax",
10766     "group": "Fax_Accounts",
10767     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10768     "version": "0.0.0",
10769     "filename": "server/api/faxAccount/index.js",
10770     "groupTitle": "Fax_Accounts"
10771   },
10772   {
10773     "type": "put",
10774     "url": "/api/fax/accounts/{id}",
10775     "title": "Update an existing Account",
10776     "examples": [
10777       {
10778         "title": "Example usage:",
10779         "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",
10780         "type": "json"
10781       }
10782     ],
10783     "name": "updateAccounts",
10784     "group": "Fax_Accounts",
10785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10786     "version": "0.0.0",
10787     "filename": "server/api/faxAccount/index.js",
10788     "groupTitle": "Fax_Accounts"
10789   },
10790   {
10791     "type": "post",
10792     "url": "/api/fax/accounts/updateaccountapplications",
10793     "title": "Update account and applications",
10794     "examples": [
10795       {
10796         "title": "Example usage:",
10797         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10798         "type": "json"
10799       }
10800     ],
10801     "name": "updateApplications",
10802     "group": "Fax_Accounts",
10803     "parameter": {
10804       "fields": {
10805         "Body": [
10806           {
10807             "group": "Body",
10808             "type": "Integer",
10809             "optional": false,
10810             "field": "priority",
10811             "description": ""
10812           },
10813           {
10814             "group": "Body",
10815             "type": "String",
10816             "optional": false,
10817             "field": "app",
10818             "description": ""
10819           },
10820           {
10821             "group": "Body",
10822             "type": "Text",
10823             "optional": true,
10824             "field": "appdata",
10825             "description": ""
10826           },
10827           {
10828             "group": "Body",
10829             "type": "String",
10830             "optional": true,
10831             "field": "description",
10832             "description": ""
10833           },
10834           {
10835             "group": "Body",
10836             "type": "String",
10837             "optional": true,
10838             "field": "interval",
10839             "description": ""
10840           }
10841         ]
10842       }
10843     },
10844     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10845     "version": "0.0.0",
10846     "filename": "server/api/faxAccount/index.js",
10847     "groupTitle": "Fax_Accounts"
10848   },
10849   {
10850     "type": "post",
10851     "url": "/api/fax/applications",
10852     "title": "Creates a new Application",
10853     "examples": [
10854       {
10855         "title": "Example usage:",
10856         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10857         "type": "json"
10858       }
10859     ],
10860     "name": "CreateApplications",
10861     "group": "Fax_Applications",
10862     "parameter": {
10863       "fields": {
10864         "Body": [
10865           {
10866             "group": "Body",
10867             "type": "Integer",
10868             "optional": false,
10869             "field": "priority",
10870             "description": ""
10871           },
10872           {
10873             "group": "Body",
10874             "type": "String",
10875             "optional": false,
10876             "field": "app",
10877             "description": ""
10878           },
10879           {
10880             "group": "Body",
10881             "type": "Text",
10882             "optional": true,
10883             "field": "appdata",
10884             "description": ""
10885           },
10886           {
10887             "group": "Body",
10888             "type": "String",
10889             "optional": true,
10890             "field": "description",
10891             "description": ""
10892           },
10893           {
10894             "group": "Body",
10895             "type": "String",
10896             "optional": true,
10897             "field": "interval",
10898             "description": ""
10899           }
10900         ]
10901       }
10902     },
10903     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10904     "version": "0.0.0",
10905     "filename": "server/api/faxApplication/index.js",
10906     "groupTitle": "Fax_Applications"
10907   },
10908   {
10909     "type": "delete",
10910     "url": "/api/fax/applications/{id}",
10911     "title": "Deletes a Application",
10912     "examples": [
10913       {
10914         "title": "Example usage:",
10915         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10916         "type": "json"
10917       }
10918     ],
10919     "name": "DeleteApplications",
10920     "group": "Fax_Applications",
10921     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10922     "version": "0.0.0",
10923     "filename": "server/api/faxApplication/index.js",
10924     "groupTitle": "Fax_Applications"
10925   },
10926   {
10927     "type": "get",
10928     "url": "/api/fax/applications",
10929     "title": "Gets a list of Applications",
10930     "examples": [
10931       {
10932         "title": "Example usage:",
10933         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10934         "type": "json"
10935       }
10936     ],
10937     "name": "GetApplications",
10938     "group": "Fax_Applications",
10939     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10940     "version": "0.0.0",
10941     "filename": "server/api/faxApplication/index.js",
10942     "groupTitle": "Fax_Applications"
10943   },
10944   {
10945     "type": "get",
10946     "url": "/api/fax/applications/{id}",
10947     "title": "Gets a single Application",
10948     "examples": [
10949       {
10950         "title": "Example usage:",
10951         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10952         "type": "json"
10953       }
10954     ],
10955     "name": "ShowApplications",
10956     "group": "Fax_Applications",
10957     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10958     "version": "0.0.0",
10959     "filename": "server/api/faxApplication/index.js",
10960     "groupTitle": "Fax_Applications"
10961   },
10962   {
10963     "type": "put",
10964     "url": "/api/fax/applications/{id}",
10965     "title": "Update an existing Application",
10966     "examples": [
10967       {
10968         "title": "Example usage:",
10969         "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",
10970         "type": "json"
10971       }
10972     ],
10973     "name": "updateApplications",
10974     "group": "Fax_Applications",
10975     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10976     "version": "0.0.0",
10977     "filename": "server/api/faxApplication/index.js",
10978     "groupTitle": "Fax_Applications"
10979   },
10980   {
10981     "type": "post",
10982     "url": "/api/fax/interactions/{id}/tags",
10983     "title": "Add tags to the interaction",
10984     "examples": [
10985       {
10986         "title": "Example usage:",
10987         "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",
10988         "type": "json"
10989       }
10990     ],
10991     "name": "AddTags",
10992     "group": "Fax_Interactions",
10993     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10994     "version": "0.0.0",
10995     "filename": "server/api/faxInteraction/index.js",
10996     "groupTitle": "Fax_Interactions"
10997   },
10998   {
10999     "type": "post",
11000     "url": "/api/fax/interactions",
11001     "title": "Creates a new Interaction",
11002     "examples": [
11003       {
11004         "title": "Example usage:",
11005         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11006         "type": "json"
11007       }
11008     ],
11009     "name": "CreateInteractions",
11010     "group": "Fax_Interactions",
11011     "parameter": {
11012       "fields": {
11013         "Body": [
11014           {
11015             "group": "Body",
11016             "type": "Boolean",
11017             "optional": true,
11018             "field": "closed",
11019             "description": ""
11020           },
11021           {
11022             "group": "Body",
11023             "type": "String",
11024             "optional": true,
11025             "field": "closedAt",
11026             "description": ""
11027           },
11028           {
11029             "group": "Body",
11030             "type": "String",
11031             "optional": true,
11032             "field": "disposition",
11033             "description": ""
11034           },
11035           {
11036             "group": "Body",
11037             "type": "String",
11038             "optional": true,
11039             "field": "secondDisposition",
11040             "description": ""
11041           },
11042           {
11043             "group": "Body",
11044             "type": "String",
11045             "optional": true,
11046             "field": "thirdDisposition",
11047             "description": ""
11048           },
11049           {
11050             "group": "Body",
11051             "type": "String",
11052             "optional": true,
11053             "field": "note",
11054             "description": ""
11055           },
11056           {
11057             "group": "Body",
11058             "type": "String",
11059             "optional": true,
11060             "field": "read1stAt",
11061             "description": ""
11062           },
11063           {
11064             "group": "Body",
11065             "type": "String",
11066             "optional": true,
11067             "field": "fax",
11068             "description": ""
11069           },
11070           {
11071             "group": "Body",
11072             "type": "String",
11073             "allowedValues": [
11074               "\"in\"",
11075               "\"out\""
11076             ],
11077             "optional": false,
11078             "field": "firstMsgDirection",
11079             "description": ""
11080           },
11081           {
11082             "group": "Body",
11083             "type": "String",
11084             "optional": true,
11085             "field": "lastMsgAt",
11086             "description": ""
11087           },
11088           {
11089             "group": "Body",
11090             "type": "String",
11091             "allowedValues": [
11092               "\"in\"",
11093               "\"out\""
11094             ],
11095             "optional": false,
11096             "field": "lastMsgDirection",
11097             "description": ""
11098           }
11099         ]
11100       }
11101     },
11102     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11103     "version": "0.0.0",
11104     "filename": "server/api/faxInteraction/index.js",
11105     "groupTitle": "Fax_Interactions"
11106   },
11107   {
11108     "type": "delete",
11109     "url": "/api/fax/interactions/{id}",
11110     "title": "Deletes a Interaction",
11111     "examples": [
11112       {
11113         "title": "Example usage:",
11114         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
11115         "type": "json"
11116       }
11117     ],
11118     "name": "DeleteInteractions",
11119     "group": "Fax_Interactions",
11120     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11121     "version": "0.0.0",
11122     "filename": "server/api/faxInteraction/index.js",
11123     "groupTitle": "Fax_Interactions"
11124   },
11125   {
11126     "type": "get",
11127     "url": "/api/fax/interactions/describe",
11128     "title": "Gets table info about Interactions",
11129     "examples": [
11130       {
11131         "title": "Example usage:",
11132         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
11133         "type": "json"
11134       }
11135     ],
11136     "name": "DescribeInteractions",
11137     "group": "Fax_Interactions",
11138     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11139     "version": "0.0.0",
11140     "filename": "server/api/faxInteraction/index.js",
11141     "groupTitle": "Fax_Interactions"
11142   },
11143   {
11144     "type": "get",
11145     "url": "/api/fax/interactions",
11146     "title": "Gets a list of Interactions",
11147     "examples": [
11148       {
11149         "title": "Example usage:",
11150         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
11151         "type": "json"
11152       }
11153     ],
11154     "name": "GetInteractions",
11155     "group": "Fax_Interactions",
11156     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11157     "version": "0.0.0",
11158     "filename": "server/api/faxInteraction/index.js",
11159     "groupTitle": "Fax_Interactions"
11160   },
11161   {
11162     "type": "delete",
11163     "url": "/api/fax/interactions/{id}/tags",
11164     "title": "Removes tags from interaction",
11165     "examples": [
11166       {
11167         "title": "Example usage:",
11168         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11169         "type": "json"
11170       }
11171     ],
11172     "name": "RemoveTags",
11173     "group": "Fax_Interactions",
11174     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11175     "version": "0.0.0",
11176     "filename": "server/api/faxInteraction/index.js",
11177     "groupTitle": "Fax_Interactions"
11178   },
11179   {
11180     "type": "get",
11181     "url": "/api/fax/interactions/{id}",
11182     "title": "Gets a single Interaction",
11183     "examples": [
11184       {
11185         "title": "Example usage:",
11186         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
11187         "type": "json"
11188       }
11189     ],
11190     "name": "ShowInteractions",
11191     "group": "Fax_Interactions",
11192     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11193     "version": "0.0.0",
11194     "filename": "server/api/faxInteraction/index.js",
11195     "groupTitle": "Fax_Interactions"
11196   },
11197   {
11198     "type": "post",
11199     "url": "/api/fax/interactions/{id}/messages",
11200     "title": "Creates new messages",
11201     "examples": [
11202       {
11203         "title": "Example usage:",
11204         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
11205         "type": "json"
11206       }
11207     ],
11208     "name": "addMessage",
11209     "group": "Fax_Interactions",
11210     "parameter": {
11211       "fields": {
11212         "Body": [
11213           {
11214             "group": "Body",
11215             "type": "Text",
11216             "optional": false,
11217             "field": "body",
11218             "description": ""
11219           },
11220           {
11221             "group": "Body",
11222             "type": "Boolean",
11223             "optional": true,
11224             "field": "read",
11225             "description": ""
11226           },
11227           {
11228             "group": "Body",
11229             "type": "String",
11230             "allowedValues": [
11231               "\"in\"",
11232               "\"out\""
11233             ],
11234             "optional": false,
11235             "field": "direction",
11236             "description": ""
11237           },
11238           {
11239             "group": "Body",
11240             "type": "Text",
11241             "optional": true,
11242             "field": "failMessage",
11243             "description": ""
11244           },
11245           {
11246             "group": "Body",
11247             "type": "String",
11248             "optional": true,
11249             "field": "readAt",
11250             "description": ""
11251           }
11252         ]
11253       }
11254     },
11255     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11256     "version": "0.0.0",
11257     "filename": "server/api/faxInteraction/index.js",
11258     "groupTitle": "Fax_Interactions"
11259   },
11260   {
11261     "type": "get",
11262     "url": "/api/fax/interactions/{id}/download",
11263     "title": "Get interactions",
11264     "examples": [
11265       {
11266         "title": "Example usage:",
11267         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
11268         "type": "json"
11269       }
11270     ],
11271     "name": "download",
11272     "group": "Fax_Interactions",
11273     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11274     "version": "0.0.0",
11275     "filename": "server/api/faxInteraction/index.js",
11276     "groupTitle": "Fax_Interactions"
11277   },
11278   {
11279     "type": "get",
11280     "url": "/api/fax/interactions/{id}/messages",
11281     "title": "Gets interaction messages",
11282     "examples": [
11283       {
11284         "title": "Example usage:",
11285         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
11286         "type": "json"
11287       }
11288     ],
11289     "name": "getMessages",
11290     "group": "Fax_Interactions",
11291     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11292     "version": "0.0.0",
11293     "filename": "server/api/faxInteraction/index.js",
11294     "groupTitle": "Fax_Interactions"
11295   },
11296   {
11297     "type": "put",
11298     "url": "/api/fax/interactions/{id}",
11299     "title": "Update an existing Interaction",
11300     "examples": [
11301       {
11302         "title": "Example usage:",
11303         "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",
11304         "type": "json"
11305       }
11306     ],
11307     "name": "updateInteractions",
11308     "group": "Fax_Interactions",
11309     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11310     "version": "0.0.0",
11311     "filename": "server/api/faxInteraction/index.js",
11312     "groupTitle": "Fax_Interactions"
11313   },
11314   {
11315     "type": "get",
11316     "url": "/api/fax/messages/{id}/download",
11317     "title": "Get message",
11318     "examples": [
11319       {
11320         "title": "Example usage:",
11321         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
11322         "type": "json"
11323       }
11324     ],
11325     "name": "download",
11326     "group": "Fax_Message",
11327     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11328     "version": "0.0.0",
11329     "filename": "server/api/faxMessage/index.js",
11330     "groupTitle": "Fax_Message"
11331   },
11332   {
11333     "type": "delete",
11334     "url": "/api/fax/messages/{id}",
11335     "title": "Deletes a Message",
11336     "examples": [
11337       {
11338         "title": "Example usage:",
11339         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
11340         "type": "json"
11341       }
11342     ],
11343     "name": "DeleteMessages",
11344     "group": "Fax_Messages",
11345     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11346     "version": "0.0.0",
11347     "filename": "server/api/faxMessage/index.js",
11348     "groupTitle": "Fax_Messages"
11349   },
11350   {
11351     "type": "get",
11352     "url": "/api/fax/messages/describe",
11353     "title": "Gets table info about Messages",
11354     "examples": [
11355       {
11356         "title": "Example usage:",
11357         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
11358         "type": "json"
11359       }
11360     ],
11361     "name": "DescribeMessages",
11362     "group": "Fax_Messages",
11363     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11364     "version": "0.0.0",
11365     "filename": "server/api/faxMessage/index.js",
11366     "groupTitle": "Fax_Messages"
11367   },
11368   {
11369     "type": "get",
11370     "url": "/api/fax/messages",
11371     "title": "Gets a list of Messages",
11372     "examples": [
11373       {
11374         "title": "Example usage:",
11375         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
11376         "type": "json"
11377       }
11378     ],
11379     "name": "GetMessages",
11380     "group": "Fax_Messages",
11381     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11382     "version": "0.0.0",
11383     "filename": "server/api/faxMessage/index.js",
11384     "groupTitle": "Fax_Messages"
11385   },
11386   {
11387     "type": "get",
11388     "url": "/api/fax/messages/{id}",
11389     "title": "Gets a single Message",
11390     "examples": [
11391       {
11392         "title": "Example usage:",
11393         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
11394         "type": "json"
11395       }
11396     ],
11397     "name": "ShowMessages",
11398     "group": "Fax_Messages",
11399     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11400     "version": "0.0.0",
11401     "filename": "server/api/faxMessage/index.js",
11402     "groupTitle": "Fax_Messages"
11403   },
11404   {
11405     "type": "put",
11406     "url": "/api/fax/messages/{id}/accept",
11407     "title": "Accepts message",
11408     "examples": [
11409       {
11410         "title": "Example usage:",
11411         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11412         "type": "json"
11413       }
11414     ],
11415     "name": "acceptMessage",
11416     "group": "Fax_Messages",
11417     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11418     "version": "0.0.0",
11419     "filename": "server/api/faxMessage/index.js",
11420     "groupTitle": "Fax_Messages"
11421   },
11422   {
11423     "type": "put",
11424     "url": "/api/fax/messages/{id}/reject",
11425     "title": "Rejects message",
11426     "examples": [
11427       {
11428         "title": "Example usage:",
11429         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11430         "type": "json"
11431       }
11432     ],
11433     "name": "rejectMessage",
11434     "group": "Fax_Messages",
11435     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11436     "version": "0.0.0",
11437     "filename": "server/api/faxMessage/index.js",
11438     "groupTitle": "Fax_Messages"
11439   },
11440   {
11441     "type": "post",
11442     "url": "/api/fax/messages",
11443     "title": "Create message and send Fax",
11444     "examples": [
11445       {
11446         "title": "Example usage:",
11447         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
11448         "type": "json"
11449       }
11450     ],
11451     "name": "rejectMessage",
11452     "group": "Fax_Messages",
11453     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11454     "version": "0.0.0",
11455     "filename": "server/api/faxMessage/index.js",
11456     "groupTitle": "Fax_Messages"
11457   },
11458   {
11459     "type": "put",
11460     "url": "/api/fax/messages/{id}",
11461     "title": "Update an existing Message",
11462     "examples": [
11463       {
11464         "title": "Example usage:",
11465         "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",
11466         "type": "json"
11467       }
11468     ],
11469     "name": "updateMessages",
11470     "group": "Fax_Messages",
11471     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11472     "version": "0.0.0",
11473     "filename": "server/api/faxMessage/index.js",
11474     "groupTitle": "Fax_Messages"
11475   },
11476   {
11477     "type": "post",
11478     "url": "/api/fax/reports/queue",
11479     "title": "Creates a new Fax Queue Report",
11480     "examples": [
11481       {
11482         "title": "Example usage:",
11483         "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",
11484         "type": "json"
11485       }
11486     ],
11487     "name": "CreateFax_Queue_Reports",
11488     "group": "Fax_Queue_Reports",
11489     "parameter": {
11490       "fields": {
11491         "Body": [
11492           {
11493             "group": "Body",
11494             "type": "String",
11495             "optional": false,
11496             "field": "uniqueid",
11497             "description": ""
11498           },
11499           {
11500             "group": "Body",
11501             "type": "String",
11502             "optional": true,
11503             "field": "from",
11504             "description": ""
11505           },
11506           {
11507             "group": "Body",
11508             "type": "String",
11509             "optional": true,
11510             "field": "joinAt",
11511             "description": ""
11512           },
11513           {
11514             "group": "Body",
11515             "type": "String",
11516             "optional": true,
11517             "field": "leaveAt",
11518             "description": ""
11519           },
11520           {
11521             "group": "Body",
11522             "type": "String",
11523             "optional": true,
11524             "field": "acceptAt",
11525             "description": ""
11526           },
11527           {
11528             "group": "Body",
11529             "type": "String",
11530             "optional": true,
11531             "field": "exitAt",
11532             "description": ""
11533           },
11534           {
11535             "group": "Body",
11536             "type": "String",
11537             "optional": true,
11538             "field": "reason",
11539             "description": ""
11540           }
11541         ]
11542       }
11543     },
11544     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11545     "version": "0.0.0",
11546     "filename": "server/api/faxQueueReport/index.js",
11547     "groupTitle": "Fax_Queue_Reports"
11548   },
11549   {
11550     "type": "delete",
11551     "url": "/api/fax/reports/queue/{id}",
11552     "title": "Deletes a Fax Queue Report",
11553     "examples": [
11554       {
11555         "title": "Example usage:",
11556         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
11557         "type": "json"
11558       }
11559     ],
11560     "name": "DeleteFax_Queue_Reports",
11561     "group": "Fax_Queue_Reports",
11562     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11563     "version": "0.0.0",
11564     "filename": "server/api/faxQueueReport/index.js",
11565     "groupTitle": "Fax_Queue_Reports"
11566   },
11567   {
11568     "type": "get",
11569     "url": "/api/fax/reports/queue/describe",
11570     "title": "Gets table info about Fax Queue Reports",
11571     "examples": [
11572       {
11573         "title": "Example usage:",
11574         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
11575         "type": "json"
11576       }
11577     ],
11578     "name": "DescribeFax_Queue_Reports",
11579     "group": "Fax_Queue_Reports",
11580     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11581     "version": "0.0.0",
11582     "filename": "server/api/faxQueueReport/index.js",
11583     "groupTitle": "Fax_Queue_Reports"
11584   },
11585   {
11586     "type": "get",
11587     "url": "/api/fax/reports/queue",
11588     "title": "Gets a list of Fax Queue Reports",
11589     "examples": [
11590       {
11591         "title": "Example usage:",
11592         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
11593         "type": "json"
11594       }
11595     ],
11596     "name": "GetFax_Queue_Reports",
11597     "group": "Fax_Queue_Reports",
11598     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11599     "version": "0.0.0",
11600     "filename": "server/api/faxQueueReport/index.js",
11601     "groupTitle": "Fax_Queue_Reports"
11602   },
11603   {
11604     "type": "get",
11605     "url": "/api/fax/reports/queue/{id}",
11606     "title": "Gets a single Fax Queue Report",
11607     "examples": [
11608       {
11609         "title": "Example usage:",
11610         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
11611         "type": "json"
11612       }
11613     ],
11614     "name": "ShowFax_Queue_Reports",
11615     "group": "Fax_Queue_Reports",
11616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11617     "version": "0.0.0",
11618     "filename": "server/api/faxQueueReport/index.js",
11619     "groupTitle": "Fax_Queue_Reports"
11620   },
11621   {
11622     "type": "put",
11623     "url": "/api/fax/reports/queue/{id}",
11624     "title": "Update an existing Fax Queue Report",
11625     "examples": [
11626       {
11627         "title": "Example usage:",
11628         "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",
11629         "type": "json"
11630       }
11631     ],
11632     "name": "updateFax_Queue_Reports",
11633     "group": "Fax_Queue_Reports",
11634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11635     "version": "0.0.0",
11636     "filename": "server/api/faxQueueReport/index.js",
11637     "groupTitle": "Fax_Queue_Reports"
11638   },
11639   {
11640     "type": "post",
11641     "url": "/api/fax/queues/{id}/users",
11642     "title": "Add agents to a queue",
11643     "examples": [
11644       {
11645         "title": "Example usage:",
11646         "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",
11647         "type": "json"
11648       }
11649     ],
11650     "name": "AddAgents",
11651     "group": "Fax_Queues",
11652     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11653     "version": "0.0.0",
11654     "filename": "server/api/faxQueue/index.js",
11655     "groupTitle": "Fax_Queues"
11656   },
11657   {
11658     "type": "post",
11659     "url": "/api/fax/queues/{id}/teams",
11660     "title": "Add teams to a queue",
11661     "examples": [
11662       {
11663         "title": "Example usage:",
11664         "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",
11665         "type": "json"
11666       }
11667     ],
11668     "name": "AddTeams",
11669     "group": "Fax_Queues",
11670     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11671     "version": "0.0.0",
11672     "filename": "server/api/faxQueue/index.js",
11673     "groupTitle": "Fax_Queues"
11674   },
11675   {
11676     "type": "post",
11677     "url": "/api/fax/queues",
11678     "title": "Creates a new Queue",
11679     "examples": [
11680       {
11681         "title": "Example usage:",
11682         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11683         "type": "json"
11684       }
11685     ],
11686     "name": "CreateQueues",
11687     "group": "Fax_Queues",
11688     "parameter": {
11689       "fields": {
11690         "Body": [
11691           {
11692             "group": "Body",
11693             "type": "String",
11694             "optional": false,
11695             "field": "name",
11696             "description": ""
11697           },
11698           {
11699             "group": "Body",
11700             "type": "String",
11701             "optional": true,
11702             "field": "description",
11703             "description": ""
11704           },
11705           {
11706             "group": "Body",
11707             "type": "Integer",
11708             "optional": false,
11709             "field": "timeout",
11710             "description": ""
11711           },
11712           {
11713             "group": "Body",
11714             "type": "String",
11715             "allowedValues": [
11716               "\"rrmemory\"",
11717               "\"beepall\"",
11718               "\"roundrobin\""
11719             ],
11720             "optional": false,
11721             "field": "strategy",
11722             "description": ""
11723           },
11724           {
11725             "group": "Body",
11726             "type": "Integer",
11727             "optional": true,
11728             "field": "lastAgent",
11729             "description": ""
11730           }
11731         ]
11732       }
11733     },
11734     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11735     "version": "0.0.0",
11736     "filename": "server/api/faxQueue/index.js",
11737     "groupTitle": "Fax_Queues"
11738   },
11739   {
11740     "type": "delete",
11741     "url": "/api/fax/queues/{id}",
11742     "title": "Deletes a Queue",
11743     "examples": [
11744       {
11745         "title": "Example usage:",
11746         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11747         "type": "json"
11748       }
11749     ],
11750     "name": "DeleteQueues",
11751     "group": "Fax_Queues",
11752     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11753     "version": "0.0.0",
11754     "filename": "server/api/faxQueue/index.js",
11755     "groupTitle": "Fax_Queues"
11756   },
11757   {
11758     "type": "get",
11759     "url": "/api/fax/queues/describe",
11760     "title": "Gets table info about Queues",
11761     "examples": [
11762       {
11763         "title": "Example usage:",
11764         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11765         "type": "json"
11766       }
11767     ],
11768     "name": "DescribeQueues",
11769     "group": "Fax_Queues",
11770     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11771     "version": "0.0.0",
11772     "filename": "server/api/faxQueue/index.js",
11773     "groupTitle": "Fax_Queues"
11774   },
11775   {
11776     "type": "get",
11777     "url": "/api/fax/queues/{id}/users",
11778     "title": "Gets queue agents",
11779     "examples": [
11780       {
11781         "title": "Example usage:",
11782         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11783         "type": "json"
11784       }
11785     ],
11786     "name": "GetAgents",
11787     "group": "Fax_Queues",
11788     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11789     "version": "0.0.0",
11790     "filename": "server/api/faxQueue/index.js",
11791     "groupTitle": "Fax_Queues"
11792   },
11793   {
11794     "type": "get",
11795     "url": "/api/fax/queues/{id}/members",
11796     "title": "GetMembers",
11797     "examples": [
11798       {
11799         "title": "Example usage:",
11800         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
11801         "type": "json"
11802       }
11803     ],
11804     "name": "GetMembers",
11805     "group": "Fax_Queues",
11806     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11807     "version": "0.0.0",
11808     "filename": "server/api/faxQueue/index.js",
11809     "groupTitle": "Fax_Queues"
11810   },
11811   {
11812     "type": "get",
11813     "url": "/api/fax/queues",
11814     "title": "Gets a list of Queues",
11815     "examples": [
11816       {
11817         "title": "Example usage:",
11818         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11819         "type": "json"
11820       }
11821     ],
11822     "name": "GetQueues",
11823     "group": "Fax_Queues",
11824     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11825     "version": "0.0.0",
11826     "filename": "server/api/faxQueue/index.js",
11827     "groupTitle": "Fax_Queues"
11828   },
11829   {
11830     "type": "get",
11831     "url": "/api/fax/queues/{id}/teams",
11832     "title": "Gets queues list",
11833     "examples": [
11834       {
11835         "title": "Example usage:",
11836         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11837         "type": "json"
11838       }
11839     ],
11840     "name": "GetTeams",
11841     "group": "Fax_Queues",
11842     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11843     "version": "0.0.0",
11844     "filename": "server/api/faxQueue/index.js",
11845     "groupTitle": "Fax_Queues"
11846   },
11847   {
11848     "type": "delete",
11849     "url": "/api/fax/queues/{id}/users",
11850     "title": "Removes agents from a queue",
11851     "examples": [
11852       {
11853         "title": "Example usage:",
11854         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11855         "type": "json"
11856       }
11857     ],
11858     "name": "RemoveAgents",
11859     "group": "Fax_Queues",
11860     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11861     "version": "0.0.0",
11862     "filename": "server/api/faxQueue/index.js",
11863     "groupTitle": "Fax_Queues"
11864   },
11865   {
11866     "type": "get",
11867     "url": "/api/fax/queues/{id}",
11868     "title": "Gets a single Queue",
11869     "examples": [
11870       {
11871         "title": "Example usage:",
11872         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11873         "type": "json"
11874       }
11875     ],
11876     "name": "ShowQueues",
11877     "group": "Fax_Queues",
11878     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11879     "version": "0.0.0",
11880     "filename": "server/api/faxQueue/index.js",
11881     "groupTitle": "Fax_Queues"
11882   },
11883   {
11884     "type": "put",
11885     "url": "/api/fax/queues/{id}",
11886     "title": "Update an existing Queue",
11887     "examples": [
11888       {
11889         "title": "Example usage:",
11890         "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",
11891         "type": "json"
11892       }
11893     ],
11894     "name": "updateQueues",
11895     "group": "Fax_Queues",
11896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11897     "version": "0.0.0",
11898     "filename": "server/api/faxQueue/index.js",
11899     "groupTitle": "Fax_Queues"
11900   },
11901   {
11902     "type": "post",
11903     "url": "/api/fax/reports/transfer",
11904     "title": "Creates a new Fax Transfer Report",
11905     "examples": [
11906       {
11907         "title": "Example usage:",
11908         "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",
11909         "type": "json"
11910       }
11911     ],
11912     "name": "CreateFax_Transfer_Reports",
11913     "group": "Fax_Transfer_Reports",
11914     "parameter": {
11915       "fields": {
11916         "Body": [
11917           {
11918             "group": "Body",
11919             "type": "String",
11920             "optional": false,
11921             "field": "uniqueid",
11922             "description": ""
11923           },
11924           {
11925             "group": "Body",
11926             "type": "String",
11927             "allowedValues": [
11928               "\"account\"",
11929               "\"agent\"",
11930               "\"queue\""
11931             ],
11932             "optional": false,
11933             "field": "type",
11934             "description": ""
11935           },
11936           {
11937             "group": "Body",
11938             "type": "String",
11939             "optional": false,
11940             "field": "transferredAt",
11941             "description": ""
11942           }
11943         ]
11944       }
11945     },
11946     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11947     "version": "0.0.0",
11948     "filename": "server/api/faxTransferReport/index.js",
11949     "groupTitle": "Fax_Transfer_Reports"
11950   },
11951   {
11952     "type": "delete",
11953     "url": "/api/fax/reports/transfer/{id}",
11954     "title": "Deletes a Fax Transfer Report",
11955     "examples": [
11956       {
11957         "title": "Example usage:",
11958         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11959         "type": "json"
11960       }
11961     ],
11962     "name": "DeleteFax_Transfer_Reports",
11963     "group": "Fax_Transfer_Reports",
11964     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11965     "version": "0.0.0",
11966     "filename": "server/api/faxTransferReport/index.js",
11967     "groupTitle": "Fax_Transfer_Reports"
11968   },
11969   {
11970     "type": "get",
11971     "url": "/api/fax/reports/transfer/describe",
11972     "title": "Gets table info about Fax Transfer Reports",
11973     "examples": [
11974       {
11975         "title": "Example usage:",
11976         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11977         "type": "json"
11978       }
11979     ],
11980     "name": "DescribeFax_Transfer_Reports",
11981     "group": "Fax_Transfer_Reports",
11982     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11983     "version": "0.0.0",
11984     "filename": "server/api/faxTransferReport/index.js",
11985     "groupTitle": "Fax_Transfer_Reports"
11986   },
11987   {
11988     "type": "get",
11989     "url": "/api/fax/reports/transfer",
11990     "title": "Gets a list of Fax Transfer Reports",
11991     "examples": [
11992       {
11993         "title": "Example usage:",
11994         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11995         "type": "json"
11996       }
11997     ],
11998     "name": "GetFax_Transfer_Reports",
11999     "group": "Fax_Transfer_Reports",
12000     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12001     "version": "0.0.0",
12002     "filename": "server/api/faxTransferReport/index.js",
12003     "groupTitle": "Fax_Transfer_Reports"
12004   },
12005   {
12006     "type": "get",
12007     "url": "/api/fax/reports/transfer/{id}",
12008     "title": "Gets a single Fax Transfer Report",
12009     "examples": [
12010       {
12011         "title": "Example usage:",
12012         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
12013         "type": "json"
12014       }
12015     ],
12016     "name": "ShowFax_Transfer_Reports",
12017     "group": "Fax_Transfer_Reports",
12018     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12019     "version": "0.0.0",
12020     "filename": "server/api/faxTransferReport/index.js",
12021     "groupTitle": "Fax_Transfer_Reports"
12022   },
12023   {
12024     "type": "put",
12025     "url": "/api/fax/reports/transfer/{id}",
12026     "title": "Update an existing Fax Transfer Report",
12027     "examples": [
12028       {
12029         "title": "Example usage:",
12030         "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",
12031         "type": "json"
12032       }
12033     ],
12034     "name": "updateFax_Transfer_Reports",
12035     "group": "Fax_Transfer_Reports",
12036     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12037     "version": "0.0.0",
12038     "filename": "server/api/faxTransferReport/index.js",
12039     "groupTitle": "Fax_Transfer_Reports"
12040   },
12041   {
12042     "type": "post",
12043     "url": "/api/integrations/freshdesk/accounts",
12044     "title": "Creates a new Freshdesk Account",
12045     "examples": [
12046       {
12047         "title": "Example usage:",
12048         "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",
12049         "type": "json"
12050       }
12051     ],
12052     "name": "CreateFreshdesk_Accounts",
12053     "group": "Freshdesk_Accounts",
12054     "parameter": {
12055       "fields": {
12056         "Body": [
12057           {
12058             "group": "Body",
12059             "type": "String",
12060             "optional": true,
12061             "field": "name",
12062             "description": ""
12063           },
12064           {
12065             "group": "Body",
12066             "type": "String",
12067             "optional": true,
12068             "field": "description",
12069             "description": ""
12070           },
12071           {
12072             "group": "Body",
12073             "type": "String",
12074             "optional": true,
12075             "field": "username",
12076             "description": ""
12077           },
12078           {
12079             "group": "Body",
12080             "type": "String",
12081             "optional": true,
12082             "field": "apiKey",
12083             "description": ""
12084           },
12085           {
12086             "group": "Body",
12087             "type": "String",
12088             "optional": true,
12089             "field": "remoteUri",
12090             "description": ""
12091           },
12092           {
12093             "group": "Body",
12094             "type": "String",
12095             "optional": false,
12096             "field": "serverUrl",
12097             "description": ""
12098           }
12099         ]
12100       }
12101     },
12102     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12103     "version": "0.0.0",
12104     "filename": "server/api/intFreshdeskAccount/index.js",
12105     "groupTitle": "Freshdesk_Accounts"
12106   },
12107   {
12108     "type": "delete",
12109     "url": "/api/integrations/freshdesk/accounts/{id}",
12110     "title": "Deletes a Freshdesk Account",
12111     "examples": [
12112       {
12113         "title": "Example usage:",
12114         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
12115         "type": "json"
12116       }
12117     ],
12118     "name": "DeleteFreshdesk_Accounts",
12119     "group": "Freshdesk_Accounts",
12120     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12121     "version": "0.0.0",
12122     "filename": "server/api/intFreshdeskAccount/index.js",
12123     "groupTitle": "Freshdesk_Accounts"
12124   },
12125   {
12126     "type": "get",
12127     "url": "/api/integrations/freshdesk/accounts",
12128     "title": "Gets a list of Freshdesk Accounts",
12129     "examples": [
12130       {
12131         "title": "Example usage:",
12132         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
12133         "type": "json"
12134       }
12135     ],
12136     "name": "GetFreshdesk_Accounts",
12137     "group": "Freshdesk_Accounts",
12138     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12139     "version": "0.0.0",
12140     "filename": "server/api/intFreshdeskAccount/index.js",
12141     "groupTitle": "Freshdesk_Accounts"
12142   },
12143   {
12144     "type": "get",
12145     "url": "/api/integrations/freshdesk/accounts/{id}",
12146     "title": "Gets a single Freshdesk Account",
12147     "examples": [
12148       {
12149         "title": "Example usage:",
12150         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
12151         "type": "json"
12152       }
12153     ],
12154     "name": "ShowFreshdesk_Accounts",
12155     "group": "Freshdesk_Accounts",
12156     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12157     "version": "0.0.0",
12158     "filename": "server/api/intFreshdeskAccount/index.js",
12159     "groupTitle": "Freshdesk_Accounts"
12160   },
12161   {
12162     "type": "post",
12163     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12164     "title": "Creates new configuration",
12165     "examples": [
12166       {
12167         "title": "Example usage:",
12168         "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",
12169         "type": "json"
12170       }
12171     ],
12172     "name": "addConfiguration",
12173     "group": "Freshdesk_Accounts",
12174     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12175     "version": "0.0.0",
12176     "filename": "server/api/intFreshdeskAccount/index.js",
12177     "groupTitle": "Freshdesk_Accounts"
12178   },
12179   {
12180     "type": "get",
12181     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
12182     "title": "Gets account configurations",
12183     "examples": [
12184       {
12185         "title": "Example usage:",
12186         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12187         "type": "json"
12188       }
12189     ],
12190     "name": "getConfigurations",
12191     "group": "Freshdesk_Accounts",
12192     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12193     "version": "0.0.0",
12194     "filename": "server/api/intFreshdeskAccount/index.js",
12195     "groupTitle": "Freshdesk_Accounts"
12196   },
12197   {
12198     "type": "get",
12199     "url": "/api/integrations/freshdesk/accounts/{id}/fields",
12200     "title": "Gets account fields",
12201     "examples": [
12202       {
12203         "title": "Example usage:",
12204         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
12205         "type": "json"
12206       }
12207     ],
12208     "name": "getFields",
12209     "group": "Freshdesk_Accounts",
12210     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12211     "version": "0.0.0",
12212     "filename": "server/api/intFreshdeskAccount/index.js",
12213     "groupTitle": "Freshdesk_Accounts"
12214   },
12215   {
12216     "type": "put",
12217     "url": "/api/integrations/freshdesk/accounts/{id}",
12218     "title": "Update an existing Freshdesk Account",
12219     "examples": [
12220       {
12221         "title": "Example usage:",
12222         "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",
12223         "type": "json"
12224       }
12225     ],
12226     "name": "updateFreshdesk_Accounts",
12227     "group": "Freshdesk_Accounts",
12228     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12229     "version": "0.0.0",
12230     "filename": "server/api/intFreshdeskAccount/index.js",
12231     "groupTitle": "Freshdesk_Accounts"
12232   },
12233   {
12234     "type": "post",
12235     "url": "/api/integrations/freshdesk/configurations",
12236     "title": "Creates a new Freshdesk Configuration",
12237     "examples": [
12238       {
12239         "title": "Example usage:",
12240         "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",
12241         "type": "json"
12242       }
12243     ],
12244     "name": "CreateFreshdesk_Configurations",
12245     "group": "Freshdesk_Configurations",
12246     "parameter": {
12247       "fields": {
12248         "Body": [
12249           {
12250             "group": "Body",
12251             "type": "String",
12252             "optional": true,
12253             "field": "name",
12254             "description": ""
12255           },
12256           {
12257             "group": "Body",
12258             "type": "String",
12259             "optional": true,
12260             "field": "description",
12261             "description": ""
12262           }
12263         ]
12264       }
12265     },
12266     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12267     "version": "0.0.0",
12268     "filename": "server/api/intFreshdeskConfiguration/index.js",
12269     "groupTitle": "Freshdesk_Configurations"
12270   },
12271   {
12272     "type": "delete",
12273     "url": "/api/integrations/freshdesk/configurations/{id}",
12274     "title": "Deletes a Freshdesk Configuration",
12275     "examples": [
12276       {
12277         "title": "Example usage:",
12278         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
12279         "type": "json"
12280       }
12281     ],
12282     "name": "DeleteFreshdesk_Configurations",
12283     "group": "Freshdesk_Configurations",
12284     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12285     "version": "0.0.0",
12286     "filename": "server/api/intFreshdeskConfiguration/index.js",
12287     "groupTitle": "Freshdesk_Configurations"
12288   },
12289   {
12290     "type": "get",
12291     "url": "/api/integrations/freshdesk/configurations",
12292     "title": "Gets a list of Freshdesk Configurations",
12293     "examples": [
12294       {
12295         "title": "Example usage:",
12296         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
12297         "type": "json"
12298       }
12299     ],
12300     "name": "GetFreshdesk_Configurations",
12301     "group": "Freshdesk_Configurations",
12302     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12303     "version": "0.0.0",
12304     "filename": "server/api/intFreshdeskConfiguration/index.js",
12305     "groupTitle": "Freshdesk_Configurations"
12306   },
12307   {
12308     "type": "get",
12309     "url": "/api/integrations/freshdesk/configurations/{id}",
12310     "title": "Gets a single Freshdesk Configuration",
12311     "examples": [
12312       {
12313         "title": "Example usage:",
12314         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
12315         "type": "json"
12316       }
12317     ],
12318     "name": "ShowFreshdesk_Configurations",
12319     "group": "Freshdesk_Configurations",
12320     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12321     "version": "0.0.0",
12322     "filename": "server/api/intFreshdeskConfiguration/index.js",
12323     "groupTitle": "Freshdesk_Configurations"
12324   },
12325   {
12326     "type": "get",
12327     "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
12328     "title": "Gets configurations descriptions",
12329     "examples": [
12330       {
12331         "title": "Example usage:",
12332         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12333         "type": "json"
12334       }
12335     ],
12336     "name": "getDescriptions",
12337     "group": "Freshdesk_Configurations",
12338     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12339     "version": "0.0.0",
12340     "filename": "server/api/intFreshdeskConfiguration/index.js",
12341     "groupTitle": "Freshdesk_Configurations"
12342   },
12343   {
12344     "type": "get",
12345     "url": "/api/integrations/freshdesk/configurations/{id}/fields",
12346     "title": "Gets configurations fields",
12347     "examples": [
12348       {
12349         "title": "Example usage:",
12350         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
12351         "type": "json"
12352       }
12353     ],
12354     "name": "getFields",
12355     "group": "Freshdesk_Configurations",
12356     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12357     "version": "0.0.0",
12358     "filename": "server/api/intFreshdeskConfiguration/index.js",
12359     "groupTitle": "Freshdesk_Configurations"
12360   },
12361   {
12362     "type": "get",
12363     "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
12364     "title": "Gets configurations subjects",
12365     "examples": [
12366       {
12367         "title": "Example usage:",
12368         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12369         "type": "json"
12370       }
12371     ],
12372     "name": "getSubjects",
12373     "group": "Freshdesk_Configurations",
12374     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12375     "version": "0.0.0",
12376     "filename": "server/api/intFreshdeskConfiguration/index.js",
12377     "groupTitle": "Freshdesk_Configurations"
12378   },
12379   {
12380     "type": "get",
12381     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12382     "title": "Gets configurations tags",
12383     "examples": [
12384       {
12385         "title": "Example usage:",
12386         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
12387         "type": "json"
12388       }
12389     ],
12390     "name": "getTags",
12391     "group": "Freshdesk_Configurations",
12392     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12393     "version": "0.0.0",
12394     "filename": "server/api/intFreshdeskConfiguration/index.js",
12395     "groupTitle": "Freshdesk_Configurations"
12396   },
12397   {
12398     "type": "post",
12399     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
12400     "title": "Sets new tags",
12401     "examples": [
12402       {
12403         "title": "Example usage:",
12404         "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",
12405         "type": "json"
12406       }
12407     ],
12408     "name": "setTags",
12409     "group": "Freshdesk_Configurations",
12410     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12411     "version": "0.0.0",
12412     "filename": "server/api/intFreshdeskConfiguration/index.js",
12413     "groupTitle": "Freshdesk_Configurations"
12414   },
12415   {
12416     "type": "put",
12417     "url": "/api/integrations/freshdesk/configurations/{id}",
12418     "title": "Update an existing Freshdesk Configuration",
12419     "examples": [
12420       {
12421         "title": "Example usage:",
12422         "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",
12423         "type": "json"
12424       }
12425     ],
12426     "name": "updateFreshdesk_Configurations",
12427     "group": "Freshdesk_Configurations",
12428     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12429     "version": "0.0.0",
12430     "filename": "server/api/intFreshdeskConfiguration/index.js",
12431     "groupTitle": "Freshdesk_Configurations"
12432   },
12433   {
12434     "type": "post",
12435     "url": "/api/integrations/freshdesk/fields",
12436     "title": "Creates a new Freshdesk Field",
12437     "examples": [
12438       {
12439         "title": "Example usage:",
12440         "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",
12441         "type": "json"
12442       }
12443     ],
12444     "name": "CreateFreshdesk_Fields",
12445     "group": "Freshdesk_Fields",
12446     "parameter": {
12447       "fields": {
12448         "Body": [
12449           {
12450             "group": "Body",
12451             "type": "String",
12452             "allowedValues": [
12453               "\"string\"",
12454               "\"variable\"",
12455               "\"customVariable\"",
12456               "\"keyValue\"",
12457               "\"picklist\""
12458             ],
12459             "optional": true,
12460             "field": "type",
12461             "description": ""
12462           },
12463           {
12464             "group": "Body",
12465             "type": "String",
12466             "optional": true,
12467             "field": "content",
12468             "description": ""
12469           },
12470           {
12471             "group": "Body",
12472             "type": "String",
12473             "optional": true,
12474             "field": "key",
12475             "description": ""
12476           },
12477           {
12478             "group": "Body",
12479             "type": "String",
12480             "allowedValues": [
12481               "\"string\"",
12482               "\"variable\"",
12483               "\"customVariable\""
12484             ],
12485             "optional": true,
12486             "field": "keyType",
12487             "description": ""
12488           },
12489           {
12490             "group": "Body",
12491             "type": "String",
12492             "optional": true,
12493             "field": "keyContent",
12494             "description": ""
12495           },
12496           {
12497             "group": "Body",
12498             "type": "String",
12499             "optional": true,
12500             "field": "idField",
12501             "description": ""
12502           },
12503           {
12504             "group": "Body",
12505             "type": "String",
12506             "optional": true,
12507             "field": "nameField",
12508             "description": ""
12509           },
12510           {
12511             "group": "Body",
12512             "type": "Boolean",
12513             "optional": true,
12514             "field": "customField",
12515             "description": ""
12516           },
12517           {
12518             "group": "Body",
12519             "type": "String",
12520             "optional": true,
12521             "field": "variableName",
12522             "description": ""
12523           }
12524         ]
12525       }
12526     },
12527     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12528     "version": "0.0.0",
12529     "filename": "server/api/intFreshdeskField/index.js",
12530     "groupTitle": "Freshdesk_Fields"
12531   },
12532   {
12533     "type": "delete",
12534     "url": "/api/integrations/freshdesk/fields/{id}",
12535     "title": "Deletes a Freshdesk Field",
12536     "examples": [
12537       {
12538         "title": "Example usage:",
12539         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
12540         "type": "json"
12541       }
12542     ],
12543     "name": "DeleteFreshdesk_Fields",
12544     "group": "Freshdesk_Fields",
12545     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12546     "version": "0.0.0",
12547     "filename": "server/api/intFreshdeskField/index.js",
12548     "groupTitle": "Freshdesk_Fields"
12549   },
12550   {
12551     "type": "get",
12552     "url": "/api/integrations/freshdesk/fields",
12553     "title": "Gets a list of Freshdesk Fields",
12554     "examples": [
12555       {
12556         "title": "Example usage:",
12557         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
12558         "type": "json"
12559       }
12560     ],
12561     "name": "GetFreshdesk_Fields",
12562     "group": "Freshdesk_Fields",
12563     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12564     "version": "0.0.0",
12565     "filename": "server/api/intFreshdeskField/index.js",
12566     "groupTitle": "Freshdesk_Fields"
12567   },
12568   {
12569     "type": "get",
12570     "url": "/api/integrations/freshdesk/fields/{id}",
12571     "title": "Gets a single Freshdesk Field",
12572     "examples": [
12573       {
12574         "title": "Example usage:",
12575         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
12576         "type": "json"
12577       }
12578     ],
12579     "name": "ShowFreshdesk_Fields",
12580     "group": "Freshdesk_Fields",
12581     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12582     "version": "0.0.0",
12583     "filename": "server/api/intFreshdeskField/index.js",
12584     "groupTitle": "Freshdesk_Fields"
12585   },
12586   {
12587     "type": "put",
12588     "url": "/api/integrations/freshdesk/fields/{id}",
12589     "title": "Update an existing Freshdesk Field",
12590     "examples": [
12591       {
12592         "title": "Example usage:",
12593         "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",
12594         "type": "json"
12595       }
12596     ],
12597     "name": "updateFreshdesk_Fields",
12598     "group": "Freshdesk_Fields",
12599     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12600     "version": "0.0.0",
12601     "filename": "server/api/intFreshdeskField/index.js",
12602     "groupTitle": "Freshdesk_Fields"
12603   },
12604   {
12605     "type": "post",
12606     "url": "/api/integrations/freshsales/accounts",
12607     "title": "Creates a new Freshsales Account",
12608     "examples": [
12609       {
12610         "title": "Example usage:",
12611         "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",
12612         "type": "json"
12613       }
12614     ],
12615     "name": "CreateFreshsales_Accounts",
12616     "group": "Freshsales_Accounts",
12617     "parameter": {
12618       "fields": {
12619         "Body": [
12620           {
12621             "group": "Body",
12622             "type": "String",
12623             "optional": true,
12624             "field": "name",
12625             "description": ""
12626           },
12627           {
12628             "group": "Body",
12629             "type": "String",
12630             "optional": true,
12631             "field": "description",
12632             "description": ""
12633           },
12634           {
12635             "group": "Body",
12636             "type": "String",
12637             "optional": true,
12638             "field": "username",
12639             "description": ""
12640           },
12641           {
12642             "group": "Body",
12643             "type": "String",
12644             "optional": true,
12645             "field": "apiKey",
12646             "description": ""
12647           },
12648           {
12649             "group": "Body",
12650             "type": "String",
12651             "optional": true,
12652             "field": "remoteUri",
12653             "description": ""
12654           },
12655           {
12656             "group": "Body",
12657             "type": "String",
12658             "optional": false,
12659             "field": "serverUrl",
12660             "description": ""
12661           }
12662         ]
12663       }
12664     },
12665     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12666     "version": "0.0.0",
12667     "filename": "server/api/intFreshsalesAccount/index.js",
12668     "groupTitle": "Freshsales_Accounts"
12669   },
12670   {
12671     "type": "delete",
12672     "url": "/api/integrations/freshsales/accounts/{id}",
12673     "title": "Deletes a Freshsales Account",
12674     "examples": [
12675       {
12676         "title": "Example usage:",
12677         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12678         "type": "json"
12679       }
12680     ],
12681     "name": "DeleteFreshsales_Accounts",
12682     "group": "Freshsales_Accounts",
12683     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12684     "version": "0.0.0",
12685     "filename": "server/api/intFreshsalesAccount/index.js",
12686     "groupTitle": "Freshsales_Accounts"
12687   },
12688   {
12689     "type": "get",
12690     "url": "/api/integrations/freshsales/accounts",
12691     "title": "Gets a list of Freshsales Accounts",
12692     "examples": [
12693       {
12694         "title": "Example usage:",
12695         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12696         "type": "json"
12697       }
12698     ],
12699     "name": "GetFreshsales_Accounts",
12700     "group": "Freshsales_Accounts",
12701     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12702     "version": "0.0.0",
12703     "filename": "server/api/intFreshsalesAccount/index.js",
12704     "groupTitle": "Freshsales_Accounts"
12705   },
12706   {
12707     "type": "get",
12708     "url": "/api/integrations/freshsales/accounts/{id}",
12709     "title": "Gets a single Freshsales Account",
12710     "examples": [
12711       {
12712         "title": "Example usage:",
12713         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12714         "type": "json"
12715       }
12716     ],
12717     "name": "ShowFreshsales_Accounts",
12718     "group": "Freshsales_Accounts",
12719     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12720     "version": "0.0.0",
12721     "filename": "server/api/intFreshsalesAccount/index.js",
12722     "groupTitle": "Freshsales_Accounts"
12723   },
12724   {
12725     "type": "post",
12726     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12727     "title": "Creates new configuration",
12728     "examples": [
12729       {
12730         "title": "Example usage:",
12731         "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",
12732         "type": "json"
12733       }
12734     ],
12735     "name": "addConfiguration",
12736     "group": "Freshsales_Accounts",
12737     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12738     "version": "0.0.0",
12739     "filename": "server/api/intFreshsalesAccount/index.js",
12740     "groupTitle": "Freshsales_Accounts"
12741   },
12742   {
12743     "type": "get",
12744     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12745     "title": "Gets account configurations",
12746     "examples": [
12747       {
12748         "title": "Example usage:",
12749         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12750         "type": "json"
12751       }
12752     ],
12753     "name": "getConfigurations",
12754     "group": "Freshsales_Accounts",
12755     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12756     "version": "0.0.0",
12757     "filename": "server/api/intFreshsalesAccount/index.js",
12758     "groupTitle": "Freshsales_Accounts"
12759   },
12760   {
12761     "type": "get",
12762     "url": "/api/integrations/freshsales/accounts/{id}/fields",
12763     "title": "Gets account fields",
12764     "examples": [
12765       {
12766         "title": "Example usage:",
12767         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12768         "type": "json"
12769       }
12770     ],
12771     "name": "getFields",
12772     "group": "Freshsales_Accounts",
12773     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12774     "version": "0.0.0",
12775     "filename": "server/api/intFreshsalesAccount/index.js",
12776     "groupTitle": "Freshsales_Accounts"
12777   },
12778   {
12779     "type": "put",
12780     "url": "/api/integrations/freshsales/accounts/{id}",
12781     "title": "Update an existing Freshsales Account",
12782     "examples": [
12783       {
12784         "title": "Example usage:",
12785         "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",
12786         "type": "json"
12787       }
12788     ],
12789     "name": "updateFreshsales_Accounts",
12790     "group": "Freshsales_Accounts",
12791     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12792     "version": "0.0.0",
12793     "filename": "server/api/intFreshsalesAccount/index.js",
12794     "groupTitle": "Freshsales_Accounts"
12795   },
12796   {
12797     "type": "post",
12798     "url": "/api/integrations/freshsales/configurations",
12799     "title": "Creates a new Freshsales Configuration",
12800     "examples": [
12801       {
12802         "title": "Example usage:",
12803         "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",
12804         "type": "json"
12805       }
12806     ],
12807     "name": "CreateFreshsales_Configurations",
12808     "group": "Freshsales_Configurations",
12809     "parameter": {
12810       "fields": {
12811         "Body": [
12812           {
12813             "group": "Body",
12814             "type": "String",
12815             "optional": true,
12816             "field": "name",
12817             "description": ""
12818           },
12819           {
12820             "group": "Body",
12821             "type": "String",
12822             "optional": true,
12823             "field": "description",
12824             "description": ""
12825           }
12826         ]
12827       }
12828     },
12829     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12830     "version": "0.0.0",
12831     "filename": "server/api/intFreshsalesConfiguration/index.js",
12832     "groupTitle": "Freshsales_Configurations"
12833   },
12834   {
12835     "type": "delete",
12836     "url": "/api/integrations/freshsales/configurations/{id}",
12837     "title": "Deletes a Freshsales Configuration",
12838     "examples": [
12839       {
12840         "title": "Example usage:",
12841         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12842         "type": "json"
12843       }
12844     ],
12845     "name": "DeleteFreshsales_Configurations",
12846     "group": "Freshsales_Configurations",
12847     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12848     "version": "0.0.0",
12849     "filename": "server/api/intFreshsalesConfiguration/index.js",
12850     "groupTitle": "Freshsales_Configurations"
12851   },
12852   {
12853     "type": "get",
12854     "url": "/api/integrations/freshsales/configurations",
12855     "title": "Gets a list of Freshsales Configurations",
12856     "examples": [
12857       {
12858         "title": "Example usage:",
12859         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12860         "type": "json"
12861       }
12862     ],
12863     "name": "GetFreshsales_Configurations",
12864     "group": "Freshsales_Configurations",
12865     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12866     "version": "0.0.0",
12867     "filename": "server/api/intFreshsalesConfiguration/index.js",
12868     "groupTitle": "Freshsales_Configurations"
12869   },
12870   {
12871     "type": "get",
12872     "url": "/api/integrations/freshsales/configurations/{id}",
12873     "title": "Gets a single Freshsales Configuration",
12874     "examples": [
12875       {
12876         "title": "Example usage:",
12877         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12878         "type": "json"
12879       }
12880     ],
12881     "name": "ShowFreshsales_Configurations",
12882     "group": "Freshsales_Configurations",
12883     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12884     "version": "0.0.0",
12885     "filename": "server/api/intFreshsalesConfiguration/index.js",
12886     "groupTitle": "Freshsales_Configurations"
12887   },
12888   {
12889     "type": "get",
12890     "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12891     "title": "Gets configurations descriptions",
12892     "examples": [
12893       {
12894         "title": "Example usage:",
12895         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12896         "type": "json"
12897       }
12898     ],
12899     "name": "getDescriptions",
12900     "group": "Freshsales_Configurations",
12901     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12902     "version": "0.0.0",
12903     "filename": "server/api/intFreshsalesConfiguration/index.js",
12904     "groupTitle": "Freshsales_Configurations"
12905   },
12906   {
12907     "type": "get",
12908     "url": "/api/integrations/freshsales/configurations/{id}/fields",
12909     "title": "Gets configurations fields",
12910     "examples": [
12911       {
12912         "title": "Example usage:",
12913         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12914         "type": "json"
12915       }
12916     ],
12917     "name": "getFields",
12918     "group": "Freshsales_Configurations",
12919     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12920     "version": "0.0.0",
12921     "filename": "server/api/intFreshsalesConfiguration/index.js",
12922     "groupTitle": "Freshsales_Configurations"
12923   },
12924   {
12925     "type": "get",
12926     "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12927     "title": "Gets configurations subjects",
12928     "examples": [
12929       {
12930         "title": "Example usage:",
12931         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12932         "type": "json"
12933       }
12934     ],
12935     "name": "getSubjects",
12936     "group": "Freshsales_Configurations",
12937     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12938     "version": "0.0.0",
12939     "filename": "server/api/intFreshsalesConfiguration/index.js",
12940     "groupTitle": "Freshsales_Configurations"
12941   },
12942   {
12943     "type": "put",
12944     "url": "/api/integrations/freshsales/configurations/{id}",
12945     "title": "Update an existing Freshsales Configuration",
12946     "examples": [
12947       {
12948         "title": "Example usage:",
12949         "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",
12950         "type": "json"
12951       }
12952     ],
12953     "name": "updateFreshsales_Configurations",
12954     "group": "Freshsales_Configurations",
12955     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12956     "version": "0.0.0",
12957     "filename": "server/api/intFreshsalesConfiguration/index.js",
12958     "groupTitle": "Freshsales_Configurations"
12959   },
12960   {
12961     "type": "post",
12962     "url": "/api/integrations/freshsales/fields",
12963     "title": "Creates a new Freshsales Field",
12964     "examples": [
12965       {
12966         "title": "Example usage:",
12967         "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",
12968         "type": "json"
12969       }
12970     ],
12971     "name": "CreateFreshsales_Fields",
12972     "group": "Freshsales_Fields",
12973     "parameter": {
12974       "fields": {
12975         "Body": [
12976           {
12977             "group": "Body",
12978             "type": "String",
12979             "allowedValues": [
12980               "\"string\"",
12981               "\"variable\"",
12982               "\"customVariable\"",
12983               "\"keyValue\"",
12984               "\"picklist\""
12985             ],
12986             "optional": true,
12987             "field": "type",
12988             "description": ""
12989           },
12990           {
12991             "group": "Body",
12992             "type": "String",
12993             "optional": true,
12994             "field": "content",
12995             "description": ""
12996           },
12997           {
12998             "group": "Body",
12999             "type": "String",
13000             "optional": true,
13001             "field": "key",
13002             "description": ""
13003           },
13004           {
13005             "group": "Body",
13006             "type": "String",
13007             "allowedValues": [
13008               "\"string\"",
13009               "\"variable\"",
13010               "\"customVariable\""
13011             ],
13012             "optional": true,
13013             "field": "keyType",
13014             "description": ""
13015           },
13016           {
13017             "group": "Body",
13018             "type": "String",
13019             "optional": true,
13020             "field": "keyContent",
13021             "description": ""
13022           },
13023           {
13024             "group": "Body",
13025             "type": "String",
13026             "optional": true,
13027             "field": "idField",
13028             "description": ""
13029           },
13030           {
13031             "group": "Body",
13032             "type": "String",
13033             "optional": true,
13034             "field": "nameField",
13035             "description": ""
13036           },
13037           {
13038             "group": "Body",
13039             "type": "Boolean",
13040             "optional": true,
13041             "field": "customField",
13042             "description": ""
13043           },
13044           {
13045             "group": "Body",
13046             "type": "String",
13047             "optional": true,
13048             "field": "variableName",
13049             "description": ""
13050           }
13051         ]
13052       }
13053     },
13054     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13055     "version": "0.0.0",
13056     "filename": "server/api/intFreshsalesField/index.js",
13057     "groupTitle": "Freshsales_Fields"
13058   },
13059   {
13060     "type": "delete",
13061     "url": "/api/integrations/freshsales/fields/{id}",
13062     "title": "Deletes a Freshsales Field",
13063     "examples": [
13064       {
13065         "title": "Example usage:",
13066         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
13067         "type": "json"
13068       }
13069     ],
13070     "name": "DeleteFreshsales_Fields",
13071     "group": "Freshsales_Fields",
13072     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13073     "version": "0.0.0",
13074     "filename": "server/api/intFreshsalesField/index.js",
13075     "groupTitle": "Freshsales_Fields"
13076   },
13077   {
13078     "type": "get",
13079     "url": "/api/integrations/freshsales/fields",
13080     "title": "Gets a list of Freshsales Fields",
13081     "examples": [
13082       {
13083         "title": "Example usage:",
13084         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
13085         "type": "json"
13086       }
13087     ],
13088     "name": "GetFreshsales_Fields",
13089     "group": "Freshsales_Fields",
13090     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13091     "version": "0.0.0",
13092     "filename": "server/api/intFreshsalesField/index.js",
13093     "groupTitle": "Freshsales_Fields"
13094   },
13095   {
13096     "type": "get",
13097     "url": "/api/integrations/freshsales/fields/{id}",
13098     "title": "Gets a single Freshsales Field",
13099     "examples": [
13100       {
13101         "title": "Example usage:",
13102         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
13103         "type": "json"
13104       }
13105     ],
13106     "name": "ShowFreshsales_Fields",
13107     "group": "Freshsales_Fields",
13108     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13109     "version": "0.0.0",
13110     "filename": "server/api/intFreshsalesField/index.js",
13111     "groupTitle": "Freshsales_Fields"
13112   },
13113   {
13114     "type": "put",
13115     "url": "/api/integrations/freshsales/fields/{id}",
13116     "title": "Update an existing Freshsales Field",
13117     "examples": [
13118       {
13119         "title": "Example usage:",
13120         "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",
13121         "type": "json"
13122       }
13123     ],
13124     "name": "updateFreshsales_Fields",
13125     "group": "Freshsales_Fields",
13126     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13127     "version": "0.0.0",
13128     "filename": "server/api/intFreshsalesField/index.js",
13129     "groupTitle": "Freshsales_Fields"
13130   },
13131   {
13132     "type": "post",
13133     "url": "/api/campaigns/{id}/blacklists",
13134     "title": "Add blacklists to an IVR campaign",
13135     "examples": [
13136       {
13137         "title": "Example usage:",
13138         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13139         "type": "json"
13140       }
13141     ],
13142     "name": "AddBlackLists",
13143     "group": "IVR_Campaigns",
13144     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13145     "version": "0.0.0",
13146     "filename": "server/api/campaign/index.js",
13147     "groupTitle": "IVR_Campaigns"
13148   },
13149   {
13150     "type": "post",
13151     "url": "/api/campaigns/{id}/lists",
13152     "title": "Add lists to an IVR campaign",
13153     "examples": [
13154       {
13155         "title": "Example usage:",
13156         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13157         "type": "json"
13158       }
13159     ],
13160     "name": "AddLists",
13161     "group": "IVR_Campaigns",
13162     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13163     "version": "0.0.0",
13164     "filename": "server/api/campaign/index.js",
13165     "groupTitle": "IVR_Campaigns"
13166   },
13167   {
13168     "type": "post",
13169     "url": "/api/campaigns/clone",
13170     "title": "Clone an existing IVR Campaign",
13171     "examples": [
13172       {
13173         "title": "Example usage:",
13174         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13175         "type": "json"
13176       }
13177     ],
13178     "name": "CloneIVR_Campaigns",
13179     "group": "IVR_Campaigns",
13180     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13181     "version": "0.0.0",
13182     "filename": "server/api/campaign/index.js",
13183     "groupTitle": "IVR_Campaigns"
13184   },
13185   {
13186     "type": "post",
13187     "url": "/api/campaigns",
13188     "title": "Creates a new IVR Campaign",
13189     "examples": [
13190       {
13191         "title": "Example usage:",
13192         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13193         "type": "json"
13194       }
13195     ],
13196     "name": "CreateIVR_Campaigns",
13197     "group": "IVR_Campaigns",
13198     "parameter": {
13199       "fields": {
13200         "Body": [
13201           {
13202             "group": "Body",
13203             "type": "String",
13204             "optional": false,
13205             "field": "name",
13206             "description": ""
13207           },
13208           {
13209             "group": "Body",
13210             "type": "String",
13211             "allowedValues": [
13212               "\"ivr\""
13213             ],
13214             "optional": false,
13215             "field": "type",
13216             "description": ""
13217           },
13218           {
13219             "group": "Body",
13220             "type": "String",
13221             "optional": true,
13222             "field": "description",
13223             "description": ""
13224           },
13225           {
13226             "group": "Body",
13227             "type": "Boolean",
13228             "optional": true,
13229             "field": "active",
13230             "description": "<p>Active/Disactive Campaign</p>"
13231           },
13232           {
13233             "group": "Body",
13234             "type": "Integer",
13235             "optional": true,
13236             "field": "limitCalls",
13237             "description": "<p>Max 200 calls.</p>"
13238           },
13239           {
13240             "group": "Body",
13241             "type": "String",
13242             "optional": true,
13243             "field": "dialOriginateCallerIdName",
13244             "description": ""
13245           },
13246           {
13247             "group": "Body",
13248             "type": "String",
13249             "optional": true,
13250             "field": "dialOriginateCallerIdNumber",
13251             "description": ""
13252           },
13253           {
13254             "group": "Body",
13255             "type": "Integer",
13256             "optional": true,
13257             "field": "dialOriginateTimeout",
13258             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
13259           },
13260           {
13261             "group": "Body",
13262             "type": "Integer",
13263             "optional": true,
13264             "field": "dialCongestionMaxRetry",
13265             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
13266           },
13267           {
13268             "group": "Body",
13269             "type": "Integer",
13270             "optional": true,
13271             "field": "dialCongestionRetryFrequency",
13272             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
13273           },
13274           {
13275             "group": "Body",
13276             "type": "Integer",
13277             "optional": true,
13278             "field": "dialBusyMaxRetry",
13279             "description": "<p>#Busy Retry (min:1, max:999)</p>"
13280           },
13281           {
13282             "group": "Body",
13283             "type": "Integer",
13284             "optional": true,
13285             "field": "dialBusyRetryFrequency",
13286             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
13287           },
13288           {
13289             "group": "Body",
13290             "type": "Integer",
13291             "optional": true,
13292             "field": "dialNoAnswerMaxRetry",
13293             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
13294           },
13295           {
13296             "group": "Body",
13297             "type": "Integer",
13298             "optional": true,
13299             "field": "dialNoAnswerRetryFrequency",
13300             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
13301           },
13302           {
13303             "group": "Body",
13304             "type": "Integer",
13305             "optional": true,
13306             "field": "dialGlobalMaxRetry",
13307             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
13308           },
13309           {
13310             "group": "Body",
13311             "type": "String",
13312             "optional": true,
13313             "field": "dialTimezone",
13314             "description": ""
13315           },
13316           {
13317             "group": "Body",
13318             "type": "String",
13319             "optional": true,
13320             "field": "dialGlobalInterval",
13321             "description": ""
13322           },
13323           {
13324             "group": "Body",
13325             "type": "String",
13326             "allowedValues": [
13327               "\"always\"",
13328               "\"never\"",
13329               "\"onlyIfOpen\""
13330             ],
13331             "optional": true,
13332             "field": "dialCheckDuplicateType",
13333             "description": ""
13334           },
13335           {
13336             "group": "Body",
13337             "type": "Boolean",
13338             "optional": true,
13339             "field": "dialAMDActive",
13340             "description": "<p>Active/Disactive AMD</p>"
13341           },
13342           {
13343             "group": "Body",
13344             "type": "Integer",
13345             "optional": true,
13346             "field": "dialAMDInitialSilence",
13347             "description": "<p>#AMD Initial Silence</p>"
13348           },
13349           {
13350             "group": "Body",
13351             "type": "Integer",
13352             "optional": true,
13353             "field": "dialAMDGreeting",
13354             "description": "<p>#AMD Greeting</p>"
13355           },
13356           {
13357             "group": "Body",
13358             "type": "Integer",
13359             "optional": true,
13360             "field": "dialAMDAfterGreetingSilence",
13361             "description": "<p>#AMD After Greeting Silence</p>"
13362           },
13363           {
13364             "group": "Body",
13365             "type": "Integer",
13366             "optional": true,
13367             "field": "dialAMDTotalAnalysisTime",
13368             "description": "<p>#AMD Total Analysis Time</p>"
13369           },
13370           {
13371             "group": "Body",
13372             "type": "Integer",
13373             "optional": true,
13374             "field": "dialAMDMinWordLength",
13375             "description": "<p>#AMD Min Word Length</p>"
13376           },
13377           {
13378             "group": "Body",
13379             "type": "Integer",
13380             "optional": true,
13381             "field": "dialAMDBetweenWordsSilence",
13382             "description": "<p>#AMD Between Words Silence</p>"
13383           },
13384           {
13385             "group": "Body",
13386             "type": "Integer",
13387             "optional": true,
13388             "field": "dialAMDMaximumNumberOfWords",
13389             "description": "<p>#AMD Maximum Number Of Words</p>"
13390           },
13391           {
13392             "group": "Body",
13393             "type": "Integer",
13394             "optional": true,
13395             "field": "dialAMDSilenceThreshold",
13396             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
13397           },
13398           {
13399             "group": "Body",
13400             "type": "Integer",
13401             "optional": true,
13402             "field": "dialAMDMaximumWordLength",
13403             "description": "<p>#AMD Maximum Word Length</p>"
13404           },
13405           {
13406             "group": "Body",
13407             "type": "String",
13408             "allowedValues": [
13409               "\"DESC\"",
13410               "\"ASC\""
13411             ],
13412             "optional": true,
13413             "field": "dialOrderByScheduledAt",
13414             "description": ""
13415           },
13416           {
13417             "group": "Body",
13418             "type": "String",
13419             "optional": true,
13420             "field": "dialPrefix",
13421             "description": ""
13422           },
13423           {
13424             "group": "Body",
13425             "type": "Integer",
13426             "optional": true,
13427             "field": "dialRandomLastDigitCallerIdNumber",
13428             "description": "<p>Random Last Digit (min:1, max:15)</p>"
13429           },
13430           {
13431             "group": "Body",
13432             "type": "Integer",
13433             "optional": true,
13434             "field": "dialCutDigit",
13435             "description": "<p>Cut Digit (min:1, max:15)</p>"
13436           },
13437           {
13438             "group": "Body",
13439             "type": "Integer",
13440             "optional": true,
13441             "field": "dialNoSuchNumberMaxRetry",
13442             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
13443           },
13444           {
13445             "group": "Body",
13446             "type": "Integer",
13447             "optional": true,
13448             "field": "dialNoSuchNumberRetryFrequency",
13449             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
13450           },
13451           {
13452             "group": "Body",
13453             "type": "Integer",
13454             "optional": true,
13455             "field": "dialDropMaxRetry",
13456             "description": "<p>#Drop Retry (min:1, max:999)</p>"
13457           },
13458           {
13459             "group": "Body",
13460             "type": "Integer",
13461             "optional": true,
13462             "field": "dialDropRetryFrequency",
13463             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
13464           },
13465           {
13466             "group": "Body",
13467             "type": "Integer",
13468             "optional": true,
13469             "field": "dialAbandonedMaxRetry",
13470             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
13471           },
13472           {
13473             "group": "Body",
13474             "type": "Integer",
13475             "optional": true,
13476             "field": "dialAbandonedRetryFrequency",
13477             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
13478           },
13479           {
13480             "group": "Body",
13481             "type": "Integer",
13482             "optional": true,
13483             "field": "dialMachineMaxRetry",
13484             "description": "<p>#Machine Retry (min:1, max:999)</p>"
13485           },
13486           {
13487             "group": "Body",
13488             "type": "Integer",
13489             "optional": true,
13490             "field": "dialMachineRetryFrequency",
13491             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
13492           },
13493           {
13494             "group": "Body",
13495             "type": "Integer",
13496             "optional": true,
13497             "field": "dialAgentRejectMaxRetry",
13498             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
13499           },
13500           {
13501             "group": "Body",
13502             "type": "Integer",
13503             "optional": true,
13504             "field": "dialAgentRejectRetryFrequency",
13505             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
13506           }
13507         ]
13508       }
13509     },
13510     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13511     "version": "0.0.0",
13512     "filename": "server/api/campaign/index.js",
13513     "groupTitle": "IVR_Campaigns"
13514   },
13515   {
13516     "type": "delete",
13517     "url": "/api/campaigns/{id}",
13518     "title": "Deletes a IVR Campaign",
13519     "examples": [
13520       {
13521         "title": "Example usage:",
13522         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
13523         "type": "json"
13524       }
13525     ],
13526     "name": "DeleteIVR_Campaigns",
13527     "group": "IVR_Campaigns",
13528     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13529     "version": "0.0.0",
13530     "filename": "server/api/campaign/index.js",
13531     "groupTitle": "IVR_Campaigns"
13532   },
13533   {
13534     "type": "get",
13535     "url": "/api/campaigns/{id}/blacklists",
13536     "title": "Get IVR campaign blacklists",
13537     "examples": [
13538       {
13539         "title": "Example usage:",
13540         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
13541         "type": "json"
13542       }
13543     ],
13544     "name": "GetBlackLists",
13545     "group": "IVR_Campaigns",
13546     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13547     "version": "0.0.0",
13548     "filename": "server/api/campaign/index.js",
13549     "groupTitle": "IVR_Campaigns"
13550   },
13551   {
13552     "type": "get",
13553     "url": "/api/campaigns/{id}/finals",
13554     "title": "Gets IVR campaign hopper finals",
13555     "examples": [
13556       {
13557         "title": "Example usage:",
13558         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
13559         "type": "json"
13560       }
13561     ],
13562     "name": "GetHopperFinals",
13563     "group": "IVR_Campaigns",
13564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13565     "version": "0.0.0",
13566     "filename": "server/api/campaign/index.js",
13567     "groupTitle": "IVR_Campaigns"
13568   },
13569   {
13570     "type": "get",
13571     "url": "/api/campaigns/{id}/hopper_histories",
13572     "title": "Gets IVR campaign hopper histories",
13573     "examples": [
13574       {
13575         "title": "Example usage:",
13576         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
13577         "type": "json"
13578       }
13579     ],
13580     "name": "GetHopperHistories",
13581     "group": "IVR_Campaigns",
13582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13583     "version": "0.0.0",
13584     "filename": "server/api/campaign/index.js",
13585     "groupTitle": "IVR_Campaigns"
13586   },
13587   {
13588     "type": "get",
13589     "url": "/api/campaigns/{id}/hoppers",
13590     "title": "Gets IVR campaign hoppers",
13591     "examples": [
13592       {
13593         "title": "Example usage:",
13594         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
13595         "type": "json"
13596       }
13597     ],
13598     "name": "GetHoppers",
13599     "group": "IVR_Campaigns",
13600     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13601     "version": "0.0.0",
13602     "filename": "server/api/campaign/index.js",
13603     "groupTitle": "IVR_Campaigns"
13604   },
13605   {
13606     "type": "get",
13607     "url": "/api/campaigns",
13608     "title": "Gets a list of IVR Campaigns",
13609     "examples": [
13610       {
13611         "title": "Example usage:",
13612         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
13613         "type": "json"
13614       }
13615     ],
13616     "name": "GetIVR_Campaigns",
13617     "group": "IVR_Campaigns",
13618     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13619     "version": "0.0.0",
13620     "filename": "server/api/campaign/index.js",
13621     "groupTitle": "IVR_Campaigns"
13622   },
13623   {
13624     "type": "get",
13625     "url": "/api/campaigns/{id}/lists",
13626     "title": "Get IVR campaign lists",
13627     "examples": [
13628       {
13629         "title": "Example usage:",
13630         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13631         "type": "json"
13632       }
13633     ],
13634     "name": "GetLists",
13635     "group": "IVR_Campaigns",
13636     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13637     "version": "0.0.0",
13638     "filename": "server/api/campaign/index.js",
13639     "groupTitle": "IVR_Campaigns"
13640   },
13641   {
13642     "type": "delete",
13643     "url": "/api/campaigns/{id}/blacklists",
13644     "title": "Remove blacklists from an IVR Campaign",
13645     "examples": [
13646       {
13647         "title": "Example usage:",
13648         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13649         "type": "json"
13650       }
13651     ],
13652     "name": "RemoveBlackLists",
13653     "group": "IVR_Campaigns",
13654     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13655     "version": "0.0.0",
13656     "filename": "server/api/campaign/index.js",
13657     "groupTitle": "IVR_Campaigns"
13658   },
13659   {
13660     "type": "delete",
13661     "url": "/api/campaigns/{id}/lists",
13662     "title": "Remove lists from an IVR Campaign",
13663     "examples": [
13664       {
13665         "title": "Example usage:",
13666         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13667         "type": "json"
13668       }
13669     ],
13670     "name": "RemoveLists",
13671     "group": "IVR_Campaigns",
13672     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13673     "version": "0.0.0",
13674     "filename": "server/api/campaign/index.js",
13675     "groupTitle": "IVR_Campaigns"
13676   },
13677   {
13678     "type": "get",
13679     "url": "/api/campaigns/{id}",
13680     "title": "Gets a single IVR Campaign",
13681     "examples": [
13682       {
13683         "title": "Example usage:",
13684         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13685         "type": "json"
13686       }
13687     ],
13688     "name": "ShowIVR_Campaigns",
13689     "group": "IVR_Campaigns",
13690     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13691     "version": "0.0.0",
13692     "filename": "server/api/campaign/index.js",
13693     "groupTitle": "IVR_Campaigns"
13694   },
13695   {
13696     "type": "get",
13697     "url": "/api/campaigns/{id}/blacks",
13698     "title": "Gets IVR campaign hopper blacks",
13699     "examples": [
13700       {
13701         "title": "Example usage:",
13702         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
13703         "type": "json"
13704       }
13705     ],
13706     "name": "getHopperBlacks",
13707     "group": "IVR_Campaigns",
13708     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13709     "version": "0.0.0",
13710     "filename": "server/api/campaign/index.js",
13711     "groupTitle": "IVR_Campaigns"
13712   },
13713   {
13714     "type": "put",
13715     "url": "/api/campaigns/{id}",
13716     "title": "Update an existing IVR Campaign",
13717     "examples": [
13718       {
13719         "title": "Example usage:",
13720         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13721         "type": "json"
13722       }
13723     ],
13724     "name": "updateIVR_Campaigns",
13725     "group": "IVR_Campaigns",
13726     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13727     "version": "0.0.0",
13728     "filename": "server/api/campaign/index.js",
13729     "groupTitle": "IVR_Campaigns"
13730   },
13731   {
13732     "type": "post",
13733     "url": "/api/integrations/reports",
13734     "title": "Creates a new Integration Report",
13735     "examples": [
13736       {
13737         "title": "Example usage:",
13738         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13739         "type": "json"
13740       }
13741     ],
13742     "name": "CreateIntegration_Reports",
13743     "group": "Integration_Reports",
13744     "parameter": {
13745       "fields": {
13746         "Body": [
13747           {
13748             "group": "Body",
13749             "type": "String",
13750             "optional": true,
13751             "field": "integration",
13752             "description": ""
13753           },
13754           {
13755             "group": "Body",
13756             "type": "String",
13757             "optional": true,
13758             "field": "eventChannel",
13759             "description": ""
13760           },
13761           {
13762             "group": "Body",
13763             "type": "String",
13764             "optional": true,
13765             "field": "exitStatus",
13766             "description": ""
13767           },
13768           {
13769             "group": "Body",
13770             "type": "String",
13771             "optional": true,
13772             "field": "ticketId",
13773             "description": ""
13774           },
13775           {
13776             "group": "Body",
13777             "type": "Integer",
13778             "optional": true,
13779             "field": "integrationId",
13780             "description": ""
13781           },
13782           {
13783             "group": "Body",
13784             "type": "String",
13785             "optional": true,
13786             "field": "contacts",
13787             "description": ""
13788           },
13789           {
13790             "group": "Body",
13791             "type": "String",
13792             "optional": true,
13793             "field": "uniqueid",
13794             "description": ""
13795           },
13796           {
13797             "group": "Body",
13798             "type": "String",
13799             "optional": true,
13800             "field": "calleridnum",
13801             "description": ""
13802           },
13803           {
13804             "group": "Body",
13805             "type": "String",
13806             "optional": true,
13807             "field": "calleridname",
13808             "description": ""
13809           },
13810           {
13811             "group": "Body",
13812             "type": "String",
13813             "optional": true,
13814             "field": "queue",
13815             "description": ""
13816           },
13817           {
13818             "group": "Body",
13819             "type": "String",
13820             "optional": true,
13821             "field": "interface",
13822             "description": ""
13823           },
13824           {
13825             "group": "Body",
13826             "type": "String",
13827             "optional": true,
13828             "field": "membername",
13829             "description": ""
13830           },
13831           {
13832             "group": "Body",
13833             "type": "String",
13834             "optional": true,
13835             "field": "agentcalledAt",
13836             "description": ""
13837           },
13838           {
13839             "group": "Body",
13840             "type": "String",
13841             "optional": true,
13842             "field": "agentconnectAt",
13843             "description": ""
13844           },
13845           {
13846             "group": "Body",
13847             "type": "Integer",
13848             "optional": true,
13849             "field": "holdtime",
13850             "description": ""
13851           },
13852           {
13853             "group": "Body",
13854             "type": "Boolean",
13855             "optional": true,
13856             "field": "agentcomplete",
13857             "description": ""
13858           },
13859           {
13860             "group": "Body",
13861             "type": "String",
13862             "optional": true,
13863             "field": "agentcompleteAt",
13864             "description": ""
13865           },
13866           {
13867             "group": "Body",
13868             "type": "Integer",
13869             "optional": true,
13870             "field": "talktime",
13871             "description": ""
13872           },
13873           {
13874             "group": "Body",
13875             "type": "Boolean",
13876             "optional": true,
13877             "field": "agentacw",
13878             "description": ""
13879           },
13880           {
13881             "group": "Body",
13882             "type": "Integer",
13883             "optional": true,
13884             "field": "acwtime",
13885             "description": ""
13886           },
13887           {
13888             "group": "Body",
13889             "type": "String",
13890             "optional": true,
13891             "field": "reason",
13892             "description": ""
13893           },
13894           {
13895             "group": "Body",
13896             "type": "Boolean",
13897             "optional": true,
13898             "field": "agentringnoanswer",
13899             "description": ""
13900           },
13901           {
13902             "group": "Body",
13903             "type": "String",
13904             "optional": true,
13905             "field": "agentringnoanswerAt",
13906             "description": ""
13907           },
13908           {
13909             "group": "Body",
13910             "type": "Boolean",
13911             "optional": true,
13912             "field": "agentdump",
13913             "description": ""
13914           },
13915           {
13916             "group": "Body",
13917             "type": "String",
13918             "optional": true,
13919             "field": "agentdumpAt",
13920             "description": ""
13921           },
13922           {
13923             "group": "Body",
13924             "type": "String",
13925             "optional": true,
13926             "field": "lastevent",
13927             "description": ""
13928           },
13929           {
13930             "group": "Body",
13931             "type": "String",
13932             "optional": true,
13933             "field": "channel",
13934             "description": ""
13935           },
13936           {
13937             "group": "Body",
13938             "type": "Integer",
13939             "optional": true,
13940             "field": "channelstate",
13941             "description": ""
13942           },
13943           {
13944             "group": "Body",
13945             "type": "String",
13946             "optional": true,
13947             "field": "channelstatedesc",
13948             "description": ""
13949           },
13950           {
13951             "group": "Body",
13952             "type": "String",
13953             "optional": true,
13954             "field": "connectedlinenum",
13955             "description": ""
13956           },
13957           {
13958             "group": "Body",
13959             "type": "String",
13960             "optional": true,
13961             "field": "connectedlinename",
13962             "description": ""
13963           },
13964           {
13965             "group": "Body",
13966             "type": "String",
13967             "optional": true,
13968             "field": "language",
13969             "description": ""
13970           },
13971           {
13972             "group": "Body",
13973             "type": "String",
13974             "optional": true,
13975             "field": "accountcode",
13976             "description": ""
13977           },
13978           {
13979             "group": "Body",
13980             "type": "String",
13981             "optional": true,
13982             "field": "context",
13983             "description": ""
13984           },
13985           {
13986             "group": "Body",
13987             "type": "String",
13988             "optional": true,
13989             "field": "exten",
13990             "description": ""
13991           },
13992           {
13993             "group": "Body",
13994             "type": "String",
13995             "optional": true,
13996             "field": "priority",
13997             "description": ""
13998           },
13999           {
14000             "group": "Body",
14001             "type": "String",
14002             "optional": true,
14003             "field": "destchannel",
14004             "description": ""
14005           },
14006           {
14007             "group": "Body",
14008             "type": "Integer",
14009             "optional": true,
14010             "field": "destchannelstate",
14011             "description": ""
14012           },
14013           {
14014             "group": "Body",
14015             "type": "String",
14016             "optional": true,
14017             "field": "destchannelstatedesc",
14018             "description": ""
14019           },
14020           {
14021             "group": "Body",
14022             "type": "String",
14023             "optional": true,
14024             "field": "destcalleridnum",
14025             "description": ""
14026           },
14027           {
14028             "group": "Body",
14029             "type": "String",
14030             "optional": true,
14031             "field": "destcalleridname",
14032             "description": ""
14033           },
14034           {
14035             "group": "Body",
14036             "type": "String",
14037             "optional": true,
14038             "field": "destconnectedlinenum",
14039             "description": ""
14040           },
14041           {
14042             "group": "Body",
14043             "type": "String",
14044             "optional": true,
14045             "field": "destconnectedlinename",
14046             "description": ""
14047           },
14048           {
14049             "group": "Body",
14050             "type": "String",
14051             "optional": true,
14052             "field": "destlanguage",
14053             "description": ""
14054           },
14055           {
14056             "group": "Body",
14057             "type": "String",
14058             "optional": true,
14059             "field": "destaccountcode",
14060             "description": ""
14061           },
14062           {
14063             "group": "Body",
14064             "type": "String",
14065             "optional": true,
14066             "field": "destcontext",
14067             "description": ""
14068           },
14069           {
14070             "group": "Body",
14071             "type": "String",
14072             "optional": true,
14073             "field": "destexten",
14074             "description": ""
14075           },
14076           {
14077             "group": "Body",
14078             "type": "String",
14079             "optional": true,
14080             "field": "destpriority",
14081             "description": ""
14082           },
14083           {
14084             "group": "Body",
14085             "type": "String",
14086             "optional": true,
14087             "field": "destuniqueid",
14088             "description": ""
14089           },
14090           {
14091             "group": "Body",
14092             "type": "String",
14093             "optional": true,
14094             "field": "messageId",
14095             "description": ""
14096           },
14097           {
14098             "group": "Body",
14099             "type": "String",
14100             "optional": true,
14101             "field": "inReplyTo",
14102             "description": ""
14103           },
14104           {
14105             "group": "Body",
14106             "type": "String",
14107             "optional": true,
14108             "field": "subject",
14109             "description": ""
14110           },
14111           {
14112             "group": "Body",
14113             "type": "String",
14114             "optional": true,
14115             "field": "from",
14116             "description": ""
14117           },
14118           {
14119             "group": "Body",
14120             "type": "String",
14121             "optional": true,
14122             "field": "to",
14123             "description": ""
14124           },
14125           {
14126             "group": "Body",
14127             "type": "String",
14128             "optional": true,
14129             "field": "cc",
14130             "description": ""
14131           },
14132           {
14133             "group": "Body",
14134             "type": "Text",
14135             "optional": true,
14136             "field": "attachment",
14137             "description": ""
14138           },
14139           {
14140             "group": "Body",
14141             "type": "Text",
14142             "optional": true,
14143             "field": "html",
14144             "description": ""
14145           },
14146           {
14147             "group": "Body",
14148             "type": "Text",
14149             "optional": true,
14150             "field": "text",
14151             "description": ""
14152           },
14153           {
14154             "group": "Body",
14155             "type": "String",
14156             "allowedValues": [
14157               "\"SENT\"",
14158               "\"SENDING\"",
14159               "\"RECEIVED\"",
14160               "\"FAILED\""
14161             ],
14162             "optional": true,
14163             "field": "status",
14164             "description": ""
14165           },
14166           {
14167             "group": "Body",
14168             "type": "String",
14169             "optional": true,
14170             "field": "url",
14171             "description": ""
14172           },
14173           {
14174             "group": "Body",
14175             "type": "String",
14176             "optional": true,
14177             "field": "app",
14178             "description": ""
14179           },
14180           {
14181             "group": "Body",
14182             "type": "String",
14183             "optional": true,
14184             "field": "appdata",
14185             "description": ""
14186           },
14187           {
14188             "group": "Body",
14189             "type": "Integer",
14190             "optional": true,
14191             "field": "projectId",
14192             "description": ""
14193           }
14194         ]
14195       }
14196     },
14197     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14198     "version": "0.0.0",
14199     "filename": "server/api/integrationReport/index.js",
14200     "groupTitle": "Integration_Reports"
14201   },
14202   {
14203     "type": "delete",
14204     "url": "/api/integrations/reports/{id}",
14205     "title": "Deletes a Integration Report",
14206     "examples": [
14207       {
14208         "title": "Example usage:",
14209         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
14210         "type": "json"
14211       }
14212     ],
14213     "name": "DeleteIntegration_Reports",
14214     "group": "Integration_Reports",
14215     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14216     "version": "0.0.0",
14217     "filename": "server/api/integrationReport/index.js",
14218     "groupTitle": "Integration_Reports"
14219   },
14220   {
14221     "type": "get",
14222     "url": "/api/integrations/reports/describe",
14223     "title": "Gets table info about Integration Reports",
14224     "examples": [
14225       {
14226         "title": "Example usage:",
14227         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
14228         "type": "json"
14229       }
14230     ],
14231     "name": "DescribeIntegration_Reports",
14232     "group": "Integration_Reports",
14233     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14234     "version": "0.0.0",
14235     "filename": "server/api/integrationReport/index.js",
14236     "groupTitle": "Integration_Reports"
14237   },
14238   {
14239     "type": "get",
14240     "url": "/api/integrations/reports",
14241     "title": "Gets a list of Integration Reports",
14242     "examples": [
14243       {
14244         "title": "Example usage:",
14245         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
14246         "type": "json"
14247       }
14248     ],
14249     "name": "GetIntegration_Reports",
14250     "group": "Integration_Reports",
14251     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14252     "version": "0.0.0",
14253     "filename": "server/api/integrationReport/index.js",
14254     "groupTitle": "Integration_Reports"
14255   },
14256   {
14257     "type": "get",
14258     "url": "/api/integrations/reports/{id}",
14259     "title": "Gets a single Integration Report",
14260     "examples": [
14261       {
14262         "title": "Example usage:",
14263         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
14264         "type": "json"
14265       }
14266     ],
14267     "name": "ShowIntegration_Reports",
14268     "group": "Integration_Reports",
14269     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14270     "version": "0.0.0",
14271     "filename": "server/api/integrationReport/index.js",
14272     "groupTitle": "Integration_Reports"
14273   },
14274   {
14275     "type": "put",
14276     "url": "/api/integrations/reports/{id}",
14277     "title": "Update an existing Integration Report",
14278     "examples": [
14279       {
14280         "title": "Example usage:",
14281         "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",
14282         "type": "json"
14283       }
14284     ],
14285     "name": "updateIntegration_Reports",
14286     "group": "Integration_Reports",
14287     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14288     "version": "0.0.0",
14289     "filename": "server/api/integrationReport/index.js",
14290     "groupTitle": "Integration_Reports"
14291   },
14292   {
14293     "type": "post",
14294     "url": "/api/intervals",
14295     "title": "Creates a new Interval",
14296     "examples": [
14297       {
14298         "title": "Example usage:",
14299         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14300         "type": "json"
14301       }
14302     ],
14303     "name": "CreateIntervals",
14304     "group": "Intervals",
14305     "parameter": {
14306       "fields": {
14307         "Body": [
14308           {
14309             "group": "Body",
14310             "type": "String",
14311             "optional": true,
14312             "field": "name",
14313             "description": ""
14314           },
14315           {
14316             "group": "Body",
14317             "type": "String",
14318             "optional": true,
14319             "field": "description",
14320             "description": ""
14321           },
14322           {
14323             "group": "Body",
14324             "type": "String",
14325             "optional": true,
14326             "field": "interval",
14327             "description": ""
14328           }
14329         ]
14330       }
14331     },
14332     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14333     "version": "0.0.0",
14334     "filename": "server/api/interval/index.js",
14335     "groupTitle": "Intervals"
14336   },
14337   {
14338     "type": "delete",
14339     "url": "/api/intervals/{id}",
14340     "title": "Deletes a Interval",
14341     "examples": [
14342       {
14343         "title": "Example usage:",
14344         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
14345         "type": "json"
14346       }
14347     ],
14348     "name": "DeleteIntervals",
14349     "group": "Intervals",
14350     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14351     "version": "0.0.0",
14352     "filename": "server/api/interval/index.js",
14353     "groupTitle": "Intervals"
14354   },
14355   {
14356     "type": "get",
14357     "url": "/api/intervals",
14358     "title": "Gets a list of Intervals",
14359     "examples": [
14360       {
14361         "title": "Example usage:",
14362         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
14363         "type": "json"
14364       }
14365     ],
14366     "name": "GetIntervals",
14367     "group": "Intervals",
14368     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14369     "version": "0.0.0",
14370     "filename": "server/api/interval/index.js",
14371     "groupTitle": "Intervals"
14372   },
14373   {
14374     "type": "get",
14375     "url": "/api/intervals/{id}",
14376     "title": "Gets a single Interval",
14377     "examples": [
14378       {
14379         "title": "Example usage:",
14380         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
14381         "type": "json"
14382       }
14383     ],
14384     "name": "ShowIntervals",
14385     "group": "Intervals",
14386     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14387     "version": "0.0.0",
14388     "filename": "server/api/interval/index.js",
14389     "groupTitle": "Intervals"
14390   },
14391   {
14392     "type": "post",
14393     "url": "/api/intervals/{id}/sub_intervals",
14394     "title": "Creates a new sub interval",
14395     "examples": [
14396       {
14397         "title": "Example usage:",
14398         "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",
14399         "type": "json"
14400       }
14401     ],
14402     "name": "addInterval",
14403     "group": "Intervals",
14404     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14405     "version": "0.0.0",
14406     "filename": "server/api/interval/index.js",
14407     "groupTitle": "Intervals"
14408   },
14409   {
14410     "type": "post",
14411     "url": "/api/intervals/{id}/sub_intervals/create_many",
14412     "title": "Create new sub intervals set",
14413     "examples": [
14414       {
14415         "title": "Example usage:",
14416         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14417         "type": "json"
14418       }
14419     ],
14420     "name": "addIntervals",
14421     "group": "Intervals",
14422     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14423     "version": "0.0.0",
14424     "filename": "server/api/interval/index.js",
14425     "groupTitle": "Intervals"
14426   },
14427   {
14428     "type": "get",
14429     "url": "/api/intervals/{id}/sub_intervals",
14430     "title": "Get sub intervals set",
14431     "examples": [
14432       {
14433         "title": "Example usage:",
14434         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
14435         "type": "json"
14436       }
14437     ],
14438     "name": "getIntervals",
14439     "group": "Intervals",
14440     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14441     "version": "0.0.0",
14442     "filename": "server/api/interval/index.js",
14443     "groupTitle": "Intervals"
14444   },
14445   {
14446     "type": "put",
14447     "url": "/api/intervals/{id}",
14448     "title": "Update an existing Interval",
14449     "examples": [
14450       {
14451         "title": "Example usage:",
14452         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
14453         "type": "json"
14454       }
14455     ],
14456     "name": "updateIntervals",
14457     "group": "Intervals",
14458     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14459     "version": "0.0.0",
14460     "filename": "server/api/interval/index.js",
14461     "groupTitle": "Intervals"
14462   },
14463   {
14464     "type": "post",
14465     "url": "/api/jira",
14466     "title": "Creates a new issue",
14467     "examples": [
14468       {
14469         "title": "Example usage:",
14470         "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}",
14471         "type": "json"
14472       }
14473     ],
14474     "name": "Creates_Issue",
14475     "group": "Issue",
14476     "parameter": {
14477       "fields": {
14478         "Body": [
14479           {
14480             "group": "Body",
14481             "type": "String",
14482             "allowedValues": [
14483               "\"Bug\""
14484             ],
14485             "optional": true,
14486             "field": "issuetype",
14487             "description": ""
14488           },
14489           {
14490             "group": "Body",
14491             "type": "String",
14492             "optional": false,
14493             "field": "summary",
14494             "description": ""
14495           },
14496           {
14497             "group": "Body",
14498             "type": "String",
14499             "optional": false,
14500             "field": "description",
14501             "description": ""
14502           }
14503         ]
14504       }
14505     },
14506     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14507     "version": "0.0.0",
14508     "filename": "server/api/jira/index.js",
14509     "groupTitle": "Issue"
14510   },
14511   {
14512     "type": "post",
14513     "url": "/api/jscripty/answers/reports",
14514     "title": "Creates a new Report",
14515     "examples": [
14516       {
14517         "title": "Example usage:",
14518         "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",
14519         "type": "json"
14520       }
14521     ],
14522     "name": "CreateReports",
14523     "group": "JscriptyAnswerReport",
14524     "parameter": {
14525       "fields": {
14526         "Body": [
14527           {
14528             "group": "Body",
14529             "type": "Text",
14530             "optional": true,
14531             "field": "question",
14532             "description": ""
14533           },
14534           {
14535             "group": "Body",
14536             "type": "Text",
14537             "optional": true,
14538             "field": "answer",
14539             "description": ""
14540           },
14541           {
14542             "group": "Body",
14543             "type": "String",
14544             "optional": true,
14545             "field": "membername",
14546             "description": ""
14547           },
14548           {
14549             "group": "Body",
14550             "type": "String",
14551             "optional": true,
14552             "field": "projectname",
14553             "description": ""
14554           },
14555           {
14556             "group": "Body",
14557             "type": "String",
14558             "optional": true,
14559             "field": "queue",
14560             "description": ""
14561           },
14562           {
14563             "group": "Body",
14564             "type": "String",
14565             "optional": true,
14566             "field": "uniqueid",
14567             "description": ""
14568           },
14569           {
14570             "group": "Body",
14571             "type": "String",
14572             "optional": true,
14573             "field": "calleridname",
14574             "description": ""
14575           },
14576           {
14577             "group": "Body",
14578             "type": "String",
14579             "optional": true,
14580             "field": "calleridnum",
14581             "description": ""
14582           },
14583           {
14584             "group": "Body",
14585             "type": "String",
14586             "optional": true,
14587             "field": "questionId",
14588             "description": ""
14589           }
14590         ]
14591       }
14592     },
14593     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14594     "version": "0.0.0",
14595     "filename": "server/api/jscriptyAnswerReport/index.js",
14596     "groupTitle": "JscriptyAnswerReport"
14597   },
14598   {
14599     "type": "delete",
14600     "url": "/api/jscripty/answers/reports/{id}",
14601     "title": "Deletes a Report",
14602     "examples": [
14603       {
14604         "title": "Example usage:",
14605         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
14606         "type": "json"
14607       }
14608     ],
14609     "name": "DeleteReports",
14610     "group": "JscriptyAnswerReport",
14611     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14612     "version": "0.0.0",
14613     "filename": "server/api/jscriptyAnswerReport/index.js",
14614     "groupTitle": "JscriptyAnswerReport"
14615   },
14616   {
14617     "type": "get",
14618     "url": "/api/jscripty/answers/reports/describe",
14619     "title": "Gets table info about Reports",
14620     "examples": [
14621       {
14622         "title": "Example usage:",
14623         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
14624         "type": "json"
14625       }
14626     ],
14627     "name": "DescribeReports",
14628     "group": "JscriptyAnswerReport",
14629     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14630     "version": "0.0.0",
14631     "filename": "server/api/jscriptyAnswerReport/index.js",
14632     "groupTitle": "JscriptyAnswerReport"
14633   },
14634   {
14635     "type": "get",
14636     "url": "/api/jscripty/answers/reports",
14637     "title": "Gets a list of Reports",
14638     "examples": [
14639       {
14640         "title": "Example usage:",
14641         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14642         "type": "json"
14643       }
14644     ],
14645     "name": "GetReports",
14646     "group": "JscriptyAnswerReport",
14647     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14648     "version": "0.0.0",
14649     "filename": "server/api/jscriptyAnswerReport/index.js",
14650     "groupTitle": "JscriptyAnswerReport"
14651   },
14652   {
14653     "type": "get",
14654     "url": "/api/jscripty/answers/reports/{id}",
14655     "title": "Gets a single Report",
14656     "examples": [
14657       {
14658         "title": "Example usage:",
14659         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14660         "type": "json"
14661       }
14662     ],
14663     "name": "ShowReports",
14664     "group": "JscriptyAnswerReport",
14665     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14666     "version": "0.0.0",
14667     "filename": "server/api/jscriptyAnswerReport/index.js",
14668     "groupTitle": "JscriptyAnswerReport"
14669   },
14670   {
14671     "type": "put",
14672     "url": "/api/jscripty/answers/reports/{id}",
14673     "title": "Update an existing Report",
14674     "examples": [
14675       {
14676         "title": "Example usage:",
14677         "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",
14678         "type": "json"
14679       }
14680     ],
14681     "name": "updateReports",
14682     "group": "JscriptyAnswerReport",
14683     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14684     "version": "0.0.0",
14685     "filename": "server/api/jscriptyAnswerReport/index.js",
14686     "groupTitle": "JscriptyAnswerReport"
14687   },
14688   {
14689     "type": "post",
14690     "url": "/api/jscripty/questions/reports",
14691     "title": "Creates a new Report",
14692     "examples": [
14693       {
14694         "title": "Example usage:",
14695         "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",
14696         "type": "json"
14697       }
14698     ],
14699     "name": "CreateReports",
14700     "group": "JscriptyQuestionReport",
14701     "parameter": {
14702       "fields": {
14703         "Body": [
14704           {
14705             "group": "Body",
14706             "type": "Text",
14707             "optional": true,
14708             "field": "question",
14709             "description": ""
14710           },
14711           {
14712             "group": "Body",
14713             "type": "Text",
14714             "optional": true,
14715             "field": "answer",
14716             "description": ""
14717           },
14718           {
14719             "group": "Body",
14720             "type": "String",
14721             "optional": true,
14722             "field": "membername",
14723             "description": ""
14724           },
14725           {
14726             "group": "Body",
14727             "type": "String",
14728             "optional": true,
14729             "field": "projectname",
14730             "description": ""
14731           },
14732           {
14733             "group": "Body",
14734             "type": "String",
14735             "optional": true,
14736             "field": "queue",
14737             "description": ""
14738           },
14739           {
14740             "group": "Body",
14741             "type": "String",
14742             "optional": true,
14743             "field": "uniqueid",
14744             "description": ""
14745           },
14746           {
14747             "group": "Body",
14748             "type": "String",
14749             "optional": true,
14750             "field": "calleridname",
14751             "description": ""
14752           },
14753           {
14754             "group": "Body",
14755             "type": "String",
14756             "optional": true,
14757             "field": "calleridnum",
14758             "description": ""
14759           },
14760           {
14761             "group": "Body",
14762             "type": "String",
14763             "optional": true,
14764             "field": "questionId",
14765             "description": ""
14766           }
14767         ]
14768       }
14769     },
14770     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14771     "version": "0.0.0",
14772     "filename": "server/api/jscriptyQuestionReport/index.js",
14773     "groupTitle": "JscriptyQuestionReport"
14774   },
14775   {
14776     "type": "delete",
14777     "url": "/api/jscripty/questions/reports/{id}",
14778     "title": "Deletes a Report",
14779     "examples": [
14780       {
14781         "title": "Example usage:",
14782         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14783         "type": "json"
14784       }
14785     ],
14786     "name": "DeleteReports",
14787     "group": "JscriptyQuestionReport",
14788     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14789     "version": "0.0.0",
14790     "filename": "server/api/jscriptyQuestionReport/index.js",
14791     "groupTitle": "JscriptyQuestionReport"
14792   },
14793   {
14794     "type": "get",
14795     "url": "/api/jscripty/questions/reports/describe",
14796     "title": "Gets table info about Reports",
14797     "examples": [
14798       {
14799         "title": "Example usage:",
14800         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14801         "type": "json"
14802       }
14803     ],
14804     "name": "DescribeReports",
14805     "group": "JscriptyQuestionReport",
14806     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14807     "version": "0.0.0",
14808     "filename": "server/api/jscriptyQuestionReport/index.js",
14809     "groupTitle": "JscriptyQuestionReport"
14810   },
14811   {
14812     "type": "get",
14813     "url": "/api/jscripty/questions/reports",
14814     "title": "Gets a list of Reports",
14815     "examples": [
14816       {
14817         "title": "Example usage:",
14818         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14819         "type": "json"
14820       }
14821     ],
14822     "name": "GetReports",
14823     "group": "JscriptyQuestionReport",
14824     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14825     "version": "0.0.0",
14826     "filename": "server/api/jscriptyQuestionReport/index.js",
14827     "groupTitle": "JscriptyQuestionReport"
14828   },
14829   {
14830     "type": "get",
14831     "url": "/api/jscripty/questions/reports/{id}",
14832     "title": "Gets a single Report",
14833     "examples": [
14834       {
14835         "title": "Example usage:",
14836         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14837         "type": "json"
14838       }
14839     ],
14840     "name": "ShowReports",
14841     "group": "JscriptyQuestionReport",
14842     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14843     "version": "0.0.0",
14844     "filename": "server/api/jscriptyQuestionReport/index.js",
14845     "groupTitle": "JscriptyQuestionReport"
14846   },
14847   {
14848     "type": "put",
14849     "url": "/api/jscripty/questions/reports/{id}",
14850     "title": "Update an existing Report",
14851     "examples": [
14852       {
14853         "title": "Example usage:",
14854         "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",
14855         "type": "json"
14856       }
14857     ],
14858     "name": "updateReports",
14859     "group": "JscriptyQuestionReport",
14860     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14861     "version": "0.0.0",
14862     "filename": "server/api/jscriptyQuestionReport/index.js",
14863     "groupTitle": "JscriptyQuestionReport"
14864   },
14865   {
14866     "type": "post",
14867     "url": "/api/jscripty/sessions/reports",
14868     "title": "Creates a new Report",
14869     "examples": [
14870       {
14871         "title": "Example usage:",
14872         "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",
14873         "type": "json"
14874       }
14875     ],
14876     "name": "CreateReports",
14877     "group": "JscriptySessionReport",
14878     "parameter": {
14879       "fields": {
14880         "Body": [
14881           {
14882             "group": "Body",
14883             "type": "String",
14884             "optional": true,
14885             "field": "starttime",
14886             "description": ""
14887           },
14888           {
14889             "group": "Body",
14890             "type": "String",
14891             "optional": true,
14892             "field": "endtime",
14893             "description": ""
14894           },
14895           {
14896             "group": "Body",
14897             "type": "String",
14898             "optional": true,
14899             "field": "membername",
14900             "description": ""
14901           },
14902           {
14903             "group": "Body",
14904             "type": "String",
14905             "optional": true,
14906             "field": "projectname",
14907             "description": ""
14908           },
14909           {
14910             "group": "Body",
14911             "type": "String",
14912             "optional": true,
14913             "field": "queue",
14914             "description": ""
14915           },
14916           {
14917             "group": "Body",
14918             "type": "String",
14919             "optional": true,
14920             "field": "uniqueid",
14921             "description": ""
14922           },
14923           {
14924             "group": "Body",
14925             "type": "String",
14926             "optional": true,
14927             "field": "calleridname",
14928             "description": ""
14929           },
14930           {
14931             "group": "Body",
14932             "type": "String",
14933             "optional": true,
14934             "field": "calleridnum",
14935             "description": ""
14936           },
14937           {
14938             "group": "Body",
14939             "type": "Boolean",
14940             "optional": true,
14941             "field": "completed",
14942             "description": ""
14943           }
14944         ]
14945       }
14946     },
14947     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14948     "version": "0.0.0",
14949     "filename": "server/api/jscriptySessionReport/index.js",
14950     "groupTitle": "JscriptySessionReport"
14951   },
14952   {
14953     "type": "delete",
14954     "url": "/api/jscripty/sessions/reports/{id}",
14955     "title": "Deletes a Report",
14956     "examples": [
14957       {
14958         "title": "Example usage:",
14959         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14960         "type": "json"
14961       }
14962     ],
14963     "name": "DeleteReports",
14964     "group": "JscriptySessionReport",
14965     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14966     "version": "0.0.0",
14967     "filename": "server/api/jscriptySessionReport/index.js",
14968     "groupTitle": "JscriptySessionReport"
14969   },
14970   {
14971     "type": "get",
14972     "url": "/api/jscripty/sessions/reports/describe",
14973     "title": "Gets table info about Reports",
14974     "examples": [
14975       {
14976         "title": "Example usage:",
14977         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14978         "type": "json"
14979       }
14980     ],
14981     "name": "DescribeReports",
14982     "group": "JscriptySessionReport",
14983     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14984     "version": "0.0.0",
14985     "filename": "server/api/jscriptySessionReport/index.js",
14986     "groupTitle": "JscriptySessionReport"
14987   },
14988   {
14989     "type": "get",
14990     "url": "/api/jscripty/sessions/reports",
14991     "title": "Gets a list of Reports",
14992     "examples": [
14993       {
14994         "title": "Example usage:",
14995         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14996         "type": "json"
14997       }
14998     ],
14999     "name": "GetReports",
15000     "group": "JscriptySessionReport",
15001     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15002     "version": "0.0.0",
15003     "filename": "server/api/jscriptySessionReport/index.js",
15004     "groupTitle": "JscriptySessionReport"
15005   },
15006   {
15007     "type": "get",
15008     "url": "/api/jscripty/sessions/reports/{id}",
15009     "title": "Gets a single Report",
15010     "examples": [
15011       {
15012         "title": "Example usage:",
15013         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
15014         "type": "json"
15015       }
15016     ],
15017     "name": "ShowReports",
15018     "group": "JscriptySessionReport",
15019     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15020     "version": "0.0.0",
15021     "filename": "server/api/jscriptySessionReport/index.js",
15022     "groupTitle": "JscriptySessionReport"
15023   },
15024   {
15025     "type": "get",
15026     "url": "/api/jscripty/sessions/reports/{id}/questions",
15027     "title": "Gets Jscripty Session questions",
15028     "examples": [
15029       {
15030         "title": "Example usage:",
15031         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
15032         "type": "json"
15033       }
15034     ],
15035     "name": "getQuestions",
15036     "group": "JscriptySessionReport",
15037     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15038     "version": "0.0.0",
15039     "filename": "server/api/jscriptySessionReport/index.js",
15040     "groupTitle": "JscriptySessionReport"
15041   },
15042   {
15043     "type": "put",
15044     "url": "/api/jscripty/sessions/reports/{id}",
15045     "title": "Update an existing Report",
15046     "examples": [
15047       {
15048         "title": "Example usage:",
15049         "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",
15050         "type": "json"
15051       }
15052     ],
15053     "name": "updateReports",
15054     "group": "JscriptySessionReport",
15055     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15056     "version": "0.0.0",
15057     "filename": "server/api/jscriptySessionReport/index.js",
15058     "groupTitle": "JscriptySessionReport"
15059   },
15060   {
15061     "type": "post",
15062     "url": "/api/jscripty/projects/clone",
15063     "title": "Clone an existing Project",
15064     "examples": [
15065       {
15066         "title": "Example usage:",
15067         "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",
15068         "type": "json"
15069       }
15070     ],
15071     "name": "CloneProjects",
15072     "group": "Jscripty_Projects",
15073     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15074     "version": "0.0.0",
15075     "filename": "server/api/jscriptyProject/index.js",
15076     "groupTitle": "Jscripty_Projects"
15077   },
15078   {
15079     "type": "post",
15080     "url": "/api/jscripty/projects",
15081     "title": "Creates a new Project",
15082     "examples": [
15083       {
15084         "title": "Example usage:",
15085         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15086         "type": "json"
15087       }
15088     ],
15089     "name": "CreateProjects",
15090     "group": "Jscripty_Projects",
15091     "parameter": {
15092       "fields": {
15093         "Body": [
15094           {
15095             "group": "Body",
15096             "type": "String",
15097             "optional": true,
15098             "field": "name",
15099             "description": ""
15100           },
15101           {
15102             "group": "Body",
15103             "type": "String",
15104             "optional": true,
15105             "field": "description",
15106             "description": ""
15107           },
15108           {
15109             "group": "Body",
15110             "type": "Text",
15111             "optional": true,
15112             "field": "formData",
15113             "description": ""
15114           },
15115           {
15116             "group": "Body",
15117             "type": "Boolean",
15118             "optional": true,
15119             "field": "enableUncompleteSave",
15120             "description": ""
15121           },
15122           {
15123             "group": "Body",
15124             "type": "Boolean",
15125             "optional": true,
15126             "field": "sendUnpauseOnSubmit",
15127             "description": ""
15128           }
15129         ]
15130       }
15131     },
15132     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15133     "version": "0.0.0",
15134     "filename": "server/api/jscriptyProject/index.js",
15135     "groupTitle": "Jscripty_Projects"
15136   },
15137   {
15138     "type": "delete",
15139     "url": "/api/jscripty/projects/{id}",
15140     "title": "Deletes a Project",
15141     "examples": [
15142       {
15143         "title": "Example usage:",
15144         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
15145         "type": "json"
15146       }
15147     ],
15148     "name": "DeleteProjects",
15149     "group": "Jscripty_Projects",
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/jscriptyProject/index.js",
15153     "groupTitle": "Jscripty_Projects"
15154   },
15155   {
15156     "type": "get",
15157     "url": "/api/jscripty/projects",
15158     "title": "Gets a list of Projects",
15159     "examples": [
15160       {
15161         "title": "Example usage:",
15162         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
15163         "type": "json"
15164       }
15165     ],
15166     "name": "GetProjects",
15167     "group": "Jscripty_Projects",
15168     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15169     "version": "0.0.0",
15170     "filename": "server/api/jscriptyProject/index.js",
15171     "groupTitle": "Jscripty_Projects"
15172   },
15173   {
15174     "type": "get",
15175     "url": "/api/jscripty/projects/{id}",
15176     "title": "Gets a single Project",
15177     "examples": [
15178       {
15179         "title": "Example usage:",
15180         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
15181         "type": "json"
15182       }
15183     ],
15184     "name": "ShowProjects",
15185     "group": "Jscripty_Projects",
15186     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/jscriptyProject/index.js",
15189     "groupTitle": "Jscripty_Projects"
15190   },
15191   {
15192     "type": "get",
15193     "url": "/api/jscripty/projects/{id}/answers",
15194     "title": "Gets jscripty project answers",
15195     "examples": [
15196       {
15197         "title": "Example usage:",
15198         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
15199         "type": "json"
15200       }
15201     ],
15202     "name": "getAnswers",
15203     "group": "Jscripty_Projects",
15204     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/jscriptyProject/index.js",
15207     "groupTitle": "Jscripty_Projects"
15208   },
15209   {
15210     "type": "get",
15211     "url": "/api/jscripty/projects/{id}/sessions",
15212     "title": "Gets jscripty project sessions",
15213     "examples": [
15214       {
15215         "title": "Example usage:",
15216         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
15217         "type": "json"
15218       }
15219     ],
15220     "name": "getSessions",
15221     "group": "Jscripty_Projects",
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/jscriptyProject/index.js",
15225     "groupTitle": "Jscripty_Projects"
15226   },
15227   {
15228     "type": "get",
15229     "url": "/api/jscripty/projects/{id}/summary",
15230     "title": "Gets jscripty project summary",
15231     "examples": [
15232       {
15233         "title": "Example usage:",
15234         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
15235         "type": "json"
15236       }
15237     ],
15238     "name": "getSummary",
15239     "group": "Jscripty_Projects",
15240     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15241     "version": "0.0.0",
15242     "filename": "server/api/jscriptyProject/index.js",
15243     "groupTitle": "Jscripty_Projects"
15244   },
15245   {
15246     "type": "put",
15247     "url": "/api/jscripty/projects/{id}",
15248     "title": "Update an existing Project",
15249     "examples": [
15250       {
15251         "title": "Example usage:",
15252         "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",
15253         "type": "json"
15254       }
15255     ],
15256     "name": "updateProjects",
15257     "group": "Jscripty_Projects",
15258     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15259     "version": "0.0.0",
15260     "filename": "server/api/jscriptyProject/index.js",
15261     "groupTitle": "Jscripty_Projects"
15262   },
15263   {
15264     "type": "get",
15265     "url": "/api/license",
15266     "title": "Gets License Info",
15267     "examples": [
15268       {
15269         "title": "Example usage:",
15270         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
15271         "type": "json"
15272       }
15273     ],
15274     "name": "index",
15275     "group": "License",
15276     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15277     "version": "0.0.0",
15278     "filename": "server/api/license/index.js",
15279     "groupTitle": "License"
15280   },
15281   {
15282     "type": "put",
15283     "url": "/api/license/{id}",
15284     "title": "Update License Info",
15285     "examples": [
15286       {
15287         "title": "Example usage:",
15288         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
15289         "type": "json"
15290       }
15291     ],
15292     "name": "update",
15293     "group": "License",
15294     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15295     "version": "0.0.0",
15296     "filename": "server/api/license/index.js",
15297     "groupTitle": "License"
15298   },
15299   {
15300     "type": "post",
15301     "url": "/api/mail/accounts/{id}/users",
15302     "title": "Add agents to a mail account",
15303     "examples": [
15304       {
15305         "title": "Example usage:",
15306         "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",
15307         "type": "json"
15308       }
15309     ],
15310     "name": "AddAgents",
15311     "group": "Mail_Accounts",
15312     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15313     "version": "0.0.0",
15314     "filename": "server/api/mailAccount/index.js",
15315     "groupTitle": "Mail_Accounts"
15316   },
15317   {
15318     "type": "post",
15319     "url": "/api/mail/accounts/{id}/in_servers",
15320     "title": "Creates a new IMAP server",
15321     "examples": [
15322       {
15323         "title": "Example usage:",
15324         "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",
15325         "type": "json"
15326       }
15327     ],
15328     "name": "AddImap",
15329     "group": "Mail_Accounts",
15330     "parameter": {
15331       "fields": {
15332         "Body": [
15333           {
15334             "group": "Body",
15335             "type": "String",
15336             "optional": true,
15337             "field": "description",
15338             "description": ""
15339           },
15340           {
15341             "group": "Body",
15342             "type": "String",
15343             "optional": true,
15344             "field": "host",
15345             "description": ""
15346           },
15347           {
15348             "group": "Body",
15349             "type": "Boolean",
15350             "optional": true,
15351             "field": "authentication",
15352             "description": ""
15353           },
15354           {
15355             "group": "Body",
15356             "type": "String",
15357             "optional": true,
15358             "field": "user",
15359             "description": ""
15360           },
15361           {
15362             "group": "Body",
15363             "type": "String",
15364             "optional": true,
15365             "field": "password",
15366             "description": ""
15367           },
15368           {
15369             "group": "Body",
15370             "type": "Integer",
15371             "optional": true,
15372             "field": "port",
15373             "description": ""
15374           },
15375           {
15376             "group": "Body",
15377             "type": "Boolean",
15378             "optional": true,
15379             "field": "tls",
15380             "description": ""
15381           },
15382           {
15383             "group": "Body",
15384             "type": "String",
15385             "optional": true,
15386             "field": "mailbox",
15387             "description": ""
15388           },
15389           {
15390             "group": "Body",
15391             "type": "Integer",
15392             "optional": true,
15393             "field": "connTimeout",
15394             "description": ""
15395           },
15396           {
15397             "group": "Body",
15398             "type": "Integer",
15399             "optional": true,
15400             "field": "authTimeout",
15401             "description": ""
15402           },
15403           {
15404             "group": "Body",
15405             "type": "String",
15406             "optional": true,
15407             "field": "service",
15408             "description": ""
15409           }
15410         ]
15411       }
15412     },
15413     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15414     "version": "0.0.0",
15415     "filename": "server/api/mailAccount/index.js",
15416     "groupTitle": "Mail_Accounts"
15417   },
15418   {
15419     "type": "post",
15420     "url": "/api/mail/accounts/{id}/out_servers",
15421     "title": "Creates a new SMTP server",
15422     "examples": [
15423       {
15424         "title": "Example usage:",
15425         "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",
15426         "type": "json"
15427       }
15428     ],
15429     "name": "AddSmtp",
15430     "group": "Mail_Accounts",
15431     "parameter": {
15432       "fields": {
15433         "Body": [
15434           {
15435             "group": "Body",
15436             "type": "String",
15437             "optional": true,
15438             "field": "description",
15439             "description": ""
15440           },
15441           {
15442             "group": "Body",
15443             "type": "String",
15444             "optional": true,
15445             "field": "host",
15446             "description": ""
15447           },
15448           {
15449             "group": "Body",
15450             "type": "String",
15451             "optional": true,
15452             "field": "user",
15453             "description": ""
15454           },
15455           {
15456             "group": "Body",
15457             "type": "String",
15458             "optional": true,
15459             "field": "pass",
15460             "description": ""
15461           },
15462           {
15463             "group": "Body",
15464             "type": "Integer",
15465             "optional": true,
15466             "field": "port",
15467             "description": ""
15468           },
15469           {
15470             "group": "Body",
15471             "type": "Boolean",
15472             "optional": true,
15473             "field": "secure",
15474             "description": ""
15475           },
15476           {
15477             "group": "Body",
15478             "type": "String",
15479             "optional": true,
15480             "field": "service",
15481             "description": ""
15482           },
15483           {
15484             "group": "Body",
15485             "type": "Boolean",
15486             "optional": true,
15487             "field": "authentication",
15488             "description": ""
15489           }
15490         ]
15491       }
15492     },
15493     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15494     "version": "0.0.0",
15495     "filename": "server/api/mailAccount/index.js",
15496     "groupTitle": "Mail_Accounts"
15497   },
15498   {
15499     "type": "delete",
15500     "url": "/api/mail/accounts/{id}",
15501     "title": "Deletes a mail account",
15502     "examples": [
15503       {
15504         "title": "Example usage:",
15505         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
15506         "type": "json"
15507       }
15508     ],
15509     "name": "DeleteMailAccounts",
15510     "group": "Mail_Accounts",
15511     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15512     "version": "0.0.0",
15513     "filename": "server/api/mailAccount/index.js",
15514     "groupTitle": "Mail_Accounts"
15515   },
15516   {
15517     "type": "get",
15518     "url": "/api/mail/accounts/describe",
15519     "title": "Gets table info about Accounts",
15520     "examples": [
15521       {
15522         "title": "Example usage:",
15523         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
15524         "type": "json"
15525       }
15526     ],
15527     "name": "DescribeAccounts",
15528     "group": "Mail_Accounts",
15529     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15530     "version": "0.0.0",
15531     "filename": "server/api/mailAccount/index.js",
15532     "groupTitle": "Mail_Accounts"
15533   },
15534   {
15535     "type": "get",
15536     "url": "/api/mail/accounts",
15537     "title": "Gets a list of Accounts",
15538     "examples": [
15539       {
15540         "title": "Example usage:",
15541         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
15542         "type": "json"
15543       }
15544     ],
15545     "name": "GetAccounts",
15546     "group": "Mail_Accounts",
15547     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15548     "version": "0.0.0",
15549     "filename": "server/api/mailAccount/index.js",
15550     "groupTitle": "Mail_Accounts"
15551   },
15552   {
15553     "type": "get",
15554     "url": "/api/mail/accounts/{id}/users",
15555     "title": "Gets agents from mail account",
15556     "examples": [
15557       {
15558         "title": "Example usage:",
15559         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
15560         "type": "json"
15561       }
15562     ],
15563     "name": "GetAgents",
15564     "group": "Mail_Accounts",
15565     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15566     "version": "0.0.0",
15567     "filename": "server/api/mailAccount/index.js",
15568     "groupTitle": "Mail_Accounts"
15569   },
15570   {
15571     "type": "get",
15572     "url": "/api/mail/accounts/{id}/in_servers",
15573     "title": "Gets account IMAP server",
15574     "examples": [
15575       {
15576         "title": "Example usage:",
15577         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
15578         "type": "json"
15579       }
15580     ],
15581     "name": "GetImap",
15582     "group": "Mail_Accounts",
15583     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15584     "version": "0.0.0",
15585     "filename": "server/api/mailAccount/index.js",
15586     "groupTitle": "Mail_Accounts"
15587   },
15588   {
15589     "type": "get",
15590     "url": "/api/mail/accounts/{id}/out_servers",
15591     "title": "Gets account SMTP server",
15592     "examples": [
15593       {
15594         "title": "Example usage:",
15595         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
15596         "type": "json"
15597       }
15598     ],
15599     "name": "GetSmtp",
15600     "group": "Mail_Accounts",
15601     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15602     "version": "0.0.0",
15603     "filename": "server/api/mailAccount/index.js",
15604     "groupTitle": "Mail_Accounts"
15605   },
15606   {
15607     "type": "delete",
15608     "url": "/api/mail/accounts/{id}/users",
15609     "title": "Removes agents from a mail account",
15610     "examples": [
15611       {
15612         "title": "Example usage:",
15613         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15614         "type": "json"
15615       }
15616     ],
15617     "name": "RemoveAgents",
15618     "group": "Mail_Accounts",
15619     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15620     "version": "0.0.0",
15621     "filename": "server/api/mailAccount/index.js",
15622     "groupTitle": "Mail_Accounts"
15623   },
15624   {
15625     "type": "delete",
15626     "url": "/api/mail/accounts/{id}/canned_answers",
15627     "title": "Removes canned answers from account",
15628     "examples": [
15629       {
15630         "title": "Example usage:",
15631         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15632         "type": "json"
15633       }
15634     ],
15635     "name": "RemoveAnswers",
15636     "group": "Mail_Accounts",
15637     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15638     "version": "0.0.0",
15639     "filename": "server/api/mailAccount/index.js",
15640     "groupTitle": "Mail_Accounts"
15641   },
15642   {
15643     "type": "delete",
15644     "url": "/api/mail/accounts/{id}/dispositions",
15645     "title": "Removes dispositions from account",
15646     "examples": [
15647       {
15648         "title": "Example usage:",
15649         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15650         "type": "json"
15651       }
15652     ],
15653     "name": "RemoveDispositions",
15654     "group": "Mail_Accounts",
15655     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15656     "version": "0.0.0",
15657     "filename": "server/api/mailAccount/index.js",
15658     "groupTitle": "Mail_Accounts"
15659   },
15660   {
15661     "type": "delete",
15662     "url": "/api/mail/accounts/{id}/in_servers",
15663     "title": "Removes IMAP server from an account",
15664     "examples": [
15665       {
15666         "title": "Example usage:",
15667         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15668         "type": "json"
15669       }
15670     ],
15671     "name": "RemoveImmap",
15672     "group": "Mail_Accounts",
15673     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15674     "version": "0.0.0",
15675     "filename": "server/api/mailAccount/index.js",
15676     "groupTitle": "Mail_Accounts"
15677   },
15678   {
15679     "type": "delete",
15680     "url": "/api/mail/accounts/{id}/out_servers",
15681     "title": "Removes SMTP server from an account",
15682     "examples": [
15683       {
15684         "title": "Example usage:",
15685         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15686         "type": "json"
15687       }
15688     ],
15689     "name": "RemoveSmtp",
15690     "group": "Mail_Accounts",
15691     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15692     "version": "0.0.0",
15693     "filename": "server/api/mailAccount/index.js",
15694     "groupTitle": "Mail_Accounts"
15695   },
15696   {
15697     "type": "get",
15698     "url": "/api/mail/accounts/{id}",
15699     "title": "Gets a single Account",
15700     "examples": [
15701       {
15702         "title": "Example usage:",
15703         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15704         "type": "json"
15705       }
15706     ],
15707     "name": "ShowAccounts",
15708     "group": "Mail_Accounts",
15709     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15710     "version": "0.0.0",
15711     "filename": "server/api/mailAccount/index.js",
15712     "groupTitle": "Mail_Accounts"
15713   },
15714   {
15715     "type": "post",
15716     "url": "/api/mail/accounts/{id}/canned_answers",
15717     "title": "Creates new canned answer",
15718     "examples": [
15719       {
15720         "title": "Example usage:",
15721         "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",
15722         "type": "json"
15723       }
15724     ],
15725     "name": "addAnswer",
15726     "group": "Mail_Accounts",
15727     "parameter": {
15728       "fields": {
15729         "Body": [
15730           {
15731             "group": "Body",
15732             "type": "String",
15733             "optional": false,
15734             "field": "key",
15735             "description": ""
15736           },
15737           {
15738             "group": "Body",
15739             "type": "Text",
15740             "optional": false,
15741             "field": "value",
15742             "description": ""
15743           },
15744           {
15745             "group": "Body",
15746             "type": "String",
15747             "optional": true,
15748             "field": "description",
15749             "description": ""
15750           },
15751           {
15752             "group": "Body",
15753             "type": "Virtual",
15754             "optional": true,
15755             "field": "name",
15756             "description": ""
15757           }
15758         ]
15759       }
15760     },
15761     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15762     "version": "0.0.0",
15763     "filename": "server/api/mailAccount/index.js",
15764     "groupTitle": "Mail_Accounts"
15765   },
15766   {
15767     "type": "post",
15768     "url": "/api/mail/accounts/{id}/applications",
15769     "title": "Creates new applications",
15770     "examples": [
15771       {
15772         "title": "Example usage:",
15773         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15774         "type": "json"
15775       }
15776     ],
15777     "name": "addApplications",
15778     "group": "Mail_Accounts",
15779     "parameter": {
15780       "fields": {
15781         "Body": [
15782           {
15783             "group": "Body",
15784             "type": "Integer",
15785             "optional": false,
15786             "field": "priority",
15787             "description": ""
15788           },
15789           {
15790             "group": "Body",
15791             "type": "String",
15792             "optional": false,
15793             "field": "app",
15794             "description": ""
15795           },
15796           {
15797             "group": "Body",
15798             "type": "Text",
15799             "optional": true,
15800             "field": "appdata",
15801             "description": ""
15802           },
15803           {
15804             "group": "Body",
15805             "type": "String",
15806             "optional": true,
15807             "field": "description",
15808             "description": ""
15809           },
15810           {
15811             "group": "Body",
15812             "type": "String",
15813             "optional": true,
15814             "field": "interval",
15815             "description": ""
15816           }
15817         ]
15818       }
15819     },
15820     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15821     "version": "0.0.0",
15822     "filename": "server/api/mailAccount/index.js",
15823     "groupTitle": "Mail_Accounts"
15824   },
15825   {
15826     "type": "post",
15827     "url": "/api/mail/accounts/{id}/dispositions",
15828     "title": "Creates new disposition",
15829     "examples": [
15830       {
15831         "title": "Example usage:",
15832         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15833         "type": "json"
15834       }
15835     ],
15836     "name": "addDisposition",
15837     "group": "Mail_Accounts",
15838     "parameter": {
15839       "fields": {
15840         "Body": [
15841           {
15842             "group": "Body",
15843             "type": "String",
15844             "optional": false,
15845             "field": "name",
15846             "description": ""
15847           },
15848           {
15849             "group": "Body",
15850             "type": "String",
15851             "allowedValues": [
15852               "\"first\"",
15853               "\"second\"",
15854               "\"third\""
15855             ],
15856             "optional": false,
15857             "field": "level",
15858             "description": ""
15859           },
15860           {
15861             "group": "Body",
15862             "type": "String",
15863             "optional": true,
15864             "field": "description",
15865             "description": ""
15866           }
15867         ]
15868       }
15869     },
15870     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15871     "version": "0.0.0",
15872     "filename": "server/api/mailAccount/index.js",
15873     "groupTitle": "Mail_Accounts"
15874   },
15875   {
15876     "type": "post",
15877     "url": "/api/mail/accounts/{id}/interactions",
15878     "title": "Creates new interactions",
15879     "examples": [
15880       {
15881         "title": "Example usage:",
15882         "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",
15883         "type": "json"
15884       }
15885     ],
15886     "name": "addInteraction",
15887     "group": "Mail_Accounts",
15888     "parameter": {
15889       "fields": {
15890         "Body": [
15891           {
15892             "group": "Body",
15893             "type": "Boolean",
15894             "optional": true,
15895             "field": "closed",
15896             "description": ""
15897           },
15898           {
15899             "group": "Body",
15900             "type": "String",
15901             "optional": true,
15902             "field": "closedAt",
15903             "description": ""
15904           },
15905           {
15906             "group": "Body",
15907             "type": "String",
15908             "optional": true,
15909             "field": "disposition",
15910             "description": ""
15911           },
15912           {
15913             "group": "Body",
15914             "type": "String",
15915             "optional": true,
15916             "field": "secondDisposition",
15917             "description": ""
15918           },
15919           {
15920             "group": "Body",
15921             "type": "String",
15922             "optional": true,
15923             "field": "thirdDisposition",
15924             "description": ""
15925           },
15926           {
15927             "group": "Body",
15928             "type": "String",
15929             "optional": true,
15930             "field": "note",
15931             "description": ""
15932           },
15933           {
15934             "group": "Body",
15935             "type": "String",
15936             "optional": true,
15937             "field": "inReplyTo",
15938             "description": ""
15939           },
15940           {
15941             "group": "Body",
15942             "type": "String",
15943             "optional": true,
15944             "field": "to",
15945             "description": ""
15946           },
15947           {
15948             "group": "Body",
15949             "type": "Text",
15950             "optional": true,
15951             "field": "cc",
15952             "description": ""
15953           },
15954           {
15955             "group": "Body",
15956             "type": "Text",
15957             "optional": true,
15958             "field": "subject",
15959             "description": ""
15960           },
15961           {
15962             "group": "Body",
15963             "type": "Boolean",
15964             "optional": true,
15965             "field": "attach",
15966             "description": ""
15967           },
15968           {
15969             "group": "Body",
15970             "type": "String",
15971             "optional": true,
15972             "field": "read1stAt",
15973             "description": ""
15974           },
15975           {
15976             "group": "Body",
15977             "type": "String",
15978             "optional": true,
15979             "field": "substatus",
15980             "description": ""
15981           },
15982           {
15983             "group": "Body",
15984             "type": "String",
15985             "optional": true,
15986             "field": "substatusAt",
15987             "description": ""
15988           },
15989           {
15990             "group": "Body",
15991             "type": "String",
15992             "allowedValues": [
15993               "\"in\"",
15994               "\"out\""
15995             ],
15996             "optional": false,
15997             "field": "firstMsgDirection",
15998             "description": ""
15999           },
16000           {
16001             "group": "Body",
16002             "type": "String",
16003             "optional": true,
16004             "field": "lastMsgAt",
16005             "description": ""
16006           },
16007           {
16008             "group": "Body",
16009             "type": "String",
16010             "allowedValues": [
16011               "\"in\"",
16012               "\"out\""
16013             ],
16014             "optional": false,
16015             "field": "lastMsgDirection",
16016             "description": ""
16017           }
16018         ]
16019       }
16020     },
16021     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16022     "version": "0.0.0",
16023     "filename": "server/api/mailAccount/index.js",
16024     "groupTitle": "Mail_Accounts"
16025   },
16026   {
16027     "type": "post",
16028     "url": "/api/mail/accounts",
16029     "title": "Create a mail account",
16030     "examples": [
16031       {
16032         "title": "Example usage:",
16033         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16034         "type": "json"
16035       }
16036     ],
16037     "name": "create",
16038     "group": "Mail_Accounts",
16039     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16040     "version": "0.0.0",
16041     "filename": "server/api/mailAccount/index.js",
16042     "groupTitle": "Mail_Accounts"
16043   },
16044   {
16045     "type": "get",
16046     "url": "/api/mail/accounts/{id}/canned_answers",
16047     "title": "Gets account canned answers",
16048     "examples": [
16049       {
16050         "title": "Example usage:",
16051         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
16052         "type": "json"
16053       }
16054     ],
16055     "name": "getAnswers",
16056     "group": "Mail_Accounts",
16057     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16058     "version": "0.0.0",
16059     "filename": "server/api/mailAccount/index.js",
16060     "groupTitle": "Mail_Accounts"
16061   },
16062   {
16063     "type": "get",
16064     "url": "/api/mail/accounts/{id}/applications",
16065     "title": "Gets account applications",
16066     "examples": [
16067       {
16068         "title": "Example usage:",
16069         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
16070         "type": "json"
16071       }
16072     ],
16073     "name": "getApplications",
16074     "group": "Mail_Accounts",
16075     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16076     "version": "0.0.0",
16077     "filename": "server/api/mailAccount/index.js",
16078     "groupTitle": "Mail_Accounts"
16079   },
16080   {
16081     "type": "get",
16082     "url": "/api/mail/accounts/{id}/dispositions",
16083     "title": "Gets account dispositions",
16084     "examples": [
16085       {
16086         "title": "Example usage:",
16087         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
16088         "type": "json"
16089       }
16090     ],
16091     "name": "getDispositions",
16092     "group": "Mail_Accounts",
16093     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16094     "version": "0.0.0",
16095     "filename": "server/api/mailAccount/index.js",
16096     "groupTitle": "Mail_Accounts"
16097   },
16098   {
16099     "type": "get",
16100     "url": "/api/mail/accounts/{id}/interactions",
16101     "title": "Gets account interactions",
16102     "examples": [
16103       {
16104         "title": "Example usage:",
16105         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
16106         "type": "json"
16107       }
16108     ],
16109     "name": "getInteraction",
16110     "group": "Mail_Accounts",
16111     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16112     "version": "0.0.0",
16113     "filename": "server/api/mailAccount/index.js",
16114     "groupTitle": "Mail_Accounts"
16115   },
16116   {
16117     "type": "get",
16118     "url": "/api/mail/accounts/{id}/messages",
16119     "title": "Gets account messages",
16120     "examples": [
16121       {
16122         "title": "Example usage:",
16123         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
16124         "type": "json"
16125       }
16126     ],
16127     "name": "getMessages",
16128     "group": "Mail_Accounts",
16129     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16130     "version": "0.0.0",
16131     "filename": "server/api/mailAccount/index.js",
16132     "groupTitle": "Mail_Accounts"
16133   },
16134   {
16135     "type": "post",
16136     "url": "/api/mail/accounts/{id}/send",
16137     "title": "Send new mail",
16138     "examples": [
16139       {
16140         "title": "Example usage:",
16141         "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",
16142         "type": "json"
16143       }
16144     ],
16145     "name": "sendMail",
16146     "group": "Mail_Accounts",
16147     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16148     "version": "0.0.0",
16149     "filename": "server/api/mailAccount/index.js",
16150     "groupTitle": "Mail_Accounts"
16151   },
16152   {
16153     "type": "put",
16154     "url": "/api/mail/accounts/{id}",
16155     "title": "Update an existing Account",
16156     "examples": [
16157       {
16158         "title": "Example usage:",
16159         "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",
16160         "type": "json"
16161       }
16162     ],
16163     "name": "updateAccounts",
16164     "group": "Mail_Accounts",
16165     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16166     "version": "0.0.0",
16167     "filename": "server/api/mailAccount/index.js",
16168     "groupTitle": "Mail_Accounts"
16169   },
16170   {
16171     "type": "get",
16172     "url": "/api/mail/accounts/{id}/verify",
16173     "title": "Verify mail account",
16174     "examples": [
16175       {
16176         "title": "Example usage:",
16177         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
16178         "type": "json"
16179       }
16180     ],
16181     "name": "verifySmtp",
16182     "group": "Mail_Accounts",
16183     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16184     "version": "0.0.0",
16185     "filename": "server/api/mailAccount/index.js",
16186     "groupTitle": "Mail_Accounts"
16187   },
16188   {
16189     "type": "delete",
16190     "url": "/api/mail/applications/{id}",
16191     "title": "Deletes a Application",
16192     "examples": [
16193       {
16194         "title": "Example usage:",
16195         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
16196         "type": "json"
16197       }
16198     ],
16199     "name": "DeleteApplications",
16200     "group": "Mail_Applications",
16201     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16202     "version": "0.0.0",
16203     "filename": "server/api/mailApplication/index.js",
16204     "groupTitle": "Mail_Applications"
16205   },
16206   {
16207     "type": "get",
16208     "url": "/api/mail/applications/{id}",
16209     "title": "Gets a single Application",
16210     "examples": [
16211       {
16212         "title": "Example usage:",
16213         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
16214         "type": "json"
16215       }
16216     ],
16217     "name": "ShowApplications",
16218     "group": "Mail_Applications",
16219     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16220     "version": "0.0.0",
16221     "filename": "server/api/mailApplication/index.js",
16222     "groupTitle": "Mail_Applications"
16223   },
16224   {
16225     "type": "put",
16226     "url": "/api/mail/applications/{id}",
16227     "title": "Update an existing Application",
16228     "examples": [
16229       {
16230         "title": "Example usage:",
16231         "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",
16232         "type": "json"
16233       }
16234     ],
16235     "name": "updateApplications",
16236     "group": "Mail_Applications",
16237     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16238     "version": "0.0.0",
16239     "filename": "server/api/mailApplication/index.js",
16240     "groupTitle": "Mail_Applications"
16241   },
16242   {
16243     "type": "post",
16244     "url": "/api/mail/interactions/{id}/tags",
16245     "title": "Add tags to the interaction",
16246     "examples": [
16247       {
16248         "title": "Example usage:",
16249         "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",
16250         "type": "json"
16251       }
16252     ],
16253     "name": "AddTags",
16254     "group": "Mail_Interactions",
16255     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16256     "version": "0.0.0",
16257     "filename": "server/api/mailInteraction/index.js",
16258     "groupTitle": "Mail_Interactions"
16259   },
16260   {
16261     "type": "post",
16262     "url": "/api/mail/interactions",
16263     "title": "Creates a new Interaction",
16264     "examples": [
16265       {
16266         "title": "Example usage:",
16267         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16268         "type": "json"
16269       }
16270     ],
16271     "name": "CreateInteractions",
16272     "group": "Mail_Interactions",
16273     "parameter": {
16274       "fields": {
16275         "Body": [
16276           {
16277             "group": "Body",
16278             "type": "Boolean",
16279             "optional": true,
16280             "field": "closed",
16281             "description": ""
16282           },
16283           {
16284             "group": "Body",
16285             "type": "String",
16286             "optional": true,
16287             "field": "closedAt",
16288             "description": ""
16289           },
16290           {
16291             "group": "Body",
16292             "type": "String",
16293             "optional": true,
16294             "field": "disposition",
16295             "description": ""
16296           },
16297           {
16298             "group": "Body",
16299             "type": "String",
16300             "optional": true,
16301             "field": "secondDisposition",
16302             "description": ""
16303           },
16304           {
16305             "group": "Body",
16306             "type": "String",
16307             "optional": true,
16308             "field": "thirdDisposition",
16309             "description": ""
16310           },
16311           {
16312             "group": "Body",
16313             "type": "String",
16314             "optional": true,
16315             "field": "note",
16316             "description": ""
16317           },
16318           {
16319             "group": "Body",
16320             "type": "String",
16321             "optional": true,
16322             "field": "inReplyTo",
16323             "description": ""
16324           },
16325           {
16326             "group": "Body",
16327             "type": "String",
16328             "optional": true,
16329             "field": "to",
16330             "description": ""
16331           },
16332           {
16333             "group": "Body",
16334             "type": "Text",
16335             "optional": true,
16336             "field": "cc",
16337             "description": ""
16338           },
16339           {
16340             "group": "Body",
16341             "type": "Text",
16342             "optional": true,
16343             "field": "subject",
16344             "description": ""
16345           },
16346           {
16347             "group": "Body",
16348             "type": "Boolean",
16349             "optional": true,
16350             "field": "attach",
16351             "description": ""
16352           },
16353           {
16354             "group": "Body",
16355             "type": "String",
16356             "optional": true,
16357             "field": "read1stAt",
16358             "description": ""
16359           },
16360           {
16361             "group": "Body",
16362             "type": "String",
16363             "optional": true,
16364             "field": "substatus",
16365             "description": ""
16366           },
16367           {
16368             "group": "Body",
16369             "type": "String",
16370             "optional": true,
16371             "field": "substatusAt",
16372             "description": ""
16373           },
16374           {
16375             "group": "Body",
16376             "type": "String",
16377             "allowedValues": [
16378               "\"in\"",
16379               "\"out\""
16380             ],
16381             "optional": false,
16382             "field": "firstMsgDirection",
16383             "description": ""
16384           },
16385           {
16386             "group": "Body",
16387             "type": "String",
16388             "optional": true,
16389             "field": "lastMsgAt",
16390             "description": ""
16391           },
16392           {
16393             "group": "Body",
16394             "type": "String",
16395             "allowedValues": [
16396               "\"in\"",
16397               "\"out\""
16398             ],
16399             "optional": false,
16400             "field": "lastMsgDirection",
16401             "description": ""
16402           }
16403         ]
16404       }
16405     },
16406     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16407     "version": "0.0.0",
16408     "filename": "server/api/mailInteraction/index.js",
16409     "groupTitle": "Mail_Interactions"
16410   },
16411   {
16412     "type": "delete",
16413     "url": "/api/mail/interactions/{id}",
16414     "title": "Deletes a Interaction",
16415     "examples": [
16416       {
16417         "title": "Example usage:",
16418         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
16419         "type": "json"
16420       }
16421     ],
16422     "name": "DeleteInteractions",
16423     "group": "Mail_Interactions",
16424     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16425     "version": "0.0.0",
16426     "filename": "server/api/mailInteraction/index.js",
16427     "groupTitle": "Mail_Interactions"
16428   },
16429   {
16430     "type": "get",
16431     "url": "/api/mail/interactions/describe",
16432     "title": "Gets table info about Interactions",
16433     "examples": [
16434       {
16435         "title": "Example usage:",
16436         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
16437         "type": "json"
16438       }
16439     ],
16440     "name": "DescribeInteractions",
16441     "group": "Mail_Interactions",
16442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16443     "version": "0.0.0",
16444     "filename": "server/api/mailInteraction/index.js",
16445     "groupTitle": "Mail_Interactions"
16446   },
16447   {
16448     "type": "get",
16449     "url": "/api/mail/interactions",
16450     "title": "Gets a list of Interactions",
16451     "examples": [
16452       {
16453         "title": "Example usage:",
16454         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
16455         "type": "json"
16456       }
16457     ],
16458     "name": "GetInteractions",
16459     "group": "Mail_Interactions",
16460     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16461     "version": "0.0.0",
16462     "filename": "server/api/mailInteraction/index.js",
16463     "groupTitle": "Mail_Interactions"
16464   },
16465   {
16466     "type": "delete",
16467     "url": "/api/mail/interactions/{id}/tags",
16468     "title": "Removes tags from interaction",
16469     "examples": [
16470       {
16471         "title": "Example usage:",
16472         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16473         "type": "json"
16474       }
16475     ],
16476     "name": "RemoveTags",
16477     "group": "Mail_Interactions",
16478     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16479     "version": "0.0.0",
16480     "filename": "server/api/mailInteraction/index.js",
16481     "groupTitle": "Mail_Interactions"
16482   },
16483   {
16484     "type": "get",
16485     "url": "/api/mail/interactions/{id}",
16486     "title": "Gets a single Interaction",
16487     "examples": [
16488       {
16489         "title": "Example usage:",
16490         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
16491         "type": "json"
16492       }
16493     ],
16494     "name": "ShowInteractions",
16495     "group": "Mail_Interactions",
16496     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16497     "version": "0.0.0",
16498     "filename": "server/api/mailInteraction/index.js",
16499     "groupTitle": "Mail_Interactions"
16500   },
16501   {
16502     "type": "post",
16503     "url": "/api/mail/interactions/{id}/messages",
16504     "title": "Creates new message",
16505     "examples": [
16506       {
16507         "title": "Example usage:",
16508         "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",
16509         "type": "json"
16510       }
16511     ],
16512     "name": "addMessage",
16513     "group": "Mail_Interactions",
16514     "parameter": {
16515       "fields": {
16516         "Body": [
16517           {
16518             "group": "Body",
16519             "type": "Text",
16520             "optional": false,
16521             "field": "body",
16522             "description": ""
16523           },
16524           {
16525             "group": "Body",
16526             "type": "Text",
16527             "optional": true,
16528             "field": "plainBody",
16529             "description": ""
16530           },
16531           {
16532             "group": "Body",
16533             "type": "Boolean",
16534             "optional": true,
16535             "field": "read",
16536             "description": ""
16537           },
16538           {
16539             "group": "Body",
16540             "type": "String",
16541             "allowedValues": [
16542               "\"in\"",
16543               "\"out\""
16544             ],
16545             "optional": false,
16546             "field": "direction",
16547             "description": ""
16548           },
16549           {
16550             "group": "Body",
16551             "type": "String",
16552             "optional": true,
16553             "field": "messageId",
16554             "description": ""
16555           },
16556           {
16557             "group": "Body",
16558             "type": "String",
16559             "optional": true,
16560             "field": "from",
16561             "description": ""
16562           },
16563           {
16564             "group": "Body",
16565             "type": "Text",
16566             "optional": true,
16567             "field": "to",
16568             "description": ""
16569           },
16570           {
16571             "group": "Body",
16572             "type": "Text",
16573             "optional": true,
16574             "field": "cc",
16575             "description": ""
16576           },
16577           {
16578             "group": "Body",
16579             "type": "Text",
16580             "optional": true,
16581             "field": "bcc",
16582             "description": ""
16583           },
16584           {
16585             "group": "Body",
16586             "type": "Text",
16587             "optional": true,
16588             "field": "subject",
16589             "description": ""
16590           },
16591           {
16592             "group": "Body",
16593             "type": "String",
16594             "optional": true,
16595             "field": "sentAt",
16596             "description": ""
16597           },
16598           {
16599             "group": "Body",
16600             "type": "Integer",
16601             "optional": true,
16602             "field": "attach",
16603             "description": ""
16604           },
16605           {
16606             "group": "Body",
16607             "type": "Boolean",
16608             "optional": true,
16609             "field": "secret",
16610             "description": ""
16611           },
16612           {
16613             "group": "Body",
16614             "type": "String",
16615             "optional": true,
16616             "field": "readAt",
16617             "description": ""
16618           },
16619           {
16620             "group": "Body",
16621             "type": "Text",
16622             "optional": true,
16623             "field": "originTo",
16624             "description": ""
16625           },
16626           {
16627             "group": "Body",
16628             "type": "Text",
16629             "optional": true,
16630             "field": "originCc",
16631             "description": ""
16632           },
16633           {
16634             "group": "Body",
16635             "type": "String",
16636             "allowedValues": [
16637               "\"Email\"",
16638               "\"Chat\""
16639             ],
16640             "optional": false,
16641             "field": "originChannel",
16642             "description": ""
16643           }
16644         ]
16645       }
16646     },
16647     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16648     "version": "0.0.0",
16649     "filename": "server/api/mailInteraction/index.js",
16650     "groupTitle": "Mail_Interactions"
16651   },
16652   {
16653     "type": "get",
16654     "url": "/api/mail/interactions/{id}/download",
16655     "title": "Gets interaction",
16656     "examples": [
16657       {
16658         "title": "Example usage:",
16659         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16660         "type": "json"
16661       }
16662     ],
16663     "name": "download",
16664     "group": "Mail_Interactions",
16665     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16666     "version": "0.0.0",
16667     "filename": "server/api/mailInteraction/index.js",
16668     "groupTitle": "Mail_Interactions"
16669   },
16670   {
16671     "type": "get",
16672     "url": "/api/mail/interactions/{id}/messages",
16673     "title": "Gets interaction messages",
16674     "examples": [
16675       {
16676         "title": "Example usage:",
16677         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16678         "type": "json"
16679       }
16680     ],
16681     "name": "getMessages",
16682     "group": "Mail_Interactions",
16683     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16684     "version": "0.0.0",
16685     "filename": "server/api/mailInteraction/index.js",
16686     "groupTitle": "Mail_Interactions"
16687   },
16688   {
16689     "type": "put",
16690     "url": "/api/mail/interactions/{id}",
16691     "title": "Update an existing Interaction",
16692     "examples": [
16693       {
16694         "title": "Example usage:",
16695         "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",
16696         "type": "json"
16697       }
16698     ],
16699     "name": "updateInteractions",
16700     "group": "Mail_Interactions",
16701     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16702     "version": "0.0.0",
16703     "filename": "server/api/mailInteraction/index.js",
16704     "groupTitle": "Mail_Interactions"
16705   },
16706   {
16707     "type": "delete",
16708     "url": "/api/mail/messages/{id}",
16709     "title": "Deletes a Message",
16710     "examples": [
16711       {
16712         "title": "Example usage:",
16713         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16714         "type": "json"
16715       }
16716     ],
16717     "name": "DeleteMessages",
16718     "group": "Mail_Messages",
16719     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16720     "version": "0.0.0",
16721     "filename": "server/api/mailMessage/index.js",
16722     "groupTitle": "Mail_Messages"
16723   },
16724   {
16725     "type": "get",
16726     "url": "/api/mail/messages/describe",
16727     "title": "Gets table info about Messages",
16728     "examples": [
16729       {
16730         "title": "Example usage:",
16731         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16732         "type": "json"
16733       }
16734     ],
16735     "name": "DescribeMessages",
16736     "group": "Mail_Messages",
16737     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16738     "version": "0.0.0",
16739     "filename": "server/api/mailMessage/index.js",
16740     "groupTitle": "Mail_Messages"
16741   },
16742   {
16743     "type": "get",
16744     "url": "/api/mail/messages",
16745     "title": "Gets a list of Messages",
16746     "examples": [
16747       {
16748         "title": "Example usage:",
16749         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16750         "type": "json"
16751       }
16752     ],
16753     "name": "GetMessages",
16754     "group": "Mail_Messages",
16755     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16756     "version": "0.0.0",
16757     "filename": "server/api/mailMessage/index.js",
16758     "groupTitle": "Mail_Messages"
16759   },
16760   {
16761     "type": "get",
16762     "url": "/api/mail/messages/{id}",
16763     "title": "Gets a single Message",
16764     "examples": [
16765       {
16766         "title": "Example usage:",
16767         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16768         "type": "json"
16769       }
16770     ],
16771     "name": "ShowMessages",
16772     "group": "Mail_Messages",
16773     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16774     "version": "0.0.0",
16775     "filename": "server/api/mailMessage/index.js",
16776     "groupTitle": "Mail_Messages"
16777   },
16778   {
16779     "type": "put",
16780     "url": "/api/mail/messages/{id}/accept",
16781     "title": "Accepts message",
16782     "examples": [
16783       {
16784         "title": "Example usage:",
16785         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16786         "type": "json"
16787       }
16788     ],
16789     "name": "acceptMessage",
16790     "group": "Mail_Messages",
16791     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16792     "version": "0.0.0",
16793     "filename": "server/api/mailMessage/index.js",
16794     "groupTitle": "Mail_Messages"
16795   },
16796   {
16797     "type": "post",
16798     "url": "/api/mail/messages",
16799     "title": "Create a message",
16800     "examples": [
16801       {
16802         "title": "Example usage:",
16803         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16804         "type": "json"
16805       }
16806     ],
16807     "name": "createMessage",
16808     "group": "Mail_Messages",
16809     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16810     "version": "0.0.0",
16811     "filename": "server/api/mailMessage/index.js",
16812     "groupTitle": "Mail_Messages"
16813   },
16814   {
16815     "type": "get",
16816     "url": "/api/mail/messages/{id}/download",
16817     "title": "Gets message",
16818     "examples": [
16819       {
16820         "title": "Example usage:",
16821         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16822         "type": "json"
16823       }
16824     ],
16825     "name": "download",
16826     "group": "Mail_Messages",
16827     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16828     "version": "0.0.0",
16829     "filename": "server/api/mailMessage/index.js",
16830     "groupTitle": "Mail_Messages"
16831   },
16832   {
16833     "type": "put",
16834     "url": "/api/mail/messages/{id}/reject",
16835     "title": "Rejects message",
16836     "examples": [
16837       {
16838         "title": "Example usage:",
16839         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16840         "type": "json"
16841       }
16842     ],
16843     "name": "rejectMessage",
16844     "group": "Mail_Messages",
16845     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16846     "version": "0.0.0",
16847     "filename": "server/api/mailMessage/index.js",
16848     "groupTitle": "Mail_Messages"
16849   },
16850   {
16851     "type": "put",
16852     "url": "/api/mail/messages/{id}",
16853     "title": "Update an existing Message",
16854     "examples": [
16855       {
16856         "title": "Example usage:",
16857         "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",
16858         "type": "json"
16859       }
16860     ],
16861     "name": "updateMessages",
16862     "group": "Mail_Messages",
16863     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16864     "version": "0.0.0",
16865     "filename": "server/api/mailMessage/index.js",
16866     "groupTitle": "Mail_Messages"
16867   },
16868   {
16869     "type": "post",
16870     "url": "/api/mail/reports/queue",
16871     "title": "Creates a new Mail Queue Report",
16872     "examples": [
16873       {
16874         "title": "Example usage:",
16875         "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",
16876         "type": "json"
16877       }
16878     ],
16879     "name": "CreateMail_Queue_Reports",
16880     "group": "Mail_Queue_Reports",
16881     "parameter": {
16882       "fields": {
16883         "Body": [
16884           {
16885             "group": "Body",
16886             "type": "String",
16887             "optional": false,
16888             "field": "uniqueid",
16889             "description": ""
16890           },
16891           {
16892             "group": "Body",
16893             "type": "String",
16894             "optional": true,
16895             "field": "from",
16896             "description": ""
16897           },
16898           {
16899             "group": "Body",
16900             "type": "String",
16901             "optional": true,
16902             "field": "joinAt",
16903             "description": ""
16904           },
16905           {
16906             "group": "Body",
16907             "type": "String",
16908             "optional": true,
16909             "field": "leaveAt",
16910             "description": ""
16911           },
16912           {
16913             "group": "Body",
16914             "type": "String",
16915             "optional": true,
16916             "field": "acceptAt",
16917             "description": ""
16918           },
16919           {
16920             "group": "Body",
16921             "type": "String",
16922             "optional": true,
16923             "field": "exitAt",
16924             "description": ""
16925           },
16926           {
16927             "group": "Body",
16928             "type": "String",
16929             "optional": true,
16930             "field": "reason",
16931             "description": ""
16932           }
16933         ]
16934       }
16935     },
16936     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16937     "version": "0.0.0",
16938     "filename": "server/api/mailQueueReport/index.js",
16939     "groupTitle": "Mail_Queue_Reports"
16940   },
16941   {
16942     "type": "delete",
16943     "url": "/api/mail/reports/queue/{id}",
16944     "title": "Deletes a Mail Queue Report",
16945     "examples": [
16946       {
16947         "title": "Example usage:",
16948         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16949         "type": "json"
16950       }
16951     ],
16952     "name": "DeleteMail_Queue_Reports",
16953     "group": "Mail_Queue_Reports",
16954     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16955     "version": "0.0.0",
16956     "filename": "server/api/mailQueueReport/index.js",
16957     "groupTitle": "Mail_Queue_Reports"
16958   },
16959   {
16960     "type": "get",
16961     "url": "/api/mail/reports/queue/describe",
16962     "title": "Gets table info about Mail Queue Reports",
16963     "examples": [
16964       {
16965         "title": "Example usage:",
16966         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16967         "type": "json"
16968       }
16969     ],
16970     "name": "DescribeMail_Queue_Reports",
16971     "group": "Mail_Queue_Reports",
16972     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16973     "version": "0.0.0",
16974     "filename": "server/api/mailQueueReport/index.js",
16975     "groupTitle": "Mail_Queue_Reports"
16976   },
16977   {
16978     "type": "get",
16979     "url": "/api/mail/reports/queue",
16980     "title": "Gets a list of Mail Queue Reports",
16981     "examples": [
16982       {
16983         "title": "Example usage:",
16984         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16985         "type": "json"
16986       }
16987     ],
16988     "name": "GetMail_Queue_Reports",
16989     "group": "Mail_Queue_Reports",
16990     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16991     "version": "0.0.0",
16992     "filename": "server/api/mailQueueReport/index.js",
16993     "groupTitle": "Mail_Queue_Reports"
16994   },
16995   {
16996     "type": "get",
16997     "url": "/api/mail/reports/queue/{id}",
16998     "title": "Gets a single Mail Queue Report",
16999     "examples": [
17000       {
17001         "title": "Example usage:",
17002         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
17003         "type": "json"
17004       }
17005     ],
17006     "name": "ShowMail_Queue_Reports",
17007     "group": "Mail_Queue_Reports",
17008     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17009     "version": "0.0.0",
17010     "filename": "server/api/mailQueueReport/index.js",
17011     "groupTitle": "Mail_Queue_Reports"
17012   },
17013   {
17014     "type": "put",
17015     "url": "/api/mail/reports/queue/{id}",
17016     "title": "Update an existing Mail Queue Report",
17017     "examples": [
17018       {
17019         "title": "Example usage:",
17020         "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",
17021         "type": "json"
17022       }
17023     ],
17024     "name": "updateMail_Queue_Reports",
17025     "group": "Mail_Queue_Reports",
17026     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17027     "version": "0.0.0",
17028     "filename": "server/api/mailQueueReport/index.js",
17029     "groupTitle": "Mail_Queue_Reports"
17030   },
17031   {
17032     "type": "post",
17033     "url": "/api/mail/queues/{id}/users",
17034     "title": "Add agents to a queue",
17035     "examples": [
17036       {
17037         "title": "Example usage:",
17038         "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",
17039         "type": "json"
17040       }
17041     ],
17042     "name": "AddAgents",
17043     "group": "Mail_Queues",
17044     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17045     "version": "0.0.0",
17046     "filename": "server/api/mailQueue/index.js",
17047     "groupTitle": "Mail_Queues"
17048   },
17049   {
17050     "type": "post",
17051     "url": "/api/mail/queues/{id}/teams",
17052     "title": "Add teams to a queue",
17053     "examples": [
17054       {
17055         "title": "Example usage:",
17056         "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",
17057         "type": "json"
17058       }
17059     ],
17060     "name": "AddTeams",
17061     "group": "Mail_Queues",
17062     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17063     "version": "0.0.0",
17064     "filename": "server/api/mailQueue/index.js",
17065     "groupTitle": "Mail_Queues"
17066   },
17067   {
17068     "type": "post",
17069     "url": "/api/mail/queues",
17070     "title": "Creates a new Queue",
17071     "examples": [
17072       {
17073         "title": "Example usage:",
17074         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17075         "type": "json"
17076       }
17077     ],
17078     "name": "CreateQueues",
17079     "group": "Mail_Queues",
17080     "parameter": {
17081       "fields": {
17082         "Body": [
17083           {
17084             "group": "Body",
17085             "type": "String",
17086             "optional": true,
17087             "field": "name",
17088             "description": ""
17089           },
17090           {
17091             "group": "Body",
17092             "type": "String",
17093             "optional": true,
17094             "field": "description",
17095             "description": ""
17096           },
17097           {
17098             "group": "Body",
17099             "type": "Integer",
17100             "optional": true,
17101             "field": "timeout",
17102             "description": ""
17103           },
17104           {
17105             "group": "Body",
17106             "type": "String",
17107             "allowedValues": [
17108               "\"rrmemory\"",
17109               "\"beepall\"",
17110               "\"roundrobin\""
17111             ],
17112             "optional": true,
17113             "field": "strategy",
17114             "description": ""
17115           }
17116         ]
17117       }
17118     },
17119     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17120     "version": "0.0.0",
17121     "filename": "server/api/mailQueue/index.js",
17122     "groupTitle": "Mail_Queues"
17123   },
17124   {
17125     "type": "delete",
17126     "url": "/api/mail/queues/{id}",
17127     "title": "Deletes a Queue",
17128     "examples": [
17129       {
17130         "title": "Example usage:",
17131         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
17132         "type": "json"
17133       }
17134     ],
17135     "name": "DeleteQueues",
17136     "group": "Mail_Queues",
17137     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17138     "version": "0.0.0",
17139     "filename": "server/api/mailQueue/index.js",
17140     "groupTitle": "Mail_Queues"
17141   },
17142   {
17143     "type": "get",
17144     "url": "/api/mail/queues/describe",
17145     "title": "Gets table info about Queues",
17146     "examples": [
17147       {
17148         "title": "Example usage:",
17149         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
17150         "type": "json"
17151       }
17152     ],
17153     "name": "DescribeQueues",
17154     "group": "Mail_Queues",
17155     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17156     "version": "0.0.0",
17157     "filename": "server/api/mailQueue/index.js",
17158     "groupTitle": "Mail_Queues"
17159   },
17160   {
17161     "type": "get",
17162     "url": "/api/mail/queues/{id}/users",
17163     "title": "Gets queue agents",
17164     "examples": [
17165       {
17166         "title": "Example usage:",
17167         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
17168         "type": "json"
17169       }
17170     ],
17171     "name": "GetAgents",
17172     "group": "Mail_Queues",
17173     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17174     "version": "0.0.0",
17175     "filename": "server/api/mailQueue/index.js",
17176     "groupTitle": "Mail_Queues"
17177   },
17178   {
17179     "type": "get",
17180     "url": "/api/mail/queues/{id}/members",
17181     "title": "GetMembers",
17182     "examples": [
17183       {
17184         "title": "Example usage:",
17185         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
17186         "type": "json"
17187       }
17188     ],
17189     "name": "GetMembers",
17190     "group": "Mail_Queues",
17191     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17192     "version": "0.0.0",
17193     "filename": "server/api/mailQueue/index.js",
17194     "groupTitle": "Mail_Queues"
17195   },
17196   {
17197     "type": "get",
17198     "url": "/api/mail/queues",
17199     "title": "Gets a list of Queues",
17200     "examples": [
17201       {
17202         "title": "Example usage:",
17203         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
17204         "type": "json"
17205       }
17206     ],
17207     "name": "GetQueues",
17208     "group": "Mail_Queues",
17209     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17210     "version": "0.0.0",
17211     "filename": "server/api/mailQueue/index.js",
17212     "groupTitle": "Mail_Queues"
17213   },
17214   {
17215     "type": "get",
17216     "url": "/api/mail/queues/{id}/teams",
17217     "title": "Gets queues list",
17218     "examples": [
17219       {
17220         "title": "Example usage:",
17221         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
17222         "type": "json"
17223       }
17224     ],
17225     "name": "GetTeams",
17226     "group": "Mail_Queues",
17227     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17228     "version": "0.0.0",
17229     "filename": "server/api/mailQueue/index.js",
17230     "groupTitle": "Mail_Queues"
17231   },
17232   {
17233     "type": "delete",
17234     "url": "/api/mail/queues/{id}/users",
17235     "title": "Removes agents from a queue",
17236     "examples": [
17237       {
17238         "title": "Example usage:",
17239         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17240         "type": "json"
17241       }
17242     ],
17243     "name": "RemoveAgents",
17244     "group": "Mail_Queues",
17245     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17246     "version": "0.0.0",
17247     "filename": "server/api/mailQueue/index.js",
17248     "groupTitle": "Mail_Queues"
17249   },
17250   {
17251     "type": "get",
17252     "url": "/api/mail/queues/{id}",
17253     "title": "Gets a single Queue",
17254     "examples": [
17255       {
17256         "title": "Example usage:",
17257         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
17258         "type": "json"
17259       }
17260     ],
17261     "name": "ShowQueues",
17262     "group": "Mail_Queues",
17263     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17264     "version": "0.0.0",
17265     "filename": "server/api/mailQueue/index.js",
17266     "groupTitle": "Mail_Queues"
17267   },
17268   {
17269     "type": "put",
17270     "url": "/api/mail/queues/{id}",
17271     "title": "Update an existing Queue",
17272     "examples": [
17273       {
17274         "title": "Example usage:",
17275         "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",
17276         "type": "json"
17277       }
17278     ],
17279     "name": "updateQueues",
17280     "group": "Mail_Queues",
17281     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17282     "version": "0.0.0",
17283     "filename": "server/api/mailQueue/index.js",
17284     "groupTitle": "Mail_Queues"
17285   },
17286   {
17287     "type": "post",
17288     "url": "/api/mail/out_servers",
17289     "title": "Creates a new SMTP",
17290     "examples": [
17291       {
17292         "title": "Example usage:",
17293         "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",
17294         "type": "json"
17295       }
17296     ],
17297     "name": "CreateSMTPs",
17298     "group": "Mail_SMTP",
17299     "parameter": {
17300       "fields": {
17301         "Body": [
17302           {
17303             "group": "Body",
17304             "type": "String",
17305             "optional": true,
17306             "field": "description",
17307             "description": ""
17308           },
17309           {
17310             "group": "Body",
17311             "type": "String",
17312             "optional": true,
17313             "field": "host",
17314             "description": ""
17315           },
17316           {
17317             "group": "Body",
17318             "type": "String",
17319             "optional": true,
17320             "field": "user",
17321             "description": ""
17322           },
17323           {
17324             "group": "Body",
17325             "type": "String",
17326             "optional": true,
17327             "field": "pass",
17328             "description": ""
17329           },
17330           {
17331             "group": "Body",
17332             "type": "Integer",
17333             "optional": true,
17334             "field": "port",
17335             "description": ""
17336           },
17337           {
17338             "group": "Body",
17339             "type": "Boolean",
17340             "optional": true,
17341             "field": "secure",
17342             "description": ""
17343           },
17344           {
17345             "group": "Body",
17346             "type": "String",
17347             "optional": true,
17348             "field": "service",
17349             "description": ""
17350           },
17351           {
17352             "group": "Body",
17353             "type": "Boolean",
17354             "optional": true,
17355             "field": "authentication",
17356             "description": ""
17357           }
17358         ]
17359       }
17360     },
17361     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17362     "version": "0.0.0",
17363     "filename": "server/api/mailServerOut/index.js",
17364     "groupTitle": "Mail_SMTP"
17365   },
17366   {
17367     "type": "delete",
17368     "url": "/api/mail/out_servers/{id}",
17369     "title": "Deletes a SMTP",
17370     "examples": [
17371       {
17372         "title": "Example usage:",
17373         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
17374         "type": "json"
17375       }
17376     ],
17377     "name": "DeleteSMTPs",
17378     "group": "Mail_SMTP",
17379     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17380     "version": "0.0.0",
17381     "filename": "server/api/mailServerOut/index.js",
17382     "groupTitle": "Mail_SMTP"
17383   },
17384   {
17385     "type": "get",
17386     "url": "/api/mail/out_servers",
17387     "title": "Gets a list of SMTPs",
17388     "examples": [
17389       {
17390         "title": "Example usage:",
17391         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
17392         "type": "json"
17393       }
17394     ],
17395     "name": "GetSMTPs",
17396     "group": "Mail_SMTP",
17397     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17398     "version": "0.0.0",
17399     "filename": "server/api/mailServerOut/index.js",
17400     "groupTitle": "Mail_SMTP"
17401   },
17402   {
17403     "type": "get",
17404     "url": "/api/mail/out_servers/{id}",
17405     "title": "Gets a single SMTP",
17406     "examples": [
17407       {
17408         "title": "Example usage:",
17409         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
17410         "type": "json"
17411       }
17412     ],
17413     "name": "ShowSMTPs",
17414     "group": "Mail_SMTP",
17415     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17416     "version": "0.0.0",
17417     "filename": "server/api/mailServerOut/index.js",
17418     "groupTitle": "Mail_SMTP"
17419   },
17420   {
17421     "type": "put",
17422     "url": "/api/mail/out_servers/{id}",
17423     "title": "Update an existing SMTP",
17424     "examples": [
17425       {
17426         "title": "Example usage:",
17427         "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",
17428         "type": "json"
17429       }
17430     ],
17431     "name": "updateSMTPs",
17432     "group": "Mail_SMTP",
17433     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17434     "version": "0.0.0",
17435     "filename": "server/api/mailServerOut/index.js",
17436     "groupTitle": "Mail_SMTP"
17437   },
17438   {
17439     "type": "post",
17440     "url": "/api/mail/substatuses",
17441     "title": "Creates a new Queue",
17442     "examples": [
17443       {
17444         "title": "Example usage:",
17445         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17446         "type": "json"
17447       }
17448     ],
17449     "name": "CreateSubstatuses",
17450     "group": "Mail_Substatuses",
17451     "parameter": {
17452       "fields": {
17453         "Body": [
17454           {
17455             "group": "Body",
17456             "type": "String",
17457             "optional": false,
17458             "field": "name",
17459             "description": ""
17460           },
17461           {
17462             "group": "Body",
17463             "type": "String",
17464             "optional": true,
17465             "field": "description",
17466             "description": ""
17467           }
17468         ]
17469       }
17470     },
17471     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17472     "version": "0.0.0",
17473     "filename": "server/api/mailSubstatus/index.js",
17474     "groupTitle": "Mail_Substatuses"
17475   },
17476   {
17477     "type": "delete",
17478     "url": "/api/mail/substatuses/{id}",
17479     "title": "Deletes a Queue",
17480     "examples": [
17481       {
17482         "title": "Example usage:",
17483         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
17484         "type": "json"
17485       }
17486     ],
17487     "name": "DeleteSubstatuses",
17488     "group": "Mail_Substatuses",
17489     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17490     "version": "0.0.0",
17491     "filename": "server/api/mailSubstatus/index.js",
17492     "groupTitle": "Mail_Substatuses"
17493   },
17494   {
17495     "type": "get",
17496     "url": "/api/mail/substatuses/describe",
17497     "title": "Gets table info about Substatuses",
17498     "examples": [
17499       {
17500         "title": "Example usage:",
17501         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
17502         "type": "json"
17503       }
17504     ],
17505     "name": "DescribeSubstatuses",
17506     "group": "Mail_Substatuses",
17507     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17508     "version": "0.0.0",
17509     "filename": "server/api/mailSubstatus/index.js",
17510     "groupTitle": "Mail_Substatuses"
17511   },
17512   {
17513     "type": "get",
17514     "url": "/api/mail/substatuses",
17515     "title": "Gets a list of Substatuses",
17516     "examples": [
17517       {
17518         "title": "Example usage:",
17519         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
17520         "type": "json"
17521       }
17522     ],
17523     "name": "GetSubstatuses",
17524     "group": "Mail_Substatuses",
17525     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17526     "version": "0.0.0",
17527     "filename": "server/api/mailSubstatus/index.js",
17528     "groupTitle": "Mail_Substatuses"
17529   },
17530   {
17531     "type": "get",
17532     "url": "/api/mail/substatuses/{id}",
17533     "title": "Gets a single Queue",
17534     "examples": [
17535       {
17536         "title": "Example usage:",
17537         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
17538         "type": "json"
17539       }
17540     ],
17541     "name": "ShowSubstatuses",
17542     "group": "Mail_Substatuses",
17543     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17544     "version": "0.0.0",
17545     "filename": "server/api/mailSubstatus/index.js",
17546     "groupTitle": "Mail_Substatuses"
17547   },
17548   {
17549     "type": "put",
17550     "url": "/api/mail/substatuses/{id}",
17551     "title": "Update an existing Queue",
17552     "examples": [
17553       {
17554         "title": "Example usage:",
17555         "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",
17556         "type": "json"
17557       }
17558     ],
17559     "name": "updateSubstatuses",
17560     "group": "Mail_Substatuses",
17561     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17562     "version": "0.0.0",
17563     "filename": "server/api/mailSubstatus/index.js",
17564     "groupTitle": "Mail_Substatuses"
17565   },
17566   {
17567     "type": "post",
17568     "url": "/api/mail/reports/transfer",
17569     "title": "Creates a new Mail Transfer Report",
17570     "examples": [
17571       {
17572         "title": "Example usage:",
17573         "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",
17574         "type": "json"
17575       }
17576     ],
17577     "name": "CreateMail_Transfer_Reports",
17578     "group": "Mail_Transfer_Reports",
17579     "parameter": {
17580       "fields": {
17581         "Body": [
17582           {
17583             "group": "Body",
17584             "type": "String",
17585             "optional": false,
17586             "field": "uniqueid",
17587             "description": ""
17588           },
17589           {
17590             "group": "Body",
17591             "type": "String",
17592             "allowedValues": [
17593               "\"account\"",
17594               "\"agent\"",
17595               "\"queue\""
17596             ],
17597             "optional": false,
17598             "field": "type",
17599             "description": ""
17600           },
17601           {
17602             "group": "Body",
17603             "type": "String",
17604             "optional": false,
17605             "field": "transferredAt",
17606             "description": ""
17607           }
17608         ]
17609       }
17610     },
17611     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17612     "version": "0.0.0",
17613     "filename": "server/api/mailTransferReport/index.js",
17614     "groupTitle": "Mail_Transfer_Reports"
17615   },
17616   {
17617     "type": "delete",
17618     "url": "/api/mail/reports/transfer/{id}",
17619     "title": "Deletes a Mail Transfer Report",
17620     "examples": [
17621       {
17622         "title": "Example usage:",
17623         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17624         "type": "json"
17625       }
17626     ],
17627     "name": "DeleteMail_Transfer_Reports",
17628     "group": "Mail_Transfer_Reports",
17629     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17630     "version": "0.0.0",
17631     "filename": "server/api/mailTransferReport/index.js",
17632     "groupTitle": "Mail_Transfer_Reports"
17633   },
17634   {
17635     "type": "get",
17636     "url": "/api/mail/reports/transfer/describe",
17637     "title": "Gets table info about Mail Transfer Reports",
17638     "examples": [
17639       {
17640         "title": "Example usage:",
17641         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17642         "type": "json"
17643       }
17644     ],
17645     "name": "DescribeMail_Transfer_Reports",
17646     "group": "Mail_Transfer_Reports",
17647     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17648     "version": "0.0.0",
17649     "filename": "server/api/mailTransferReport/index.js",
17650     "groupTitle": "Mail_Transfer_Reports"
17651   },
17652   {
17653     "type": "get",
17654     "url": "/api/mail/reports/transfer",
17655     "title": "Gets a list of Mail Transfer Reports",
17656     "examples": [
17657       {
17658         "title": "Example usage:",
17659         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17660         "type": "json"
17661       }
17662     ],
17663     "name": "GetMail_Transfer_Reports",
17664     "group": "Mail_Transfer_Reports",
17665     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17666     "version": "0.0.0",
17667     "filename": "server/api/mailTransferReport/index.js",
17668     "groupTitle": "Mail_Transfer_Reports"
17669   },
17670   {
17671     "type": "get",
17672     "url": "/api/mail/reports/transfer/{id}",
17673     "title": "Gets a single Mail Transfer Report",
17674     "examples": [
17675       {
17676         "title": "Example usage:",
17677         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17678         "type": "json"
17679       }
17680     ],
17681     "name": "ShowMail_Transfer_Reports",
17682     "group": "Mail_Transfer_Reports",
17683     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17684     "version": "0.0.0",
17685     "filename": "server/api/mailTransferReport/index.js",
17686     "groupTitle": "Mail_Transfer_Reports"
17687   },
17688   {
17689     "type": "put",
17690     "url": "/api/mail/reports/transfer/{id}",
17691     "title": "Update an existing Mail Transfer Report",
17692     "examples": [
17693       {
17694         "title": "Example usage:",
17695         "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",
17696         "type": "json"
17697       }
17698     ],
17699     "name": "updateMail_Transfer_Reports",
17700     "group": "Mail_Transfer_Reports",
17701     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17702     "version": "0.0.0",
17703     "filename": "server/api/mailTransferReport/index.js",
17704     "groupTitle": "Mail_Transfer_Reports"
17705   },
17706   {
17707     "type": "get",
17708     "url": "/api/members/reports/describe",
17709     "title": "Gets table info about Member Reports",
17710     "examples": [
17711       {
17712         "title": "Example usage:",
17713         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17714         "type": "json"
17715       }
17716     ],
17717     "name": "DescribeMember_Reports",
17718     "group": "Member_Reports",
17719     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17720     "version": "0.0.0",
17721     "filename": "server/api/memberReport/index.js",
17722     "groupTitle": "Member_Reports"
17723   },
17724   {
17725     "type": "get",
17726     "url": "/api/members/reports",
17727     "title": "Gets a list of Member Reports",
17728     "examples": [
17729       {
17730         "title": "Example usage:",
17731         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17732         "type": "json"
17733       }
17734     ],
17735     "name": "GetMember_Reports",
17736     "group": "Member_Reports",
17737     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17738     "version": "0.0.0",
17739     "filename": "server/api/memberReport/index.js",
17740     "groupTitle": "Member_Reports"
17741   },
17742   {
17743     "type": "get",
17744     "url": "/api/members/reports/{id}",
17745     "title": "Gets a single Member Report",
17746     "examples": [
17747       {
17748         "title": "Example usage:",
17749         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17750         "type": "json"
17751       }
17752     ],
17753     "name": "ShowMember_Reports",
17754     "group": "Member_Reports",
17755     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17756     "version": "0.0.0",
17757     "filename": "server/api/memberReport/index.js",
17758     "groupTitle": "Member_Reports"
17759   },
17760   {
17761     "type": "get",
17762     "url": "/api/migrations",
17763     "title": "Gets a list of Migrations",
17764     "examples": [
17765       {
17766         "title": "Example usage:",
17767         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17768         "type": "json"
17769       }
17770     ],
17771     "name": "GetMigrations",
17772     "group": "Migrations",
17773     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17774     "version": "0.0.0",
17775     "filename": "server/api/migration/index.js",
17776     "groupTitle": "Migrations"
17777   },
17778   {
17779     "type": "post",
17780     "url": "/api/voice/networks",
17781     "title": "Create a new network",
17782     "examples": [
17783       {
17784         "title": "Example usage:",
17785         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17786         "type": "json"
17787       }
17788     ],
17789     "name": "Create",
17790     "group": "Networks",
17791     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17792     "version": "0.0.0",
17793     "filename": "server/api/network/index.js",
17794     "groupTitle": "Networks"
17795   },
17796   {
17797     "type": "delete",
17798     "url": "/api/voice/networks/{id}",
17799     "title": "Deletes a network",
17800     "examples": [
17801       {
17802         "title": "Example usage:",
17803         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17804         "type": "json"
17805       }
17806     ],
17807     "name": "Delete",
17808     "group": "Networks",
17809     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17810     "version": "0.0.0",
17811     "filename": "server/api/network/index.js",
17812     "groupTitle": "Networks"
17813   },
17814   {
17815     "type": "get",
17816     "url": "/api/networks",
17817     "title": "Gets a list of Networks",
17818     "examples": [
17819       {
17820         "title": "Example usage:",
17821         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17822         "type": "json"
17823       }
17824     ],
17825     "name": "GetNetworks",
17826     "group": "Networks",
17827     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17828     "version": "0.0.0",
17829     "filename": "server/api/network/index.js",
17830     "groupTitle": "Networks"
17831   },
17832   {
17833     "type": "get",
17834     "url": "/api/networks/{id}",
17835     "title": "Gets a single Network",
17836     "examples": [
17837       {
17838         "title": "Example usage:",
17839         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17840         "type": "json"
17841       }
17842     ],
17843     "name": "ShowNetworks",
17844     "group": "Networks",
17845     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17846     "version": "0.0.0",
17847     "filename": "server/api/network/index.js",
17848     "groupTitle": "Networks"
17849   },
17850   {
17851     "type": "put",
17852     "url": "/api/voice/networks/{id}",
17853     "title": "Update an existing network",
17854     "examples": [
17855       {
17856         "title": "Example usage:",
17857         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17858         "type": "json"
17859       }
17860     ],
17861     "name": "Update",
17862     "group": "Networks",
17863     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17864     "version": "0.0.0",
17865     "filename": "server/api/network/index.js",
17866     "groupTitle": "Networks"
17867   },
17868   {
17869     "type": "post",
17870     "url": "/api/openchannel/accounts/{id}/users",
17871     "title": "Add agents to a openchannel account",
17872     "examples": [
17873       {
17874         "title": "Example usage:",
17875         "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",
17876         "type": "json"
17877       }
17878     ],
17879     "name": "AddAgents",
17880     "group": "Openchannel_Accounts",
17881     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17882     "version": "0.0.0",
17883     "filename": "server/api/openchannelAccount/index.js",
17884     "groupTitle": "Openchannel_Accounts"
17885   },
17886   {
17887     "type": "post",
17888     "url": "/api/openchannel/accounts",
17889     "title": "Creates a new Account",
17890     "examples": [
17891       {
17892         "title": "Example usage:",
17893         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17894         "type": "json"
17895       }
17896     ],
17897     "name": "CreateAccounts",
17898     "group": "Openchannel_Accounts",
17899     "parameter": {
17900       "fields": {
17901         "Body": [
17902           {
17903             "group": "Body",
17904             "type": "String",
17905             "optional": false,
17906             "field": "name",
17907             "description": ""
17908           },
17909           {
17910             "group": "Body",
17911             "type": "String",
17912             "optional": true,
17913             "field": "description",
17914             "description": ""
17915           },
17916           {
17917             "group": "Body",
17918             "type": "String",
17919             "optional": true,
17920             "field": "token",
17921             "description": ""
17922           },
17923           {
17924             "group": "Body",
17925             "type": "String",
17926             "optional": true,
17927             "field": "replyUri",
17928             "description": ""
17929           },
17930           {
17931             "group": "Body",
17932             "type": "String",
17933             "optional": false,
17934             "field": "key",
17935             "description": ""
17936           },
17937           {
17938             "group": "Body",
17939             "type": "Text",
17940             "optional": true,
17941             "field": "notificationTemplate",
17942             "description": ""
17943           },
17944           {
17945             "group": "Body",
17946             "type": "Boolean",
17947             "optional": true,
17948             "field": "notificationSound",
17949             "description": ""
17950           },
17951           {
17952             "group": "Body",
17953             "type": "Boolean",
17954             "optional": true,
17955             "field": "notificationShake",
17956             "description": ""
17957           },
17958           {
17959             "group": "Body",
17960             "type": "Integer",
17961             "optional": true,
17962             "field": "waitForTheAssignedAgent",
17963             "description": ""
17964           },
17965           {
17966             "group": "Body",
17967             "type": "String",
17968             "optional": true,
17969             "field": "mapKey",
17970             "description": ""
17971           },
17972           {
17973             "group": "Body",
17974             "type": "Boolean",
17975             "optional": true,
17976             "field": "queueTransfer",
17977             "description": ""
17978           },
17979           {
17980             "group": "Body",
17981             "type": "Integer",
17982             "optional": true,
17983             "field": "queueTransferTimeout",
17984             "description": ""
17985           },
17986           {
17987             "group": "Body",
17988             "type": "Boolean",
17989             "optional": true,
17990             "field": "agentTransfer",
17991             "description": ""
17992           },
17993           {
17994             "group": "Body",
17995             "type": "Integer",
17996             "optional": true,
17997             "field": "agentTransferTimeout",
17998             "description": ""
17999           },
18000           {
18001             "group": "Body",
18002             "type": "Integer",
18003             "optional": true,
18004             "field": "mandatoryDispositionPauseId",
18005             "description": "<p>Status to put when mandatory disposition is enabled</p>"
18006           },
18007           {
18008             "group": "Body",
18009             "type": "Boolean",
18010             "optional": true,
18011             "field": "mandatoryDisposition",
18012             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
18013           }
18014         ]
18015       }
18016     },
18017     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18018     "version": "0.0.0",
18019     "filename": "server/api/openchannelAccount/index.js",
18020     "groupTitle": "Openchannel_Accounts"
18021   },
18022   {
18023     "type": "delete",
18024     "url": "/api/openchannel/accounts/{id}",
18025     "title": "Deletes a Account",
18026     "examples": [
18027       {
18028         "title": "Example usage:",
18029         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
18030         "type": "json"
18031       }
18032     ],
18033     "name": "DeleteAccounts",
18034     "group": "Openchannel_Accounts",
18035     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18036     "version": "0.0.0",
18037     "filename": "server/api/openchannelAccount/index.js",
18038     "groupTitle": "Openchannel_Accounts"
18039   },
18040   {
18041     "type": "get",
18042     "url": "/api/openchannel/accounts/describe",
18043     "title": "Gets table info about Accounts",
18044     "examples": [
18045       {
18046         "title": "Example usage:",
18047         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
18048         "type": "json"
18049       }
18050     ],
18051     "name": "DescribeAccounts",
18052     "group": "Openchannel_Accounts",
18053     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18054     "version": "0.0.0",
18055     "filename": "server/api/openchannelAccount/index.js",
18056     "groupTitle": "Openchannel_Accounts"
18057   },
18058   {
18059     "type": "get",
18060     "url": "/api/openchannel/accounts",
18061     "title": "Gets a list of Accounts",
18062     "examples": [
18063       {
18064         "title": "Example usage:",
18065         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
18066         "type": "json"
18067       }
18068     ],
18069     "name": "GetAccounts",
18070     "group": "Openchannel_Accounts",
18071     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18072     "version": "0.0.0",
18073     "filename": "server/api/openchannelAccount/index.js",
18074     "groupTitle": "Openchannel_Accounts"
18075   },
18076   {
18077     "type": "get",
18078     "url": "/api/openchannel/accounts/{id}/users",
18079     "title": "Gets agents from openchannel account",
18080     "examples": [
18081       {
18082         "title": "Example usage:",
18083         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
18084         "type": "json"
18085       }
18086     ],
18087     "name": "GetAgents",
18088     "group": "Openchannel_Accounts",
18089     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18090     "version": "0.0.0",
18091     "filename": "server/api/openchannelAccount/index.js",
18092     "groupTitle": "Openchannel_Accounts"
18093   },
18094   {
18095     "type": "delete",
18096     "url": "/api/openchannel/accounts/{id}/users",
18097     "title": "Removes agents from a openchannel account",
18098     "examples": [
18099       {
18100         "title": "Example usage:",
18101         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18102         "type": "json"
18103       }
18104     ],
18105     "name": "RemoveAgents",
18106     "group": "Openchannel_Accounts",
18107     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18108     "version": "0.0.0",
18109     "filename": "server/api/openchannelAccount/index.js",
18110     "groupTitle": "Openchannel_Accounts"
18111   },
18112   {
18113     "type": "delete",
18114     "url": "/api/openchannel/accounts/{id}/canned_answers",
18115     "title": "Removes canned answers from account",
18116     "examples": [
18117       {
18118         "title": "Example usage:",
18119         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18120         "type": "json"
18121       }
18122     ],
18123     "name": "RemoveAnswers",
18124     "group": "Openchannel_Accounts",
18125     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18126     "version": "0.0.0",
18127     "filename": "server/api/openchannelAccount/index.js",
18128     "groupTitle": "Openchannel_Accounts"
18129   },
18130   {
18131     "type": "delete",
18132     "url": "/api/openchannel/accounts/{id}/dispositions",
18133     "title": "Removes dispositions from account",
18134     "examples": [
18135       {
18136         "title": "Example usage:",
18137         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18138         "type": "json"
18139       }
18140     ],
18141     "name": "RemoveDispositions",
18142     "group": "Openchannel_Accounts",
18143     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18144     "version": "0.0.0",
18145     "filename": "server/api/openchannelAccount/index.js",
18146     "groupTitle": "Openchannel_Accounts"
18147   },
18148   {
18149     "type": "get",
18150     "url": "/api/openchannel/accounts/{id}",
18151     "title": "Gets a single Account",
18152     "examples": [
18153       {
18154         "title": "Example usage:",
18155         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
18156         "type": "json"
18157       }
18158     ],
18159     "name": "ShowAccounts",
18160     "group": "Openchannel_Accounts",
18161     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18162     "version": "0.0.0",
18163     "filename": "server/api/openchannelAccount/index.js",
18164     "groupTitle": "Openchannel_Accounts"
18165   },
18166   {
18167     "type": "post",
18168     "url": "/api/openchannel/accounts/{id}/canned_answers",
18169     "title": "Creates new canned answer",
18170     "examples": [
18171       {
18172         "title": "Example usage:",
18173         "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",
18174         "type": "json"
18175       }
18176     ],
18177     "name": "addAnswer",
18178     "group": "Openchannel_Accounts",
18179     "parameter": {
18180       "fields": {
18181         "Body": [
18182           {
18183             "group": "Body",
18184             "type": "String",
18185             "optional": false,
18186             "field": "key",
18187             "description": ""
18188           },
18189           {
18190             "group": "Body",
18191             "type": "Text",
18192             "optional": false,
18193             "field": "value",
18194             "description": ""
18195           },
18196           {
18197             "group": "Body",
18198             "type": "String",
18199             "optional": true,
18200             "field": "description",
18201             "description": ""
18202           },
18203           {
18204             "group": "Body",
18205             "type": "Virtual",
18206             "optional": true,
18207             "field": "name",
18208             "description": ""
18209           }
18210         ]
18211       }
18212     },
18213     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18214     "version": "0.0.0",
18215     "filename": "server/api/openchannelAccount/index.js",
18216     "groupTitle": "Openchannel_Accounts"
18217   },
18218   {
18219     "type": "post",
18220     "url": "/api/openchannel/accounts/{id}/applications",
18221     "title": "Creates new applications",
18222     "examples": [
18223       {
18224         "title": "Example usage:",
18225         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18226         "type": "json"
18227       }
18228     ],
18229     "name": "addApplications",
18230     "group": "Openchannel_Accounts",
18231     "parameter": {
18232       "fields": {
18233         "Body": [
18234           {
18235             "group": "Body",
18236             "type": "Integer",
18237             "optional": false,
18238             "field": "priority",
18239             "description": ""
18240           },
18241           {
18242             "group": "Body",
18243             "type": "String",
18244             "optional": false,
18245             "field": "app",
18246             "description": ""
18247           },
18248           {
18249             "group": "Body",
18250             "type": "Text",
18251             "optional": true,
18252             "field": "appdata",
18253             "description": ""
18254           },
18255           {
18256             "group": "Body",
18257             "type": "String",
18258             "optional": true,
18259             "field": "description",
18260             "description": ""
18261           },
18262           {
18263             "group": "Body",
18264             "type": "String",
18265             "optional": true,
18266             "field": "interval",
18267             "description": ""
18268           }
18269         ]
18270       }
18271     },
18272     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18273     "version": "0.0.0",
18274     "filename": "server/api/openchannelAccount/index.js",
18275     "groupTitle": "Openchannel_Accounts"
18276   },
18277   {
18278     "type": "post",
18279     "url": "/api/openchannel/accounts/{id}/dispositions",
18280     "title": "Creates new disposition",
18281     "examples": [
18282       {
18283         "title": "Example usage:",
18284         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18285         "type": "json"
18286       }
18287     ],
18288     "name": "addDisposition",
18289     "group": "Openchannel_Accounts",
18290     "parameter": {
18291       "fields": {
18292         "Body": [
18293           {
18294             "group": "Body",
18295             "type": "String",
18296             "optional": false,
18297             "field": "name",
18298             "description": ""
18299           },
18300           {
18301             "group": "Body",
18302             "type": "String",
18303             "allowedValues": [
18304               "\"first\"",
18305               "\"second\"",
18306               "\"third\""
18307             ],
18308             "optional": false,
18309             "field": "level",
18310             "description": ""
18311           },
18312           {
18313             "group": "Body",
18314             "type": "String",
18315             "optional": true,
18316             "field": "description",
18317             "description": ""
18318           }
18319         ]
18320       }
18321     },
18322     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18323     "version": "0.0.0",
18324     "filename": "server/api/openchannelAccount/index.js",
18325     "groupTitle": "Openchannel_Accounts"
18326   },
18327   {
18328     "type": "get",
18329     "url": "/api/openchannel/accounts/{id}/canned_answers",
18330     "title": "Gets account canned answers",
18331     "examples": [
18332       {
18333         "title": "Example usage:",
18334         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
18335         "type": "json"
18336       }
18337     ],
18338     "name": "getAnswers",
18339     "group": "Openchannel_Accounts",
18340     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18341     "version": "0.0.0",
18342     "filename": "server/api/openchannelAccount/index.js",
18343     "groupTitle": "Openchannel_Accounts"
18344   },
18345   {
18346     "type": "get",
18347     "url": "/api/openchannel/accounts/{id}/applications",
18348     "title": "Gets account applications",
18349     "examples": [
18350       {
18351         "title": "Example usage:",
18352         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
18353         "type": "json"
18354       }
18355     ],
18356     "name": "getApplications",
18357     "group": "Openchannel_Accounts",
18358     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18359     "version": "0.0.0",
18360     "filename": "server/api/openchannelAccount/index.js",
18361     "groupTitle": "Openchannel_Accounts"
18362   },
18363   {
18364     "type": "get",
18365     "url": "/api/openchannel/accounts/{id}/dispositions",
18366     "title": "Gets account dispositions",
18367     "examples": [
18368       {
18369         "title": "Example usage:",
18370         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
18371         "type": "json"
18372       }
18373     ],
18374     "name": "getDispositions",
18375     "group": "Openchannel_Accounts",
18376     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18377     "version": "0.0.0",
18378     "filename": "server/api/openchannelAccount/index.js",
18379     "groupTitle": "Openchannel_Accounts"
18380   },
18381   {
18382     "type": "get",
18383     "url": "/api/openchannel/accounts/{id}/interactions",
18384     "title": "Gets Openchannel Account Interactions",
18385     "examples": [
18386       {
18387         "title": "Example usage:",
18388         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
18389         "type": "json"
18390       }
18391     ],
18392     "name": "getInteractions",
18393     "group": "Openchannel_Accounts",
18394     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18395     "version": "0.0.0",
18396     "filename": "server/api/openchannelAccount/index.js",
18397     "groupTitle": "Openchannel_Accounts"
18398   },
18399   {
18400     "type": "post",
18401     "url": "/api/openchannel/accounts/{id}/notify",
18402     "title": "Notify new message",
18403     "examples": [
18404       {
18405         "title": "Example usage:",
18406         "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",
18407         "type": "json"
18408       }
18409     ],
18410     "name": "notify",
18411     "group": "Openchannel_Accounts",
18412     "description": "<p>Motion 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>",
18413     "version": "0.0.0",
18414     "filename": "server/api/openchannelAccount/index.js",
18415     "groupTitle": "Openchannel_Accounts"
18416   },
18417   {
18418     "type": "post",
18419     "url": "/api/openchannel/accounts/{id}/send",
18420     "title": "Send new openchannel message",
18421     "examples": [
18422       {
18423         "title": "Example usage:",
18424         "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",
18425         "type": "json"
18426       }
18427     ],
18428     "name": "sendOpenchannel",
18429     "group": "Openchannel_Accounts",
18430     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18431     "version": "0.0.0",
18432     "filename": "server/api/openchannelAccount/index.js",
18433     "groupTitle": "Openchannel_Accounts"
18434   },
18435   {
18436     "type": "put",
18437     "url": "/api/openchannel/accounts/{id}",
18438     "title": "Update an existing Account",
18439     "examples": [
18440       {
18441         "title": "Example usage:",
18442         "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",
18443         "type": "json"
18444       }
18445     ],
18446     "name": "updateAccounts",
18447     "group": "Openchannel_Accounts",
18448     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18449     "version": "0.0.0",
18450     "filename": "server/api/openchannelAccount/index.js",
18451     "groupTitle": "Openchannel_Accounts"
18452   },
18453   {
18454     "type": "post",
18455     "url": "/api/openchannel/applications",
18456     "title": "Creates a new Application",
18457     "examples": [
18458       {
18459         "title": "Example usage:",
18460         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18461         "type": "json"
18462       }
18463     ],
18464     "name": "CreateApplications",
18465     "group": "Openchannel_Applications",
18466     "parameter": {
18467       "fields": {
18468         "Body": [
18469           {
18470             "group": "Body",
18471             "type": "Integer",
18472             "optional": false,
18473             "field": "priority",
18474             "description": ""
18475           },
18476           {
18477             "group": "Body",
18478             "type": "String",
18479             "optional": false,
18480             "field": "app",
18481             "description": ""
18482           },
18483           {
18484             "group": "Body",
18485             "type": "Text",
18486             "optional": true,
18487             "field": "appdata",
18488             "description": ""
18489           },
18490           {
18491             "group": "Body",
18492             "type": "String",
18493             "optional": true,
18494             "field": "description",
18495             "description": ""
18496           },
18497           {
18498             "group": "Body",
18499             "type": "String",
18500             "optional": true,
18501             "field": "interval",
18502             "description": ""
18503           }
18504         ]
18505       }
18506     },
18507     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18508     "version": "0.0.0",
18509     "filename": "server/api/openchannelApplication/index.js",
18510     "groupTitle": "Openchannel_Applications"
18511   },
18512   {
18513     "type": "delete",
18514     "url": "/api/openchannel/applications/{id}",
18515     "title": "Deletes a Application",
18516     "examples": [
18517       {
18518         "title": "Example usage:",
18519         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
18520         "type": "json"
18521       }
18522     ],
18523     "name": "DeleteApplications",
18524     "group": "Openchannel_Applications",
18525     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18526     "version": "0.0.0",
18527     "filename": "server/api/openchannelApplication/index.js",
18528     "groupTitle": "Openchannel_Applications"
18529   },
18530   {
18531     "type": "get",
18532     "url": "/api/openchannel/applications",
18533     "title": "Gets a list of Applications",
18534     "examples": [
18535       {
18536         "title": "Example usage:",
18537         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
18538         "type": "json"
18539       }
18540     ],
18541     "name": "GetApplications",
18542     "group": "Openchannel_Applications",
18543     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18544     "version": "0.0.0",
18545     "filename": "server/api/openchannelApplication/index.js",
18546     "groupTitle": "Openchannel_Applications"
18547   },
18548   {
18549     "type": "get",
18550     "url": "/api/openchannel/applications/{id}",
18551     "title": "Gets a single Application",
18552     "examples": [
18553       {
18554         "title": "Example usage:",
18555         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
18556         "type": "json"
18557       }
18558     ],
18559     "name": "ShowApplications",
18560     "group": "Openchannel_Applications",
18561     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18562     "version": "0.0.0",
18563     "filename": "server/api/openchannelApplication/index.js",
18564     "groupTitle": "Openchannel_Applications"
18565   },
18566   {
18567     "type": "put",
18568     "url": "/api/openchannel/applications/{id}",
18569     "title": "Update an existing Application",
18570     "examples": [
18571       {
18572         "title": "Example usage:",
18573         "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",
18574         "type": "json"
18575       }
18576     ],
18577     "name": "updateApplications",
18578     "group": "Openchannel_Applications",
18579     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18580     "version": "0.0.0",
18581     "filename": "server/api/openchannelApplication/index.js",
18582     "groupTitle": "Openchannel_Applications"
18583   },
18584   {
18585     "type": "post",
18586     "url": "/api/openchannel/interactions/{id}/tags",
18587     "title": "Add tags to the interaction",
18588     "examples": [
18589       {
18590         "title": "Example usage:",
18591         "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",
18592         "type": "json"
18593       }
18594     ],
18595     "name": "AddTags",
18596     "group": "Openchannel_Interactions",
18597     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18598     "version": "0.0.0",
18599     "filename": "server/api/openchannelInteraction/index.js",
18600     "groupTitle": "Openchannel_Interactions"
18601   },
18602   {
18603     "type": "post",
18604     "url": "/api/openchannel/interactions",
18605     "title": "Creates a new Interaction",
18606     "examples": [
18607       {
18608         "title": "Example usage:",
18609         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18610         "type": "json"
18611       }
18612     ],
18613     "name": "CreateInteractions",
18614     "group": "Openchannel_Interactions",
18615     "parameter": {
18616       "fields": {
18617         "Body": [
18618           {
18619             "group": "Body",
18620             "type": "Boolean",
18621             "optional": true,
18622             "field": "closed",
18623             "description": ""
18624           },
18625           {
18626             "group": "Body",
18627             "type": "String",
18628             "optional": true,
18629             "field": "closedAt",
18630             "description": ""
18631           },
18632           {
18633             "group": "Body",
18634             "type": "String",
18635             "optional": true,
18636             "field": "disposition",
18637             "description": ""
18638           },
18639           {
18640             "group": "Body",
18641             "type": "String",
18642             "optional": true,
18643             "field": "secondDisposition",
18644             "description": ""
18645           },
18646           {
18647             "group": "Body",
18648             "type": "String",
18649             "optional": true,
18650             "field": "thirdDisposition",
18651             "description": ""
18652           },
18653           {
18654             "group": "Body",
18655             "type": "String",
18656             "optional": true,
18657             "field": "note",
18658             "description": ""
18659           },
18660           {
18661             "group": "Body",
18662             "type": "String",
18663             "optional": true,
18664             "field": "read1stAt",
18665             "description": ""
18666           },
18667           {
18668             "group": "Body",
18669             "type": "String",
18670             "optional": true,
18671             "field": "threadId",
18672             "description": ""
18673           },
18674           {
18675             "group": "Body",
18676             "type": "String",
18677             "optional": true,
18678             "field": "externalUrl",
18679             "description": ""
18680           },
18681           {
18682             "group": "Body",
18683             "type": "String",
18684             "optional": true,
18685             "field": "lastMsgAt",
18686             "description": ""
18687           },
18688           {
18689             "group": "Body",
18690             "type": "String",
18691             "allowedValues": [
18692               "\"in\"",
18693               "\"out\""
18694             ],
18695             "optional": false,
18696             "field": "lastMsgDirection",
18697             "description": ""
18698           },
18699           {
18700             "group": "Body",
18701             "type": "String",
18702             "optional": true,
18703             "field": "from",
18704             "description": ""
18705           }
18706         ]
18707       }
18708     },
18709     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18710     "version": "0.0.0",
18711     "filename": "server/api/openchannelInteraction/index.js",
18712     "groupTitle": "Openchannel_Interactions"
18713   },
18714   {
18715     "type": "delete",
18716     "url": "/api/openchannel/interactions/{id}",
18717     "title": "Deletes a Interaction",
18718     "examples": [
18719       {
18720         "title": "Example usage:",
18721         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18722         "type": "json"
18723       }
18724     ],
18725     "name": "DeleteInteractions",
18726     "group": "Openchannel_Interactions",
18727     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18728     "version": "0.0.0",
18729     "filename": "server/api/openchannelInteraction/index.js",
18730     "groupTitle": "Openchannel_Interactions"
18731   },
18732   {
18733     "type": "get",
18734     "url": "/api/openchannel/interactions/describe",
18735     "title": "Gets table info about Interactions",
18736     "examples": [
18737       {
18738         "title": "Example usage:",
18739         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18740         "type": "json"
18741       }
18742     ],
18743     "name": "DescribeInteractions",
18744     "group": "Openchannel_Interactions",
18745     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18746     "version": "0.0.0",
18747     "filename": "server/api/openchannelInteraction/index.js",
18748     "groupTitle": "Openchannel_Interactions"
18749   },
18750   {
18751     "type": "get",
18752     "url": "/api/openchannel/interactions",
18753     "title": "Gets a list of Interactions",
18754     "examples": [
18755       {
18756         "title": "Example usage:",
18757         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18758         "type": "json"
18759       }
18760     ],
18761     "name": "GetInteractions",
18762     "group": "Openchannel_Interactions",
18763     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18764     "version": "0.0.0",
18765     "filename": "server/api/openchannelInteraction/index.js",
18766     "groupTitle": "Openchannel_Interactions"
18767   },
18768   {
18769     "type": "delete",
18770     "url": "/api/openchannel/interactions/{id}/tags",
18771     "title": "Removes tags from interaction",
18772     "examples": [
18773       {
18774         "title": "Example usage:",
18775         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18776         "type": "json"
18777       }
18778     ],
18779     "name": "RemoveTags",
18780     "group": "Openchannel_Interactions",
18781     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18782     "version": "0.0.0",
18783     "filename": "server/api/openchannelInteraction/index.js",
18784     "groupTitle": "Openchannel_Interactions"
18785   },
18786   {
18787     "type": "get",
18788     "url": "/api/openchannel/interactions/{id}",
18789     "title": "Gets a single Interaction",
18790     "examples": [
18791       {
18792         "title": "Example usage:",
18793         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18794         "type": "json"
18795       }
18796     ],
18797     "name": "ShowInteractions",
18798     "group": "Openchannel_Interactions",
18799     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18800     "version": "0.0.0",
18801     "filename": "server/api/openchannelInteraction/index.js",
18802     "groupTitle": "Openchannel_Interactions"
18803   },
18804   {
18805     "type": "post",
18806     "url": "/api/openchannel/interactions/{id}/messages",
18807     "title": "Creates new messages",
18808     "examples": [
18809       {
18810         "title": "Example usage:",
18811         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18812         "type": "json"
18813       }
18814     ],
18815     "name": "addMessage",
18816     "group": "Openchannel_Interactions",
18817     "parameter": {
18818       "fields": {
18819         "Body": [
18820           {
18821             "group": "Body",
18822             "type": "Text",
18823             "optional": false,
18824             "field": "body",
18825             "description": ""
18826           },
18827           {
18828             "group": "Body",
18829             "type": "Boolean",
18830             "optional": true,
18831             "field": "read",
18832             "description": ""
18833           },
18834           {
18835             "group": "Body",
18836             "type": "Boolean",
18837             "optional": true,
18838             "field": "secret",
18839             "description": ""
18840           },
18841           {
18842             "group": "Body",
18843             "type": "String",
18844             "allowedValues": [
18845               "\"in\"",
18846               "\"out\""
18847             ],
18848             "optional": false,
18849             "field": "direction",
18850             "description": ""
18851           },
18852           {
18853             "group": "Body",
18854             "type": "String",
18855             "optional": true,
18856             "field": "readAt",
18857             "description": ""
18858           },
18859           {
18860             "group": "Body",
18861             "type": "String",
18862             "optional": true,
18863             "field": "providerName",
18864             "description": ""
18865           },
18866           {
18867             "group": "Body",
18868             "type": "Text",
18869             "optional": true,
18870             "field": "providerResponse",
18871             "description": ""
18872           }
18873         ]
18874       }
18875     },
18876     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18877     "version": "0.0.0",
18878     "filename": "server/api/openchannelInteraction/index.js",
18879     "groupTitle": "Openchannel_Interactions"
18880   },
18881   {
18882     "type": "get",
18883     "url": "/api/openchannel/interactions/{id}/download",
18884     "title": "Gets interaction",
18885     "examples": [
18886       {
18887         "title": "Example usage:",
18888         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18889         "type": "json"
18890       }
18891     ],
18892     "name": "download",
18893     "group": "Openchannel_Interactions",
18894     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18895     "version": "0.0.0",
18896     "filename": "server/api/openchannelInteraction/index.js",
18897     "groupTitle": "Openchannel_Interactions"
18898   },
18899   {
18900     "type": "get",
18901     "url": "/api/openchannel/interactions/{id}/messages",
18902     "title": "Gets interaction messages",
18903     "examples": [
18904       {
18905         "title": "Example usage:",
18906         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18907         "type": "json"
18908       }
18909     ],
18910     "name": "getMessages",
18911     "group": "Openchannel_Interactions",
18912     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18913     "version": "0.0.0",
18914     "filename": "server/api/openchannelInteraction/index.js",
18915     "groupTitle": "Openchannel_Interactions"
18916   },
18917   {
18918     "type": "put",
18919     "url": "/api/openchannel/interactions/{id}",
18920     "title": "Update an existing Interaction",
18921     "examples": [
18922       {
18923         "title": "Example usage:",
18924         "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",
18925         "type": "json"
18926       }
18927     ],
18928     "name": "updateInteractions",
18929     "group": "Openchannel_Interactions",
18930     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18931     "version": "0.0.0",
18932     "filename": "server/api/openchannelInteraction/index.js",
18933     "groupTitle": "Openchannel_Interactions"
18934   },
18935   {
18936     "type": "post",
18937     "url": "/api/openchannel/messages",
18938     "title": "Creates a new Message",
18939     "examples": [
18940       {
18941         "title": "Example usage:",
18942         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18943         "type": "json"
18944       }
18945     ],
18946     "name": "CreateMessages",
18947     "group": "Openchannel_Messages",
18948     "parameter": {
18949       "fields": {
18950         "Body": [
18951           {
18952             "group": "Body",
18953             "type": "Text",
18954             "optional": false,
18955             "field": "body",
18956             "description": ""
18957           },
18958           {
18959             "group": "Body",
18960             "type": "Boolean",
18961             "optional": true,
18962             "field": "read",
18963             "description": ""
18964           },
18965           {
18966             "group": "Body",
18967             "type": "Boolean",
18968             "optional": true,
18969             "field": "secret",
18970             "description": ""
18971           },
18972           {
18973             "group": "Body",
18974             "type": "String",
18975             "allowedValues": [
18976               "\"in\"",
18977               "\"out\""
18978             ],
18979             "optional": false,
18980             "field": "direction",
18981             "description": ""
18982           },
18983           {
18984             "group": "Body",
18985             "type": "String",
18986             "optional": true,
18987             "field": "readAt",
18988             "description": ""
18989           },
18990           {
18991             "group": "Body",
18992             "type": "String",
18993             "optional": true,
18994             "field": "providerName",
18995             "description": ""
18996           },
18997           {
18998             "group": "Body",
18999             "type": "Text",
19000             "optional": true,
19001             "field": "providerResponse",
19002             "description": ""
19003           }
19004         ]
19005       }
19006     },
19007     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19008     "version": "0.0.0",
19009     "filename": "server/api/openchannelMessage/index.js",
19010     "groupTitle": "Openchannel_Messages"
19011   },
19012   {
19013     "type": "delete",
19014     "url": "/api/openchannel/messages/{id}",
19015     "title": "Deletes a Message",
19016     "examples": [
19017       {
19018         "title": "Example usage:",
19019         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
19020         "type": "json"
19021       }
19022     ],
19023     "name": "DeleteMessages",
19024     "group": "Openchannel_Messages",
19025     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19026     "version": "0.0.0",
19027     "filename": "server/api/openchannelMessage/index.js",
19028     "groupTitle": "Openchannel_Messages"
19029   },
19030   {
19031     "type": "get",
19032     "url": "/api/openchannel/messages/describe",
19033     "title": "Gets table info about Messages",
19034     "examples": [
19035       {
19036         "title": "Example usage:",
19037         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
19038         "type": "json"
19039       }
19040     ],
19041     "name": "DescribeMessages",
19042     "group": "Openchannel_Messages",
19043     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19044     "version": "0.0.0",
19045     "filename": "server/api/openchannelMessage/index.js",
19046     "groupTitle": "Openchannel_Messages"
19047   },
19048   {
19049     "type": "get",
19050     "url": "/api/openchannel/messages",
19051     "title": "Gets a list of Messages",
19052     "examples": [
19053       {
19054         "title": "Example usage:",
19055         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
19056         "type": "json"
19057       }
19058     ],
19059     "name": "GetMessages",
19060     "group": "Openchannel_Messages",
19061     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19062     "version": "0.0.0",
19063     "filename": "server/api/openchannelMessage/index.js",
19064     "groupTitle": "Openchannel_Messages"
19065   },
19066   {
19067     "type": "get",
19068     "url": "/api/openchannel/messages/{id}",
19069     "title": "Gets a single Message",
19070     "examples": [
19071       {
19072         "title": "Example usage:",
19073         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
19074         "type": "json"
19075       }
19076     ],
19077     "name": "ShowMessages",
19078     "group": "Openchannel_Messages",
19079     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19080     "version": "0.0.0",
19081     "filename": "server/api/openchannelMessage/index.js",
19082     "groupTitle": "Openchannel_Messages"
19083   },
19084   {
19085     "type": "put",
19086     "url": "/api/openchannel/messages/{id}/accept",
19087     "title": "Accepts message",
19088     "examples": [
19089       {
19090         "title": "Example usage:",
19091         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
19092         "type": "json"
19093       }
19094     ],
19095     "name": "acceptMessage",
19096     "group": "Openchannel_Messages",
19097     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19098     "version": "0.0.0",
19099     "filename": "server/api/openchannelMessage/index.js",
19100     "groupTitle": "Openchannel_Messages"
19101   },
19102   {
19103     "type": "put",
19104     "url": "/api/openchannel/messages/{id}/reject",
19105     "title": "Rejects message",
19106     "examples": [
19107       {
19108         "title": "Example usage:",
19109         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
19110         "type": "json"
19111       }
19112     ],
19113     "name": "rejectMessage",
19114     "group": "Openchannel_Messages",
19115     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19116     "version": "0.0.0",
19117     "filename": "server/api/openchannelMessage/index.js",
19118     "groupTitle": "Openchannel_Messages"
19119   },
19120   {
19121     "type": "put",
19122     "url": "/api/openchannel/messages/{id}",
19123     "title": "Update an existing Message",
19124     "examples": [
19125       {
19126         "title": "Example usage:",
19127         "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",
19128         "type": "json"
19129       }
19130     ],
19131     "name": "updateMessages",
19132     "group": "Openchannel_Messages",
19133     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19134     "version": "0.0.0",
19135     "filename": "server/api/openchannelMessage/index.js",
19136     "groupTitle": "Openchannel_Messages"
19137   },
19138   {
19139     "type": "post",
19140     "url": "/api/openchannel/reports/queue",
19141     "title": "Creates a new Openchannel Queue Report",
19142     "examples": [
19143       {
19144         "title": "Example usage:",
19145         "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",
19146         "type": "json"
19147       }
19148     ],
19149     "name": "CreateOpenchannel_Queue_Reports",
19150     "group": "Openchannel_Queue_Reports",
19151     "parameter": {
19152       "fields": {
19153         "Body": [
19154           {
19155             "group": "Body",
19156             "type": "String",
19157             "optional": false,
19158             "field": "uniqueid",
19159             "description": ""
19160           },
19161           {
19162             "group": "Body",
19163             "type": "String",
19164             "optional": true,
19165             "field": "from",
19166             "description": ""
19167           },
19168           {
19169             "group": "Body",
19170             "type": "String",
19171             "optional": true,
19172             "field": "joinAt",
19173             "description": ""
19174           },
19175           {
19176             "group": "Body",
19177             "type": "String",
19178             "optional": true,
19179             "field": "leaveAt",
19180             "description": ""
19181           },
19182           {
19183             "group": "Body",
19184             "type": "String",
19185             "optional": true,
19186             "field": "acceptAt",
19187             "description": ""
19188           },
19189           {
19190             "group": "Body",
19191             "type": "String",
19192             "optional": true,
19193             "field": "exitAt",
19194             "description": ""
19195           },
19196           {
19197             "group": "Body",
19198             "type": "String",
19199             "optional": true,
19200             "field": "reason",
19201             "description": ""
19202           }
19203         ]
19204       }
19205     },
19206     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19207     "version": "0.0.0",
19208     "filename": "server/api/openchannelQueueReport/index.js",
19209     "groupTitle": "Openchannel_Queue_Reports"
19210   },
19211   {
19212     "type": "delete",
19213     "url": "/api/openchannel/reports/queue/{id}",
19214     "title": "Deletes a Openchannel Queue Report",
19215     "examples": [
19216       {
19217         "title": "Example usage:",
19218         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
19219         "type": "json"
19220       }
19221     ],
19222     "name": "DeleteOpenchannel_Queue_Reports",
19223     "group": "Openchannel_Queue_Reports",
19224     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19225     "version": "0.0.0",
19226     "filename": "server/api/openchannelQueueReport/index.js",
19227     "groupTitle": "Openchannel_Queue_Reports"
19228   },
19229   {
19230     "type": "get",
19231     "url": "/api/openchannel/reports/queue/describe",
19232     "title": "Gets table info about Openchannel Queue Reports",
19233     "examples": [
19234       {
19235         "title": "Example usage:",
19236         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
19237         "type": "json"
19238       }
19239     ],
19240     "name": "DescribeOpenchannel_Queue_Reports",
19241     "group": "Openchannel_Queue_Reports",
19242     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19243     "version": "0.0.0",
19244     "filename": "server/api/openchannelQueueReport/index.js",
19245     "groupTitle": "Openchannel_Queue_Reports"
19246   },
19247   {
19248     "type": "get",
19249     "url": "/api/openchannel/reports/queue",
19250     "title": "Gets a list of Openchannel Queue Reports",
19251     "examples": [
19252       {
19253         "title": "Example usage:",
19254         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
19255         "type": "json"
19256       }
19257     ],
19258     "name": "GetOpenchannel_Queue_Reports",
19259     "group": "Openchannel_Queue_Reports",
19260     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19261     "version": "0.0.0",
19262     "filename": "server/api/openchannelQueueReport/index.js",
19263     "groupTitle": "Openchannel_Queue_Reports"
19264   },
19265   {
19266     "type": "get",
19267     "url": "/api/openchannel/reports/queue/{id}",
19268     "title": "Gets a single Openchannel Queue Report",
19269     "examples": [
19270       {
19271         "title": "Example usage:",
19272         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
19273         "type": "json"
19274       }
19275     ],
19276     "name": "ShowOpenchannel_Queue_Reports",
19277     "group": "Openchannel_Queue_Reports",
19278     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19279     "version": "0.0.0",
19280     "filename": "server/api/openchannelQueueReport/index.js",
19281     "groupTitle": "Openchannel_Queue_Reports"
19282   },
19283   {
19284     "type": "put",
19285     "url": "/api/openchannel/reports/queue/{id}",
19286     "title": "Update an existing Openchannel Queue Report",
19287     "examples": [
19288       {
19289         "title": "Example usage:",
19290         "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",
19291         "type": "json"
19292       }
19293     ],
19294     "name": "updateOpenchannel_Queue_Reports",
19295     "group": "Openchannel_Queue_Reports",
19296     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19297     "version": "0.0.0",
19298     "filename": "server/api/openchannelQueueReport/index.js",
19299     "groupTitle": "Openchannel_Queue_Reports"
19300   },
19301   {
19302     "type": "post",
19303     "url": "/api/openchannel/queues/{id}/users",
19304     "title": "Add agents to a queue",
19305     "examples": [
19306       {
19307         "title": "Example usage:",
19308         "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",
19309         "type": "json"
19310       }
19311     ],
19312     "name": "AddAgents",
19313     "group": "Openchannel_Queues",
19314     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19315     "version": "0.0.0",
19316     "filename": "server/api/openchannelQueue/index.js",
19317     "groupTitle": "Openchannel_Queues"
19318   },
19319   {
19320     "type": "post",
19321     "url": "/api/openchannel/queues/{id}/teams",
19322     "title": "Add teams to a queue",
19323     "examples": [
19324       {
19325         "title": "Example usage:",
19326         "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",
19327         "type": "json"
19328       }
19329     ],
19330     "name": "AddTeams",
19331     "group": "Openchannel_Queues",
19332     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19333     "version": "0.0.0",
19334     "filename": "server/api/openchannelQueue/index.js",
19335     "groupTitle": "Openchannel_Queues"
19336   },
19337   {
19338     "type": "post",
19339     "url": "/api/openchannel/queues",
19340     "title": "Creates a new Queue",
19341     "examples": [
19342       {
19343         "title": "Example usage:",
19344         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19345         "type": "json"
19346       }
19347     ],
19348     "name": "CreateQueues",
19349     "group": "Openchannel_Queues",
19350     "parameter": {
19351       "fields": {
19352         "Body": [
19353           {
19354             "group": "Body",
19355             "type": "String",
19356             "optional": true,
19357             "field": "name",
19358             "description": ""
19359           },
19360           {
19361             "group": "Body",
19362             "type": "String",
19363             "optional": true,
19364             "field": "description",
19365             "description": ""
19366           },
19367           {
19368             "group": "Body",
19369             "type": "Integer",
19370             "optional": true,
19371             "field": "timeout",
19372             "description": ""
19373           },
19374           {
19375             "group": "Body",
19376             "type": "String",
19377             "allowedValues": [
19378               "\"rrmemory\"",
19379               "\"beepall\"",
19380               "\"roundrobin\""
19381             ],
19382             "optional": true,
19383             "field": "strategy",
19384             "description": ""
19385           }
19386         ]
19387       }
19388     },
19389     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19390     "version": "0.0.0",
19391     "filename": "server/api/openchannelQueue/index.js",
19392     "groupTitle": "Openchannel_Queues"
19393   },
19394   {
19395     "type": "delete",
19396     "url": "/api/openchannel/queues/{id}",
19397     "title": "Deletes a Queue",
19398     "examples": [
19399       {
19400         "title": "Example usage:",
19401         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
19402         "type": "json"
19403       }
19404     ],
19405     "name": "DeleteQueues",
19406     "group": "Openchannel_Queues",
19407     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/openchannelQueue/index.js",
19410     "groupTitle": "Openchannel_Queues"
19411   },
19412   {
19413     "type": "get",
19414     "url": "/api/openchannel/queues/describe",
19415     "title": "Gets table info about Queues",
19416     "examples": [
19417       {
19418         "title": "Example usage:",
19419         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
19420         "type": "json"
19421       }
19422     ],
19423     "name": "DescribeQueues",
19424     "group": "Openchannel_Queues",
19425     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19426     "version": "0.0.0",
19427     "filename": "server/api/openchannelQueue/index.js",
19428     "groupTitle": "Openchannel_Queues"
19429   },
19430   {
19431     "type": "get",
19432     "url": "/api/openchannel/queues/{id}/users",
19433     "title": "Gets queue agents",
19434     "examples": [
19435       {
19436         "title": "Example usage:",
19437         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
19438         "type": "json"
19439       }
19440     ],
19441     "name": "GetAgents",
19442     "group": "Openchannel_Queues",
19443     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19444     "version": "0.0.0",
19445     "filename": "server/api/openchannelQueue/index.js",
19446     "groupTitle": "Openchannel_Queues"
19447   },
19448   {
19449     "type": "get",
19450     "url": "/api/openchannel/queues/{id}/members",
19451     "title": "GetMembers",
19452     "examples": [
19453       {
19454         "title": "Example usage:",
19455         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
19456         "type": "json"
19457       }
19458     ],
19459     "name": "GetMembers",
19460     "group": "Openchannel_Queues",
19461     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19462     "version": "0.0.0",
19463     "filename": "server/api/openchannelQueue/index.js",
19464     "groupTitle": "Openchannel_Queues"
19465   },
19466   {
19467     "type": "get",
19468     "url": "/api/openchannel/queues",
19469     "title": "Gets a list of Queues",
19470     "examples": [
19471       {
19472         "title": "Example usage:",
19473         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
19474         "type": "json"
19475       }
19476     ],
19477     "name": "GetQueues",
19478     "group": "Openchannel_Queues",
19479     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19480     "version": "0.0.0",
19481     "filename": "server/api/openchannelQueue/index.js",
19482     "groupTitle": "Openchannel_Queues"
19483   },
19484   {
19485     "type": "get",
19486     "url": "/api/openchannel/queues/{id}/teams",
19487     "title": "Gets queues list",
19488     "examples": [
19489       {
19490         "title": "Example usage:",
19491         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
19492         "type": "json"
19493       }
19494     ],
19495     "name": "GetTeams",
19496     "group": "Openchannel_Queues",
19497     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/openchannelQueue/index.js",
19500     "groupTitle": "Openchannel_Queues"
19501   },
19502   {
19503     "type": "delete",
19504     "url": "/api/openchannel/queues/{id}/users",
19505     "title": "Removes agents from a queue",
19506     "examples": [
19507       {
19508         "title": "Example usage:",
19509         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
19510         "type": "json"
19511       }
19512     ],
19513     "name": "RemoveAgents",
19514     "group": "Openchannel_Queues",
19515     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/openchannelQueue/index.js",
19518     "groupTitle": "Openchannel_Queues"
19519   },
19520   {
19521     "type": "get",
19522     "url": "/api/openchannel/queues/{id}",
19523     "title": "Gets a single Queue",
19524     "examples": [
19525       {
19526         "title": "Example usage:",
19527         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
19528         "type": "json"
19529       }
19530     ],
19531     "name": "ShowQueues",
19532     "group": "Openchannel_Queues",
19533     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19534     "version": "0.0.0",
19535     "filename": "server/api/openchannelQueue/index.js",
19536     "groupTitle": "Openchannel_Queues"
19537   },
19538   {
19539     "type": "put",
19540     "url": "/api/openchannel/queues/{id}",
19541     "title": "Update an existing Queue",
19542     "examples": [
19543       {
19544         "title": "Example usage:",
19545         "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",
19546         "type": "json"
19547       }
19548     ],
19549     "name": "updateQueues",
19550     "group": "Openchannel_Queues",
19551     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19552     "version": "0.0.0",
19553     "filename": "server/api/openchannelQueue/index.js",
19554     "groupTitle": "Openchannel_Queues"
19555   },
19556   {
19557     "type": "post",
19558     "url": "/api/openchannel/reports/transfer",
19559     "title": "Creates a new Openchannel Transfer Report",
19560     "examples": [
19561       {
19562         "title": "Example usage:",
19563         "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",
19564         "type": "json"
19565       }
19566     ],
19567     "name": "CreateOpenchannel_Transfer_Reports",
19568     "group": "Openchannel_Transfer_Reports",
19569     "parameter": {
19570       "fields": {
19571         "Body": [
19572           {
19573             "group": "Body",
19574             "type": "String",
19575             "optional": false,
19576             "field": "uniqueid",
19577             "description": ""
19578           },
19579           {
19580             "group": "Body",
19581             "type": "String",
19582             "allowedValues": [
19583               "\"account\"",
19584               "\"agent\"",
19585               "\"queue\""
19586             ],
19587             "optional": false,
19588             "field": "type",
19589             "description": ""
19590           },
19591           {
19592             "group": "Body",
19593             "type": "String",
19594             "optional": false,
19595             "field": "transferredAt",
19596             "description": ""
19597           }
19598         ]
19599       }
19600     },
19601     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19602     "version": "0.0.0",
19603     "filename": "server/api/openchannelTransferReport/index.js",
19604     "groupTitle": "Openchannel_Transfer_Reports"
19605   },
19606   {
19607     "type": "delete",
19608     "url": "/api/openchannel/reports/transfer/{id}",
19609     "title": "Deletes a Openchannel Transfer Report",
19610     "examples": [
19611       {
19612         "title": "Example usage:",
19613         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
19614         "type": "json"
19615       }
19616     ],
19617     "name": "DeleteOpenchannel_Transfer_Reports",
19618     "group": "Openchannel_Transfer_Reports",
19619     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19620     "version": "0.0.0",
19621     "filename": "server/api/openchannelTransferReport/index.js",
19622     "groupTitle": "Openchannel_Transfer_Reports"
19623   },
19624   {
19625     "type": "get",
19626     "url": "/api/openchannel/reports/transfer/describe",
19627     "title": "Gets table info about Openchannel Transfer Reports",
19628     "examples": [
19629       {
19630         "title": "Example usage:",
19631         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19632         "type": "json"
19633       }
19634     ],
19635     "name": "DescribeOpenchannel_Transfer_Reports",
19636     "group": "Openchannel_Transfer_Reports",
19637     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19638     "version": "0.0.0",
19639     "filename": "server/api/openchannelTransferReport/index.js",
19640     "groupTitle": "Openchannel_Transfer_Reports"
19641   },
19642   {
19643     "type": "get",
19644     "url": "/api/openchannel/reports/transfer",
19645     "title": "Gets a list of Openchannel Transfer Reports",
19646     "examples": [
19647       {
19648         "title": "Example usage:",
19649         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19650         "type": "json"
19651       }
19652     ],
19653     "name": "GetOpenchannel_Transfer_Reports",
19654     "group": "Openchannel_Transfer_Reports",
19655     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19656     "version": "0.0.0",
19657     "filename": "server/api/openchannelTransferReport/index.js",
19658     "groupTitle": "Openchannel_Transfer_Reports"
19659   },
19660   {
19661     "type": "get",
19662     "url": "/api/openchannel/reports/transfer/{id}",
19663     "title": "Gets a single Openchannel Transfer Report",
19664     "examples": [
19665       {
19666         "title": "Example usage:",
19667         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19668         "type": "json"
19669       }
19670     ],
19671     "name": "ShowOpenchannel_Transfer_Reports",
19672     "group": "Openchannel_Transfer_Reports",
19673     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19674     "version": "0.0.0",
19675     "filename": "server/api/openchannelTransferReport/index.js",
19676     "groupTitle": "Openchannel_Transfer_Reports"
19677   },
19678   {
19679     "type": "put",
19680     "url": "/api/openchannel/reports/transfer/{id}",
19681     "title": "Update an existing Openchannel Transfer Report",
19682     "examples": [
19683       {
19684         "title": "Example usage:",
19685         "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",
19686         "type": "json"
19687       }
19688     ],
19689     "name": "updateOpenchannel_Transfer_Reports",
19690     "group": "Openchannel_Transfer_Reports",
19691     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19692     "version": "0.0.0",
19693     "filename": "server/api/openchannelTransferReport/index.js",
19694     "groupTitle": "Openchannel_Transfer_Reports"
19695   },
19696   {
19697     "type": "post",
19698     "url": "/api/pauses",
19699     "title": "Creates a new Pause",
19700     "examples": [
19701       {
19702         "title": "Example usage:",
19703         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19704         "type": "json"
19705       }
19706     ],
19707     "name": "CreatePauses",
19708     "group": "Pauses",
19709     "parameter": {
19710       "fields": {
19711         "Body": [
19712           {
19713             "group": "Body",
19714             "type": "String",
19715             "optional": false,
19716             "field": "name",
19717             "description": ""
19718           },
19719           {
19720             "group": "Body",
19721             "type": "String",
19722             "optional": true,
19723             "field": "description",
19724             "description": ""
19725           }
19726         ]
19727       }
19728     },
19729     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19730     "version": "0.0.0",
19731     "filename": "server/api/pause/index.js",
19732     "groupTitle": "Pauses"
19733   },
19734   {
19735     "type": "delete",
19736     "url": "/api/pauses/{id}",
19737     "title": "Deletes a Pause",
19738     "examples": [
19739       {
19740         "title": "Example usage:",
19741         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19742         "type": "json"
19743       }
19744     ],
19745     "name": "DeletePauses",
19746     "group": "Pauses",
19747     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19748     "version": "0.0.0",
19749     "filename": "server/api/pause/index.js",
19750     "groupTitle": "Pauses"
19751   },
19752   {
19753     "type": "get",
19754     "url": "/api/pauses",
19755     "title": "Gets a list of Pauses",
19756     "examples": [
19757       {
19758         "title": "Example usage:",
19759         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19760         "type": "json"
19761       }
19762     ],
19763     "name": "GetPauses",
19764     "group": "Pauses",
19765     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19766     "version": "0.0.0",
19767     "filename": "server/api/pause/index.js",
19768     "groupTitle": "Pauses"
19769   },
19770   {
19771     "type": "get",
19772     "url": "/api/pauses/{id}",
19773     "title": "Gets a single Pause",
19774     "examples": [
19775       {
19776         "title": "Example usage:",
19777         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19778         "type": "json"
19779       }
19780     ],
19781     "name": "ShowPauses",
19782     "group": "Pauses",
19783     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19784     "version": "0.0.0",
19785     "filename": "server/api/pause/index.js",
19786     "groupTitle": "Pauses"
19787   },
19788   {
19789     "type": "put",
19790     "url": "/api/pauses/{id}",
19791     "title": "Update an existing Pause",
19792     "examples": [
19793       {
19794         "title": "Example usage:",
19795         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19796         "type": "json"
19797       }
19798     ],
19799     "name": "updatePauses",
19800     "group": "Pauses",
19801     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19802     "version": "0.0.0",
19803     "filename": "server/api/pause/index.js",
19804     "groupTitle": "Pauses"
19805   },
19806   {
19807     "type": "get",
19808     "url": "/api/plugins",
19809     "title": "Gets a list of Plugins",
19810     "examples": [
19811       {
19812         "title": "Example usage:",
19813         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19814         "type": "json"
19815       }
19816     ],
19817     "name": "GetPlugins",
19818     "group": "Plugins",
19819     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19820     "version": "0.0.0",
19821     "filename": "server/api/plugin/index.js",
19822     "groupTitle": "Plugins"
19823   },
19824   {
19825     "type": "get",
19826     "url": "/api/plugins/{id}",
19827     "title": "Gets a single Plugin",
19828     "examples": [
19829       {
19830         "title": "Example usage:",
19831         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19832         "type": "json"
19833       }
19834     ],
19835     "name": "ShowPlugins",
19836     "group": "Plugins",
19837     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19838     "version": "0.0.0",
19839     "filename": "server/api/plugin/index.js",
19840     "groupTitle": "Plugins"
19841   },
19842   {
19843     "type": "delete",
19844     "url": "/api/plugins/{id}",
19845     "title": "Delete a plugin",
19846     "examples": [
19847       {
19848         "title": "Example usage:",
19849         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19850         "type": "json"
19851       }
19852     ],
19853     "name": "destroyPlugin",
19854     "group": "Plugins",
19855     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19856     "version": "0.0.0",
19857     "filename": "server/api/plugin/index.js",
19858     "groupTitle": "Plugins"
19859   },
19860   {
19861     "type": "get",
19862     "url": "/api/plugins/{id}/download",
19863     "title": "Download plugin source code",
19864     "examples": [
19865       {
19866         "title": "Example usage:",
19867         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19868         "type": "json"
19869       }
19870     ],
19871     "name": "download",
19872     "group": "Plugins",
19873     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19874     "version": "0.0.0",
19875     "filename": "server/api/plugin/index.js",
19876     "groupTitle": "Plugins"
19877   },
19878   {
19879     "type": "put",
19880     "url": "/api/plugins/{id}",
19881     "title": "Update an existing plugin",
19882     "examples": [
19883       {
19884         "title": "Example usage:",
19885         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19886         "type": "json"
19887       }
19888     ],
19889     "name": "updatePlugin",
19890     "group": "Plugins",
19891     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19892     "version": "0.0.0",
19893     "filename": "server/api/plugin/index.js",
19894     "groupTitle": "Plugins"
19895   },
19896   {
19897     "type": "post",
19898     "url": "/api/plugins",
19899     "title": "Upload new plugin",
19900     "examples": [
19901       {
19902         "title": "Example usage:",
19903         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19904         "type": "json"
19905       }
19906     ],
19907     "name": "uploadPlugin",
19908     "group": "Plugins",
19909     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19910     "version": "0.0.0",
19911     "filename": "server/api/plugin/index.js",
19912     "groupTitle": "Plugins"
19913   },
19914   {
19915     "type": "get",
19916     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19917     "title": "Redirect a plugin request to the specified path",
19918     "examples": [
19919       {
19920         "title": "Example usage:",
19921         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19922         "type": "json"
19923       }
19924     ],
19925     "name": "webhookPlugin",
19926     "group": "Plugins",
19927     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19928     "version": "0.0.0",
19929     "filename": "server/api/plugin/index.js",
19930     "groupTitle": "Plugins"
19931   },
19932   {
19933     "type": "post",
19934     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19935     "title": "Redirect a plugin request to the specified path",
19936     "examples": [
19937       {
19938         "title": "Example usage:",
19939         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19940         "type": "json"
19941       }
19942     ],
19943     "name": "webhookPlugin",
19944     "group": "Plugins",
19945     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19946     "version": "0.0.0",
19947     "filename": "server/api/plugin/index.js",
19948     "groupTitle": "Plugins"
19949   },
19950   {
19951     "type": "delete",
19952     "url": "/api/pm2/{id}",
19953     "title": "Deletes an existing process",
19954     "examples": [
19955       {
19956         "title": "Example usage:",
19957         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19958         "type": "json"
19959       }
19960     ],
19961     "name": "DeletePm2Process",
19962     "group": "Pm2",
19963     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19964     "version": "0.0.0",
19965     "filename": "server/api/pm2/index.js",
19966     "groupTitle": "Pm2"
19967   },
19968   {
19969     "type": "get",
19970     "url": "/api/pm2/{id}",
19971     "title": "Gets a single pm2 process",
19972     "examples": [
19973       {
19974         "title": "Example usage:",
19975         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19976         "type": "json"
19977       }
19978     ],
19979     "name": "GetPm2Process",
19980     "group": "Pm2",
19981     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19982     "version": "0.0.0",
19983     "filename": "server/api/pm2/index.js",
19984     "groupTitle": "Pm2"
19985   },
19986   {
19987     "type": "get",
19988     "url": "/api/pm2",
19989     "title": "Gets pm2 processes",
19990     "examples": [
19991       {
19992         "title": "Example usage:",
19993         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19994         "type": "json"
19995       }
19996     ],
19997     "name": "GetPm2Processes",
19998     "group": "Pm2",
19999     "description": "<p>Motion returns the pm2 processes list.</p>",
20000     "version": "0.0.0",
20001     "filename": "server/api/pm2/index.js",
20002     "groupTitle": "Pm2"
20003   },
20004   {
20005     "type": "post",
20006     "url": "/api/pm2",
20007     "title": "Start a single pm2 process",
20008     "examples": [
20009       {
20010         "title": "Example usage:",
20011         "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",
20012         "type": "json"
20013       }
20014     ],
20015     "name": "StartPm2Process",
20016     "group": "Pm2",
20017     "parameter": {
20018       "fields": {
20019         "Body": [
20020           {
20021             "group": "Body",
20022             "type": "String",
20023             "optional": false,
20024             "field": "name",
20025             "description": ""
20026           },
20027           {
20028             "group": "Body",
20029             "type": "String",
20030             "optional": false,
20031             "field": "script",
20032             "description": ""
20033           }
20034         ]
20035       }
20036     },
20037     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20038     "version": "0.0.0",
20039     "filename": "server/api/pm2/index.js",
20040     "groupTitle": "Pm2"
20041   },
20042   {
20043     "type": "put",
20044     "url": "/api/pm2/{id}",
20045     "title": "Update an existing process",
20046     "examples": [
20047       {
20048         "title": "Example usage:",
20049         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20050         "type": "json"
20051       }
20052     ],
20053     "name": "UpdatePm2Process",
20054     "group": "Pm2",
20055     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20056     "version": "0.0.0",
20057     "filename": "server/api/pm2/index.js",
20058     "groupTitle": "Pm2"
20059   },
20060   {
20061     "type": "get",
20062     "url": "/api/rpc/campaigns/",
20063     "title": "Gets a list of campaigns",
20064     "examples": [
20065       {
20066         "title": "Example usage:",
20067         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
20068         "type": "json"
20069       }
20070     ],
20071     "name": "Campaigns",
20072     "group": "RPC_Realtime",
20073     "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>",
20074     "version": "0.0.0",
20075     "filename": "server/api/rpc/index.js",
20076     "groupTitle": "RPC_Realtime"
20077   },
20078   {
20079     "type": "get",
20080     "url": "/api/rpc/fax/accounts",
20081     "title": "Gets a list of FaxAccounts",
20082     "examples": [
20083       {
20084         "title": "Example usage:",
20085         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
20086         "type": "json"
20087       }
20088     ],
20089     "name": "FaxAccounts",
20090     "group": "RPC_Realtime",
20091     "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>",
20092     "version": "0.0.0",
20093     "filename": "server/api/rpc/index.js",
20094     "groupTitle": "RPC_Realtime"
20095   },
20096   {
20097     "type": "put",
20098     "url": "/api/rpc/agents/:id/capacity",
20099     "title": "Sets agent capacity",
20100     "examples": [
20101       {
20102         "title": "Example usage:",
20103         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
20104         "type": "json"
20105       }
20106     ],
20107     "name": "RTAgentCapacity",
20108     "group": "RPC_Realtime",
20109     "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>",
20110     "version": "0.0.0",
20111     "filename": "server/api/rpc/index.js",
20112     "groupTitle": "RPC_Realtime"
20113   },
20114   {
20115     "type": "get",
20116     "url": "/api/rpc/agents",
20117     "title": "Gets a list of RTAgents",
20118     "examples": [
20119       {
20120         "title": "Example usage:",
20121         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
20122         "type": "json"
20123       }
20124     ],
20125     "name": "RTAgents",
20126     "group": "RPC_Realtime",
20127     "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>",
20128     "version": "0.0.0",
20129     "filename": "server/api/rpc/index.js",
20130     "groupTitle": "RPC_Realtime"
20131   },
20132   {
20133     "type": "get",
20134     "url": "/api/rpc/chat/queues",
20135     "title": "Gets a list of RTChatQueues",
20136     "examples": [
20137       {
20138         "title": "Example usage:",
20139         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
20140         "type": "json"
20141       }
20142     ],
20143     "name": "RTChatQueues",
20144     "group": "RPC_Realtime",
20145     "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>",
20146     "version": "0.0.0",
20147     "filename": "server/api/rpc/index.js",
20148     "groupTitle": "RPC_Realtime"
20149   },
20150   {
20151     "type": "get",
20152     "url": "/api/rpc/fax/queues",
20153     "title": "Gets a list of RTFaxQueues",
20154     "examples": [
20155       {
20156         "title": "Example usage:",
20157         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
20158         "type": "json"
20159       }
20160     ],
20161     "name": "RTFaxQueues",
20162     "group": "RPC_Realtime",
20163     "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>",
20164     "version": "0.0.0",
20165     "filename": "server/api/rpc/index.js",
20166     "groupTitle": "RPC_Realtime"
20167   },
20168   {
20169     "type": "get",
20170     "url": "/api/rpc/mail/accounts",
20171     "title": "Gets a list of RTMailAccounts",
20172     "examples": [
20173       {
20174         "title": "Example usage:",
20175         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
20176         "type": "json"
20177       }
20178     ],
20179     "name": "RTMailAccounts",
20180     "group": "RPC_Realtime",
20181     "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>",
20182     "version": "0.0.0",
20183     "filename": "server/api/rpc/index.js",
20184     "groupTitle": "RPC_Realtime"
20185   },
20186   {
20187     "type": "get",
20188     "url": "/api/rpc/mail/queues",
20189     "title": "Gets a list of RTMailQueues",
20190     "examples": [
20191       {
20192         "title": "Example usage:",
20193         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
20194         "type": "json"
20195       }
20196     ],
20197     "name": "RTMailQueues",
20198     "group": "RPC_Realtime",
20199     "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>",
20200     "version": "0.0.0",
20201     "filename": "server/api/rpc/index.js",
20202     "groupTitle": "RPC_Realtime"
20203   },
20204   {
20205     "type": "get",
20206     "url": "/api/rpc/openchannel/queues",
20207     "title": "Gets a list of RTOpenchannelQueues",
20208     "examples": [
20209       {
20210         "title": "Example usage:",
20211         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
20212         "type": "json"
20213       }
20214     ],
20215     "name": "RTOpenchannelQueues",
20216     "group": "RPC_Realtime",
20217     "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>",
20218     "version": "0.0.0",
20219     "filename": "server/api/rpc/index.js",
20220     "groupTitle": "RPC_Realtime"
20221   },
20222   {
20223     "type": "get",
20224     "url": "/api/rpc/outbound/channels",
20225     "title": "Gets a list of RTOutboundChannels",
20226     "examples": [
20227       {
20228         "title": "Example usage:",
20229         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
20230         "type": "json"
20231       }
20232     ],
20233     "name": "RTOutboundChannels",
20234     "group": "RPC_Realtime",
20235     "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>",
20236     "version": "0.0.0",
20237     "filename": "server/api/rpc/index.js",
20238     "groupTitle": "RPC_Realtime"
20239   },
20240   {
20241     "type": "get",
20242     "url": "/api/rpc/sms/queues",
20243     "title": "Gets a list of RTSmsQueues",
20244     "examples": [
20245       {
20246         "title": "Example usage:",
20247         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
20248         "type": "json"
20249       }
20250     ],
20251     "name": "RTSmsQueues",
20252     "group": "RPC_Realtime",
20253     "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>",
20254     "version": "0.0.0",
20255     "filename": "server/api/rpc/index.js",
20256     "groupTitle": "RPC_Realtime"
20257   },
20258   {
20259     "type": "get",
20260     "url": "/api/rpc/telephones",
20261     "title": "Gets a list of RTTelephones",
20262     "examples": [
20263       {
20264         "title": "Example usage:",
20265         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
20266         "type": "json"
20267       }
20268     ],
20269     "name": "RTTelephones",
20270     "group": "RPC_Realtime",
20271     "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>",
20272     "version": "0.0.0",
20273     "filename": "server/api/rpc/index.js",
20274     "groupTitle": "RPC_Realtime"
20275   },
20276   {
20277     "type": "get",
20278     "url": "/api/rpc/trunks",
20279     "title": "Gets a list of RTTrunks",
20280     "examples": [
20281       {
20282         "title": "Example usage:",
20283         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
20284         "type": "json"
20285       }
20286     ],
20287     "name": "RTTrunks",
20288     "group": "RPC_Realtime",
20289     "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>",
20290     "version": "0.0.0",
20291     "filename": "server/api/rpc/index.js",
20292     "groupTitle": "RPC_Realtime"
20293   },
20294   {
20295     "type": "get",
20296     "url": "/api/rpc/voice/channels",
20297     "title": "Gets a list of RTVoiceChannelMixMonitor",
20298     "examples": [
20299       {
20300         "title": "Example usage:",
20301         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
20302         "type": "json"
20303       }
20304     ],
20305     "name": "RTVoiceChannelMixMonitor",
20306     "group": "RPC_Realtime",
20307     "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>",
20308     "version": "0.0.0",
20309     "filename": "server/api/rpc/index.js",
20310     "groupTitle": "RPC_Realtime"
20311   },
20312   {
20313     "type": "get",
20314     "url": "/api/rpc/voice/channels",
20315     "title": "Gets a list of RTVoiceChannelStopMixMonitor",
20316     "examples": [
20317       {
20318         "title": "Example usage:",
20319         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
20320         "type": "json"
20321       }
20322     ],
20323     "name": "RTVoiceChannelStopMixMonitor",
20324     "group": "RPC_Realtime",
20325     "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>",
20326     "version": "0.0.0",
20327     "filename": "server/api/rpc/index.js",
20328     "groupTitle": "RPC_Realtime"
20329   },
20330   {
20331     "type": "get",
20332     "url": "/api/rpc/voice/channels",
20333     "title": "Gets a list of RTVoiceChannels",
20334     "examples": [
20335       {
20336         "title": "Example usage:",
20337         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
20338         "type": "json"
20339       }
20340     ],
20341     "name": "RTVoiceChannels",
20342     "group": "RPC_Realtime",
20343     "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>",
20344     "version": "0.0.0",
20345     "filename": "server/api/rpc/index.js",
20346     "groupTitle": "RPC_Realtime"
20347   },
20348   {
20349     "type": "get",
20350     "url": "/api/rpc/voice/queues/channels/{uniqueid}",
20351     "title": "Gets a single RTVoiceQueueChannel",
20352     "examples": [
20353       {
20354         "title": "Example usage:",
20355         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
20356         "type": "json"
20357       }
20358     ],
20359     "name": "RTVoiceQueueChannel",
20360     "group": "RPC_Realtime",
20361     "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20362     "version": "0.0.0",
20363     "filename": "server/api/rpc/index.js",
20364     "groupTitle": "RPC_Realtime"
20365   },
20366   {
20367     "type": "get",
20368     "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
20369     "title": "Hangup a single RTVoiceQueueChannel",
20370     "examples": [
20371       {
20372         "title": "Example usage:",
20373         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
20374         "type": "json"
20375       }
20376     ],
20377     "name": "RTVoiceQueueChannelHangup",
20378     "group": "RPC_Realtime",
20379     "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20380     "version": "0.0.0",
20381     "filename": "server/api/rpc/index.js",
20382     "groupTitle": "RPC_Realtime"
20383   },
20384   {
20385     "type": "get",
20386     "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
20387     "title": "Hangup a single RTVoiceQueueChannel",
20388     "examples": [
20389       {
20390         "title": "Example usage:",
20391         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
20392         "type": "json"
20393       }
20394     ],
20395     "name": "RTVoiceQueueChannelRedirect",
20396     "group": "RPC_Realtime",
20397     "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>",
20398     "version": "0.0.0",
20399     "filename": "server/api/rpc/index.js",
20400     "groupTitle": "RPC_Realtime"
20401   },
20402   {
20403     "type": "get",
20404     "url": "/api/rpc/voice/queues/preview/{id}",
20405     "title": "Gets a single preview contact",
20406     "examples": [
20407       {
20408         "title": "Example usage:",
20409         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
20410         "type": "json"
20411       }
20412     ],
20413     "name": "RTVoiceQueuePreview",
20414     "group": "RPC_Realtime",
20415     "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20416     "version": "0.0.0",
20417     "filename": "server/api/rpc/index.js",
20418     "groupTitle": "RPC_Realtime"
20419   },
20420   {
20421     "type": "get",
20422     "url": "/api/rpc/voice/queues",
20423     "title": "Gets a list of RTVoiceQueues",
20424     "examples": [
20425       {
20426         "title": "Example usage:",
20427         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
20428         "type": "json"
20429       }
20430     ],
20431     "name": "RTVoiceQueues",
20432     "group": "RPC_Realtime",
20433     "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>",
20434     "version": "0.0.0",
20435     "filename": "server/api/rpc/index.js",
20436     "groupTitle": "RPC_Realtime"
20437   },
20438   {
20439     "type": "get",
20440     "url": "/api/rpc/outbound",
20441     "title": "Gets a list of RTOutbound",
20442     "examples": [
20443       {
20444         "title": "Example usage:",
20445         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
20446         "type": "json"
20447       }
20448     ],
20449     "name": "RTVoiceQueues",
20450     "group": "RPC_Realtime",
20451     "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>",
20452     "version": "0.0.0",
20453     "filename": "server/api/rpc/index.js",
20454     "groupTitle": "RPC_Realtime"
20455   },
20456   {
20457     "type": "get",
20458     "url": "/api/rpc/voice/queues/channels",
20459     "title": "Gets a list of RTVoiceQueuesChannels",
20460     "examples": [
20461       {
20462         "title": "Example usage:",
20463         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
20464         "type": "json"
20465       }
20466     ],
20467     "name": "RTVoiceQueuesChannels",
20468     "group": "RPC_Realtime",
20469     "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>",
20470     "version": "0.0.0",
20471     "filename": "server/api/rpc/index.js",
20472     "groupTitle": "RPC_Realtime"
20473   },
20474   {
20475     "type": "get",
20476     "url": "/api/rpc/chat/queues/{id}",
20477     "title": "Gets a single RTChatQueue",
20478     "examples": [
20479       {
20480         "title": "Example usage:",
20481         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
20482         "type": "json"
20483       }
20484     ],
20485     "name": "ShowRTChatQueues",
20486     "group": "RPC_Realtime",
20487     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20488     "version": "0.0.0",
20489     "filename": "server/api/rpc/index.js",
20490     "groupTitle": "RPC_Realtime"
20491   },
20492   {
20493     "type": "get",
20494     "url": "/api/rpc/fax/queues/{id}",
20495     "title": "Gets a single RTFaxQueue",
20496     "examples": [
20497       {
20498         "title": "Example usage:",
20499         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
20500         "type": "json"
20501       }
20502     ],
20503     "name": "ShowRTFaxQueues",
20504     "group": "RPC_Realtime",
20505     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20506     "version": "0.0.0",
20507     "filename": "server/api/rpc/index.js",
20508     "groupTitle": "RPC_Realtime"
20509   },
20510   {
20511     "type": "get",
20512     "url": "/api/rpc/mail/queues/{id}",
20513     "title": "Gets a single RTMailQueue",
20514     "examples": [
20515       {
20516         "title": "Example usage:",
20517         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
20518         "type": "json"
20519       }
20520     ],
20521     "name": "ShowRTMailQueues",
20522     "group": "RPC_Realtime",
20523     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20524     "version": "0.0.0",
20525     "filename": "server/api/rpc/index.js",
20526     "groupTitle": "RPC_Realtime"
20527   },
20528   {
20529     "type": "get",
20530     "url": "/api/rpc/openchannel/queues/{id}",
20531     "title": "Gets a single RTOpenchannelQueue",
20532     "examples": [
20533       {
20534         "title": "Example usage:",
20535         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
20536         "type": "json"
20537       }
20538     ],
20539     "name": "ShowRTOpenchannelQueues",
20540     "group": "RPC_Realtime",
20541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20542     "version": "0.0.0",
20543     "filename": "server/api/rpc/index.js",
20544     "groupTitle": "RPC_Realtime"
20545   },
20546   {
20547     "type": "get",
20548     "url": "/api/rpc/sms/queues/{id}",
20549     "title": "Gets a single RTSmsQueue",
20550     "examples": [
20551       {
20552         "title": "Example usage:",
20553         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
20554         "type": "json"
20555       }
20556     ],
20557     "name": "ShowRTSmsQueues",
20558     "group": "RPC_Realtime",
20559     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20560     "version": "0.0.0",
20561     "filename": "server/api/rpc/index.js",
20562     "groupTitle": "RPC_Realtime"
20563   },
20564   {
20565     "type": "get",
20566     "url": "/api/rpc/voice/queues/{id}",
20567     "title": "Gets a single RTVoiceQueue",
20568     "examples": [
20569       {
20570         "title": "Example usage:",
20571         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20572         "type": "json"
20573       }
20574     ],
20575     "name": "ShowRTVoiceQueues",
20576     "group": "RPC_Realtime",
20577     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20578     "version": "0.0.0",
20579     "filename": "server/api/rpc/index.js",
20580     "groupTitle": "RPC_Realtime"
20581   },
20582   {
20583     "type": "put",
20584     "url": "/api/rpc/voice/{id}/queues",
20585     "title": "Updates a single VoiceQueue",
20586     "examples": [
20587       {
20588         "title": "Example usage:",
20589         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
20590         "type": "json"
20591       }
20592     ],
20593     "name": "UpdateVoiceQueues",
20594     "group": "RPC_Realtime",
20595     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20596     "version": "0.0.0",
20597     "filename": "server/api/rpc/index.js",
20598     "groupTitle": "RPC_Realtime"
20599   },
20600   {
20601     "type": "post",
20602     "url": "/api/rpc/agents/:id/notify",
20603     "title": "Notify message to a specific agent",
20604     "examples": [
20605       {
20606         "title": "Example usage:",
20607         "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",
20608         "type": "json"
20609       }
20610     ],
20611     "name": "agentNotify",
20612     "group": "RPC_Realtime",
20613     "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>",
20614     "version": "0.0.0",
20615     "filename": "server/api/rpc/index.js",
20616     "groupTitle": "RPC_Realtime"
20617   },
20618   {
20619     "type": "post",
20620     "url": "/api/rpc/chat/queues/:id/notify",
20621     "title": "Notify message to a specific queue",
20622     "examples": [
20623       {
20624         "title": "Example usage:",
20625         "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",
20626         "type": "json"
20627       }
20628     ],
20629     "name": "chatQueueNotify",
20630     "group": "RPC_Realtime",
20631     "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>",
20632     "version": "0.0.0",
20633     "filename": "server/api/rpc/index.js",
20634     "groupTitle": "RPC_Realtime"
20635   },
20636   {
20637     "type": "get",
20638     "url": "/api/rpc/chat/queues/waitinginteractions",
20639     "title": "Gets a list of chatQueuesWaitingInteractions",
20640     "examples": [
20641       {
20642         "title": "Example usage:",
20643         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20644         "type": "json"
20645       }
20646     ],
20647     "name": "chatQueuesWaitingInteractions",
20648     "group": "RPC_Realtime",
20649     "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>",
20650     "version": "0.0.0",
20651     "filename": "server/api/rpc/index.js",
20652     "groupTitle": "RPC_Realtime"
20653   },
20654   {
20655     "type": "post",
20656     "url": "/api/rpc/fax/queues/:id/notify",
20657     "title": "Notify message to a specific queue",
20658     "examples": [
20659       {
20660         "title": "Example usage:",
20661         "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",
20662         "type": "json"
20663       }
20664     ],
20665     "name": "faxQueueNotify",
20666     "group": "RPC_Realtime",
20667     "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>",
20668     "version": "0.0.0",
20669     "filename": "server/api/rpc/index.js",
20670     "groupTitle": "RPC_Realtime"
20671   },
20672   {
20673     "type": "get",
20674     "url": "/api/rpc/fax/queues/waitinginteractions",
20675     "title": "Gets a list of faxQueuesWaitingInteractions",
20676     "examples": [
20677       {
20678         "title": "Example usage:",
20679         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20680         "type": "json"
20681       }
20682     ],
20683     "name": "faxQueuesWaitingInteractions",
20684     "group": "RPC_Realtime",
20685     "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>",
20686     "version": "0.0.0",
20687     "filename": "server/api/rpc/index.js",
20688     "groupTitle": "RPC_Realtime"
20689   },
20690   {
20691     "type": "post",
20692     "url": "/api/rpc/mail/queues/:id/notify",
20693     "title": "Notify message to a specific queue",
20694     "examples": [
20695       {
20696         "title": "Example usage:",
20697         "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",
20698         "type": "json"
20699       }
20700     ],
20701     "name": "mailQueueNotify",
20702     "group": "RPC_Realtime",
20703     "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>",
20704     "version": "0.0.0",
20705     "filename": "server/api/rpc/index.js",
20706     "groupTitle": "RPC_Realtime"
20707   },
20708   {
20709     "type": "get",
20710     "url": "/api/rpc/mail/queues/waitinginteractions",
20711     "title": "Gets a list of mailQueuesWaitingInteractions",
20712     "examples": [
20713       {
20714         "title": "Example usage:",
20715         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20716         "type": "json"
20717       }
20718     ],
20719     "name": "mailQueuesWaitingInteractions",
20720     "group": "RPC_Realtime",
20721     "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>",
20722     "version": "0.0.0",
20723     "filename": "server/api/rpc/index.js",
20724     "groupTitle": "RPC_Realtime"
20725   },
20726   {
20727     "type": "post",
20728     "url": "/api/rpc/openchannel/queues/:id/notify",
20729     "title": "Notify message to a specific queue",
20730     "examples": [
20731       {
20732         "title": "Example usage:",
20733         "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",
20734         "type": "json"
20735       }
20736     ],
20737     "name": "openchannelQueueNotify",
20738     "group": "RPC_Realtime",
20739     "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>",
20740     "version": "0.0.0",
20741     "filename": "server/api/rpc/index.js",
20742     "groupTitle": "RPC_Realtime"
20743   },
20744   {
20745     "type": "get",
20746     "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20747     "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20748     "examples": [
20749       {
20750         "title": "Example usage:",
20751         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20752         "type": "json"
20753       }
20754     ],
20755     "name": "openchannelQueuesIdWaitingInteractions",
20756     "group": "RPC_Realtime",
20757     "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>",
20758     "version": "0.0.0",
20759     "filename": "server/api/rpc/index.js",
20760     "groupTitle": "RPC_Realtime"
20761   },
20762   {
20763     "type": "get",
20764     "url": "/api/rpc/openchannel/queues/waitinginteractions",
20765     "title": "Gets a list of openchannelQueuesWaitingInteractions",
20766     "examples": [
20767       {
20768         "title": "Example usage:",
20769         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20770         "type": "json"
20771       }
20772     ],
20773     "name": "openchannelQueuesWaitingInteractions",
20774     "group": "RPC_Realtime",
20775     "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>",
20776     "version": "0.0.0",
20777     "filename": "server/api/rpc/index.js",
20778     "groupTitle": "RPC_Realtime"
20779   },
20780   {
20781     "type": "post",
20782     "url": "/api/rpc/sms/queues/:id/notify",
20783     "title": "Notify message to a specific queue",
20784     "examples": [
20785       {
20786         "title": "Example usage:",
20787         "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",
20788         "type": "json"
20789       }
20790     ],
20791     "name": "smsQueueNotify",
20792     "group": "RPC_Realtime",
20793     "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>",
20794     "version": "0.0.0",
20795     "filename": "server/api/rpc/index.js",
20796     "groupTitle": "RPC_Realtime"
20797   },
20798   {
20799     "type": "get",
20800     "url": "/api/rpc/sms/queues/waitinginteractions",
20801     "title": "Gets a list of smsQueuesWaitingInteractions",
20802     "examples": [
20803       {
20804         "title": "Example usage:",
20805         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20806         "type": "json"
20807       }
20808     ],
20809     "name": "smsQueuesWaitingInteractions",
20810     "group": "RPC_Realtime",
20811     "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>",
20812     "version": "0.0.0",
20813     "filename": "server/api/rpc/index.js",
20814     "groupTitle": "RPC_Realtime"
20815   },
20816   {
20817     "type": "post",
20818     "url": "/api/integrations/salesforce/accounts",
20819     "title": "Creates a new Salesforce Account",
20820     "examples": [
20821       {
20822         "title": "Example usage:",
20823         "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",
20824         "type": "json"
20825       }
20826     ],
20827     "name": "CreateSalesforce_Accounts",
20828     "group": "Salesforce_Accounts",
20829     "parameter": {
20830       "fields": {
20831         "Body": [
20832           {
20833             "group": "Body",
20834             "type": "String",
20835             "optional": true,
20836             "field": "name",
20837             "description": ""
20838           },
20839           {
20840             "group": "Body",
20841             "type": "String",
20842             "optional": true,
20843             "field": "description",
20844             "description": ""
20845           },
20846           {
20847             "group": "Body",
20848             "type": "String",
20849             "optional": true,
20850             "field": "username",
20851             "description": ""
20852           },
20853           {
20854             "group": "Body",
20855             "type": "String",
20856             "optional": true,
20857             "field": "remoteUri",
20858             "description": ""
20859           },
20860           {
20861             "group": "Body",
20862             "type": "String",
20863             "optional": true,
20864             "field": "password",
20865             "description": ""
20866           },
20867           {
20868             "group": "Body",
20869             "type": "String",
20870             "optional": true,
20871             "field": "clientId",
20872             "description": ""
20873           },
20874           {
20875             "group": "Body",
20876             "type": "String",
20877             "optional": true,
20878             "field": "clientSecret",
20879             "description": ""
20880           },
20881           {
20882             "group": "Body",
20883             "type": "String",
20884             "optional": true,
20885             "field": "securityToken",
20886             "description": ""
20887           },
20888           {
20889             "group": "Body",
20890             "type": "String",
20891             "optional": false,
20892             "field": "serverUrl",
20893             "description": ""
20894           },
20895           {
20896             "group": "Body",
20897             "type": "String",
20898             "allowedValues": [
20899               "\"integrationTab\"",
20900               "\"newTab\""
20901             ],
20902             "optional": true,
20903             "field": "type",
20904             "description": ""
20905           }
20906         ]
20907       }
20908     },
20909     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20910     "version": "0.0.0",
20911     "filename": "server/api/intSalesforceAccount/index.js",
20912     "groupTitle": "Salesforce_Accounts"
20913   },
20914   {
20915     "type": "delete",
20916     "url": "/api/integrations/salesforce/accounts/{id}",
20917     "title": "Deletes a Salesforce Account",
20918     "examples": [
20919       {
20920         "title": "Example usage:",
20921         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20922         "type": "json"
20923       }
20924     ],
20925     "name": "DeleteSalesforce_Accounts",
20926     "group": "Salesforce_Accounts",
20927     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20928     "version": "0.0.0",
20929     "filename": "server/api/intSalesforceAccount/index.js",
20930     "groupTitle": "Salesforce_Accounts"
20931   },
20932   {
20933     "type": "get",
20934     "url": "/api/integrations/salesforce/accounts",
20935     "title": "Gets a list of Salesforce Accounts",
20936     "examples": [
20937       {
20938         "title": "Example usage:",
20939         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20940         "type": "json"
20941       }
20942     ],
20943     "name": "GetSalesforce_Accounts",
20944     "group": "Salesforce_Accounts",
20945     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20946     "version": "0.0.0",
20947     "filename": "server/api/intSalesforceAccount/index.js",
20948     "groupTitle": "Salesforce_Accounts"
20949   },
20950   {
20951     "type": "get",
20952     "url": "/api/integrations/salesforce/accounts/{id}",
20953     "title": "Gets a single Salesforce Account",
20954     "examples": [
20955       {
20956         "title": "Example usage:",
20957         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20958         "type": "json"
20959       }
20960     ],
20961     "name": "ShowSalesforce_Accounts",
20962     "group": "Salesforce_Accounts",
20963     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20964     "version": "0.0.0",
20965     "filename": "server/api/intSalesforceAccount/index.js",
20966     "groupTitle": "Salesforce_Accounts"
20967   },
20968   {
20969     "type": "post",
20970     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20971     "title": "Creates new configuration",
20972     "examples": [
20973       {
20974         "title": "Example usage:",
20975         "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",
20976         "type": "json"
20977       }
20978     ],
20979     "name": "addConfiguration",
20980     "group": "Salesforce_Accounts",
20981     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20982     "version": "0.0.0",
20983     "filename": "server/api/intSalesforceAccount/index.js",
20984     "groupTitle": "Salesforce_Accounts"
20985   },
20986   {
20987     "type": "get",
20988     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20989     "title": "Gets account configurations",
20990     "examples": [
20991       {
20992         "title": "Example usage:",
20993         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20994         "type": "json"
20995       }
20996     ],
20997     "name": "getConfigurations",
20998     "group": "Salesforce_Accounts",
20999     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21000     "version": "0.0.0",
21001     "filename": "server/api/intSalesforceAccount/index.js",
21002     "groupTitle": "Salesforce_Accounts"
21003   },
21004   {
21005     "type": "get",
21006     "url": "/api/integrations/salesforce/accounts/{id}/fields",
21007     "title": "Gets account fields",
21008     "examples": [
21009       {
21010         "title": "Example usage:",
21011         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
21012         "type": "json"
21013       }
21014     ],
21015     "name": "getFields",
21016     "group": "Salesforce_Accounts",
21017     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21018     "version": "0.0.0",
21019     "filename": "server/api/intSalesforceAccount/index.js",
21020     "groupTitle": "Salesforce_Accounts"
21021   },
21022   {
21023     "type": "put",
21024     "url": "/api/integrations/salesforce/accounts/{id}",
21025     "title": "Update an existing Salesforce Account",
21026     "examples": [
21027       {
21028         "title": "Example usage:",
21029         "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",
21030         "type": "json"
21031       }
21032     ],
21033     "name": "updateSalesforce_Accounts",
21034     "group": "Salesforce_Accounts",
21035     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21036     "version": "0.0.0",
21037     "filename": "server/api/intSalesforceAccount/index.js",
21038     "groupTitle": "Salesforce_Accounts"
21039   },
21040   {
21041     "type": "post",
21042     "url": "/api/integrations/salesforce/configurations",
21043     "title": "Creates a new Salesforce Configuration",
21044     "examples": [
21045       {
21046         "title": "Example usage:",
21047         "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",
21048         "type": "json"
21049       }
21050     ],
21051     "name": "CreateSalesforce_Configurations",
21052     "group": "Salesforce_Configurations",
21053     "parameter": {
21054       "fields": {
21055         "Body": [
21056           {
21057             "group": "Body",
21058             "type": "String",
21059             "optional": true,
21060             "field": "name",
21061             "description": ""
21062           },
21063           {
21064             "group": "Body",
21065             "type": "String",
21066             "optional": true,
21067             "field": "description",
21068             "description": ""
21069           },
21070           {
21071             "group": "Body",
21072             "type": "String",
21073             "allowedValues": [
21074               "\"Task\"",
21075               "\"Case\""
21076             ],
21077             "optional": true,
21078             "field": "ticketType",
21079             "description": ""
21080           },
21081           {
21082             "group": "Body",
21083             "type": "String",
21084             "allowedValues": [
21085               "\"contact_lead\"",
21086               "\"contact\"",
21087               "\"lead\"",
21088               "\"account_contact_lead\"",
21089               "\"account\""
21090             ],
21091             "optional": true,
21092             "field": "moduleSearch",
21093             "description": ""
21094           },
21095           {
21096             "group": "Body",
21097             "type": "String",
21098             "allowedValues": [
21099               "\"nothing\"",
21100               "\"contact\"",
21101               "\"lead\"",
21102               "\"account\""
21103             ],
21104             "optional": true,
21105             "field": "moduleCreate",
21106             "description": ""
21107           },
21108           {
21109             "group": "Body",
21110             "type": "String",
21111             "optional": true,
21112             "field": "leadId",
21113             "description": ""
21114           },
21115           {
21116             "group": "Body",
21117             "type": "String",
21118             "optional": true,
21119             "field": "additionalSearchAccount",
21120             "description": ""
21121           },
21122           {
21123             "group": "Body",
21124             "type": "String",
21125             "optional": true,
21126             "field": "additionalSearchContact",
21127             "description": ""
21128           },
21129           {
21130             "group": "Body",
21131             "type": "String",
21132             "optional": true,
21133             "field": "additionalSearchLead",
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/intSalesforceConfiguration/index.js",
21142     "groupTitle": "Salesforce_Configurations"
21143   },
21144   {
21145     "type": "delete",
21146     "url": "/api/integrations/salesforce/configurations/{id}",
21147     "title": "Deletes a Salesforce Configuration",
21148     "examples": [
21149       {
21150         "title": "Example usage:",
21151         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
21152         "type": "json"
21153       }
21154     ],
21155     "name": "DeleteSalesforce_Configurations",
21156     "group": "Salesforce_Configurations",
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/intSalesforceConfiguration/index.js",
21160     "groupTitle": "Salesforce_Configurations"
21161   },
21162   {
21163     "type": "get",
21164     "url": "/api/integrations/salesforce/configurations",
21165     "title": "Gets a list of Salesforce Configurations",
21166     "examples": [
21167       {
21168         "title": "Example usage:",
21169         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
21170         "type": "json"
21171       }
21172     ],
21173     "name": "GetSalesforce_Configurations",
21174     "group": "Salesforce_Configurations",
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/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>",
21176     "version": "0.0.0",
21177     "filename": "server/api/intSalesforceConfiguration/index.js",
21178     "groupTitle": "Salesforce_Configurations"
21179   },
21180   {
21181     "type": "get",
21182     "url": "/api/integrations/salesforce/configurations/{id}",
21183     "title": "Gets a single Salesforce Configuration",
21184     "examples": [
21185       {
21186         "title": "Example usage:",
21187         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
21188         "type": "json"
21189       }
21190     ],
21191     "name": "ShowSalesforce_Configurations",
21192     "group": "Salesforce_Configurations",
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/intSalesforceConfiguration/index.js",
21196     "groupTitle": "Salesforce_Configurations"
21197   },
21198   {
21199     "type": "get",
21200     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
21201     "title": "Gets configurations descriptions",
21202     "examples": [
21203       {
21204         "title": "Example usage:",
21205         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21206         "type": "json"
21207       }
21208     ],
21209     "name": "getDescriptions",
21210     "group": "Salesforce_Configurations",
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/intSalesforceConfiguration/index.js",
21214     "groupTitle": "Salesforce_Configurations"
21215   },
21216   {
21217     "type": "get",
21218     "url": "/api/integrations/salesforce/configurations/{id}/fields",
21219     "title": "Gets configurations fields",
21220     "examples": [
21221       {
21222         "title": "Example usage:",
21223         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
21224         "type": "json"
21225       }
21226     ],
21227     "name": "getFields",
21228     "group": "Salesforce_Configurations",
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/intSalesforceConfiguration/index.js",
21232     "groupTitle": "Salesforce_Configurations"
21233   },
21234   {
21235     "type": "get",
21236     "url": "/api/integrations/salesforce/configurations/{id}/subjects",
21237     "title": "Gets configurations subjects",
21238     "examples": [
21239       {
21240         "title": "Example usage:",
21241         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21242         "type": "json"
21243       }
21244     ],
21245     "name": "getSubjects",
21246     "group": "Salesforce_Configurations",
21247     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21248     "version": "0.0.0",
21249     "filename": "server/api/intSalesforceConfiguration/index.js",
21250     "groupTitle": "Salesforce_Configurations"
21251   },
21252   {
21253     "type": "put",
21254     "url": "/api/integrations/salesforce/configurations/{id}",
21255     "title": "Update an existing Salesforce Configuration",
21256     "examples": [
21257       {
21258         "title": "Example usage:",
21259         "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",
21260         "type": "json"
21261       }
21262     ],
21263     "name": "updateSalesforce_Configurations",
21264     "group": "Salesforce_Configurations",
21265     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21266     "version": "0.0.0",
21267     "filename": "server/api/intSalesforceConfiguration/index.js",
21268     "groupTitle": "Salesforce_Configurations"
21269   },
21270   {
21271     "type": "post",
21272     "url": "/api/integrations/salesforce/fields",
21273     "title": "Creates a new Salesforce Field",
21274     "examples": [
21275       {
21276         "title": "Example usage:",
21277         "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",
21278         "type": "json"
21279       }
21280     ],
21281     "name": "CreateSalesforce_Fields",
21282     "group": "Salesforce_Fields",
21283     "parameter": {
21284       "fields": {
21285         "Body": [
21286           {
21287             "group": "Body",
21288             "type": "String",
21289             "allowedValues": [
21290               "\"string\"",
21291               "\"variable\"",
21292               "\"customVariable\"",
21293               "\"keyValue\"",
21294               "\"picklist\""
21295             ],
21296             "optional": true,
21297             "field": "type",
21298             "description": ""
21299           },
21300           {
21301             "group": "Body",
21302             "type": "String",
21303             "optional": true,
21304             "field": "content",
21305             "description": ""
21306           },
21307           {
21308             "group": "Body",
21309             "type": "String",
21310             "optional": true,
21311             "field": "key",
21312             "description": ""
21313           },
21314           {
21315             "group": "Body",
21316             "type": "String",
21317             "allowedValues": [
21318               "\"string\"",
21319               "\"variable\"",
21320               "\"customVariable\""
21321             ],
21322             "optional": true,
21323             "field": "keyType",
21324             "description": ""
21325           },
21326           {
21327             "group": "Body",
21328             "type": "String",
21329             "optional": true,
21330             "field": "keyContent",
21331             "description": ""
21332           },
21333           {
21334             "group": "Body",
21335             "type": "String",
21336             "optional": true,
21337             "field": "idField",
21338             "description": ""
21339           },
21340           {
21341             "group": "Body",
21342             "type": "String",
21343             "optional": true,
21344             "field": "variableName",
21345             "description": ""
21346           }
21347         ]
21348       }
21349     },
21350     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21351     "version": "0.0.0",
21352     "filename": "server/api/intSalesforceField/index.js",
21353     "groupTitle": "Salesforce_Fields"
21354   },
21355   {
21356     "type": "delete",
21357     "url": "/api/integrations/salesforce/fields/{id}",
21358     "title": "Deletes a Salesforce Field",
21359     "examples": [
21360       {
21361         "title": "Example usage:",
21362         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
21363         "type": "json"
21364       }
21365     ],
21366     "name": "DeleteSalesforce_Fields",
21367     "group": "Salesforce_Fields",
21368     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21369     "version": "0.0.0",
21370     "filename": "server/api/intSalesforceField/index.js",
21371     "groupTitle": "Salesforce_Fields"
21372   },
21373   {
21374     "type": "get",
21375     "url": "/api/integrations/salesforce/fields",
21376     "title": "Gets a list of Salesforce Fields",
21377     "examples": [
21378       {
21379         "title": "Example usage:",
21380         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
21381         "type": "json"
21382       }
21383     ],
21384     "name": "GetSalesforce_Fields",
21385     "group": "Salesforce_Fields",
21386     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21387     "version": "0.0.0",
21388     "filename": "server/api/intSalesforceField/index.js",
21389     "groupTitle": "Salesforce_Fields"
21390   },
21391   {
21392     "type": "get",
21393     "url": "/api/integrations/salesforce/fields/{id}",
21394     "title": "Gets a single Salesforce Field",
21395     "examples": [
21396       {
21397         "title": "Example usage:",
21398         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
21399         "type": "json"
21400       }
21401     ],
21402     "name": "ShowSalesforce_Fields",
21403     "group": "Salesforce_Fields",
21404     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21405     "version": "0.0.0",
21406     "filename": "server/api/intSalesforceField/index.js",
21407     "groupTitle": "Salesforce_Fields"
21408   },
21409   {
21410     "type": "put",
21411     "url": "/api/integrations/salesforce/fields/{id}",
21412     "title": "Update an existing Salesforce Field",
21413     "examples": [
21414       {
21415         "title": "Example usage:",
21416         "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",
21417         "type": "json"
21418       }
21419     ],
21420     "name": "updateSalesforce_Fields",
21421     "group": "Salesforce_Fields",
21422     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21423     "version": "0.0.0",
21424     "filename": "server/api/intSalesforceField/index.js",
21425     "groupTitle": "Salesforce_Fields"
21426   },
21427   {
21428     "type": "post",
21429     "url": "/api/schedules",
21430     "title": "Creates a new Schedule",
21431     "examples": [
21432       {
21433         "title": "Example usage:",
21434         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21435         "type": "json"
21436       }
21437     ],
21438     "name": "CreateSchedules",
21439     "group": "Schedules",
21440     "parameter": {
21441       "fields": {
21442         "Body": [
21443           {
21444             "group": "Body",
21445             "type": "String",
21446             "optional": false,
21447             "field": "name",
21448             "description": ""
21449           },
21450           {
21451             "group": "Body",
21452             "type": "String",
21453             "optional": true,
21454             "field": "description",
21455             "description": ""
21456           },
21457           {
21458             "group": "Body",
21459             "type": "Boolean",
21460             "optional": false,
21461             "field": "active",
21462             "description": ""
21463           },
21464           {
21465             "group": "Body",
21466             "type": "String",
21467             "optional": false,
21468             "field": "cron",
21469             "description": ""
21470           },
21471           {
21472             "group": "Body",
21473             "type": "String",
21474             "optional": false,
21475             "field": "startAt",
21476             "description": ""
21477           },
21478           {
21479             "group": "Body",
21480             "type": "String",
21481             "optional": false,
21482             "field": "endAt",
21483             "description": ""
21484           },
21485           {
21486             "group": "Body",
21487             "type": "Integer",
21488             "optional": false,
21489             "field": "subtractNumber",
21490             "description": ""
21491           },
21492           {
21493             "group": "Body",
21494             "type": "String",
21495             "allowedValues": [
21496               "\"years\"",
21497               "\"quarters\"",
21498               "\"months\"",
21499               "\"weeks\"",
21500               "\"days\"",
21501               "\"hours\"",
21502               "\"minutes\""
21503             ],
21504             "optional": false,
21505             "field": "subtractUnit",
21506             "description": ""
21507           },
21508           {
21509             "group": "Body",
21510             "type": "String",
21511             "allowedValues": [
21512               "\"csv\"",
21513               "\"pdf\"",
21514               "\"xlsx\""
21515             ],
21516             "optional": false,
21517             "field": "output",
21518             "description": ""
21519           },
21520           {
21521             "group": "Body",
21522             "type": "String",
21523             "allowedValues": [
21524               "\"custom\"",
21525               "\"default\""
21526             ],
21527             "optional": false,
21528             "field": "type",
21529             "description": ""
21530           },
21531           {
21532             "group": "Body",
21533             "type": "Boolean",
21534             "optional": true,
21535             "field": "sendMail",
21536             "description": ""
21537           },
21538           {
21539             "group": "Body",
21540             "type": "String",
21541             "optional": true,
21542             "field": "email",
21543             "description": ""
21544           },
21545           {
21546             "group": "Body",
21547             "type": "Text",
21548             "optional": true,
21549             "field": "cc",
21550             "description": ""
21551           },
21552           {
21553             "group": "Body",
21554             "type": "Text",
21555             "optional": true,
21556             "field": "bcc",
21557             "description": ""
21558           },
21559           {
21560             "group": "Body",
21561             "type": "Boolean",
21562             "optional": true,
21563             "field": "sendIfEmpty",
21564             "description": ""
21565           }
21566         ]
21567       }
21568     },
21569     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21570     "version": "0.0.0",
21571     "filename": "server/api/schedule/index.js",
21572     "groupTitle": "Schedules"
21573   },
21574   {
21575     "type": "delete",
21576     "url": "/api/schedules/{id}",
21577     "title": "Deletes a Schedule",
21578     "examples": [
21579       {
21580         "title": "Example usage:",
21581         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
21582         "type": "json"
21583       }
21584     ],
21585     "name": "DeleteSchedules",
21586     "group": "Schedules",
21587     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21588     "version": "0.0.0",
21589     "filename": "server/api/schedule/index.js",
21590     "groupTitle": "Schedules"
21591   },
21592   {
21593     "type": "get",
21594     "url": "/api/schedules",
21595     "title": "Gets a list of Schedules",
21596     "examples": [
21597       {
21598         "title": "Example usage:",
21599         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
21600         "type": "json"
21601       }
21602     ],
21603     "name": "GetSchedules",
21604     "group": "Schedules",
21605     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21606     "version": "0.0.0",
21607     "filename": "server/api/schedule/index.js",
21608     "groupTitle": "Schedules"
21609   },
21610   {
21611     "type": "get",
21612     "url": "/api/schedules/{id}",
21613     "title": "Gets a single Schedule",
21614     "examples": [
21615       {
21616         "title": "Example usage:",
21617         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
21618         "type": "json"
21619       }
21620     ],
21621     "name": "ShowSchedules",
21622     "group": "Schedules",
21623     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21624     "version": "0.0.0",
21625     "filename": "server/api/schedule/index.js",
21626     "groupTitle": "Schedules"
21627   },
21628   {
21629     "type": "get",
21630     "url": "/api/schedules/{id}/run",
21631     "title": "Run Scheduler",
21632     "examples": [
21633       {
21634         "title": "Example usage:",
21635         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
21636         "type": "json"
21637       }
21638     ],
21639     "name": "run",
21640     "group": "Schedules",
21641     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21642     "version": "0.0.0",
21643     "filename": "server/api/schedule/index.js",
21644     "groupTitle": "Schedules"
21645   },
21646   {
21647     "type": "put",
21648     "url": "/api/schedules/{id}",
21649     "title": "Update an existing Schedule",
21650     "examples": [
21651       {
21652         "title": "Example usage:",
21653         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21654         "type": "json"
21655       }
21656     ],
21657     "name": "updateSchedules",
21658     "group": "Schedules",
21659     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21660     "version": "0.0.0",
21661     "filename": "server/api/schedule/index.js",
21662     "groupTitle": "Schedules"
21663   },
21664   {
21665     "type": "post",
21666     "url": "/api/screen/recordings",
21667     "title": "Creates a new Recording",
21668     "examples": [
21669       {
21670         "title": "Example usage:",
21671         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21672         "type": "json"
21673       }
21674     ],
21675     "name": "CreateRecordings",
21676     "group": "Screen_Recordings",
21677     "parameter": {
21678       "fields": {
21679         "Body": [
21680           {
21681             "group": "Body",
21682             "type": "Virtual",
21683             "optional": true,
21684             "field": "format",
21685             "description": ""
21686           },
21687           {
21688             "group": "Body",
21689             "type": "String",
21690             "optional": true,
21691             "field": "interactionid",
21692             "description": ""
21693           },
21694           {
21695             "group": "Body",
21696             "type": "String",
21697             "optional": true,
21698             "field": "channel",
21699             "description": ""
21700           },
21701           {
21702             "group": "Body",
21703             "type": "String",
21704             "optional": true,
21705             "field": "value",
21706             "description": ""
21707           },
21708           {
21709             "group": "Body",
21710             "type": "Integer",
21711             "optional": true,
21712             "field": "rating",
21713             "description": ""
21714           },
21715           {
21716             "group": "Body",
21717             "type": "Integer",
21718             "optional": true,
21719             "field": "duration",
21720             "description": ""
21721           },
21722           {
21723             "group": "Body",
21724             "type": "String",
21725             "optional": true,
21726             "field": "startedAt",
21727             "description": ""
21728           },
21729           {
21730             "group": "Body",
21731             "type": "String",
21732             "optional": true,
21733             "field": "closedAt",
21734             "description": ""
21735           },
21736           {
21737             "group": "Body",
21738             "type": "String",
21739             "optional": true,
21740             "field": "createdAt",
21741             "description": ""
21742           },
21743           {
21744             "group": "Body",
21745             "type": "String",
21746             "optional": true,
21747             "field": "updatedAt",
21748             "description": ""
21749           }
21750         ]
21751       }
21752     },
21753     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21754     "version": "0.0.0",
21755     "filename": "server/api/screenRecording/index.js",
21756     "groupTitle": "Screen_Recordings"
21757   },
21758   {
21759     "type": "get",
21760     "url": "/api/screen/recordings/describe",
21761     "title": "Gets table info about Recordings",
21762     "examples": [
21763       {
21764         "title": "Example usage:",
21765         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21766         "type": "json"
21767       }
21768     ],
21769     "name": "DescribeRecordings",
21770     "group": "Screen_Recordings",
21771     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21772     "version": "0.0.0",
21773     "filename": "server/api/screenRecording/index.js",
21774     "groupTitle": "Screen_Recordings"
21775   },
21776   {
21777     "type": "get",
21778     "url": "/api/screen/recordings",
21779     "title": "Gets a list of Recordings",
21780     "examples": [
21781       {
21782         "title": "Example usage:",
21783         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21784         "type": "json"
21785       }
21786     ],
21787     "name": "GetRecordings",
21788     "group": "Screen_Recordings",
21789     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21790     "version": "0.0.0",
21791     "filename": "server/api/screenRecording/index.js",
21792     "groupTitle": "Screen_Recordings"
21793   },
21794   {
21795     "type": "get",
21796     "url": "/api/screen/recordings/{id}",
21797     "title": "Gets a single Recording",
21798     "examples": [
21799       {
21800         "title": "Example usage:",
21801         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21802         "type": "json"
21803       }
21804     ],
21805     "name": "ShowRecordings",
21806     "group": "Screen_Recordings",
21807     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21808     "version": "0.0.0",
21809     "filename": "server/api/screenRecording/index.js",
21810     "groupTitle": "Screen_Recordings"
21811   },
21812   {
21813     "type": "delete",
21814     "url": "/api/screen/recordings/{id}",
21815     "title": "Delete screen recording",
21816     "examples": [
21817       {
21818         "title": "Example usage:",
21819         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21820         "type": "json"
21821       }
21822     ],
21823     "name": "destroy",
21824     "group": "Screen_Recordings",
21825     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21826     "version": "0.0.0",
21827     "filename": "server/api/screenRecording/index.js",
21828     "groupTitle": "Screen_Recordings"
21829   },
21830   {
21831     "type": "get",
21832     "url": "/api/screen/recordings/{id}/download",
21833     "title": "Download Recording",
21834     "examples": [
21835       {
21836         "title": "Example usage:",
21837         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21838         "type": "json"
21839       }
21840     ],
21841     "name": "download",
21842     "group": "Screen_Recordings",
21843     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21844     "version": "0.0.0",
21845     "filename": "server/api/screenRecording/index.js",
21846     "groupTitle": "Screen_Recordings"
21847   },
21848   {
21849     "type": "put",
21850     "url": "/api/screen/recordings/{id}",
21851     "title": "Update an existing Recording",
21852     "examples": [
21853       {
21854         "title": "Example usage:",
21855         "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",
21856         "type": "json"
21857       }
21858     ],
21859     "name": "updateRecordings",
21860     "group": "Screen_Recordings",
21861     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21862     "version": "0.0.0",
21863     "filename": "server/api/screenRecording/index.js",
21864     "groupTitle": "Screen_Recordings"
21865   },
21866   {
21867     "type": "post",
21868     "url": "/api/integrations/servicenow/accounts",
21869     "title": "Creates a new Servicenow Account",
21870     "examples": [
21871       {
21872         "title": "Example usage:",
21873         "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",
21874         "type": "json"
21875       }
21876     ],
21877     "name": "CreateServicenow_Accounts",
21878     "group": "Servicenow_Accounts",
21879     "parameter": {
21880       "fields": {
21881         "Body": [
21882           {
21883             "group": "Body",
21884             "type": "String",
21885             "optional": true,
21886             "field": "name",
21887             "description": ""
21888           },
21889           {
21890             "group": "Body",
21891             "type": "String",
21892             "optional": true,
21893             "field": "description",
21894             "description": ""
21895           },
21896           {
21897             "group": "Body",
21898             "type": "String",
21899             "optional": true,
21900             "field": "username",
21901             "description": ""
21902           },
21903           {
21904             "group": "Body",
21905             "type": "String",
21906             "optional": true,
21907             "field": "password",
21908             "description": ""
21909           },
21910           {
21911             "group": "Body",
21912             "type": "String",
21913             "optional": true,
21914             "field": "email",
21915             "description": ""
21916           },
21917           {
21918             "group": "Body",
21919             "type": "String",
21920             "optional": true,
21921             "field": "remoteUri",
21922             "description": ""
21923           },
21924           {
21925             "group": "Body",
21926             "type": "String",
21927             "optional": false,
21928             "field": "serverUrl",
21929             "description": ""
21930           }
21931         ]
21932       }
21933     },
21934     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21935     "version": "0.0.0",
21936     "filename": "server/api/intServicenowAccount/index.js",
21937     "groupTitle": "Servicenow_Accounts"
21938   },
21939   {
21940     "type": "delete",
21941     "url": "/api/integrations/servicenow/accounts/{id}",
21942     "title": "Deletes a Servicenow Account",
21943     "examples": [
21944       {
21945         "title": "Example usage:",
21946         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21947         "type": "json"
21948       }
21949     ],
21950     "name": "DeleteServicenow_Accounts",
21951     "group": "Servicenow_Accounts",
21952     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21953     "version": "0.0.0",
21954     "filename": "server/api/intServicenowAccount/index.js",
21955     "groupTitle": "Servicenow_Accounts"
21956   },
21957   {
21958     "type": "get",
21959     "url": "/api/integrations/servicenow/accounts",
21960     "title": "Gets a list of Servicenow Accounts",
21961     "examples": [
21962       {
21963         "title": "Example usage:",
21964         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21965         "type": "json"
21966       }
21967     ],
21968     "name": "GetServicenow_Accounts",
21969     "group": "Servicenow_Accounts",
21970     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21971     "version": "0.0.0",
21972     "filename": "server/api/intServicenowAccount/index.js",
21973     "groupTitle": "Servicenow_Accounts"
21974   },
21975   {
21976     "type": "get",
21977     "url": "/api/integrations/servicenow/accounts/{id}",
21978     "title": "Gets a single Servicenow Account",
21979     "examples": [
21980       {
21981         "title": "Example usage:",
21982         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21983         "type": "json"
21984       }
21985     ],
21986     "name": "ShowServicenow_Accounts",
21987     "group": "Servicenow_Accounts",
21988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21989     "version": "0.0.0",
21990     "filename": "server/api/intServicenowAccount/index.js",
21991     "groupTitle": "Servicenow_Accounts"
21992   },
21993   {
21994     "type": "post",
21995     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21996     "title": "Creates new configuration",
21997     "examples": [
21998       {
21999         "title": "Example usage:",
22000         "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",
22001         "type": "json"
22002       }
22003     ],
22004     "name": "addConfiguration",
22005     "group": "Servicenow_Accounts",
22006     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22007     "version": "0.0.0",
22008     "filename": "server/api/intServicenowAccount/index.js",
22009     "groupTitle": "Servicenow_Accounts"
22010   },
22011   {
22012     "type": "get",
22013     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
22014     "title": "Gets account configurations",
22015     "examples": [
22016       {
22017         "title": "Example usage:",
22018         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
22019         "type": "json"
22020       }
22021     ],
22022     "name": "getConfigurations",
22023     "group": "Servicenow_Accounts",
22024     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22025     "version": "0.0.0",
22026     "filename": "server/api/intServicenowAccount/index.js",
22027     "groupTitle": "Servicenow_Accounts"
22028   },
22029   {
22030     "type": "get",
22031     "url": "/api/integrations/servicenow/accounts/{id}/fields",
22032     "title": "Gets account fields",
22033     "examples": [
22034       {
22035         "title": "Example usage:",
22036         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
22037         "type": "json"
22038       }
22039     ],
22040     "name": "getFields",
22041     "group": "Servicenow_Accounts",
22042     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22043     "version": "0.0.0",
22044     "filename": "server/api/intServicenowAccount/index.js",
22045     "groupTitle": "Servicenow_Accounts"
22046   },
22047   {
22048     "type": "put",
22049     "url": "/api/integrations/servicenow/accounts/{id}",
22050     "title": "Update an existing Servicenow Account",
22051     "examples": [
22052       {
22053         "title": "Example usage:",
22054         "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",
22055         "type": "json"
22056       }
22057     ],
22058     "name": "updateServicenow_Accounts",
22059     "group": "Servicenow_Accounts",
22060     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22061     "version": "0.0.0",
22062     "filename": "server/api/intServicenowAccount/index.js",
22063     "groupTitle": "Servicenow_Accounts"
22064   },
22065   {
22066     "type": "post",
22067     "url": "/api/integrations/servicenow/configurations",
22068     "title": "Creates a new Servicenow Configuration",
22069     "examples": [
22070       {
22071         "title": "Example usage:",
22072         "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",
22073         "type": "json"
22074       }
22075     ],
22076     "name": "CreateServicenow_Configurations",
22077     "group": "Servicenow_Configurations",
22078     "parameter": {
22079       "fields": {
22080         "Body": [
22081           {
22082             "group": "Body",
22083             "type": "String",
22084             "optional": true,
22085             "field": "name",
22086             "description": ""
22087           },
22088           {
22089             "group": "Body",
22090             "type": "String",
22091             "optional": true,
22092             "field": "description",
22093             "description": ""
22094           }
22095         ]
22096       }
22097     },
22098     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22099     "version": "0.0.0",
22100     "filename": "server/api/intServicenowConfiguration/index.js",
22101     "groupTitle": "Servicenow_Configurations"
22102   },
22103   {
22104     "type": "delete",
22105     "url": "/api/integrations/servicenow/configurations/{id}",
22106     "title": "Deletes a Servicenow Configuration",
22107     "examples": [
22108       {
22109         "title": "Example usage:",
22110         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
22111         "type": "json"
22112       }
22113     ],
22114     "name": "DeleteServicenow_Configurations",
22115     "group": "Servicenow_Configurations",
22116     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22117     "version": "0.0.0",
22118     "filename": "server/api/intServicenowConfiguration/index.js",
22119     "groupTitle": "Servicenow_Configurations"
22120   },
22121   {
22122     "type": "get",
22123     "url": "/api/integrations/servicenow/configurations",
22124     "title": "Gets a list of Servicenow Configurations",
22125     "examples": [
22126       {
22127         "title": "Example usage:",
22128         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
22129         "type": "json"
22130       }
22131     ],
22132     "name": "GetServicenow_Configurations",
22133     "group": "Servicenow_Configurations",
22134     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22135     "version": "0.0.0",
22136     "filename": "server/api/intServicenowConfiguration/index.js",
22137     "groupTitle": "Servicenow_Configurations"
22138   },
22139   {
22140     "type": "get",
22141     "url": "/api/integrations/servicenow/configurations/{id}",
22142     "title": "Gets a single Servicenow Configuration",
22143     "examples": [
22144       {
22145         "title": "Example usage:",
22146         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
22147         "type": "json"
22148       }
22149     ],
22150     "name": "ShowServicenow_Configurations",
22151     "group": "Servicenow_Configurations",
22152     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22153     "version": "0.0.0",
22154     "filename": "server/api/intServicenowConfiguration/index.js",
22155     "groupTitle": "Servicenow_Configurations"
22156   },
22157   {
22158     "type": "get",
22159     "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
22160     "title": "Gets configurations descriptions",
22161     "examples": [
22162       {
22163         "title": "Example usage:",
22164         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
22165         "type": "json"
22166       }
22167     ],
22168     "name": "getDescriptions",
22169     "group": "Servicenow_Configurations",
22170     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22171     "version": "0.0.0",
22172     "filename": "server/api/intServicenowConfiguration/index.js",
22173     "groupTitle": "Servicenow_Configurations"
22174   },
22175   {
22176     "type": "get",
22177     "url": "/api/integrations/servicenow/configurations/{id}/fields",
22178     "title": "Gets configurations fields",
22179     "examples": [
22180       {
22181         "title": "Example usage:",
22182         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
22183         "type": "json"
22184       }
22185     ],
22186     "name": "getFields",
22187     "group": "Servicenow_Configurations",
22188     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22189     "version": "0.0.0",
22190     "filename": "server/api/intServicenowConfiguration/index.js",
22191     "groupTitle": "Servicenow_Configurations"
22192   },
22193   {
22194     "type": "get",
22195     "url": "/api/integrations/servicenow/configurations/{id}/subjects",
22196     "title": "Gets configurations subjects",
22197     "examples": [
22198       {
22199         "title": "Example usage:",
22200         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
22201         "type": "json"
22202       }
22203     ],
22204     "name": "getSubjects",
22205     "group": "Servicenow_Configurations",
22206     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22207     "version": "0.0.0",
22208     "filename": "server/api/intServicenowConfiguration/index.js",
22209     "groupTitle": "Servicenow_Configurations"
22210   },
22211   {
22212     "type": "put",
22213     "url": "/api/integrations/servicenow/configurations/{id}",
22214     "title": "Update an existing Servicenow Configuration",
22215     "examples": [
22216       {
22217         "title": "Example usage:",
22218         "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",
22219         "type": "json"
22220       }
22221     ],
22222     "name": "updateServicenow_Configurations",
22223     "group": "Servicenow_Configurations",
22224     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22225     "version": "0.0.0",
22226     "filename": "server/api/intServicenowConfiguration/index.js",
22227     "groupTitle": "Servicenow_Configurations"
22228   },
22229   {
22230     "type": "post",
22231     "url": "/api/integrations/servicenow/fields",
22232     "title": "Creates a new Servicenow Field",
22233     "examples": [
22234       {
22235         "title": "Example usage:",
22236         "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",
22237         "type": "json"
22238       }
22239     ],
22240     "name": "CreateServicenow_Fields",
22241     "group": "Servicenow_Fields",
22242     "parameter": {
22243       "fields": {
22244         "Body": [
22245           {
22246             "group": "Body",
22247             "type": "String",
22248             "allowedValues": [
22249               "\"string\"",
22250               "\"variable\"",
22251               "\"customVariable\"",
22252               "\"keyValue\"",
22253               "\"picklist\""
22254             ],
22255             "optional": true,
22256             "field": "type",
22257             "description": ""
22258           },
22259           {
22260             "group": "Body",
22261             "type": "String",
22262             "optional": true,
22263             "field": "content",
22264             "description": ""
22265           },
22266           {
22267             "group": "Body",
22268             "type": "String",
22269             "optional": true,
22270             "field": "key",
22271             "description": ""
22272           },
22273           {
22274             "group": "Body",
22275             "type": "String",
22276             "allowedValues": [
22277               "\"string\"",
22278               "\"variable\"",
22279               "\"customVariable\""
22280             ],
22281             "optional": true,
22282             "field": "keyType",
22283             "description": ""
22284           },
22285           {
22286             "group": "Body",
22287             "type": "String",
22288             "optional": true,
22289             "field": "keyContent",
22290             "description": ""
22291           },
22292           {
22293             "group": "Body",
22294             "type": "String",
22295             "optional": true,
22296             "field": "idField",
22297             "description": ""
22298           },
22299           {
22300             "group": "Body",
22301             "type": "String",
22302             "optional": true,
22303             "field": "nameField",
22304             "description": ""
22305           },
22306           {
22307             "group": "Body",
22308             "type": "Boolean",
22309             "optional": true,
22310             "field": "customField",
22311             "description": ""
22312           },
22313           {
22314             "group": "Body",
22315             "type": "String",
22316             "optional": true,
22317             "field": "variableName",
22318             "description": ""
22319           }
22320         ]
22321       }
22322     },
22323     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22324     "version": "0.0.0",
22325     "filename": "server/api/intServicenowField/index.js",
22326     "groupTitle": "Servicenow_Fields"
22327   },
22328   {
22329     "type": "delete",
22330     "url": "/api/integrations/servicenow/fields/{id}",
22331     "title": "Deletes a Servicenow Field",
22332     "examples": [
22333       {
22334         "title": "Example usage:",
22335         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
22336         "type": "json"
22337       }
22338     ],
22339     "name": "DeleteServicenow_Fields",
22340     "group": "Servicenow_Fields",
22341     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22342     "version": "0.0.0",
22343     "filename": "server/api/intServicenowField/index.js",
22344     "groupTitle": "Servicenow_Fields"
22345   },
22346   {
22347     "type": "get",
22348     "url": "/api/integrations/servicenow/fields",
22349     "title": "Gets a list of Servicenow Fields",
22350     "examples": [
22351       {
22352         "title": "Example usage:",
22353         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
22354         "type": "json"
22355       }
22356     ],
22357     "name": "GetServicenow_Fields",
22358     "group": "Servicenow_Fields",
22359     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22360     "version": "0.0.0",
22361     "filename": "server/api/intServicenowField/index.js",
22362     "groupTitle": "Servicenow_Fields"
22363   },
22364   {
22365     "type": "get",
22366     "url": "/api/integrations/servicenow/fields/{id}",
22367     "title": "Gets a single Servicenow Field",
22368     "examples": [
22369       {
22370         "title": "Example usage:",
22371         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
22372         "type": "json"
22373       }
22374     ],
22375     "name": "ShowServicenow_Fields",
22376     "group": "Servicenow_Fields",
22377     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22378     "version": "0.0.0",
22379     "filename": "server/api/intServicenowField/index.js",
22380     "groupTitle": "Servicenow_Fields"
22381   },
22382   {
22383     "type": "put",
22384     "url": "/api/integrations/servicenow/fields/{id}",
22385     "title": "Update an existing Servicenow Field",
22386     "examples": [
22387       {
22388         "title": "Example usage:",
22389         "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",
22390         "type": "json"
22391       }
22392     ],
22393     "name": "updateServicenow_Fields",
22394     "group": "Servicenow_Fields",
22395     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22396     "version": "0.0.0",
22397     "filename": "server/api/intServicenowField/index.js",
22398     "groupTitle": "Servicenow_Fields"
22399   },
22400   {
22401     "type": "get",
22402     "url": "/api/settings",
22403     "title": "Gets a list of Settings",
22404     "examples": [
22405       {
22406         "title": "Example usage:",
22407         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
22408         "type": "json"
22409       }
22410     ],
22411     "name": "GetSettings",
22412     "group": "Settings",
22413     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22414     "version": "0.0.0",
22415     "filename": "server/api/setting/index.js",
22416     "groupTitle": "Settings"
22417   },
22418   {
22419     "type": "get",
22420     "url": "/api/settings/{id}",
22421     "title": "Gets a single Setting",
22422     "examples": [
22423       {
22424         "title": "Example usage:",
22425         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
22426         "type": "json"
22427       }
22428     ],
22429     "name": "ShowSettings",
22430     "group": "Settings",
22431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22432     "version": "0.0.0",
22433     "filename": "server/api/setting/index.js",
22434     "groupTitle": "Settings"
22435   },
22436   {
22437     "type": "post",
22438     "url": "/api/settings/{id}/favicon",
22439     "title": "Add Favicon",
22440     "examples": [
22441       {
22442         "title": "Example usage:",
22443         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22444         "type": "json"
22445       }
22446     ],
22447     "name": "addFavicon",
22448     "group": "Settings",
22449     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22450     "version": "0.0.0",
22451     "filename": "server/api/setting/index.js",
22452     "groupTitle": "Settings"
22453   },
22454   {
22455     "type": "post",
22456     "url": "/api/settings/{id}/logo",
22457     "title": "Add logo",
22458     "examples": [
22459       {
22460         "title": "Example usage:",
22461         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22462         "type": "json"
22463       }
22464     ],
22465     "name": "addLogo",
22466     "group": "Settings",
22467     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22468     "version": "0.0.0",
22469     "filename": "server/api/setting/index.js",
22470     "groupTitle": "Settings"
22471   },
22472   {
22473     "type": "post",
22474     "url": "/api/settings/{id}/logo_login",
22475     "title": "Add logo login",
22476     "examples": [
22477       {
22478         "title": "Example usage:",
22479         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22480         "type": "json"
22481       }
22482     ],
22483     "name": "addLogoLogin",
22484     "group": "Settings",
22485     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22486     "version": "0.0.0",
22487     "filename": "server/api/setting/index.js",
22488     "groupTitle": "Settings"
22489   },
22490   {
22491     "type": "post",
22492     "url": "/api/settings/{id}/preferred",
22493     "title": "Add Preferred",
22494     "examples": [
22495       {
22496         "title": "Example usage:",
22497         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
22498         "type": "json"
22499       }
22500     ],
22501     "name": "addPreferred",
22502     "group": "Settings",
22503     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22504     "version": "0.0.0",
22505     "filename": "server/api/setting/index.js",
22506     "groupTitle": "Settings"
22507   },
22508   {
22509     "type": "get",
22510     "url": "/api/settings/now",
22511     "title": "Get Server Current Date",
22512     "examples": [
22513       {
22514         "title": "Example usage:",
22515         "content": "curl https://{domain}/api/settings/now -v -X GET",
22516         "type": "json"
22517       }
22518     ],
22519     "name": "getDate",
22520     "group": "Settings",
22521     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22522     "version": "0.0.0",
22523     "filename": "server/api/setting/index.js",
22524     "groupTitle": "Settings"
22525   },
22526   {
22527     "type": "get",
22528     "url": "/api/settings/{id}/favicon",
22529     "title": "Get Favicon",
22530     "examples": [
22531       {
22532         "title": "Example usage:",
22533         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
22534         "type": "json"
22535       }
22536     ],
22537     "name": "getFavicon",
22538     "group": "Settings",
22539     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22540     "version": "0.0.0",
22541     "filename": "server/api/setting/index.js",
22542     "groupTitle": "Settings"
22543   },
22544   {
22545     "type": "get",
22546     "url": "/api/settings/{id}/gdpr",
22547     "title": "Get gdpr settings",
22548     "examples": [
22549       {
22550         "title": "Example usage:",
22551         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
22552         "type": "json"
22553       }
22554     ],
22555     "name": "getGdpr",
22556     "group": "Settings",
22557     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22558     "version": "0.0.0",
22559     "filename": "server/api/setting/index.js",
22560     "groupTitle": "Settings"
22561   },
22562   {
22563     "type": "get",
22564     "url": "/api/settings/{id}/logo",
22565     "title": "Get logo",
22566     "examples": [
22567       {
22568         "title": "Example usage:",
22569         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
22570         "type": "json"
22571       }
22572     ],
22573     "name": "getLogo",
22574     "group": "Settings",
22575     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22576     "version": "0.0.0",
22577     "filename": "server/api/setting/index.js",
22578     "groupTitle": "Settings"
22579   },
22580   {
22581     "type": "get",
22582     "url": "/api/settings/{id}/logo_login",
22583     "title": "Get logo login",
22584     "examples": [
22585       {
22586         "title": "Example usage:",
22587         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
22588         "type": "json"
22589       }
22590     ],
22591     "name": "getLogoLogin",
22592     "group": "Settings",
22593     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22594     "version": "0.0.0",
22595     "filename": "server/api/setting/index.js",
22596     "groupTitle": "Settings"
22597   },
22598   {
22599     "type": "get",
22600     "url": "/api/settings/{id}/preferred",
22601     "title": "Get Preferred",
22602     "examples": [
22603       {
22604         "title": "Example usage:",
22605         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
22606         "type": "json"
22607       }
22608     ],
22609     "name": "getPreferred",
22610     "group": "Settings",
22611     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22612     "version": "0.0.0",
22613     "filename": "server/api/setting/index.js",
22614     "groupTitle": "Settings"
22615   },
22616   {
22617     "type": "put",
22618     "url": "/api/settings/{id}",
22619     "title": "Update an existing Setting",
22620     "examples": [
22621       {
22622         "title": "Example usage:",
22623         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
22624         "type": "json"
22625       }
22626     ],
22627     "name": "updateSettings",
22628     "group": "Settings",
22629     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22630     "version": "0.0.0",
22631     "filename": "server/api/setting/index.js",
22632     "groupTitle": "Settings"
22633   },
22634   {
22635     "type": "post",
22636     "url": "/api/sms/accounts/{id}/users",
22637     "title": "Add agents to a sms account",
22638     "examples": [
22639       {
22640         "title": "Example usage:",
22641         "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",
22642         "type": "json"
22643       }
22644     ],
22645     "name": "AddAgents",
22646     "group": "Sms_Accounts",
22647     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22648     "version": "0.0.0",
22649     "filename": "server/api/smsAccount/index.js",
22650     "groupTitle": "Sms_Accounts"
22651   },
22652   {
22653     "type": "post",
22654     "url": "/api/sms/accounts",
22655     "title": "Creates a new Account",
22656     "examples": [
22657       {
22658         "title": "Example usage:",
22659         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22660         "type": "json"
22661       }
22662     ],
22663     "name": "CreateAccounts",
22664     "group": "Sms_Accounts",
22665     "parameter": {
22666       "fields": {
22667         "Body": [
22668           {
22669             "group": "Body",
22670             "type": "String",
22671             "optional": false,
22672             "field": "name",
22673             "description": ""
22674           },
22675           {
22676             "group": "Body",
22677             "type": "String",
22678             "optional": false,
22679             "field": "key",
22680             "description": ""
22681           },
22682           {
22683             "group": "Body",
22684             "type": "String",
22685             "optional": false,
22686             "field": "remote",
22687             "description": ""
22688           },
22689           {
22690             "group": "Body",
22691             "type": "String",
22692             "optional": true,
22693             "field": "token",
22694             "description": ""
22695           },
22696           {
22697             "group": "Body",
22698             "type": "String",
22699             "optional": true,
22700             "field": "phone",
22701             "description": ""
22702           },
22703           {
22704             "group": "Body",
22705             "type": "String",
22706             "allowedValues": [
22707               "\"twilio\"",
22708               "\"skebby\"",
22709               "\"connectel\"",
22710               "\"clicksend\"",
22711               "\"plivo\"",
22712               "\"clickatell\"",
22713               "\"bandwidth\"",
22714               "\"csc\"",
22715               "\"infobip\"",
22716               "\"intelepeer\""
22717             ],
22718             "optional": true,
22719             "field": "type",
22720             "description": ""
22721           },
22722           {
22723             "group": "Body",
22724             "type": "String",
22725             "optional": true,
22726             "field": "accountSid",
22727             "description": ""
22728           },
22729           {
22730             "group": "Body",
22731             "type": "String",
22732             "optional": true,
22733             "field": "authId",
22734             "description": ""
22735           },
22736           {
22737             "group": "Body",
22738             "type": "String",
22739             "optional": true,
22740             "field": "authToken",
22741             "description": ""
22742           },
22743           {
22744             "group": "Body",
22745             "type": "String",
22746             "allowedValues": [
22747               "\"SI\"",
22748               "\"TI\"",
22749               "\"GP\""
22750             ],
22751             "optional": true,
22752             "field": "smsMethod",
22753             "description": ""
22754           },
22755           {
22756             "group": "Body",
22757             "type": "String",
22758             "optional": true,
22759             "field": "username",
22760             "description": ""
22761           },
22762           {
22763             "group": "Body",
22764             "type": "String",
22765             "optional": true,
22766             "field": "password",
22767             "description": ""
22768           },
22769           {
22770             "group": "Body",
22771             "type": "String",
22772             "optional": true,
22773             "field": "apiKey",
22774             "description": ""
22775           },
22776           {
22777             "group": "Body",
22778             "type": "String",
22779             "optional": true,
22780             "field": "applicationId",
22781             "description": ""
22782           },
22783           {
22784             "group": "Body",
22785             "type": "String",
22786             "optional": true,
22787             "field": "accountId",
22788             "description": ""
22789           },
22790           {
22791             "group": "Body",
22792             "type": "String",
22793             "optional": true,
22794             "field": "senderString",
22795             "description": ""
22796           },
22797           {
22798             "group": "Body",
22799             "type": "Boolean",
22800             "optional": true,
22801             "field": "deliveryReport",
22802             "description": ""
22803           },
22804           {
22805             "group": "Body",
22806             "type": "String",
22807             "optional": true,
22808             "field": "description",
22809             "description": ""
22810           },
22811           {
22812             "group": "Body",
22813             "type": "Text",
22814             "optional": true,
22815             "field": "notificationTemplate",
22816             "description": ""
22817           },
22818           {
22819             "group": "Body",
22820             "type": "Boolean",
22821             "optional": true,
22822             "field": "notificationSound",
22823             "description": ""
22824           },
22825           {
22826             "group": "Body",
22827             "type": "Boolean",
22828             "optional": true,
22829             "field": "notificationShake",
22830             "description": ""
22831           },
22832           {
22833             "group": "Body",
22834             "type": "Integer",
22835             "optional": true,
22836             "field": "waitForTheAssignedAgent",
22837             "description": ""
22838           },
22839           {
22840             "group": "Body",
22841             "type": "Boolean",
22842             "optional": true,
22843             "field": "queueTransfer",
22844             "description": ""
22845           },
22846           {
22847             "group": "Body",
22848             "type": "Integer",
22849             "optional": true,
22850             "field": "queueTransferTimeout",
22851             "description": ""
22852           },
22853           {
22854             "group": "Body",
22855             "type": "Boolean",
22856             "optional": true,
22857             "field": "agentTransfer",
22858             "description": ""
22859           },
22860           {
22861             "group": "Body",
22862             "type": "Integer",
22863             "optional": true,
22864             "field": "agentTransferTimeout",
22865             "description": ""
22866           },
22867           {
22868             "group": "Body",
22869             "type": "String",
22870             "optional": true,
22871             "field": "baseUrl",
22872             "description": ""
22873           },
22874           {
22875             "group": "Body",
22876             "type": "Integer",
22877             "optional": true,
22878             "field": "mandatoryDispositionPauseId",
22879             "description": "<p>Status to put when mandatory disposition is enabled</p>"
22880           },
22881           {
22882             "group": "Body",
22883             "type": "Boolean",
22884             "optional": true,
22885             "field": "mandatoryDisposition",
22886             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22887           }
22888         ]
22889       }
22890     },
22891     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22892     "version": "0.0.0",
22893     "filename": "server/api/smsAccount/index.js",
22894     "groupTitle": "Sms_Accounts"
22895   },
22896   {
22897     "type": "delete",
22898     "url": "/api/sms/accounts/{id}",
22899     "title": "Deletes a Account",
22900     "examples": [
22901       {
22902         "title": "Example usage:",
22903         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22904         "type": "json"
22905       }
22906     ],
22907     "name": "DeleteAccounts",
22908     "group": "Sms_Accounts",
22909     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22910     "version": "0.0.0",
22911     "filename": "server/api/smsAccount/index.js",
22912     "groupTitle": "Sms_Accounts"
22913   },
22914   {
22915     "type": "get",
22916     "url": "/api/sms/accounts/describe",
22917     "title": "Gets table info about Accounts",
22918     "examples": [
22919       {
22920         "title": "Example usage:",
22921         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22922         "type": "json"
22923       }
22924     ],
22925     "name": "DescribeAccounts",
22926     "group": "Sms_Accounts",
22927     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22928     "version": "0.0.0",
22929     "filename": "server/api/smsAccount/index.js",
22930     "groupTitle": "Sms_Accounts"
22931   },
22932   {
22933     "type": "get",
22934     "url": "/api/sms/accounts",
22935     "title": "Gets a list of Accounts",
22936     "examples": [
22937       {
22938         "title": "Example usage:",
22939         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22940         "type": "json"
22941       }
22942     ],
22943     "name": "GetAccounts",
22944     "group": "Sms_Accounts",
22945     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22946     "version": "0.0.0",
22947     "filename": "server/api/smsAccount/index.js",
22948     "groupTitle": "Sms_Accounts"
22949   },
22950   {
22951     "type": "get",
22952     "url": "/api/sms/accounts/{id}/users",
22953     "title": "Gets agents from sms account",
22954     "examples": [
22955       {
22956         "title": "Example usage:",
22957         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22958         "type": "json"
22959       }
22960     ],
22961     "name": "GetAgents",
22962     "group": "Sms_Accounts",
22963     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22964     "version": "0.0.0",
22965     "filename": "server/api/smsAccount/index.js",
22966     "groupTitle": "Sms_Accounts"
22967   },
22968   {
22969     "type": "delete",
22970     "url": "/api/sms/accounts/{id}/users",
22971     "title": "Removes agents from a sms account",
22972     "examples": [
22973       {
22974         "title": "Example usage:",
22975         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22976         "type": "json"
22977       }
22978     ],
22979     "name": "RemoveAgents",
22980     "group": "Sms_Accounts",
22981     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22982     "version": "0.0.0",
22983     "filename": "server/api/smsAccount/index.js",
22984     "groupTitle": "Sms_Accounts"
22985   },
22986   {
22987     "type": "delete",
22988     "url": "/api/sms/accounts/{id}/canned_answers",
22989     "title": "Removes canned answers from account",
22990     "examples": [
22991       {
22992         "title": "Example usage:",
22993         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22994         "type": "json"
22995       }
22996     ],
22997     "name": "RemoveAnswers",
22998     "group": "Sms_Accounts",
22999     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23000     "version": "0.0.0",
23001     "filename": "server/api/smsAccount/index.js",
23002     "groupTitle": "Sms_Accounts"
23003   },
23004   {
23005     "type": "delete",
23006     "url": "/api/sms/accounts/{id}/dispositions",
23007     "title": "Removes dispositions from account",
23008     "examples": [
23009       {
23010         "title": "Example usage:",
23011         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23012         "type": "json"
23013       }
23014     ],
23015     "name": "RemoveDispositions",
23016     "group": "Sms_Accounts",
23017     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23018     "version": "0.0.0",
23019     "filename": "server/api/smsAccount/index.js",
23020     "groupTitle": "Sms_Accounts"
23021   },
23022   {
23023     "type": "get",
23024     "url": "/api/sms/accounts/{id}",
23025     "title": "Gets a single Account",
23026     "examples": [
23027       {
23028         "title": "Example usage:",
23029         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
23030         "type": "json"
23031       }
23032     ],
23033     "name": "ShowAccounts",
23034     "group": "Sms_Accounts",
23035     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23036     "version": "0.0.0",
23037     "filename": "server/api/smsAccount/index.js",
23038     "groupTitle": "Sms_Accounts"
23039   },
23040   {
23041     "type": "put",
23042     "url": "/api/sms/messages/{id}/accept",
23043     "title": "Accepts message",
23044     "examples": [
23045       {
23046         "title": "Example usage:",
23047         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
23048         "type": "json"
23049       }
23050     ],
23051     "name": "acceptMessage",
23052     "group": "Sms_Accounts",
23053     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23054     "version": "0.0.0",
23055     "filename": "server/api/smsMessage/index.js",
23056     "groupTitle": "Sms_Accounts"
23057   },
23058   {
23059     "type": "post",
23060     "url": "/api/sms/accounts/{id}/canned_answers",
23061     "title": "Creates new canned answer",
23062     "examples": [
23063       {
23064         "title": "Example usage:",
23065         "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",
23066         "type": "json"
23067       }
23068     ],
23069     "name": "addAnswer",
23070     "group": "Sms_Accounts",
23071     "parameter": {
23072       "fields": {
23073         "Body": [
23074           {
23075             "group": "Body",
23076             "type": "String",
23077             "optional": false,
23078             "field": "key",
23079             "description": ""
23080           },
23081           {
23082             "group": "Body",
23083             "type": "Text",
23084             "optional": false,
23085             "field": "value",
23086             "description": ""
23087           },
23088           {
23089             "group": "Body",
23090             "type": "String",
23091             "optional": true,
23092             "field": "description",
23093             "description": ""
23094           },
23095           {
23096             "group": "Body",
23097             "type": "Virtual",
23098             "optional": true,
23099             "field": "name",
23100             "description": ""
23101           }
23102         ]
23103       }
23104     },
23105     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23106     "version": "0.0.0",
23107     "filename": "server/api/smsAccount/index.js",
23108     "groupTitle": "Sms_Accounts"
23109   },
23110   {
23111     "type": "post",
23112     "url": "/api/sms/accounts/{id}/applications",
23113     "title": "Creates new applications",
23114     "examples": [
23115       {
23116         "title": "Example usage:",
23117         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23118         "type": "json"
23119       }
23120     ],
23121     "name": "addApplications",
23122     "group": "Sms_Accounts",
23123     "parameter": {
23124       "fields": {
23125         "Body": [
23126           {
23127             "group": "Body",
23128             "type": "Integer",
23129             "optional": false,
23130             "field": "priority",
23131             "description": ""
23132           },
23133           {
23134             "group": "Body",
23135             "type": "String",
23136             "optional": false,
23137             "field": "app",
23138             "description": ""
23139           },
23140           {
23141             "group": "Body",
23142             "type": "Text",
23143             "optional": true,
23144             "field": "appdata",
23145             "description": ""
23146           },
23147           {
23148             "group": "Body",
23149             "type": "String",
23150             "optional": true,
23151             "field": "description",
23152             "description": ""
23153           },
23154           {
23155             "group": "Body",
23156             "type": "String",
23157             "optional": true,
23158             "field": "interval",
23159             "description": ""
23160           }
23161         ]
23162       }
23163     },
23164     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23165     "version": "0.0.0",
23166     "filename": "server/api/smsAccount/index.js",
23167     "groupTitle": "Sms_Accounts"
23168   },
23169   {
23170     "type": "post",
23171     "url": "/api/sms/accounts/{id}/dispositions",
23172     "title": "Creates new disposition",
23173     "examples": [
23174       {
23175         "title": "Example usage:",
23176         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23177         "type": "json"
23178       }
23179     ],
23180     "name": "addDisposition",
23181     "group": "Sms_Accounts",
23182     "parameter": {
23183       "fields": {
23184         "Body": [
23185           {
23186             "group": "Body",
23187             "type": "String",
23188             "optional": false,
23189             "field": "name",
23190             "description": ""
23191           },
23192           {
23193             "group": "Body",
23194             "type": "String",
23195             "allowedValues": [
23196               "\"first\"",
23197               "\"second\"",
23198               "\"third\""
23199             ],
23200             "optional": false,
23201             "field": "level",
23202             "description": ""
23203           },
23204           {
23205             "group": "Body",
23206             "type": "String",
23207             "optional": true,
23208             "field": "description",
23209             "description": ""
23210           }
23211         ]
23212       }
23213     },
23214     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23215     "version": "0.0.0",
23216     "filename": "server/api/smsAccount/index.js",
23217     "groupTitle": "Sms_Accounts"
23218   },
23219   {
23220     "type": "get",
23221     "url": "/api/sms/accounts/{id}/canned_answers",
23222     "title": "Gets account canned answers",
23223     "examples": [
23224       {
23225         "title": "Example usage:",
23226         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
23227         "type": "json"
23228       }
23229     ],
23230     "name": "getAnswers",
23231     "group": "Sms_Accounts",
23232     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23233     "version": "0.0.0",
23234     "filename": "server/api/smsAccount/index.js",
23235     "groupTitle": "Sms_Accounts"
23236   },
23237   {
23238     "type": "get",
23239     "url": "/api/sms/accounts/{id}/applications",
23240     "title": "Gets account applications",
23241     "examples": [
23242       {
23243         "title": "Example usage:",
23244         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
23245         "type": "json"
23246       }
23247     ],
23248     "name": "getApplications",
23249     "group": "Sms_Accounts",
23250     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23251     "version": "0.0.0",
23252     "filename": "server/api/smsAccount/index.js",
23253     "groupTitle": "Sms_Accounts"
23254   },
23255   {
23256     "type": "get",
23257     "url": "/api/sms/accounts/{id}/dispositions",
23258     "title": "Gets account dispositions",
23259     "examples": [
23260       {
23261         "title": "Example usage:",
23262         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
23263         "type": "json"
23264       }
23265     ],
23266     "name": "getDispositions",
23267     "group": "Sms_Accounts",
23268     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23269     "version": "0.0.0",
23270     "filename": "server/api/smsAccount/index.js",
23271     "groupTitle": "Sms_Accounts"
23272   },
23273   {
23274     "type": "get",
23275     "url": "/api/sms/accounts/{id}/interactions",
23276     "title": "Gets Sms Account interactions",
23277     "examples": [
23278       {
23279         "title": "Example usage:",
23280         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
23281         "type": "json"
23282       }
23283     ],
23284     "name": "getInteractions",
23285     "group": "Sms_Accounts",
23286     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23287     "version": "0.0.0",
23288     "filename": "server/api/smsAccount/index.js",
23289     "groupTitle": "Sms_Accounts"
23290   },
23291   {
23292     "type": "post",
23293     "url": "/api/sms/accounts/{id}/notify",
23294     "title": "Notify new message",
23295     "examples": [
23296       {
23297         "title": "Example usage:",
23298         "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",
23299         "type": "json"
23300       }
23301     ],
23302     "name": "notify",
23303     "group": "Sms_Accounts",
23304     "description": "<p>Motion 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>",
23305     "version": "0.0.0",
23306     "filename": "server/api/smsAccount/index.js",
23307     "groupTitle": "Sms_Accounts"
23308   },
23309   {
23310     "type": "put",
23311     "url": "/api/sms/messages/{id}/reject",
23312     "title": "Rejects message",
23313     "examples": [
23314       {
23315         "title": "Example usage:",
23316         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
23317         "type": "json"
23318       }
23319     ],
23320     "name": "rejectMessage",
23321     "group": "Sms_Accounts",
23322     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23323     "version": "0.0.0",
23324     "filename": "server/api/smsMessage/index.js",
23325     "groupTitle": "Sms_Accounts"
23326   },
23327   {
23328     "type": "post",
23329     "url": "/api/sms/accounts/{id}/send",
23330     "title": "Send new sms message",
23331     "examples": [
23332       {
23333         "title": "Example usage:",
23334         "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",
23335         "type": "json"
23336       }
23337     ],
23338     "name": "sendSms",
23339     "group": "Sms_Accounts",
23340     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23341     "version": "0.0.0",
23342     "filename": "server/api/smsAccount/index.js",
23343     "groupTitle": "Sms_Accounts"
23344   },
23345   {
23346     "type": "post",
23347     "url": "/api/sms/messages/{id}/status",
23348     "title": "Receive message status",
23349     "examples": [
23350       {
23351         "title": "Example usage:",
23352         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
23353         "type": "json"
23354       }
23355     ],
23356     "name": "statusMessage",
23357     "group": "Sms_Accounts",
23358     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23359     "version": "0.0.0",
23360     "filename": "server/api/smsMessage/index.js",
23361     "groupTitle": "Sms_Accounts"
23362   },
23363   {
23364     "type": "post",
23365     "url": "/api/sms/accounts/{id}/status",
23366     "title": "Receive message status",
23367     "examples": [
23368       {
23369         "title": "Example usage:",
23370         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
23371         "type": "json"
23372       }
23373     ],
23374     "name": "statusMessage",
23375     "group": "Sms_Accounts",
23376     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23377     "version": "0.0.0",
23378     "filename": "server/api/smsAccount/index.js",
23379     "groupTitle": "Sms_Accounts"
23380   },
23381   {
23382     "type": "get",
23383     "url": "/api/sms/accounts/{id}/status",
23384     "title": "Receive message status as get request",
23385     "examples": [
23386       {
23387         "title": "Example usage:",
23388         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
23389         "type": "json"
23390       }
23391     ],
23392     "name": "statusMessage",
23393     "group": "Sms_Accounts",
23394     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23395     "version": "0.0.0",
23396     "filename": "server/api/smsAccount/index.js",
23397     "groupTitle": "Sms_Accounts"
23398   },
23399   {
23400     "type": "put",
23401     "url": "/api/sms/accounts/{id}",
23402     "title": "Update an existing Account",
23403     "examples": [
23404       {
23405         "title": "Example usage:",
23406         "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",
23407         "type": "json"
23408       }
23409     ],
23410     "name": "updateAccounts",
23411     "group": "Sms_Accounts",
23412     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23413     "version": "0.0.0",
23414     "filename": "server/api/smsAccount/index.js",
23415     "groupTitle": "Sms_Accounts"
23416   },
23417   {
23418     "type": "post",
23419     "url": "/api/sms/applications",
23420     "title": "Creates a new Application",
23421     "examples": [
23422       {
23423         "title": "Example usage:",
23424         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23425         "type": "json"
23426       }
23427     ],
23428     "name": "CreateApplications",
23429     "group": "Sms_Applications",
23430     "parameter": {
23431       "fields": {
23432         "Body": [
23433           {
23434             "group": "Body",
23435             "type": "Integer",
23436             "optional": false,
23437             "field": "priority",
23438             "description": ""
23439           },
23440           {
23441             "group": "Body",
23442             "type": "String",
23443             "optional": false,
23444             "field": "app",
23445             "description": ""
23446           },
23447           {
23448             "group": "Body",
23449             "type": "Text",
23450             "optional": true,
23451             "field": "appdata",
23452             "description": ""
23453           },
23454           {
23455             "group": "Body",
23456             "type": "String",
23457             "optional": true,
23458             "field": "description",
23459             "description": ""
23460           },
23461           {
23462             "group": "Body",
23463             "type": "String",
23464             "optional": true,
23465             "field": "interval",
23466             "description": ""
23467           }
23468         ]
23469       }
23470     },
23471     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23472     "version": "0.0.0",
23473     "filename": "server/api/smsApplication/index.js",
23474     "groupTitle": "Sms_Applications"
23475   },
23476   {
23477     "type": "delete",
23478     "url": "/api/sms/applications/{id}",
23479     "title": "Deletes a Application",
23480     "examples": [
23481       {
23482         "title": "Example usage:",
23483         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
23484         "type": "json"
23485       }
23486     ],
23487     "name": "DeleteApplications",
23488     "group": "Sms_Applications",
23489     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23490     "version": "0.0.0",
23491     "filename": "server/api/smsApplication/index.js",
23492     "groupTitle": "Sms_Applications"
23493   },
23494   {
23495     "type": "get",
23496     "url": "/api/sms/applications",
23497     "title": "Gets a list of Applications",
23498     "examples": [
23499       {
23500         "title": "Example usage:",
23501         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
23502         "type": "json"
23503       }
23504     ],
23505     "name": "GetApplications",
23506     "group": "Sms_Applications",
23507     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23508     "version": "0.0.0",
23509     "filename": "server/api/smsApplication/index.js",
23510     "groupTitle": "Sms_Applications"
23511   },
23512   {
23513     "type": "get",
23514     "url": "/api/sms/applications/{id}",
23515     "title": "Gets a single Application",
23516     "examples": [
23517       {
23518         "title": "Example usage:",
23519         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
23520         "type": "json"
23521       }
23522     ],
23523     "name": "ShowApplications",
23524     "group": "Sms_Applications",
23525     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23526     "version": "0.0.0",
23527     "filename": "server/api/smsApplication/index.js",
23528     "groupTitle": "Sms_Applications"
23529   },
23530   {
23531     "type": "put",
23532     "url": "/api/sms/applications/{id}",
23533     "title": "Update an existing Application",
23534     "examples": [
23535       {
23536         "title": "Example usage:",
23537         "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",
23538         "type": "json"
23539       }
23540     ],
23541     "name": "updateApplications",
23542     "group": "Sms_Applications",
23543     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23544     "version": "0.0.0",
23545     "filename": "server/api/smsApplication/index.js",
23546     "groupTitle": "Sms_Applications"
23547   },
23548   {
23549     "type": "post",
23550     "url": "/api/sms/interactions/{id}/tags",
23551     "title": "Add tags to the interaction",
23552     "examples": [
23553       {
23554         "title": "Example usage:",
23555         "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",
23556         "type": "json"
23557       }
23558     ],
23559     "name": "AddTags",
23560     "group": "Sms_Interactions",
23561     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23562     "version": "0.0.0",
23563     "filename": "server/api/smsInteraction/index.js",
23564     "groupTitle": "Sms_Interactions"
23565   },
23566   {
23567     "type": "post",
23568     "url": "/api/sms/interactions",
23569     "title": "Creates a new Interaction",
23570     "examples": [
23571       {
23572         "title": "Example usage:",
23573         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23574         "type": "json"
23575       }
23576     ],
23577     "name": "CreateInteractions",
23578     "group": "Sms_Interactions",
23579     "parameter": {
23580       "fields": {
23581         "Body": [
23582           {
23583             "group": "Body",
23584             "type": "Boolean",
23585             "optional": true,
23586             "field": "closed",
23587             "description": ""
23588           },
23589           {
23590             "group": "Body",
23591             "type": "String",
23592             "optional": true,
23593             "field": "closedAt",
23594             "description": ""
23595           },
23596           {
23597             "group": "Body",
23598             "type": "String",
23599             "optional": true,
23600             "field": "disposition",
23601             "description": ""
23602           },
23603           {
23604             "group": "Body",
23605             "type": "String",
23606             "optional": true,
23607             "field": "secondDisposition",
23608             "description": ""
23609           },
23610           {
23611             "group": "Body",
23612             "type": "String",
23613             "optional": true,
23614             "field": "thirdDisposition",
23615             "description": ""
23616           },
23617           {
23618             "group": "Body",
23619             "type": "String",
23620             "optional": true,
23621             "field": "note",
23622             "description": ""
23623           },
23624           {
23625             "group": "Body",
23626             "type": "String",
23627             "optional": true,
23628             "field": "phone",
23629             "description": ""
23630           },
23631           {
23632             "group": "Body",
23633             "type": "String",
23634             "optional": true,
23635             "field": "read1stAt",
23636             "description": ""
23637           },
23638           {
23639             "group": "Body",
23640             "type": "String",
23641             "allowedValues": [
23642               "\"in\"",
23643               "\"out\""
23644             ],
23645             "optional": false,
23646             "field": "firstMsgDirection",
23647             "description": ""
23648           },
23649           {
23650             "group": "Body",
23651             "type": "String",
23652             "optional": true,
23653             "field": "lastMsgAt",
23654             "description": ""
23655           },
23656           {
23657             "group": "Body",
23658             "type": "String",
23659             "allowedValues": [
23660               "\"in\"",
23661               "\"out\""
23662             ],
23663             "optional": false,
23664             "field": "lastMsgDirection",
23665             "description": ""
23666           }
23667         ]
23668       }
23669     },
23670     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23671     "version": "0.0.0",
23672     "filename": "server/api/smsInteraction/index.js",
23673     "groupTitle": "Sms_Interactions"
23674   },
23675   {
23676     "type": "delete",
23677     "url": "/api/sms/interactions/{id}",
23678     "title": "Deletes a Interaction",
23679     "examples": [
23680       {
23681         "title": "Example usage:",
23682         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
23683         "type": "json"
23684       }
23685     ],
23686     "name": "DeleteInteractions",
23687     "group": "Sms_Interactions",
23688     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23689     "version": "0.0.0",
23690     "filename": "server/api/smsInteraction/index.js",
23691     "groupTitle": "Sms_Interactions"
23692   },
23693   {
23694     "type": "get",
23695     "url": "/api/sms/interactions/describe",
23696     "title": "Gets table info about Interactions",
23697     "examples": [
23698       {
23699         "title": "Example usage:",
23700         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
23701         "type": "json"
23702       }
23703     ],
23704     "name": "DescribeInteractions",
23705     "group": "Sms_Interactions",
23706     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23707     "version": "0.0.0",
23708     "filename": "server/api/smsInteraction/index.js",
23709     "groupTitle": "Sms_Interactions"
23710   },
23711   {
23712     "type": "get",
23713     "url": "/api/sms/interactions",
23714     "title": "Gets a list of Interactions",
23715     "examples": [
23716       {
23717         "title": "Example usage:",
23718         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23719         "type": "json"
23720       }
23721     ],
23722     "name": "GetInteractions",
23723     "group": "Sms_Interactions",
23724     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23725     "version": "0.0.0",
23726     "filename": "server/api/smsInteraction/index.js",
23727     "groupTitle": "Sms_Interactions"
23728   },
23729   {
23730     "type": "delete",
23731     "url": "/api/sms/interactions/{id}/tags",
23732     "title": "Removes tags from interaction",
23733     "examples": [
23734       {
23735         "title": "Example usage:",
23736         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23737         "type": "json"
23738       }
23739     ],
23740     "name": "RemoveTags",
23741     "group": "Sms_Interactions",
23742     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23743     "version": "0.0.0",
23744     "filename": "server/api/smsInteraction/index.js",
23745     "groupTitle": "Sms_Interactions"
23746   },
23747   {
23748     "type": "get",
23749     "url": "/api/sms/interactions/{id}",
23750     "title": "Gets a single Interaction",
23751     "examples": [
23752       {
23753         "title": "Example usage:",
23754         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23755         "type": "json"
23756       }
23757     ],
23758     "name": "ShowInteractions",
23759     "group": "Sms_Interactions",
23760     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23761     "version": "0.0.0",
23762     "filename": "server/api/smsInteraction/index.js",
23763     "groupTitle": "Sms_Interactions"
23764   },
23765   {
23766     "type": "post",
23767     "url": "/api/sms/interactions/{id}/messages",
23768     "title": "Creates new messages",
23769     "examples": [
23770       {
23771         "title": "Example usage:",
23772         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23773         "type": "json"
23774       }
23775     ],
23776     "name": "addMessage",
23777     "group": "Sms_Interactions",
23778     "parameter": {
23779       "fields": {
23780         "Body": [
23781           {
23782             "group": "Body",
23783             "type": "Text",
23784             "optional": false,
23785             "field": "body",
23786             "description": ""
23787           },
23788           {
23789             "group": "Body",
23790             "type": "Boolean",
23791             "optional": true,
23792             "field": "read",
23793             "description": ""
23794           },
23795           {
23796             "group": "Body",
23797             "type": "String",
23798             "allowedValues": [
23799               "\"in\"",
23800               "\"out\""
23801             ],
23802             "optional": false,
23803             "field": "direction",
23804             "description": ""
23805           },
23806           {
23807             "group": "Body",
23808             "type": "String",
23809             "optional": true,
23810             "field": "messageId",
23811             "description": ""
23812           },
23813           {
23814             "group": "Body",
23815             "type": "String",
23816             "optional": true,
23817             "field": "phone",
23818             "description": ""
23819           },
23820           {
23821             "group": "Body",
23822             "type": "String",
23823             "optional": true,
23824             "field": "readAt",
23825             "description": ""
23826           },
23827           {
23828             "group": "Body",
23829             "type": "Boolean",
23830             "optional": true,
23831             "field": "secret",
23832             "description": ""
23833           },
23834           {
23835             "group": "Body",
23836             "type": "String",
23837             "optional": true,
23838             "field": "providerName",
23839             "description": ""
23840           },
23841           {
23842             "group": "Body",
23843             "type": "Text",
23844             "optional": true,
23845             "field": "providerResponse",
23846             "description": ""
23847           }
23848         ]
23849       }
23850     },
23851     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23852     "version": "0.0.0",
23853     "filename": "server/api/smsInteraction/index.js",
23854     "groupTitle": "Sms_Interactions"
23855   },
23856   {
23857     "type": "get",
23858     "url": "/api/sms/interactions/{id}/download",
23859     "title": "Gets interaction",
23860     "examples": [
23861       {
23862         "title": "Example usage:",
23863         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23864         "type": "json"
23865       }
23866     ],
23867     "name": "download",
23868     "group": "Sms_Interactions",
23869     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23870     "version": "0.0.0",
23871     "filename": "server/api/smsInteraction/index.js",
23872     "groupTitle": "Sms_Interactions"
23873   },
23874   {
23875     "type": "get",
23876     "url": "/api/sms/interactions/{id}/messages",
23877     "title": "Gets interaction messages",
23878     "examples": [
23879       {
23880         "title": "Example usage:",
23881         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23882         "type": "json"
23883       }
23884     ],
23885     "name": "getMessages",
23886     "group": "Sms_Interactions",
23887     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23888     "version": "0.0.0",
23889     "filename": "server/api/smsInteraction/index.js",
23890     "groupTitle": "Sms_Interactions"
23891   },
23892   {
23893     "type": "put",
23894     "url": "/api/sms/interactions/{id}",
23895     "title": "Update an existing Interaction",
23896     "examples": [
23897       {
23898         "title": "Example usage:",
23899         "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",
23900         "type": "json"
23901       }
23902     ],
23903     "name": "updateInteractions",
23904     "group": "Sms_Interactions",
23905     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23906     "version": "0.0.0",
23907     "filename": "server/api/smsInteraction/index.js",
23908     "groupTitle": "Sms_Interactions"
23909   },
23910   {
23911     "type": "post",
23912     "url": "/api/sms/messages",
23913     "title": "Creates a new Message",
23914     "examples": [
23915       {
23916         "title": "Example usage:",
23917         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23918         "type": "json"
23919       }
23920     ],
23921     "name": "CreateMessages",
23922     "group": "Sms_Messages",
23923     "parameter": {
23924       "fields": {
23925         "Body": [
23926           {
23927             "group": "Body",
23928             "type": "Text",
23929             "optional": false,
23930             "field": "body",
23931             "description": ""
23932           },
23933           {
23934             "group": "Body",
23935             "type": "Boolean",
23936             "optional": true,
23937             "field": "read",
23938             "description": ""
23939           },
23940           {
23941             "group": "Body",
23942             "type": "String",
23943             "allowedValues": [
23944               "\"in\"",
23945               "\"out\""
23946             ],
23947             "optional": false,
23948             "field": "direction",
23949             "description": ""
23950           },
23951           {
23952             "group": "Body",
23953             "type": "String",
23954             "optional": true,
23955             "field": "messageId",
23956             "description": ""
23957           },
23958           {
23959             "group": "Body",
23960             "type": "String",
23961             "optional": true,
23962             "field": "phone",
23963             "description": ""
23964           },
23965           {
23966             "group": "Body",
23967             "type": "String",
23968             "optional": true,
23969             "field": "readAt",
23970             "description": ""
23971           },
23972           {
23973             "group": "Body",
23974             "type": "Boolean",
23975             "optional": true,
23976             "field": "secret",
23977             "description": ""
23978           },
23979           {
23980             "group": "Body",
23981             "type": "String",
23982             "optional": true,
23983             "field": "providerName",
23984             "description": ""
23985           },
23986           {
23987             "group": "Body",
23988             "type": "Text",
23989             "optional": true,
23990             "field": "providerResponse",
23991             "description": ""
23992           }
23993         ]
23994       }
23995     },
23996     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23997     "version": "0.0.0",
23998     "filename": "server/api/smsMessage/index.js",
23999     "groupTitle": "Sms_Messages"
24000   },
24001   {
24002     "type": "delete",
24003     "url": "/api/sms/messages/{id}",
24004     "title": "Deletes a Message",
24005     "examples": [
24006       {
24007         "title": "Example usage:",
24008         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
24009         "type": "json"
24010       }
24011     ],
24012     "name": "DeleteMessages",
24013     "group": "Sms_Messages",
24014     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24015     "version": "0.0.0",
24016     "filename": "server/api/smsMessage/index.js",
24017     "groupTitle": "Sms_Messages"
24018   },
24019   {
24020     "type": "get",
24021     "url": "/api/sms/messages/describe",
24022     "title": "Gets table info about Messages",
24023     "examples": [
24024       {
24025         "title": "Example usage:",
24026         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
24027         "type": "json"
24028       }
24029     ],
24030     "name": "DescribeMessages",
24031     "group": "Sms_Messages",
24032     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24033     "version": "0.0.0",
24034     "filename": "server/api/smsMessage/index.js",
24035     "groupTitle": "Sms_Messages"
24036   },
24037   {
24038     "type": "get",
24039     "url": "/api/sms/messages",
24040     "title": "Gets a list of Messages",
24041     "examples": [
24042       {
24043         "title": "Example usage:",
24044         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
24045         "type": "json"
24046       }
24047     ],
24048     "name": "GetMessages",
24049     "group": "Sms_Messages",
24050     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24051     "version": "0.0.0",
24052     "filename": "server/api/smsMessage/index.js",
24053     "groupTitle": "Sms_Messages"
24054   },
24055   {
24056     "type": "get",
24057     "url": "/api/sms/messages/{id}",
24058     "title": "Gets a single Message",
24059     "examples": [
24060       {
24061         "title": "Example usage:",
24062         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
24063         "type": "json"
24064       }
24065     ],
24066     "name": "ShowMessages",
24067     "group": "Sms_Messages",
24068     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24069     "version": "0.0.0",
24070     "filename": "server/api/smsMessage/index.js",
24071     "groupTitle": "Sms_Messages"
24072   },
24073   {
24074     "type": "put",
24075     "url": "/api/sms/messages/{id}",
24076     "title": "Update an existing Message",
24077     "examples": [
24078       {
24079         "title": "Example usage:",
24080         "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",
24081         "type": "json"
24082       }
24083     ],
24084     "name": "updateMessages",
24085     "group": "Sms_Messages",
24086     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24087     "version": "0.0.0",
24088     "filename": "server/api/smsMessage/index.js",
24089     "groupTitle": "Sms_Messages"
24090   },
24091   {
24092     "type": "post",
24093     "url": "/api/sms/reports/queue",
24094     "title": "Creates a new Sms Queue Report",
24095     "examples": [
24096       {
24097         "title": "Example usage:",
24098         "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",
24099         "type": "json"
24100       }
24101     ],
24102     "name": "CreateSms_Queue_Reports",
24103     "group": "Sms_Queue_Reports",
24104     "parameter": {
24105       "fields": {
24106         "Body": [
24107           {
24108             "group": "Body",
24109             "type": "String",
24110             "optional": false,
24111             "field": "uniqueid",
24112             "description": ""
24113           },
24114           {
24115             "group": "Body",
24116             "type": "String",
24117             "optional": true,
24118             "field": "from",
24119             "description": ""
24120           },
24121           {
24122             "group": "Body",
24123             "type": "String",
24124             "optional": true,
24125             "field": "joinAt",
24126             "description": ""
24127           },
24128           {
24129             "group": "Body",
24130             "type": "String",
24131             "optional": true,
24132             "field": "leaveAt",
24133             "description": ""
24134           },
24135           {
24136             "group": "Body",
24137             "type": "String",
24138             "optional": true,
24139             "field": "acceptAt",
24140             "description": ""
24141           },
24142           {
24143             "group": "Body",
24144             "type": "String",
24145             "optional": true,
24146             "field": "exitAt",
24147             "description": ""
24148           },
24149           {
24150             "group": "Body",
24151             "type": "String",
24152             "optional": true,
24153             "field": "reason",
24154             "description": ""
24155           }
24156         ]
24157       }
24158     },
24159     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24160     "version": "0.0.0",
24161     "filename": "server/api/smsQueueReport/index.js",
24162     "groupTitle": "Sms_Queue_Reports"
24163   },
24164   {
24165     "type": "delete",
24166     "url": "/api/sms/reports/queue/{id}",
24167     "title": "Deletes a Sms Queue Report",
24168     "examples": [
24169       {
24170         "title": "Example usage:",
24171         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
24172         "type": "json"
24173       }
24174     ],
24175     "name": "DeleteSms_Queue_Reports",
24176     "group": "Sms_Queue_Reports",
24177     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24178     "version": "0.0.0",
24179     "filename": "server/api/smsQueueReport/index.js",
24180     "groupTitle": "Sms_Queue_Reports"
24181   },
24182   {
24183     "type": "get",
24184     "url": "/api/sms/reports/queue/describe",
24185     "title": "Gets table info about Sms Queue Reports",
24186     "examples": [
24187       {
24188         "title": "Example usage:",
24189         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
24190         "type": "json"
24191       }
24192     ],
24193     "name": "DescribeSms_Queue_Reports",
24194     "group": "Sms_Queue_Reports",
24195     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24196     "version": "0.0.0",
24197     "filename": "server/api/smsQueueReport/index.js",
24198     "groupTitle": "Sms_Queue_Reports"
24199   },
24200   {
24201     "type": "get",
24202     "url": "/api/sms/reports/queue",
24203     "title": "Gets a list of Sms Queue Reports",
24204     "examples": [
24205       {
24206         "title": "Example usage:",
24207         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
24208         "type": "json"
24209       }
24210     ],
24211     "name": "GetSms_Queue_Reports",
24212     "group": "Sms_Queue_Reports",
24213     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24214     "version": "0.0.0",
24215     "filename": "server/api/smsQueueReport/index.js",
24216     "groupTitle": "Sms_Queue_Reports"
24217   },
24218   {
24219     "type": "get",
24220     "url": "/api/sms/reports/queue/{id}",
24221     "title": "Gets a single Sms Queue Report",
24222     "examples": [
24223       {
24224         "title": "Example usage:",
24225         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
24226         "type": "json"
24227       }
24228     ],
24229     "name": "ShowSms_Queue_Reports",
24230     "group": "Sms_Queue_Reports",
24231     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24232     "version": "0.0.0",
24233     "filename": "server/api/smsQueueReport/index.js",
24234     "groupTitle": "Sms_Queue_Reports"
24235   },
24236   {
24237     "type": "put",
24238     "url": "/api/sms/reports/queue/{id}",
24239     "title": "Update an existing Sms Queue Report",
24240     "examples": [
24241       {
24242         "title": "Example usage:",
24243         "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",
24244         "type": "json"
24245       }
24246     ],
24247     "name": "updateSms_Queue_Reports",
24248     "group": "Sms_Queue_Reports",
24249     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24250     "version": "0.0.0",
24251     "filename": "server/api/smsQueueReport/index.js",
24252     "groupTitle": "Sms_Queue_Reports"
24253   },
24254   {
24255     "type": "post",
24256     "url": "/api/sms/queues/{id}/users",
24257     "title": "Add agents to a queue",
24258     "examples": [
24259       {
24260         "title": "Example usage:",
24261         "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",
24262         "type": "json"
24263       }
24264     ],
24265     "name": "AddAgents",
24266     "group": "Sms_Queues",
24267     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24268     "version": "0.0.0",
24269     "filename": "server/api/smsQueue/index.js",
24270     "groupTitle": "Sms_Queues"
24271   },
24272   {
24273     "type": "post",
24274     "url": "/api/sms/queues/{id}/teams",
24275     "title": "Add teams to a queue",
24276     "examples": [
24277       {
24278         "title": "Example usage:",
24279         "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",
24280         "type": "json"
24281       }
24282     ],
24283     "name": "AddTeams",
24284     "group": "Sms_Queues",
24285     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24286     "version": "0.0.0",
24287     "filename": "server/api/smsQueue/index.js",
24288     "groupTitle": "Sms_Queues"
24289   },
24290   {
24291     "type": "post",
24292     "url": "/api/sms/queues",
24293     "title": "Creates a new Queue",
24294     "examples": [
24295       {
24296         "title": "Example usage:",
24297         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24298         "type": "json"
24299       }
24300     ],
24301     "name": "CreateQueues",
24302     "group": "Sms_Queues",
24303     "parameter": {
24304       "fields": {
24305         "Body": [
24306           {
24307             "group": "Body",
24308             "type": "String",
24309             "optional": true,
24310             "field": "name",
24311             "description": ""
24312           },
24313           {
24314             "group": "Body",
24315             "type": "String",
24316             "optional": true,
24317             "field": "description",
24318             "description": ""
24319           },
24320           {
24321             "group": "Body",
24322             "type": "Integer",
24323             "optional": true,
24324             "field": "timeout",
24325             "description": ""
24326           },
24327           {
24328             "group": "Body",
24329             "type": "String",
24330             "allowedValues": [
24331               "\"rrmemory\"",
24332               "\"beepall\"",
24333               "\"roundrobin\""
24334             ],
24335             "optional": true,
24336             "field": "strategy",
24337             "description": ""
24338           }
24339         ]
24340       }
24341     },
24342     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24343     "version": "0.0.0",
24344     "filename": "server/api/smsQueue/index.js",
24345     "groupTitle": "Sms_Queues"
24346   },
24347   {
24348     "type": "delete",
24349     "url": "/api/sms/queues/{id}",
24350     "title": "Deletes a Queue",
24351     "examples": [
24352       {
24353         "title": "Example usage:",
24354         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
24355         "type": "json"
24356       }
24357     ],
24358     "name": "DeleteQueues",
24359     "group": "Sms_Queues",
24360     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24361     "version": "0.0.0",
24362     "filename": "server/api/smsQueue/index.js",
24363     "groupTitle": "Sms_Queues"
24364   },
24365   {
24366     "type": "get",
24367     "url": "/api/sms/queues/describe",
24368     "title": "Gets table info about Queues",
24369     "examples": [
24370       {
24371         "title": "Example usage:",
24372         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
24373         "type": "json"
24374       }
24375     ],
24376     "name": "DescribeQueues",
24377     "group": "Sms_Queues",
24378     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24379     "version": "0.0.0",
24380     "filename": "server/api/smsQueue/index.js",
24381     "groupTitle": "Sms_Queues"
24382   },
24383   {
24384     "type": "get",
24385     "url": "/api/sms/queues/{id}/users",
24386     "title": "Gets queue agents",
24387     "examples": [
24388       {
24389         "title": "Example usage:",
24390         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
24391         "type": "json"
24392       }
24393     ],
24394     "name": "GetAgents",
24395     "group": "Sms_Queues",
24396     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24397     "version": "0.0.0",
24398     "filename": "server/api/smsQueue/index.js",
24399     "groupTitle": "Sms_Queues"
24400   },
24401   {
24402     "type": "get",
24403     "url": "/api/sms/queues/{id}/members",
24404     "title": "GetMembers",
24405     "examples": [
24406       {
24407         "title": "Example usage:",
24408         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
24409         "type": "json"
24410       }
24411     ],
24412     "name": "GetMembers",
24413     "group": "Sms_Queues",
24414     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24415     "version": "0.0.0",
24416     "filename": "server/api/smsQueue/index.js",
24417     "groupTitle": "Sms_Queues"
24418   },
24419   {
24420     "type": "get",
24421     "url": "/api/sms/queues",
24422     "title": "Gets a list of Queues",
24423     "examples": [
24424       {
24425         "title": "Example usage:",
24426         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
24427         "type": "json"
24428       }
24429     ],
24430     "name": "GetQueues",
24431     "group": "Sms_Queues",
24432     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24433     "version": "0.0.0",
24434     "filename": "server/api/smsQueue/index.js",
24435     "groupTitle": "Sms_Queues"
24436   },
24437   {
24438     "type": "get",
24439     "url": "/api/sms/queues/{id}/teams",
24440     "title": "Gets queues list",
24441     "examples": [
24442       {
24443         "title": "Example usage:",
24444         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
24445         "type": "json"
24446       }
24447     ],
24448     "name": "GetTeams",
24449     "group": "Sms_Queues",
24450     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24451     "version": "0.0.0",
24452     "filename": "server/api/smsQueue/index.js",
24453     "groupTitle": "Sms_Queues"
24454   },
24455   {
24456     "type": "delete",
24457     "url": "/api/sms/queues/{id}/users",
24458     "title": "Removes agents from a queue",
24459     "examples": [
24460       {
24461         "title": "Example usage:",
24462         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24463         "type": "json"
24464       }
24465     ],
24466     "name": "RemoveAgents",
24467     "group": "Sms_Queues",
24468     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24469     "version": "0.0.0",
24470     "filename": "server/api/smsQueue/index.js",
24471     "groupTitle": "Sms_Queues"
24472   },
24473   {
24474     "type": "get",
24475     "url": "/api/sms/queues/{id}",
24476     "title": "Gets a single Queue",
24477     "examples": [
24478       {
24479         "title": "Example usage:",
24480         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
24481         "type": "json"
24482       }
24483     ],
24484     "name": "ShowQueues",
24485     "group": "Sms_Queues",
24486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24487     "version": "0.0.0",
24488     "filename": "server/api/smsQueue/index.js",
24489     "groupTitle": "Sms_Queues"
24490   },
24491   {
24492     "type": "put",
24493     "url": "/api/sms/queues/{id}",
24494     "title": "Update an existing Queue",
24495     "examples": [
24496       {
24497         "title": "Example usage:",
24498         "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",
24499         "type": "json"
24500       }
24501     ],
24502     "name": "updateQueues",
24503     "group": "Sms_Queues",
24504     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24505     "version": "0.0.0",
24506     "filename": "server/api/smsQueue/index.js",
24507     "groupTitle": "Sms_Queues"
24508   },
24509   {
24510     "type": "post",
24511     "url": "/api/sms/reports/transfer",
24512     "title": "Creates a new Sms Transfer Report",
24513     "examples": [
24514       {
24515         "title": "Example usage:",
24516         "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",
24517         "type": "json"
24518       }
24519     ],
24520     "name": "CreateSms_Transfer_Reports",
24521     "group": "Sms_Transfer_Reports",
24522     "parameter": {
24523       "fields": {
24524         "Body": [
24525           {
24526             "group": "Body",
24527             "type": "String",
24528             "optional": false,
24529             "field": "uniqueid",
24530             "description": ""
24531           },
24532           {
24533             "group": "Body",
24534             "type": "String",
24535             "allowedValues": [
24536               "\"account\"",
24537               "\"agent\"",
24538               "\"queue\""
24539             ],
24540             "optional": false,
24541             "field": "type",
24542             "description": ""
24543           },
24544           {
24545             "group": "Body",
24546             "type": "String",
24547             "optional": false,
24548             "field": "transferredAt",
24549             "description": ""
24550           }
24551         ]
24552       }
24553     },
24554     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24555     "version": "0.0.0",
24556     "filename": "server/api/smsTransferReport/index.js",
24557     "groupTitle": "Sms_Transfer_Reports"
24558   },
24559   {
24560     "type": "delete",
24561     "url": "/api/sms/reports/transfer/{id}",
24562     "title": "Deletes a Sms Transfer Report",
24563     "examples": [
24564       {
24565         "title": "Example usage:",
24566         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
24567         "type": "json"
24568       }
24569     ],
24570     "name": "DeleteSms_Transfer_Reports",
24571     "group": "Sms_Transfer_Reports",
24572     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24573     "version": "0.0.0",
24574     "filename": "server/api/smsTransferReport/index.js",
24575     "groupTitle": "Sms_Transfer_Reports"
24576   },
24577   {
24578     "type": "get",
24579     "url": "/api/sms/reports/transfer/describe",
24580     "title": "Gets table info about Sms Transfer Reports",
24581     "examples": [
24582       {
24583         "title": "Example usage:",
24584         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
24585         "type": "json"
24586       }
24587     ],
24588     "name": "DescribeSms_Transfer_Reports",
24589     "group": "Sms_Transfer_Reports",
24590     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24591     "version": "0.0.0",
24592     "filename": "server/api/smsTransferReport/index.js",
24593     "groupTitle": "Sms_Transfer_Reports"
24594   },
24595   {
24596     "type": "get",
24597     "url": "/api/sms/reports/transfer",
24598     "title": "Gets a list of Sms Transfer Reports",
24599     "examples": [
24600       {
24601         "title": "Example usage:",
24602         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
24603         "type": "json"
24604       }
24605     ],
24606     "name": "GetSms_Transfer_Reports",
24607     "group": "Sms_Transfer_Reports",
24608     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24609     "version": "0.0.0",
24610     "filename": "server/api/smsTransferReport/index.js",
24611     "groupTitle": "Sms_Transfer_Reports"
24612   },
24613   {
24614     "type": "get",
24615     "url": "/api/sms/reports/transfer/{id}",
24616     "title": "Gets a single Sms Transfer Report",
24617     "examples": [
24618       {
24619         "title": "Example usage:",
24620         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
24621         "type": "json"
24622       }
24623     ],
24624     "name": "ShowSms_Transfer_Reports",
24625     "group": "Sms_Transfer_Reports",
24626     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24627     "version": "0.0.0",
24628     "filename": "server/api/smsTransferReport/index.js",
24629     "groupTitle": "Sms_Transfer_Reports"
24630   },
24631   {
24632     "type": "put",
24633     "url": "/api/sms/reports/transfer/{id}",
24634     "title": "Update an existing Sms Transfer Report",
24635     "examples": [
24636       {
24637         "title": "Example usage:",
24638         "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",
24639         "type": "json"
24640       }
24641     ],
24642     "name": "updateSms_Transfer_Reports",
24643     "group": "Sms_Transfer_Reports",
24644     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24645     "version": "0.0.0",
24646     "filename": "server/api/smsTransferReport/index.js",
24647     "groupTitle": "Sms_Transfer_Reports"
24648   },
24649   {
24650     "type": "get",
24651     "url": "/api/sounds",
24652     "title": "Gets a list of Sounds",
24653     "examples": [
24654       {
24655         "title": "Example usage:",
24656         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
24657         "type": "json"
24658       }
24659     ],
24660     "name": "GetSounds",
24661     "group": "Sounds",
24662     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24663     "version": "0.0.0",
24664     "filename": "server/api/sound/index.js",
24665     "groupTitle": "Sounds"
24666   },
24667   {
24668     "type": "get",
24669     "url": "/api/sounds/{id}",
24670     "title": "Gets a single Sound",
24671     "examples": [
24672       {
24673         "title": "Example usage:",
24674         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
24675         "type": "json"
24676       }
24677     ],
24678     "name": "ShowSounds",
24679     "group": "Sounds",
24680     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24681     "version": "0.0.0",
24682     "filename": "server/api/sound/index.js",
24683     "groupTitle": "Sounds"
24684   },
24685   {
24686     "type": "post",
24687     "url": "/api/sounds",
24688     "title": "Create a new sound",
24689     "examples": [
24690       {
24691         "title": "Example usage:",
24692         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
24693         "type": "json"
24694       }
24695     ],
24696     "name": "addSound",
24697     "group": "Sounds",
24698     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24699     "version": "0.0.0",
24700     "filename": "server/api/sound/index.js",
24701     "groupTitle": "Sounds"
24702   },
24703   {
24704     "type": "delete",
24705     "url": "/api/sounds/{id}",
24706     "title": "Deletes a sound",
24707     "examples": [
24708       {
24709         "title": "Example usage:",
24710         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
24711         "type": "json"
24712       }
24713     ],
24714     "name": "destroySound",
24715     "group": "Sounds",
24716     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24717     "version": "0.0.0",
24718     "filename": "server/api/sound/index.js",
24719     "groupTitle": "Sounds"
24720   },
24721   {
24722     "type": "get",
24723     "url": "/api/sounds/{id}/download",
24724     "title": "Download Sound",
24725     "examples": [
24726       {
24727         "title": "Example usage:",
24728         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
24729         "type": "json"
24730       }
24731     ],
24732     "name": "download",
24733     "group": "Sounds",
24734     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24735     "version": "0.0.0",
24736     "filename": "server/api/sound/index.js",
24737     "groupTitle": "Sounds"
24738   },
24739   {
24740     "type": "put",
24741     "url": "/api/sounds",
24742     "title": "Update an existing new sound",
24743     "examples": [
24744       {
24745         "title": "Example usage:",
24746         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24747         "type": "json"
24748       }
24749     ],
24750     "name": "updateSound",
24751     "group": "Sounds",
24752     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24753     "version": "0.0.0",
24754     "filename": "server/api/sound/index.js",
24755     "groupTitle": "Sounds"
24756   },
24757   {
24758     "type": "post",
24759     "url": "/api/square/details/reports",
24760     "title": "Creates a new Square Detail Report",
24761     "examples": [
24762       {
24763         "title": "Example usage:",
24764         "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",
24765         "type": "json"
24766       }
24767     ],
24768     "name": "CreateSquare_Detail_Reports",
24769     "group": "Square_Details_Reports",
24770     "parameter": {
24771       "fields": {
24772         "Body": [
24773           {
24774             "group": "Body",
24775             "type": "String",
24776             "optional": true,
24777             "field": "uniqueid",
24778             "description": ""
24779           },
24780           {
24781             "group": "Body",
24782             "type": "String",
24783             "optional": true,
24784             "field": "node",
24785             "description": ""
24786           },
24787           {
24788             "group": "Body",
24789             "type": "String",
24790             "optional": true,
24791             "field": "application",
24792             "description": ""
24793           },
24794           {
24795             "group": "Body",
24796             "type": "Text",
24797             "optional": true,
24798             "field": "data",
24799             "description": ""
24800           },
24801           {
24802             "group": "Body",
24803             "type": "String",
24804             "optional": true,
24805             "field": "project_name",
24806             "description": ""
24807           },
24808           {
24809             "group": "Body",
24810             "type": "String",
24811             "optional": true,
24812             "field": "callerid",
24813             "description": ""
24814           }
24815         ]
24816       }
24817     },
24818     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24819     "version": "0.0.0",
24820     "filename": "server/api/squareReportDetail/index.js",
24821     "groupTitle": "Square_Details_Reports"
24822   },
24823   {
24824     "type": "delete",
24825     "url": "/api/square/details/reports/{id}",
24826     "title": "Deletes a Square Detail Report",
24827     "examples": [
24828       {
24829         "title": "Example usage:",
24830         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24831         "type": "json"
24832       }
24833     ],
24834     "name": "DeleteSquare_Detail_Reports",
24835     "group": "Square_Details_Reports",
24836     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24837     "version": "0.0.0",
24838     "filename": "server/api/squareReportDetail/index.js",
24839     "groupTitle": "Square_Details_Reports"
24840   },
24841   {
24842     "type": "get",
24843     "url": "/api/square/details/reports/describe",
24844     "title": "Gets table info about Square Detail Reports",
24845     "examples": [
24846       {
24847         "title": "Example usage:",
24848         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24849         "type": "json"
24850       }
24851     ],
24852     "name": "DescribeSquare_Detail_Reports",
24853     "group": "Square_Details_Reports",
24854     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24855     "version": "0.0.0",
24856     "filename": "server/api/squareReportDetail/index.js",
24857     "groupTitle": "Square_Details_Reports"
24858   },
24859   {
24860     "type": "get",
24861     "url": "/api/square/details/reports",
24862     "title": "Gets a list of Square Detail Reports",
24863     "examples": [
24864       {
24865         "title": "Example usage:",
24866         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24867         "type": "json"
24868       }
24869     ],
24870     "name": "GetSquare_Detail_Reports",
24871     "group": "Square_Details_Reports",
24872     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24873     "version": "0.0.0",
24874     "filename": "server/api/squareReportDetail/index.js",
24875     "groupTitle": "Square_Details_Reports"
24876   },
24877   {
24878     "type": "get",
24879     "url": "/api/square/details/reports/{id}",
24880     "title": "Gets a single Square Detail Report",
24881     "examples": [
24882       {
24883         "title": "Example usage:",
24884         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24885         "type": "json"
24886       }
24887     ],
24888     "name": "ShowSquare_Detail_Reports",
24889     "group": "Square_Details_Reports",
24890     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24891     "version": "0.0.0",
24892     "filename": "server/api/squareReportDetail/index.js",
24893     "groupTitle": "Square_Details_Reports"
24894   },
24895   {
24896     "type": "put",
24897     "url": "/api/square/details/reports/{id}",
24898     "title": "Update an existing Square Detail Report",
24899     "examples": [
24900       {
24901         "title": "Example usage:",
24902         "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",
24903         "type": "json"
24904       }
24905     ],
24906     "name": "updateSquare_Detail_Reports",
24907     "group": "Square_Details_Reports",
24908     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24909     "version": "0.0.0",
24910     "filename": "server/api/squareReportDetail/index.js",
24911     "groupTitle": "Square_Details_Reports"
24912   },
24913   {
24914     "type": "post",
24915     "url": "/api/square/messages",
24916     "title": "Creates a new Message",
24917     "examples": [
24918       {
24919         "title": "Example usage:",
24920         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24921         "type": "json"
24922       }
24923     ],
24924     "name": "CreateMessages",
24925     "group": "Square_Messages",
24926     "parameter": {
24927       "fields": {
24928         "Body": [
24929           {
24930             "group": "Body",
24931             "type": "String",
24932             "optional": true,
24933             "field": "uniqueid",
24934             "description": ""
24935           },
24936           {
24937             "group": "Body",
24938             "type": "Text",
24939             "optional": false,
24940             "field": "body",
24941             "description": ""
24942           },
24943           {
24944             "group": "Body",
24945             "type": "String",
24946             "allowedValues": [
24947               "\"in\"",
24948               "\"out\""
24949             ],
24950             "optional": false,
24951             "field": "direction",
24952             "description": ""
24953           },
24954           {
24955             "group": "Body",
24956             "type": "String",
24957             "optional": true,
24958             "field": "providerName",
24959             "description": ""
24960           },
24961           {
24962             "group": "Body",
24963             "type": "Text",
24964             "optional": true,
24965             "field": "providerResponse",
24966             "description": ""
24967           }
24968         ]
24969       }
24970     },
24971     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24972     "version": "0.0.0",
24973     "filename": "server/api/squareMessage/index.js",
24974     "groupTitle": "Square_Messages"
24975   },
24976   {
24977     "type": "delete",
24978     "url": "/api/square/messages/{id}",
24979     "title": "Deletes a Message",
24980     "examples": [
24981       {
24982         "title": "Example usage:",
24983         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24984         "type": "json"
24985       }
24986     ],
24987     "name": "DeleteMessages",
24988     "group": "Square_Messages",
24989     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24990     "version": "0.0.0",
24991     "filename": "server/api/squareMessage/index.js",
24992     "groupTitle": "Square_Messages"
24993   },
24994   {
24995     "type": "get",
24996     "url": "/api/square/messages",
24997     "title": "Gets a list of Messages",
24998     "examples": [
24999       {
25000         "title": "Example usage:",
25001         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
25002         "type": "json"
25003       }
25004     ],
25005     "name": "GetMessages",
25006     "group": "Square_Messages",
25007     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25008     "version": "0.0.0",
25009     "filename": "server/api/squareMessage/index.js",
25010     "groupTitle": "Square_Messages"
25011   },
25012   {
25013     "type": "get",
25014     "url": "/api/square/messages/{id}",
25015     "title": "Gets a single Message",
25016     "examples": [
25017       {
25018         "title": "Example usage:",
25019         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
25020         "type": "json"
25021       }
25022     ],
25023     "name": "ShowMessages",
25024     "group": "Square_Messages",
25025     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25026     "version": "0.0.0",
25027     "filename": "server/api/squareMessage/index.js",
25028     "groupTitle": "Square_Messages"
25029   },
25030   {
25031     "type": "put",
25032     "url": "/api/square/messages/{id}",
25033     "title": "Update an existing Message",
25034     "examples": [
25035       {
25036         "title": "Example usage:",
25037         "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",
25038         "type": "json"
25039       }
25040     ],
25041     "name": "updateMessages",
25042     "group": "Square_Messages",
25043     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25044     "version": "0.0.0",
25045     "filename": "server/api/squareMessage/index.js",
25046     "groupTitle": "Square_Messages"
25047   },
25048   {
25049     "type": "post",
25050     "url": "/api/square/odbc",
25051     "title": "Creates a new ODBC",
25052     "examples": [
25053       {
25054         "title": "Example usage:",
25055         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25056         "type": "json"
25057       }
25058     ],
25059     "name": "CreateODBCs",
25060     "group": "Square_ODBC",
25061     "parameter": {
25062       "fields": {
25063         "Body": [
25064           {
25065             "group": "Body",
25066             "type": "String",
25067             "optional": false,
25068             "field": "name",
25069             "description": ""
25070           },
25071           {
25072             "group": "Body",
25073             "type": "String",
25074             "optional": true,
25075             "field": "dsn",
25076             "description": ""
25077           },
25078           {
25079             "group": "Body",
25080             "type": "String",
25081             "optional": true,
25082             "field": "description",
25083             "description": ""
25084           }
25085         ]
25086       }
25087     },
25088     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25089     "version": "0.0.0",
25090     "filename": "server/api/squareOdbc/index.js",
25091     "groupTitle": "Square_ODBC"
25092   },
25093   {
25094     "type": "delete",
25095     "url": "/api/square/odbc/{id}",
25096     "title": "Deletes a ODBC",
25097     "examples": [
25098       {
25099         "title": "Example usage:",
25100         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
25101         "type": "json"
25102       }
25103     ],
25104     "name": "DeleteODBCs",
25105     "group": "Square_ODBC",
25106     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25107     "version": "0.0.0",
25108     "filename": "server/api/squareOdbc/index.js",
25109     "groupTitle": "Square_ODBC"
25110   },
25111   {
25112     "type": "get",
25113     "url": "/api/square/odbc",
25114     "title": "Gets a list of ODBCs",
25115     "examples": [
25116       {
25117         "title": "Example usage:",
25118         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
25119         "type": "json"
25120       }
25121     ],
25122     "name": "GetODBCs",
25123     "group": "Square_ODBC",
25124     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25125     "version": "0.0.0",
25126     "filename": "server/api/squareOdbc/index.js",
25127     "groupTitle": "Square_ODBC"
25128   },
25129   {
25130     "type": "get",
25131     "url": "/api/square/odbc/{id}",
25132     "title": "Gets a single ODBC",
25133     "examples": [
25134       {
25135         "title": "Example usage:",
25136         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
25137         "type": "json"
25138       }
25139     ],
25140     "name": "ShowODBCs",
25141     "group": "Square_ODBC",
25142     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25143     "version": "0.0.0",
25144     "filename": "server/api/squareOdbc/index.js",
25145     "groupTitle": "Square_ODBC"
25146   },
25147   {
25148     "type": "get",
25149     "url": "/api/square/odbc/{id}/test",
25150     "title": "Test Odbc",
25151     "examples": [
25152       {
25153         "title": "Example usage:",
25154         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
25155         "type": "json"
25156       }
25157     ],
25158     "name": "test",
25159     "group": "Square_ODBC",
25160     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25161     "version": "0.0.0",
25162     "filename": "server/api/squareOdbc/index.js",
25163     "groupTitle": "Square_ODBC"
25164   },
25165   {
25166     "type": "put",
25167     "url": "/api/square/odbc/{id}",
25168     "title": "Update an existing ODBC",
25169     "examples": [
25170       {
25171         "title": "Example usage:",
25172         "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",
25173         "type": "json"
25174       }
25175     ],
25176     "name": "updateODBCs",
25177     "group": "Square_ODBC",
25178     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25179     "version": "0.0.0",
25180     "filename": "server/api/squareOdbc/index.js",
25181     "groupTitle": "Square_ODBC"
25182   },
25183   {
25184     "type": "post",
25185     "url": "/api/square/projects",
25186     "title": "Creates a new Project",
25187     "examples": [
25188       {
25189         "title": "Example usage:",
25190         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25191         "type": "json"
25192       }
25193     ],
25194     "name": "CreateProjects",
25195     "group": "Square_Projects",
25196     "parameter": {
25197       "fields": {
25198         "Body": [
25199           {
25200             "group": "Body",
25201             "type": "String",
25202             "optional": false,
25203             "field": "name",
25204             "description": ""
25205           },
25206           {
25207             "group": "Body",
25208             "type": "String",
25209             "optional": true,
25210             "field": "description",
25211             "description": ""
25212           },
25213           {
25214             "group": "Body",
25215             "type": "Text",
25216             "optional": true,
25217             "field": "notes",
25218             "description": ""
25219           },
25220           {
25221             "group": "Body",
25222             "type": "Blob",
25223             "optional": true,
25224             "field": "preproduction",
25225             "description": ""
25226           },
25227           {
25228             "group": "Body",
25229             "type": "Blob",
25230             "optional": true,
25231             "field": "production",
25232             "description": ""
25233           },
25234           {
25235             "group": "Body",
25236             "type": "String",
25237             "optional": true,
25238             "field": "savedAt",
25239             "description": ""
25240           },
25241           {
25242             "group": "Body",
25243             "type": "String",
25244             "optional": true,
25245             "field": "publishedAt",
25246             "description": ""
25247           }
25248         ]
25249       }
25250     },
25251     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25252     "version": "0.0.0",
25253     "filename": "server/api/squareProject/index.js",
25254     "groupTitle": "Square_Projects"
25255   },
25256   {
25257     "type": "delete",
25258     "url": "/api/square/projects/{id}",
25259     "title": "Deletes a Project",
25260     "examples": [
25261       {
25262         "title": "Example usage:",
25263         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
25264         "type": "json"
25265       }
25266     ],
25267     "name": "DeleteProjects",
25268     "group": "Square_Projects",
25269     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25270     "version": "0.0.0",
25271     "filename": "server/api/squareProject/index.js",
25272     "groupTitle": "Square_Projects"
25273   },
25274   {
25275     "type": "get",
25276     "url": "/api/square/projects",
25277     "title": "Gets a list of Projects",
25278     "examples": [
25279       {
25280         "title": "Example usage:",
25281         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
25282         "type": "json"
25283       }
25284     ],
25285     "name": "GetProjects",
25286     "group": "Square_Projects",
25287     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25288     "version": "0.0.0",
25289     "filename": "server/api/squareProject/index.js",
25290     "groupTitle": "Square_Projects"
25291   },
25292   {
25293     "type": "get",
25294     "url": "/api/square/projects/{id}",
25295     "title": "Gets a single Project",
25296     "examples": [
25297       {
25298         "title": "Example usage:",
25299         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
25300         "type": "json"
25301       }
25302     ],
25303     "name": "ShowProjects",
25304     "group": "Square_Projects",
25305     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25306     "version": "0.0.0",
25307     "filename": "server/api/squareProject/index.js",
25308     "groupTitle": "Square_Projects"
25309   },
25310   {
25311     "type": "post",
25312     "url": "/api/square/projects/{id}/users",
25313     "title": "Adds user permissions to a Project",
25314     "examples": [
25315       {
25316         "title": "Example usage:",
25317         "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",
25318         "type": "json"
25319       }
25320     ],
25321     "name": "addUsers",
25322     "group": "Square_Projects",
25323     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25324     "version": "0.0.0",
25325     "filename": "server/api/squareProject/index.js",
25326     "groupTitle": "Square_Projects"
25327   },
25328   {
25329     "type": "get",
25330     "url": "/api/square/projects/{id}/users",
25331     "title": "Gets users permissions from Project",
25332     "examples": [
25333       {
25334         "title": "Example usage:",
25335         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
25336         "type": "json"
25337       }
25338     ],
25339     "name": "getUsers",
25340     "group": "Square_Projects",
25341     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25342     "version": "0.0.0",
25343     "filename": "server/api/squareProject/index.js",
25344     "groupTitle": "Square_Projects"
25345   },
25346   {
25347     "type": "delete",
25348     "url": "/api/square/projects/{id}/users",
25349     "title": "Removes user permissions from a Project",
25350     "examples": [
25351       {
25352         "title": "Example usage:",
25353         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25354         "type": "json"
25355       }
25356     ],
25357     "name": "removeUsers",
25358     "group": "Square_Projects",
25359     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25360     "version": "0.0.0",
25361     "filename": "server/api/squareProject/index.js",
25362     "groupTitle": "Square_Projects"
25363   },
25364   {
25365     "type": "put",
25366     "url": "/api/square/projects/{id}",
25367     "title": "Update an existing Project",
25368     "examples": [
25369       {
25370         "title": "Example usage:",
25371         "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",
25372         "type": "json"
25373       }
25374     ],
25375     "name": "updateProjects",
25376     "group": "Square_Projects",
25377     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25378     "version": "0.0.0",
25379     "filename": "server/api/squareProject/index.js",
25380     "groupTitle": "Square_Projects"
25381   },
25382   {
25383     "type": "post",
25384     "url": "/api/square/recordings",
25385     "title": "Creates a new Recording",
25386     "examples": [
25387       {
25388         "title": "Example usage:",
25389         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25390         "type": "json"
25391       }
25392     ],
25393     "name": "CreateRecordings",
25394     "group": "Square_Recordings",
25395     "parameter": {
25396       "fields": {
25397         "Body": [
25398           {
25399             "group": "Body",
25400             "type": "String",
25401             "optional": true,
25402             "field": "uniqueid",
25403             "description": ""
25404           },
25405           {
25406             "group": "Body",
25407             "type": "String",
25408             "optional": true,
25409             "field": "callerid",
25410             "description": ""
25411           },
25412           {
25413             "group": "Body",
25414             "type": "String",
25415             "optional": true,
25416             "field": "calleridname",
25417             "description": ""
25418           },
25419           {
25420             "group": "Body",
25421             "type": "String",
25422             "optional": true,
25423             "field": "context",
25424             "description": ""
25425           },
25426           {
25427             "group": "Body",
25428             "type": "String",
25429             "optional": true,
25430             "field": "extension",
25431             "description": ""
25432           },
25433           {
25434             "group": "Body",
25435             "type": "String",
25436             "optional": true,
25437             "field": "priority",
25438             "description": ""
25439           },
25440           {
25441             "group": "Body",
25442             "type": "String",
25443             "optional": true,
25444             "field": "accountcode",
25445             "description": ""
25446           },
25447           {
25448             "group": "Body",
25449             "type": "String",
25450             "optional": true,
25451             "field": "dnid",
25452             "description": ""
25453           },
25454           {
25455             "group": "Body",
25456             "type": "String",
25457             "optional": true,
25458             "field": "projectName",
25459             "description": ""
25460           },
25461           {
25462             "group": "Body",
25463             "type": "String",
25464             "optional": true,
25465             "field": "saveName",
25466             "description": ""
25467           },
25468           {
25469             "group": "Body",
25470             "type": "String",
25471             "optional": true,
25472             "field": "filename",
25473             "description": ""
25474           },
25475           {
25476             "group": "Body",
25477             "type": "String",
25478             "optional": true,
25479             "field": "savePath",
25480             "description": ""
25481           },
25482           {
25483             "group": "Body",
25484             "type": "Virtual",
25485             "optional": true,
25486             "field": "format",
25487             "description": ""
25488           }
25489         ]
25490       }
25491     },
25492     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25493     "version": "0.0.0",
25494     "filename": "server/api/squareRecording/index.js",
25495     "groupTitle": "Square_Recordings"
25496   },
25497   {
25498     "type": "get",
25499     "url": "/api/square/recordings",
25500     "title": "Gets a list of Recordings",
25501     "examples": [
25502       {
25503         "title": "Example usage:",
25504         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
25505         "type": "json"
25506       }
25507     ],
25508     "name": "GetRecordings",
25509     "group": "Square_Recordings",
25510     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25511     "version": "0.0.0",
25512     "filename": "server/api/squareRecording/index.js",
25513     "groupTitle": "Square_Recordings"
25514   },
25515   {
25516     "type": "get",
25517     "url": "/api/square/recordings/{id}",
25518     "title": "Gets a single Recording",
25519     "examples": [
25520       {
25521         "title": "Example usage:",
25522         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
25523         "type": "json"
25524       }
25525     ],
25526     "name": "ShowRecordings",
25527     "group": "Square_Recordings",
25528     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25529     "version": "0.0.0",
25530     "filename": "server/api/squareRecording/index.js",
25531     "groupTitle": "Square_Recordings"
25532   },
25533   {
25534     "type": "delete",
25535     "url": "/api/square/recordings/{id}",
25536     "title": "Delete recording",
25537     "examples": [
25538       {
25539         "title": "Example usage:",
25540         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password} -X DELETE",
25541         "type": "json"
25542       }
25543     ],
25544     "name": "destroy",
25545     "group": "Square_Recordings",
25546     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25547     "version": "0.0.0",
25548     "filename": "server/api/squareRecording/index.js",
25549     "groupTitle": "Square_Recordings"
25550   },
25551   {
25552     "type": "get",
25553     "url": "/api/square/recordings/{id}/download",
25554     "title": "Download Recording",
25555     "examples": [
25556       {
25557         "title": "Example usage:",
25558         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
25559         "type": "json"
25560       }
25561     ],
25562     "name": "download",
25563     "group": "Square_Recordings",
25564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25565     "version": "0.0.0",
25566     "filename": "server/api/squareRecording/index.js",
25567     "groupTitle": "Square_Recordings"
25568   },
25569   {
25570     "type": "put",
25571     "url": "/api/square/recordings/{id}",
25572     "title": "Update an existing Recording",
25573     "examples": [
25574       {
25575         "title": "Example usage:",
25576         "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",
25577         "type": "json"
25578       }
25579     ],
25580     "name": "updateRecordings",
25581     "group": "Square_Recordings",
25582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25583     "version": "0.0.0",
25584     "filename": "server/api/squareRecording/index.js",
25585     "groupTitle": "Square_Recordings"
25586   },
25587   {
25588     "type": "post",
25589     "url": "/api/square/reports",
25590     "title": "Creates a new Square Report",
25591     "examples": [
25592       {
25593         "title": "Example usage:",
25594         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25595         "type": "json"
25596       }
25597     ],
25598     "name": "CreateSquare_Reports",
25599     "group": "Square_Reports",
25600     "parameter": {
25601       "fields": {
25602         "Body": [
25603           {
25604             "group": "Body",
25605             "type": "String",
25606             "optional": true,
25607             "field": "network",
25608             "description": ""
25609           },
25610           {
25611             "group": "Body",
25612             "type": "String",
25613             "optional": true,
25614             "field": "network_script",
25615             "description": ""
25616           },
25617           {
25618             "group": "Body",
25619             "type": "String",
25620             "optional": true,
25621             "field": "request",
25622             "description": ""
25623           },
25624           {
25625             "group": "Body",
25626             "type": "String",
25627             "optional": true,
25628             "field": "channel",
25629             "description": ""
25630           },
25631           {
25632             "group": "Body",
25633             "type": "String",
25634             "optional": true,
25635             "field": "language",
25636             "description": ""
25637           },
25638           {
25639             "group": "Body",
25640             "type": "String",
25641             "optional": true,
25642             "field": "type",
25643             "description": ""
25644           },
25645           {
25646             "group": "Body",
25647             "type": "String",
25648             "optional": true,
25649             "field": "uniqueid",
25650             "description": ""
25651           },
25652           {
25653             "group": "Body",
25654             "type": "String",
25655             "optional": true,
25656             "field": "version",
25657             "description": ""
25658           },
25659           {
25660             "group": "Body",
25661             "type": "String",
25662             "optional": true,
25663             "field": "callerid",
25664             "description": ""
25665           },
25666           {
25667             "group": "Body",
25668             "type": "String",
25669             "optional": true,
25670             "field": "calleridname",
25671             "description": ""
25672           },
25673           {
25674             "group": "Body",
25675             "type": "String",
25676             "optional": true,
25677             "field": "callingpres",
25678             "description": ""
25679           },
25680           {
25681             "group": "Body",
25682             "type": "String",
25683             "optional": true,
25684             "field": "callingani2",
25685             "description": ""
25686           },
25687           {
25688             "group": "Body",
25689             "type": "String",
25690             "optional": true,
25691             "field": "callington",
25692             "description": ""
25693           },
25694           {
25695             "group": "Body",
25696             "type": "String",
25697             "optional": true,
25698             "field": "callingtns",
25699             "description": ""
25700           },
25701           {
25702             "group": "Body",
25703             "type": "String",
25704             "optional": true,
25705             "field": "dnid",
25706             "description": ""
25707           },
25708           {
25709             "group": "Body",
25710             "type": "String",
25711             "optional": true,
25712             "field": "rdnis",
25713             "description": ""
25714           },
25715           {
25716             "group": "Body",
25717             "type": "String",
25718             "optional": true,
25719             "field": "context",
25720             "description": ""
25721           },
25722           {
25723             "group": "Body",
25724             "type": "String",
25725             "optional": true,
25726             "field": "extension",
25727             "description": ""
25728           },
25729           {
25730             "group": "Body",
25731             "type": "String",
25732             "optional": true,
25733             "field": "priority",
25734             "description": ""
25735           },
25736           {
25737             "group": "Body",
25738             "type": "String",
25739             "optional": true,
25740             "field": "enhanced",
25741             "description": ""
25742           },
25743           {
25744             "group": "Body",
25745             "type": "String",
25746             "optional": true,
25747             "field": "accountcode",
25748             "description": ""
25749           },
25750           {
25751             "group": "Body",
25752             "type": "String",
25753             "optional": true,
25754             "field": "threadid",
25755             "description": ""
25756           },
25757           {
25758             "group": "Body",
25759             "type": "String",
25760             "optional": true,
25761             "field": "project_name",
25762             "description": ""
25763           },
25764           {
25765             "group": "Body",
25766             "type": "String",
25767             "optional": true,
25768             "field": "joinAt",
25769             "description": ""
25770           },
25771           {
25772             "group": "Body",
25773             "type": "String",
25774             "optional": true,
25775             "field": "leaveAt",
25776             "description": ""
25777           },
25778           {
25779             "group": "Body",
25780             "type": "Boolean",
25781             "optional": true,
25782             "field": "bot",
25783             "description": ""
25784           }
25785         ]
25786       }
25787     },
25788     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25789     "version": "0.0.0",
25790     "filename": "server/api/squareReport/index.js",
25791     "groupTitle": "Square_Reports"
25792   },
25793   {
25794     "type": "delete",
25795     "url": "/api/square/reports/{id}",
25796     "title": "Deletes a Square Report",
25797     "examples": [
25798       {
25799         "title": "Example usage:",
25800         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25801         "type": "json"
25802       }
25803     ],
25804     "name": "DeleteSquare_Reports",
25805     "group": "Square_Reports",
25806     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25807     "version": "0.0.0",
25808     "filename": "server/api/squareReport/index.js",
25809     "groupTitle": "Square_Reports"
25810   },
25811   {
25812     "type": "get",
25813     "url": "/api/square/reports/describe",
25814     "title": "Gets table info about Square Reports",
25815     "examples": [
25816       {
25817         "title": "Example usage:",
25818         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25819         "type": "json"
25820       }
25821     ],
25822     "name": "DescribeSquare_Reports",
25823     "group": "Square_Reports",
25824     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25825     "version": "0.0.0",
25826     "filename": "server/api/squareReport/index.js",
25827     "groupTitle": "Square_Reports"
25828   },
25829   {
25830     "type": "get",
25831     "url": "/api/square/reports",
25832     "title": "Gets a list of Square Reports",
25833     "examples": [
25834       {
25835         "title": "Example usage:",
25836         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25837         "type": "json"
25838       }
25839     ],
25840     "name": "GetSquare_Reports",
25841     "group": "Square_Reports",
25842     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25843     "version": "0.0.0",
25844     "filename": "server/api/squareReport/index.js",
25845     "groupTitle": "Square_Reports"
25846   },
25847   {
25848     "type": "get",
25849     "url": "/api/square/reports/{id}",
25850     "title": "Gets a single Square Report",
25851     "examples": [
25852       {
25853         "title": "Example usage:",
25854         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25855         "type": "json"
25856       }
25857     ],
25858     "name": "ShowSquare_Reports",
25859     "group": "Square_Reports",
25860     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25861     "version": "0.0.0",
25862     "filename": "server/api/squareReport/index.js",
25863     "groupTitle": "Square_Reports"
25864   },
25865   {
25866     "type": "put",
25867     "url": "/api/square/reports/{id}",
25868     "title": "Update an existing Square Report",
25869     "examples": [
25870       {
25871         "title": "Example usage:",
25872         "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",
25873         "type": "json"
25874       }
25875     ],
25876     "name": "updateSquare_Reports",
25877     "group": "Square_Reports",
25878     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25879     "version": "0.0.0",
25880     "filename": "server/api/squareReport/index.js",
25881     "groupTitle": "Square_Reports"
25882   },
25883   {
25884     "type": "post",
25885     "url": "/api/integrations/sugarcrm/configurations",
25886     "title": "Creates a new SugarCRM Configuration",
25887     "examples": [
25888       {
25889         "title": "Example usage:",
25890         "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",
25891         "type": "json"
25892       }
25893     ],
25894     "name": "CreateSugarCRM_Configurations",
25895     "group": "SugarCRM_Configurations",
25896     "parameter": {
25897       "fields": {
25898         "Body": [
25899           {
25900             "group": "Body",
25901             "type": "String",
25902             "optional": true,
25903             "field": "name",
25904             "description": ""
25905           },
25906           {
25907             "group": "Body",
25908             "type": "String",
25909             "optional": true,
25910             "field": "description",
25911             "description": ""
25912           }
25913         ]
25914       }
25915     },
25916     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25917     "version": "0.0.0",
25918     "filename": "server/api/intSugarcrmConfiguration/index.js",
25919     "groupTitle": "SugarCRM_Configurations"
25920   },
25921   {
25922     "type": "delete",
25923     "url": "/api/integrations/sugarcrm/configurations/{id}",
25924     "title": "Deletes a SugarCRM Configuration",
25925     "examples": [
25926       {
25927         "title": "Example usage:",
25928         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25929         "type": "json"
25930       }
25931     ],
25932     "name": "DeleteSugarCRM_Configurations",
25933     "group": "SugarCRM_Configurations",
25934     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25935     "version": "0.0.0",
25936     "filename": "server/api/intSugarcrmConfiguration/index.js",
25937     "groupTitle": "SugarCRM_Configurations"
25938   },
25939   {
25940     "type": "get",
25941     "url": "/api/integrations/sugarcrm/configurations",
25942     "title": "Gets a list of SugarCRM Configurations",
25943     "examples": [
25944       {
25945         "title": "Example usage:",
25946         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25947         "type": "json"
25948       }
25949     ],
25950     "name": "GetSugarCRM_Configurations",
25951     "group": "SugarCRM_Configurations",
25952     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25953     "version": "0.0.0",
25954     "filename": "server/api/intSugarcrmConfiguration/index.js",
25955     "groupTitle": "SugarCRM_Configurations"
25956   },
25957   {
25958     "type": "get",
25959     "url": "/api/integrations/sugarcrm/configurations/{id}",
25960     "title": "Gets a single SugarCRM Configuration",
25961     "examples": [
25962       {
25963         "title": "Example usage:",
25964         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25965         "type": "json"
25966       }
25967     ],
25968     "name": "ShowSugarCRM_Configurations",
25969     "group": "SugarCRM_Configurations",
25970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25971     "version": "0.0.0",
25972     "filename": "server/api/intSugarcrmConfiguration/index.js",
25973     "groupTitle": "SugarCRM_Configurations"
25974   },
25975   {
25976     "type": "put",
25977     "url": "/api/integrations/sugarcrm/configurations/{id}",
25978     "title": "Update an existing SugarCRM Configuration",
25979     "examples": [
25980       {
25981         "title": "Example usage:",
25982         "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",
25983         "type": "json"
25984       }
25985     ],
25986     "name": "updateSugarCRM_Configurations",
25987     "group": "SugarCRM_Configurations",
25988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25989     "version": "0.0.0",
25990     "filename": "server/api/intSugarcrmConfiguration/index.js",
25991     "groupTitle": "SugarCRM_Configurations"
25992   },
25993   {
25994     "type": "post",
25995     "url": "/api/integrations/sugarcrm/accounts",
25996     "title": "Creates a new Sugarcrm Account",
25997     "examples": [
25998       {
25999         "title": "Example usage:",
26000         "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",
26001         "type": "json"
26002       }
26003     ],
26004     "name": "CreateSugarcrm_Accounts",
26005     "group": "Sugarcrm_Accounts",
26006     "parameter": {
26007       "fields": {
26008         "Body": [
26009           {
26010             "group": "Body",
26011             "type": "String",
26012             "optional": true,
26013             "field": "name",
26014             "description": ""
26015           },
26016           {
26017             "group": "Body",
26018             "type": "String",
26019             "optional": true,
26020             "field": "description",
26021             "description": ""
26022           },
26023           {
26024             "group": "Body",
26025             "type": "String",
26026             "optional": true,
26027             "field": "username",
26028             "description": ""
26029           },
26030           {
26031             "group": "Body",
26032             "type": "String",
26033             "optional": true,
26034             "field": "password",
26035             "description": ""
26036           },
26037           {
26038             "group": "Body",
26039             "type": "String",
26040             "optional": true,
26041             "field": "remoteUri",
26042             "description": ""
26043           },
26044           {
26045             "group": "Body",
26046             "type": "String",
26047             "optional": false,
26048             "field": "serverUrl",
26049             "description": ""
26050           }
26051         ]
26052       }
26053     },
26054     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26055     "version": "0.0.0",
26056     "filename": "server/api/intSugarcrmAccount/index.js",
26057     "groupTitle": "Sugarcrm_Accounts"
26058   },
26059   {
26060     "type": "delete",
26061     "url": "/api/integrations/sugarcrm/accounts/{id}",
26062     "title": "Deletes a Sugarcrm Account",
26063     "examples": [
26064       {
26065         "title": "Example usage:",
26066         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
26067         "type": "json"
26068       }
26069     ],
26070     "name": "DeleteSugarcrm_Accounts",
26071     "group": "Sugarcrm_Accounts",
26072     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26073     "version": "0.0.0",
26074     "filename": "server/api/intSugarcrmAccount/index.js",
26075     "groupTitle": "Sugarcrm_Accounts"
26076   },
26077   {
26078     "type": "get",
26079     "url": "/api/integrations/sugarcrm/accounts",
26080     "title": "Gets a list of Sugarcrm Accounts",
26081     "examples": [
26082       {
26083         "title": "Example usage:",
26084         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
26085         "type": "json"
26086       }
26087     ],
26088     "name": "GetSugarcrm_Accounts",
26089     "group": "Sugarcrm_Accounts",
26090     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26091     "version": "0.0.0",
26092     "filename": "server/api/intSugarcrmAccount/index.js",
26093     "groupTitle": "Sugarcrm_Accounts"
26094   },
26095   {
26096     "type": "get",
26097     "url": "/api/integrations/sugarcrm/accounts/{id}",
26098     "title": "Gets a single Sugarcrm Account",
26099     "examples": [
26100       {
26101         "title": "Example usage:",
26102         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
26103         "type": "json"
26104       }
26105     ],
26106     "name": "ShowSugarcrm_Accounts",
26107     "group": "Sugarcrm_Accounts",
26108     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26109     "version": "0.0.0",
26110     "filename": "server/api/intSugarcrmAccount/index.js",
26111     "groupTitle": "Sugarcrm_Accounts"
26112   },
26113   {
26114     "type": "post",
26115     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
26116     "title": "Creates new configuration",
26117     "examples": [
26118       {
26119         "title": "Example usage:",
26120         "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",
26121         "type": "json"
26122       }
26123     ],
26124     "name": "addConfiguration",
26125     "group": "Sugarcrm_Accounts",
26126     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26127     "version": "0.0.0",
26128     "filename": "server/api/intSugarcrmAccount/index.js",
26129     "groupTitle": "Sugarcrm_Accounts"
26130   },
26131   {
26132     "type": "get",
26133     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
26134     "title": "Gets account configurations",
26135     "examples": [
26136       {
26137         "title": "Example usage:",
26138         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
26139         "type": "json"
26140       }
26141     ],
26142     "name": "getConfigurations",
26143     "group": "Sugarcrm_Accounts",
26144     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26145     "version": "0.0.0",
26146     "filename": "server/api/intSugarcrmAccount/index.js",
26147     "groupTitle": "Sugarcrm_Accounts"
26148   },
26149   {
26150     "type": "get",
26151     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
26152     "title": "Gets account fields",
26153     "examples": [
26154       {
26155         "title": "Example usage:",
26156         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
26157         "type": "json"
26158       }
26159     ],
26160     "name": "getFields",
26161     "group": "Sugarcrm_Accounts",
26162     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26163     "version": "0.0.0",
26164     "filename": "server/api/intSugarcrmAccount/index.js",
26165     "groupTitle": "Sugarcrm_Accounts"
26166   },
26167   {
26168     "type": "put",
26169     "url": "/api/integrations/sugarcrm/accounts/{id}",
26170     "title": "Update an existing Sugarcrm Account",
26171     "examples": [
26172       {
26173         "title": "Example usage:",
26174         "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",
26175         "type": "json"
26176       }
26177     ],
26178     "name": "updateSugarcrm_Accounts",
26179     "group": "Sugarcrm_Accounts",
26180     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26181     "version": "0.0.0",
26182     "filename": "server/api/intSugarcrmAccount/index.js",
26183     "groupTitle": "Sugarcrm_Accounts"
26184   },
26185   {
26186     "type": "get",
26187     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
26188     "title": "Gets configurations descriptions",
26189     "examples": [
26190       {
26191         "title": "Example usage:",
26192         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
26193         "type": "json"
26194       }
26195     ],
26196     "name": "getDescriptions",
26197     "group": "Sugarcrm_Configurations",
26198     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26199     "version": "0.0.0",
26200     "filename": "server/api/intSugarcrmConfiguration/index.js",
26201     "groupTitle": "Sugarcrm_Configurations"
26202   },
26203   {
26204     "type": "get",
26205     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
26206     "title": "Gets configurations fields",
26207     "examples": [
26208       {
26209         "title": "Example usage:",
26210         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
26211         "type": "json"
26212       }
26213     ],
26214     "name": "getFields",
26215     "group": "Sugarcrm_Configurations",
26216     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26217     "version": "0.0.0",
26218     "filename": "server/api/intSugarcrmConfiguration/index.js",
26219     "groupTitle": "Sugarcrm_Configurations"
26220   },
26221   {
26222     "type": "get",
26223     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
26224     "title": "Gets configurations subjects",
26225     "examples": [
26226       {
26227         "title": "Example usage:",
26228         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
26229         "type": "json"
26230       }
26231     ],
26232     "name": "getSubjects",
26233     "group": "Sugarcrm_Configurations",
26234     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26235     "version": "0.0.0",
26236     "filename": "server/api/intSugarcrmConfiguration/index.js",
26237     "groupTitle": "Sugarcrm_Configurations"
26238   },
26239   {
26240     "type": "post",
26241     "url": "/api/integrations/sugarcrm/fields",
26242     "title": "Creates a new Sugarcrm Field",
26243     "examples": [
26244       {
26245         "title": "Example usage:",
26246         "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",
26247         "type": "json"
26248       }
26249     ],
26250     "name": "CreateSugarcrm_Fields",
26251     "group": "Sugarcrm_Fields",
26252     "parameter": {
26253       "fields": {
26254         "Body": [
26255           {
26256             "group": "Body",
26257             "type": "String",
26258             "allowedValues": [
26259               "\"string\"",
26260               "\"variable\"",
26261               "\"customVariable\"",
26262               "\"keyValue\"",
26263               "\"picklist\""
26264             ],
26265             "optional": true,
26266             "field": "type",
26267             "description": ""
26268           },
26269           {
26270             "group": "Body",
26271             "type": "String",
26272             "optional": true,
26273             "field": "content",
26274             "description": ""
26275           },
26276           {
26277             "group": "Body",
26278             "type": "String",
26279             "optional": true,
26280             "field": "key",
26281             "description": ""
26282           },
26283           {
26284             "group": "Body",
26285             "type": "String",
26286             "allowedValues": [
26287               "\"string\"",
26288               "\"variable\"",
26289               "\"customVariable\""
26290             ],
26291             "optional": true,
26292             "field": "keyType",
26293             "description": ""
26294           },
26295           {
26296             "group": "Body",
26297             "type": "String",
26298             "optional": true,
26299             "field": "keyContent",
26300             "description": ""
26301           },
26302           {
26303             "group": "Body",
26304             "type": "String",
26305             "optional": true,
26306             "field": "idField",
26307             "description": ""
26308           },
26309           {
26310             "group": "Body",
26311             "type": "String",
26312             "optional": true,
26313             "field": "nameField",
26314             "description": ""
26315           },
26316           {
26317             "group": "Body",
26318             "type": "Boolean",
26319             "optional": true,
26320             "field": "customField",
26321             "description": ""
26322           },
26323           {
26324             "group": "Body",
26325             "type": "String",
26326             "optional": true,
26327             "field": "variableName",
26328             "description": ""
26329           }
26330         ]
26331       }
26332     },
26333     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26334     "version": "0.0.0",
26335     "filename": "server/api/intSugarcrmField/index.js",
26336     "groupTitle": "Sugarcrm_Fields"
26337   },
26338   {
26339     "type": "delete",
26340     "url": "/api/integrations/sugarcrm/fields/{id}",
26341     "title": "Deletes a Sugarcrm Field",
26342     "examples": [
26343       {
26344         "title": "Example usage:",
26345         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
26346         "type": "json"
26347       }
26348     ],
26349     "name": "DeleteSugarcrm_Fields",
26350     "group": "Sugarcrm_Fields",
26351     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26352     "version": "0.0.0",
26353     "filename": "server/api/intSugarcrmField/index.js",
26354     "groupTitle": "Sugarcrm_Fields"
26355   },
26356   {
26357     "type": "get",
26358     "url": "/api/integrations/sugarcrm/fields",
26359     "title": "Gets a list of Sugarcrm Fields",
26360     "examples": [
26361       {
26362         "title": "Example usage:",
26363         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
26364         "type": "json"
26365       }
26366     ],
26367     "name": "GetSugarcrm_Fields",
26368     "group": "Sugarcrm_Fields",
26369     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26370     "version": "0.0.0",
26371     "filename": "server/api/intSugarcrmField/index.js",
26372     "groupTitle": "Sugarcrm_Fields"
26373   },
26374   {
26375     "type": "get",
26376     "url": "/api/integrations/sugarcrm/fields/{id}",
26377     "title": "Gets a single Sugarcrm Field",
26378     "examples": [
26379       {
26380         "title": "Example usage:",
26381         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
26382         "type": "json"
26383       }
26384     ],
26385     "name": "ShowSugarcrm_Fields",
26386     "group": "Sugarcrm_Fields",
26387     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26388     "version": "0.0.0",
26389     "filename": "server/api/intSugarcrmField/index.js",
26390     "groupTitle": "Sugarcrm_Fields"
26391   },
26392   {
26393     "type": "put",
26394     "url": "/api/integrations/sugarcrm/fields/{id}",
26395     "title": "Update an existing Sugarcrm Field",
26396     "examples": [
26397       {
26398         "title": "Example usage:",
26399         "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",
26400         "type": "json"
26401       }
26402     ],
26403     "name": "updateSugarcrm_Fields",
26404     "group": "Sugarcrm_Fields",
26405     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26406     "version": "0.0.0",
26407     "filename": "server/api/intSugarcrmField/index.js",
26408     "groupTitle": "Sugarcrm_Fields"
26409   },
26410   {
26411     "type": "get",
26412     "url": "/api/system",
26413     "title": "Gets system information",
26414     "examples": [
26415       {
26416         "title": "Example usage:",
26417         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26418         "type": "json"
26419       }
26420     ],
26421     "name": "GetSystemInformation",
26422     "group": "System_Information",
26423     "description": "<p>Motion returns the system information.</p>",
26424     "version": "0.0.0",
26425     "filename": "server/api/system/index.js",
26426     "groupTitle": "System_Information"
26427   },
26428   {
26429     "type": "get",
26430     "url": "/api/system/process",
26431     "title": "Gets system information",
26432     "examples": [
26433       {
26434         "title": "Example usage:",
26435         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
26436         "type": "json"
26437       }
26438     ],
26439     "name": "GetSystemInformation",
26440     "group": "System_Information",
26441     "description": "<p>Motion returns the system information.</p>",
26442     "version": "0.0.0",
26443     "filename": "server/api/system/index.js",
26444     "groupTitle": "System_Information"
26445   },
26446   {
26447     "type": "post",
26448     "url": "/api/tags",
26449     "title": "Creates a new Tag",
26450     "examples": [
26451       {
26452         "title": "Example usage:",
26453         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26454         "type": "json"
26455       }
26456     ],
26457     "name": "CreateTags",
26458     "group": "Tags",
26459     "parameter": {
26460       "fields": {
26461         "Body": [
26462           {
26463             "group": "Body",
26464             "type": "String",
26465             "optional": false,
26466             "field": "name",
26467             "description": ""
26468           },
26469           {
26470             "group": "Body",
26471             "type": "String",
26472             "optional": true,
26473             "field": "color",
26474             "description": ""
26475           },
26476           {
26477             "group": "Body",
26478             "type": "String",
26479             "optional": true,
26480             "field": "description",
26481             "description": ""
26482           }
26483         ]
26484       }
26485     },
26486     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26487     "version": "0.0.0",
26488     "filename": "server/api/tag/index.js",
26489     "groupTitle": "Tags"
26490   },
26491   {
26492     "type": "delete",
26493     "url": "/api/tags/{id}",
26494     "title": "Deletes a Tag",
26495     "examples": [
26496       {
26497         "title": "Example usage:",
26498         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
26499         "type": "json"
26500       }
26501     ],
26502     "name": "DeleteTags",
26503     "group": "Tags",
26504     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26505     "version": "0.0.0",
26506     "filename": "server/api/tag/index.js",
26507     "groupTitle": "Tags"
26508   },
26509   {
26510     "type": "get",
26511     "url": "/api/tags",
26512     "title": "Gets a list of Tags",
26513     "examples": [
26514       {
26515         "title": "Example usage:",
26516         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
26517         "type": "json"
26518       }
26519     ],
26520     "name": "GetTags",
26521     "group": "Tags",
26522     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26523     "version": "0.0.0",
26524     "filename": "server/api/tag/index.js",
26525     "groupTitle": "Tags"
26526   },
26527   {
26528     "type": "get",
26529     "url": "/api/tags/{id}",
26530     "title": "Gets a single Tag",
26531     "examples": [
26532       {
26533         "title": "Example usage:",
26534         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
26535         "type": "json"
26536       }
26537     ],
26538     "name": "ShowTags",
26539     "group": "Tags",
26540     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26541     "version": "0.0.0",
26542     "filename": "server/api/tag/index.js",
26543     "groupTitle": "Tags"
26544   },
26545   {
26546     "type": "put",
26547     "url": "/api/tags/{id}",
26548     "title": "Update an existing Tag",
26549     "examples": [
26550       {
26551         "title": "Example usage:",
26552         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26553         "type": "json"
26554       }
26555     ],
26556     "name": "updateTags",
26557     "group": "Tags",
26558     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26559     "version": "0.0.0",
26560     "filename": "server/api/tag/index.js",
26561     "groupTitle": "Tags"
26562   },
26563   {
26564     "type": "post",
26565     "url": "/api/teams/{id}/queues",
26566     "title": "Add queues to a team",
26567     "examples": [
26568       {
26569         "title": "Example usage:",
26570         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26571         "type": "json"
26572       }
26573     ],
26574     "name": "AddQueues",
26575     "group": "Teams",
26576     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26577     "version": "0.0.0",
26578     "filename": "server/api/team/index.js",
26579     "groupTitle": "Teams"
26580   },
26581   {
26582     "type": "post",
26583     "url": "/api/teams",
26584     "title": "Creates a new Team",
26585     "examples": [
26586       {
26587         "title": "Example usage:",
26588         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26589         "type": "json"
26590       }
26591     ],
26592     "name": "CreateTeams",
26593     "group": "Teams",
26594     "parameter": {
26595       "fields": {
26596         "Body": [
26597           {
26598             "group": "Body",
26599             "type": "String",
26600             "optional": false,
26601             "field": "name",
26602             "description": ""
26603           },
26604           {
26605             "group": "Body",
26606             "type": "String",
26607             "optional": true,
26608             "field": "description",
26609             "description": ""
26610           }
26611         ]
26612       }
26613     },
26614     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26615     "version": "0.0.0",
26616     "filename": "server/api/team/index.js",
26617     "groupTitle": "Teams"
26618   },
26619   {
26620     "type": "delete",
26621     "url": "/api/teams/{id}",
26622     "title": "Deletes a Team",
26623     "examples": [
26624       {
26625         "title": "Example usage:",
26626         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
26627         "type": "json"
26628       }
26629     ],
26630     "name": "DeleteTeams",
26631     "group": "Teams",
26632     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26633     "version": "0.0.0",
26634     "filename": "server/api/team/index.js",
26635     "groupTitle": "Teams"
26636   },
26637   {
26638     "type": "get",
26639     "url": "/api/teams/{id}/users",
26640     "title": "Gets agents from team",
26641     "examples": [
26642       {
26643         "title": "Example usage:",
26644         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
26645         "type": "json"
26646       }
26647     ],
26648     "name": "GetAgents",
26649     "group": "Teams",
26650     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26651     "version": "0.0.0",
26652     "filename": "server/api/team/index.js",
26653     "groupTitle": "Teams"
26654   },
26655   {
26656     "type": "get",
26657     "url": "/api/teams/{id}/queues?channel={channel}",
26658     "title": "Gets Queues list",
26659     "examples": [
26660       {
26661         "title": "Example usage:",
26662         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
26663         "type": "json"
26664       }
26665     ],
26666     "name": "GetQueues",
26667     "group": "Teams",
26668     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26669     "version": "0.0.0",
26670     "filename": "server/api/team/index.js",
26671     "groupTitle": "Teams"
26672   },
26673   {
26674     "type": "get",
26675     "url": "/api/teams",
26676     "title": "Gets a list of Teams",
26677     "examples": [
26678       {
26679         "title": "Example usage:",
26680         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
26681         "type": "json"
26682       }
26683     ],
26684     "name": "GetTeams",
26685     "group": "Teams",
26686     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26687     "version": "0.0.0",
26688     "filename": "server/api/team/index.js",
26689     "groupTitle": "Teams"
26690   },
26691   {
26692     "type": "delete",
26693     "url": "/api/teams/{id}/users",
26694     "title": "Removes agents from a team",
26695     "examples": [
26696       {
26697         "title": "Example usage:",
26698         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26699         "type": "json"
26700       }
26701     ],
26702     "name": "RemoveAgents",
26703     "group": "Teams",
26704     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26705     "version": "0.0.0",
26706     "filename": "server/api/team/index.js",
26707     "groupTitle": "Teams"
26708   },
26709   {
26710     "type": "delete",
26711     "url": "/api/teams/{id}/queues",
26712     "title": "Remove queues to a team",
26713     "examples": [
26714       {
26715         "title": "Example usage:",
26716         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
26717         "type": "json"
26718       }
26719     ],
26720     "name": "RemoveQueues",
26721     "group": "Teams",
26722     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26723     "version": "0.0.0",
26724     "filename": "server/api/team/index.js",
26725     "groupTitle": "Teams"
26726   },
26727   {
26728     "type": "delete",
26729     "url": "/api/fax/queues/{id}/teams",
26730     "title": "Remove teams from a queue",
26731     "examples": [
26732       {
26733         "title": "Example usage:",
26734         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26735         "type": "json"
26736       }
26737     ],
26738     "name": "RemoveTeams",
26739     "group": "Teams",
26740     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26741     "version": "0.0.0",
26742     "filename": "server/api/faxQueue/index.js",
26743     "groupTitle": "Teams"
26744   },
26745   {
26746     "type": "delete",
26747     "url": "/api/whatsapp/queues/{id}/teams",
26748     "title": "Remove teams from a queue",
26749     "examples": [
26750       {
26751         "title": "Example usage:",
26752         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26753         "type": "json"
26754       }
26755     ],
26756     "name": "RemoveTeams",
26757     "group": "Teams",
26758     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26759     "version": "0.0.0",
26760     "filename": "server/api/whatsappQueue/index.js",
26761     "groupTitle": "Teams"
26762   },
26763   {
26764     "type": "delete",
26765     "url": "/api/openchannel/queues/{id}/teams",
26766     "title": "Remove teams from a queue",
26767     "examples": [
26768       {
26769         "title": "Example usage:",
26770         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26771         "type": "json"
26772       }
26773     ],
26774     "name": "RemoveTeams",
26775     "group": "Teams",
26776     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26777     "version": "0.0.0",
26778     "filename": "server/api/openchannelQueue/index.js",
26779     "groupTitle": "Teams"
26780   },
26781   {
26782     "type": "delete",
26783     "url": "/api/sms/queues/{id}/teams",
26784     "title": "Remove teams from a queue",
26785     "examples": [
26786       {
26787         "title": "Example usage:",
26788         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26789         "type": "json"
26790       }
26791     ],
26792     "name": "RemoveTeams",
26793     "group": "Teams",
26794     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26795     "version": "0.0.0",
26796     "filename": "server/api/smsQueue/index.js",
26797     "groupTitle": "Teams"
26798   },
26799   {
26800     "type": "delete",
26801     "url": "/api/voice/queues/{id}/teams",
26802     "title": "Remove teams from a queue",
26803     "examples": [
26804       {
26805         "title": "Example usage:",
26806         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26807         "type": "json"
26808       }
26809     ],
26810     "name": "RemoveTeams",
26811     "group": "Teams",
26812     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26813     "version": "0.0.0",
26814     "filename": "server/api/voiceQueue/index.js",
26815     "groupTitle": "Teams"
26816   },
26817   {
26818     "type": "delete",
26819     "url": "/api/chat/queues/{id}/teams",
26820     "title": "Remove teams from a queue",
26821     "examples": [
26822       {
26823         "title": "Example usage:",
26824         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26825         "type": "json"
26826       }
26827     ],
26828     "name": "RemoveTeams",
26829     "group": "Teams",
26830     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26831     "version": "0.0.0",
26832     "filename": "server/api/chatQueue/index.js",
26833     "groupTitle": "Teams"
26834   },
26835   {
26836     "type": "delete",
26837     "url": "/api/mail/queues/{id}/teams",
26838     "title": "Remove teams from a queue",
26839     "examples": [
26840       {
26841         "title": "Example usage:",
26842         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26843         "type": "json"
26844       }
26845     ],
26846     "name": "RemoveTeams",
26847     "group": "Teams",
26848     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26849     "version": "0.0.0",
26850     "filename": "server/api/mailQueue/index.js",
26851     "groupTitle": "Teams"
26852   },
26853   {
26854     "type": "get",
26855     "url": "/api/teams/{id}",
26856     "title": "Gets a single Team",
26857     "examples": [
26858       {
26859         "title": "Example usage:",
26860         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26861         "type": "json"
26862       }
26863     ],
26864     "name": "ShowTeams",
26865     "group": "Teams",
26866     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26867     "version": "0.0.0",
26868     "filename": "server/api/team/index.js",
26869     "groupTitle": "Teams"
26870   },
26871   {
26872     "type": "post",
26873     "url": "/api/teams/{id}/users",
26874     "title": "Adds agents to a team",
26875     "examples": [
26876       {
26877         "title": "Example usage:",
26878         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26879         "type": "json"
26880       }
26881     ],
26882     "name": "addAgents",
26883     "group": "Teams",
26884     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26885     "version": "0.0.0",
26886     "filename": "server/api/team/index.js",
26887     "groupTitle": "Teams"
26888   },
26889   {
26890     "type": "put",
26891     "url": "/api/teams/{id}",
26892     "title": "Update an existing Team",
26893     "examples": [
26894       {
26895         "title": "Example usage:",
26896         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26897         "type": "json"
26898       }
26899     ],
26900     "name": "updateTeams",
26901     "group": "Teams",
26902     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26903     "version": "0.0.0",
26904     "filename": "server/api/team/index.js",
26905     "groupTitle": "Teams"
26906   },
26907   {
26908     "type": "post",
26909     "url": "/api/templates",
26910     "title": "Creates a new Template",
26911     "examples": [
26912       {
26913         "title": "Example usage:",
26914         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26915         "type": "json"
26916       }
26917     ],
26918     "name": "CreateTemplates",
26919     "group": "Templates",
26920     "parameter": {
26921       "fields": {
26922         "Body": [
26923           {
26924             "group": "Body",
26925             "type": "String",
26926             "optional": true,
26927             "field": "name",
26928             "description": ""
26929           },
26930           {
26931             "group": "Body",
26932             "type": "String",
26933             "optional": true,
26934             "field": "description",
26935             "description": ""
26936           },
26937           {
26938             "group": "Body",
26939             "type": "Text",
26940             "optional": true,
26941             "field": "html",
26942             "description": ""
26943           }
26944         ]
26945       }
26946     },
26947     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26948     "version": "0.0.0",
26949     "filename": "server/api/template/index.js",
26950     "groupTitle": "Templates"
26951   },
26952   {
26953     "type": "delete",
26954     "url": "/api/templates/{id}",
26955     "title": "Deletes a Template",
26956     "examples": [
26957       {
26958         "title": "Example usage:",
26959         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26960         "type": "json"
26961       }
26962     ],
26963     "name": "DeleteTemplates",
26964     "group": "Templates",
26965     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/template/index.js",
26968     "groupTitle": "Templates"
26969   },
26970   {
26971     "type": "get",
26972     "url": "/api/templates",
26973     "title": "Gets a list of Templates",
26974     "examples": [
26975       {
26976         "title": "Example usage:",
26977         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26978         "type": "json"
26979       }
26980     ],
26981     "name": "GetTemplates",
26982     "group": "Templates",
26983     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26984     "version": "0.0.0",
26985     "filename": "server/api/template/index.js",
26986     "groupTitle": "Templates"
26987   },
26988   {
26989     "type": "get",
26990     "url": "/api/templates/{id}",
26991     "title": "Gets a single Template",
26992     "examples": [
26993       {
26994         "title": "Example usage:",
26995         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26996         "type": "json"
26997       }
26998     ],
26999     "name": "ShowTemplates",
27000     "group": "Templates",
27001     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27002     "version": "0.0.0",
27003     "filename": "server/api/template/index.js",
27004     "groupTitle": "Templates"
27005   },
27006   {
27007     "type": "put",
27008     "url": "/api/templates/{id}",
27009     "title": "Update an existing Template",
27010     "examples": [
27011       {
27012         "title": "Example usage:",
27013         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27014         "type": "json"
27015       }
27016     ],
27017     "name": "updateTemplates",
27018     "group": "Templates",
27019     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27020     "version": "0.0.0",
27021     "filename": "server/api/template/index.js",
27022     "groupTitle": "Templates"
27023   },
27024   {
27025     "type": "post",
27026     "url": "/api/triggers",
27027     "title": "Creates a new Trigger",
27028     "examples": [
27029       {
27030         "title": "Example usage:",
27031         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27032         "type": "json"
27033       }
27034     ],
27035     "name": "CreateTriggers",
27036     "group": "Triggers",
27037     "parameter": {
27038       "fields": {
27039         "Body": [
27040           {
27041             "group": "Body",
27042             "type": "String",
27043             "optional": true,
27044             "field": "name",
27045             "description": ""
27046           },
27047           {
27048             "group": "Body",
27049             "type": "String",
27050             "optional": true,
27051             "field": "channel",
27052             "description": ""
27053           },
27054           {
27055             "group": "Body",
27056             "type": "String",
27057             "optional": true,
27058             "field": "description",
27059             "description": ""
27060           },
27061           {
27062             "group": "Body",
27063             "type": "Boolean",
27064             "optional": true,
27065             "field": "status",
27066             "description": ""
27067           }
27068         ]
27069       }
27070     },
27071     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27072     "version": "0.0.0",
27073     "filename": "server/api/trigger/index.js",
27074     "groupTitle": "Triggers"
27075   },
27076   {
27077     "type": "delete",
27078     "url": "/api/triggers/{id}",
27079     "title": "Deletes a Trigger",
27080     "examples": [
27081       {
27082         "title": "Example usage:",
27083         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
27084         "type": "json"
27085       }
27086     ],
27087     "name": "DeleteTriggers",
27088     "group": "Triggers",
27089     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27090     "version": "0.0.0",
27091     "filename": "server/api/trigger/index.js",
27092     "groupTitle": "Triggers"
27093   },
27094   {
27095     "type": "get",
27096     "url": "/api/triggers",
27097     "title": "Gets a list of Triggers",
27098     "examples": [
27099       {
27100         "title": "Example usage:",
27101         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
27102         "type": "json"
27103       }
27104     ],
27105     "name": "GetTriggers",
27106     "group": "Triggers",
27107     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27108     "version": "0.0.0",
27109     "filename": "server/api/trigger/index.js",
27110     "groupTitle": "Triggers"
27111   },
27112   {
27113     "type": "get",
27114     "url": "/api/triggers/{id}",
27115     "title": "Gets a single Trigger",
27116     "examples": [
27117       {
27118         "title": "Example usage:",
27119         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
27120         "type": "json"
27121       }
27122     ],
27123     "name": "ShowTriggers",
27124     "group": "Triggers",
27125     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27126     "version": "0.0.0",
27127     "filename": "server/api/trigger/index.js",
27128     "groupTitle": "Triggers"
27129   },
27130   {
27131     "type": "post",
27132     "url": "/api/triggers/{id}/actions",
27133     "title": "Creates new actions",
27134     "examples": [
27135       {
27136         "title": "Example usage:",
27137         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27138         "type": "json"
27139       }
27140     ],
27141     "name": "addAction",
27142     "group": "Triggers",
27143     "parameter": {
27144       "fields": {
27145         "Body": [
27146           {
27147             "group": "Body",
27148             "type": "Virtual",
27149             "optional": true,
27150             "field": "name",
27151             "description": ""
27152           },
27153           {
27154             "group": "Body",
27155             "type": "String",
27156             "optional": false,
27157             "field": "action",
27158             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
27159           },
27160           {
27161             "group": "Body",
27162             "type": "String",
27163             "optional": true,
27164             "field": "data1",
27165             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
27166           },
27167           {
27168             "group": "Body",
27169             "type": "String",
27170             "optional": true,
27171             "field": "data2",
27172             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
27173           },
27174           {
27175             "group": "Body",
27176             "type": "String",
27177             "optional": true,
27178             "field": "data3",
27179             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
27180           },
27181           {
27182             "group": "Body",
27183             "type": "String",
27184             "optional": true,
27185             "field": "data4",
27186             "description": ""
27187           },
27188           {
27189             "group": "Body",
27190             "type": "String",
27191             "optional": true,
27192             "field": "data5",
27193             "description": ""
27194           },
27195           {
27196             "group": "Body",
27197             "type": "String",
27198             "optional": true,
27199             "field": "data6",
27200             "description": ""
27201           },
27202           {
27203             "group": "Body",
27204             "type": "Text",
27205             "optional": true,
27206             "field": "data7",
27207             "description": ""
27208           }
27209         ]
27210       }
27211     },
27212     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27213     "version": "0.0.0",
27214     "filename": "server/api/trigger/index.js",
27215     "groupTitle": "Triggers"
27216   },
27217   {
27218     "type": "post",
27219     "url": "/api/triggers/{id}/all_conditions",
27220     "title": "Creates a new \"AND\"condition",
27221     "examples": [
27222       {
27223         "title": "Example usage:",
27224         "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",
27225         "type": "json"
27226       }
27227     ],
27228     "name": "addAllCondition",
27229     "group": "Triggers",
27230     "parameter": {
27231       "fields": {
27232         "Body": [
27233           {
27234             "group": "Body",
27235             "type": "Virtual",
27236             "optional": true,
27237             "field": "name",
27238             "description": ""
27239           },
27240           {
27241             "group": "Body",
27242             "type": "String",
27243             "optional": false,
27244             "field": "field",
27245             "description": ""
27246           },
27247           {
27248             "group": "Body",
27249             "type": "String",
27250             "optional": false,
27251             "field": "operator",
27252             "description": ""
27253           },
27254           {
27255             "group": "Body",
27256             "type": "String",
27257             "optional": false,
27258             "field": "value",
27259             "description": ""
27260           }
27261         ]
27262       }
27263     },
27264     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27265     "version": "0.0.0",
27266     "filename": "server/api/trigger/index.js",
27267     "groupTitle": "Triggers"
27268   },
27269   {
27270     "type": "post",
27271     "url": "/api/triggers/{id}/any_conditions",
27272     "title": "Creates a new \"OR\"condition",
27273     "examples": [
27274       {
27275         "title": "Example usage:",
27276         "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",
27277         "type": "json"
27278       }
27279     ],
27280     "name": "addAnyCondition",
27281     "group": "Triggers",
27282     "parameter": {
27283       "fields": {
27284         "Body": [
27285           {
27286             "group": "Body",
27287             "type": "Virtual",
27288             "optional": true,
27289             "field": "name",
27290             "description": ""
27291           },
27292           {
27293             "group": "Body",
27294             "type": "String",
27295             "optional": false,
27296             "field": "field",
27297             "description": ""
27298           },
27299           {
27300             "group": "Body",
27301             "type": "String",
27302             "optional": false,
27303             "field": "operator",
27304             "description": ""
27305           },
27306           {
27307             "group": "Body",
27308             "type": "String",
27309             "optional": false,
27310             "field": "value",
27311             "description": ""
27312           }
27313         ]
27314       }
27315     },
27316     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27317     "version": "0.0.0",
27318     "filename": "server/api/trigger/index.js",
27319     "groupTitle": "Triggers"
27320   },
27321   {
27322     "type": "get",
27323     "url": "/api/triggers/{id}/actions",
27324     "title": "Gets Trigger Actions",
27325     "examples": [
27326       {
27327         "title": "Example usage:",
27328         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
27329         "type": "json"
27330       }
27331     ],
27332     "name": "getActions",
27333     "group": "Triggers",
27334     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27335     "version": "0.0.0",
27336     "filename": "server/api/trigger/index.js",
27337     "groupTitle": "Triggers"
27338   },
27339   {
27340     "type": "get",
27341     "url": "/api/triggers/{id}/all_conditions",
27342     "title": "Gets \"AND\" Trigger Conditions",
27343     "examples": [
27344       {
27345         "title": "Example usage:",
27346         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
27347         "type": "json"
27348       }
27349     ],
27350     "name": "getAllConditions",
27351     "group": "Triggers",
27352     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27353     "version": "0.0.0",
27354     "filename": "server/api/trigger/index.js",
27355     "groupTitle": "Triggers"
27356   },
27357   {
27358     "type": "get",
27359     "url": "/api/triggers/{id}/any_conditions",
27360     "title": "Gets \"OR\" Trigger Conditions",
27361     "examples": [
27362       {
27363         "title": "Example usage:",
27364         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
27365         "type": "json"
27366       }
27367     ],
27368     "name": "getAnyConditions",
27369     "group": "Triggers",
27370     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27371     "version": "0.0.0",
27372     "filename": "server/api/trigger/index.js",
27373     "groupTitle": "Triggers"
27374   },
27375   {
27376     "type": "put",
27377     "url": "/api/triggers/{id}",
27378     "title": "Update an existing Trigger",
27379     "examples": [
27380       {
27381         "title": "Example usage:",
27382         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27383         "type": "json"
27384       }
27385     ],
27386     "name": "updateTriggers",
27387     "group": "Triggers",
27388     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27389     "version": "0.0.0",
27390     "filename": "server/api/trigger/index.js",
27391     "groupTitle": "Triggers"
27392   },
27393   {
27394     "type": "post",
27395     "url": "/api/trunks/clone",
27396     "title": "Clone an existing Trunk",
27397     "examples": [
27398       {
27399         "title": "Example usage:",
27400         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27401         "type": "json"
27402       }
27403     ],
27404     "name": "CloneTrunks",
27405     "group": "Trunks",
27406     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27407     "version": "0.0.0",
27408     "filename": "server/api/trunk/index.js",
27409     "groupTitle": "Trunks"
27410   },
27411   {
27412     "type": "post",
27413     "url": "/api/trunks",
27414     "title": "Create a new trunk",
27415     "examples": [
27416       {
27417         "title": "Example usage:",
27418         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
27419         "type": "json"
27420       }
27421     ],
27422     "name": "Create",
27423     "group": "Trunks",
27424     "parameter": {
27425       "fields": {
27426         "Body": [
27427           {
27428             "group": "Body",
27429             "type": "String",
27430             "optional": false,
27431             "field": "name",
27432             "description": ""
27433           },
27434           {
27435             "group": "Body",
27436             "type": "String",
27437             "allowedValues": [
27438               "\"friend\"",
27439               "\"user\"",
27440               "\"peer\""
27441             ],
27442             "optional": false,
27443             "field": "type",
27444             "description": ""
27445           },
27446           {
27447             "group": "Body",
27448             "type": "String",
27449             "optional": false,
27450             "field": "context",
27451             "description": ""
27452           },
27453           {
27454             "group": "Body",
27455             "type": "String",
27456             "allowedValues": [
27457               "\"ALLOWED_NOT_SCREENED\"",
27458               "\"ALLOWED_PASSED_SCREEN\"",
27459               "\"ALLOWED_FAILED_SCREEN\"",
27460               "\"ALLOWED\"",
27461               "\"PROHIB_NOT_SCREENED\"",
27462               "\"PROHIB_PASSED_SCREEN\"",
27463               "\"PROHIB_FAILED_SCREEN\"",
27464               "\"PROHIB\""
27465             ],
27466             "optional": true,
27467             "field": "callingpres",
27468             "description": ""
27469           },
27470           {
27471             "group": "Body",
27472             "type": "String",
27473             "optional": true,
27474             "field": "deny",
27475             "description": ""
27476           },
27477           {
27478             "group": "Body",
27479             "type": "String",
27480             "optional": true,
27481             "field": "permit",
27482             "description": ""
27483           },
27484           {
27485             "group": "Body",
27486             "type": "String",
27487             "optional": true,
27488             "field": "secret",
27489             "description": ""
27490           },
27491           {
27492             "group": "Body",
27493             "type": "String",
27494             "optional": true,
27495             "field": "md5secret",
27496             "description": ""
27497           },
27498           {
27499             "group": "Body",
27500             "type": "String",
27501             "optional": true,
27502             "field": "remotesecret",
27503             "description": ""
27504           },
27505           {
27506             "group": "Body",
27507             "type": "String",
27508             "optional": true,
27509             "field": "transport",
27510             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
27511           },
27512           {
27513             "group": "Body",
27514             "type": "String",
27515             "allowedValues": [
27516               "\"rfc2833\"",
27517               "\"info\"",
27518               "\"shortinfo\"",
27519               "\"inband\"",
27520               "\"auto\""
27521             ],
27522             "optional": true,
27523             "field": "dtmfmode",
27524             "description": ""
27525           },
27526           {
27527             "group": "Body",
27528             "type": "String",
27529             "allowedValues": [
27530               "\"yes\"",
27531               "\"no\"",
27532               "\"nonat\"",
27533               "\"update\"",
27534               "\"outgoing\""
27535             ],
27536             "optional": true,
27537             "field": "directmedia",
27538             "description": ""
27539           },
27540           {
27541             "group": "Body",
27542             "type": "String",
27543             "allowedValues": [
27544               "\"yes\"",
27545               "\"no\""
27546             ],
27547             "optional": true,
27548             "field": "directrtpsetup",
27549             "description": ""
27550           },
27551           {
27552             "group": "Body",
27553             "type": "String",
27554             "optional": true,
27555             "field": "directmediapermit",
27556             "description": ""
27557           },
27558           {
27559             "group": "Body",
27560             "type": "String",
27561             "optional": true,
27562             "field": "directmediadeny",
27563             "description": ""
27564           },
27565           {
27566             "group": "Body",
27567             "type": "String",
27568             "optional": true,
27569             "field": "nat",
27570             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
27571           },
27572           {
27573             "group": "Body",
27574             "type": "String",
27575             "optional": true,
27576             "field": "callgroup",
27577             "description": ""
27578           },
27579           {
27580             "group": "Body",
27581             "type": "String",
27582             "optional": true,
27583             "field": "namedcallgroup",
27584             "description": ""
27585           },
27586           {
27587             "group": "Body",
27588             "type": "String",
27589             "optional": true,
27590             "field": "pickupgroup",
27591             "description": ""
27592           },
27593           {
27594             "group": "Body",
27595             "type": "String",
27596             "optional": true,
27597             "field": "namedpickupgroup",
27598             "description": ""
27599           },
27600           {
27601             "group": "Body",
27602             "type": "String",
27603             "optional": true,
27604             "field": "language",
27605             "description": ""
27606           },
27607           {
27608             "group": "Body",
27609             "type": "String",
27610             "optional": true,
27611             "field": "tonezone",
27612             "description": ""
27613           },
27614           {
27615             "group": "Body",
27616             "type": "String",
27617             "optional": true,
27618             "field": "disallow",
27619             "description": ""
27620           },
27621           {
27622             "group": "Body",
27623             "type": "String",
27624             "optional": false,
27625             "field": "allow",
27626             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
27627           },
27628           {
27629             "group": "Body",
27630             "type": "String",
27631             "allowedValues": [
27632               "\"yes\"",
27633               "\"no\""
27634             ],
27635             "optional": true,
27636             "field": "autoframing",
27637             "description": ""
27638           },
27639           {
27640             "group": "Body",
27641             "type": "String",
27642             "optional": true,
27643             "field": "insecure",
27644             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
27645           },
27646           {
27647             "group": "Body",
27648             "type": "String",
27649             "allowedValues": [
27650               "\"yes\"",
27651               "\"no\""
27652             ],
27653             "optional": true,
27654             "field": "trustrpid",
27655             "description": ""
27656           },
27657           {
27658             "group": "Body",
27659             "type": "String",
27660             "allowedValues": [
27661               "\"yes\"",
27662               "\"no\""
27663             ],
27664             "optional": true,
27665             "field": "trust_id_outbound",
27666             "description": ""
27667           },
27668           {
27669             "group": "Body",
27670             "type": "String",
27671             "allowedValues": [
27672               "\"yes\"",
27673               "\"no\"",
27674               "\"never\""
27675             ],
27676             "optional": true,
27677             "field": "progressinband",
27678             "description": ""
27679           },
27680           {
27681             "group": "Body",
27682             "type": "String",
27683             "allowedValues": [
27684               "\"yes\"",
27685               "\"no\""
27686             ],
27687             "optional": true,
27688             "field": "promiscredir",
27689             "description": ""
27690           },
27691           {
27692             "group": "Body",
27693             "type": "String",
27694             "allowedValues": [
27695               "\"yes\"",
27696               "\"no\""
27697             ],
27698             "optional": true,
27699             "field": "useclientcode",
27700             "description": ""
27701           },
27702           {
27703             "group": "Body",
27704             "type": "Integer",
27705             "optional": true,
27706             "field": "accountcode",
27707             "description": ""
27708           },
27709           {
27710             "group": "Body",
27711             "type": "String",
27712             "optional": true,
27713             "field": "setvar",
27714             "description": ""
27715           },
27716           {
27717             "group": "Body",
27718             "type": "String",
27719             "optional": true,
27720             "field": "callerid",
27721             "description": ""
27722           },
27723           {
27724             "group": "Body",
27725             "type": "String",
27726             "optional": true,
27727             "field": "amaflags",
27728             "description": ""
27729           },
27730           {
27731             "group": "Body",
27732             "type": "String",
27733             "allowedValues": [
27734               "\"yes\"",
27735               "\"no\""
27736             ],
27737             "optional": true,
27738             "field": "callcounter",
27739             "description": ""
27740           },
27741           {
27742             "group": "Body",
27743             "type": "Integer",
27744             "optional": true,
27745             "field": "busylevel",
27746             "description": ""
27747           },
27748           {
27749             "group": "Body",
27750             "type": "String",
27751             "allowedValues": [
27752               "\"yes\"",
27753               "\"no\""
27754             ],
27755             "optional": true,
27756             "field": "allowoverlap",
27757             "description": ""
27758           },
27759           {
27760             "group": "Body",
27761             "type": "String",
27762             "allowedValues": [
27763               "\"yes\"",
27764               "\"no\""
27765             ],
27766             "optional": true,
27767             "field": "allowsubscribe",
27768             "description": ""
27769           },
27770           {
27771             "group": "Body",
27772             "type": "String",
27773             "allowedValues": [
27774               "\"yes\"",
27775               "\"no\""
27776             ],
27777             "optional": true,
27778             "field": "allowtransfer",
27779             "description": ""
27780           },
27781           {
27782             "group": "Body",
27783             "type": "String",
27784             "allowedValues": [
27785               "\"yes\"",
27786               "\"no\""
27787             ],
27788             "optional": true,
27789             "field": "ignoresdpversion",
27790             "description": ""
27791           },
27792           {
27793             "group": "Body",
27794             "type": "String",
27795             "optional": true,
27796             "field": "subscribecontext",
27797             "description": ""
27798           },
27799           {
27800             "group": "Body",
27801             "type": "String",
27802             "optional": true,
27803             "field": "template",
27804             "description": ""
27805           },
27806           {
27807             "group": "Body",
27808             "type": "String",
27809             "allowedValues": [
27810               "\"yes\"",
27811               "\"no\"",
27812               "\"always\""
27813             ],
27814             "optional": true,
27815             "field": "videosupport",
27816             "description": ""
27817           },
27818           {
27819             "group": "Body",
27820             "type": "Integer",
27821             "optional": true,
27822             "field": "maxcallbitrate",
27823             "description": ""
27824           },
27825           {
27826             "group": "Body",
27827             "type": "String",
27828             "allowedValues": [
27829               "\"yes\"",
27830               "\"no\""
27831             ],
27832             "optional": true,
27833             "field": "rfc2833compensate",
27834             "description": ""
27835           },
27836           {
27837             "group": "Body",
27838             "type": "String",
27839             "optional": true,
27840             "field": "mailbox",
27841             "description": ""
27842           },
27843           {
27844             "group": "Body",
27845             "type": "String",
27846             "allowedValues": [
27847               "\"accept\"",
27848               "\"refuse\"",
27849               "\"originate\""
27850             ],
27851             "optional": true,
27852             "field": "session_timers",
27853             "description": ""
27854           },
27855           {
27856             "group": "Body",
27857             "type": "Integer",
27858             "optional": true,
27859             "field": "session_expires",
27860             "description": ""
27861           },
27862           {
27863             "group": "Body",
27864             "type": "Integer",
27865             "optional": true,
27866             "field": "session_minse",
27867             "description": ""
27868           },
27869           {
27870             "group": "Body",
27871             "type": "String",
27872             "allowedValues": [
27873               "\"uac\"",
27874               "\"uas\""
27875             ],
27876             "optional": true,
27877             "field": "session_refresher",
27878             "description": ""
27879           },
27880           {
27881             "group": "Body",
27882             "type": "String",
27883             "optional": true,
27884             "field": "t38pt_usertpsource",
27885             "description": ""
27886           },
27887           {
27888             "group": "Body",
27889             "type": "String",
27890             "optional": true,
27891             "field": "regexten",
27892             "description": ""
27893           },
27894           {
27895             "group": "Body",
27896             "type": "String",
27897             "optional": true,
27898             "field": "fromdomain",
27899             "description": ""
27900           },
27901           {
27902             "group": "Body",
27903             "type": "String",
27904             "optional": true,
27905             "field": "fromuser",
27906             "description": ""
27907           },
27908           {
27909             "group": "Body",
27910             "type": "Integer",
27911             "optional": true,
27912             "field": "port",
27913             "description": ""
27914           },
27915           {
27916             "group": "Body",
27917             "type": "String",
27918             "allowedValues": [
27919               "\"yes\"",
27920               "\"no\""
27921             ],
27922             "optional": true,
27923             "field": "qualify",
27924             "description": ""
27925           },
27926           {
27927             "group": "Body",
27928             "type": "Integer",
27929             "optional": true,
27930             "field": "keepalive",
27931             "description": ""
27932           },
27933           {
27934             "group": "Body",
27935             "type": "String",
27936             "optional": true,
27937             "field": "defaultip",
27938             "description": ""
27939           },
27940           {
27941             "group": "Body",
27942             "type": "String",
27943             "optional": true,
27944             "field": "defaultuser",
27945             "description": ""
27946           },
27947           {
27948             "group": "Body",
27949             "type": "Integer",
27950             "optional": true,
27951             "field": "rtptimeout",
27952             "description": ""
27953           },
27954           {
27955             "group": "Body",
27956             "type": "Integer",
27957             "optional": true,
27958             "field": "rtpholdtimeout",
27959             "description": ""
27960           },
27961           {
27962             "group": "Body",
27963             "type": "Integer",
27964             "optional": true,
27965             "field": "rtpkeepalive",
27966             "description": ""
27967           },
27968           {
27969             "group": "Body",
27970             "type": "String",
27971             "allowedValues": [
27972               "\"yes\"",
27973               "\"no\"",
27974               "\"pai\""
27975             ],
27976             "optional": true,
27977             "field": "sendrpid",
27978             "description": ""
27979           },
27980           {
27981             "group": "Body",
27982             "type": "String",
27983             "optional": true,
27984             "field": "outboundproxy",
27985             "description": ""
27986           },
27987           {
27988             "group": "Body",
27989             "type": "String",
27990             "optional": true,
27991             "field": "callbackextension",
27992             "description": ""
27993           },
27994           {
27995             "group": "Body",
27996             "type": "Integer",
27997             "optional": true,
27998             "field": "timert1",
27999             "description": ""
28000           },
28001           {
28002             "group": "Body",
28003             "type": "Integer",
28004             "optional": true,
28005             "field": "timerb",
28006             "description": ""
28007           },
28008           {
28009             "group": "Body",
28010             "type": "Integer",
28011             "optional": true,
28012             "field": "qualifyfreq",
28013             "description": ""
28014           },
28015           {
28016             "group": "Body",
28017             "type": "String",
28018             "optional": true,
28019             "field": "contactpermit",
28020             "description": ""
28021           },
28022           {
28023             "group": "Body",
28024             "type": "String",
28025             "optional": true,
28026             "field": "contactdeny",
28027             "description": ""
28028           },
28029           {
28030             "group": "Body",
28031             "type": "String",
28032             "optional": true,
28033             "field": "contactacl",
28034             "description": ""
28035           },
28036           {
28037             "group": "Body",
28038             "type": "String",
28039             "optional": true,
28040             "field": "unsolicited_mailbox",
28041             "description": ""
28042           },
28043           {
28044             "group": "Body",
28045             "type": "String",
28046             "optional": true,
28047             "field": "use_q850_reason",
28048             "description": ""
28049           },
28050           {
28051             "group": "Body",
28052             "type": "Integer",
28053             "optional": true,
28054             "field": "maxforwards",
28055             "description": ""
28056           },
28057           {
28058             "group": "Body",
28059             "type": "String",
28060             "allowedValues": [
28061               "\"yes\"",
28062               "\"no\""
28063             ],
28064             "optional": true,
28065             "field": "encryption",
28066             "description": ""
28067           },
28068           {
28069             "group": "Body",
28070             "type": "String",
28071             "allowedValues": [
28072               "\"yes\"",
28073               "\"no\""
28074             ],
28075             "optional": true,
28076             "field": "avpf",
28077             "description": ""
28078           },
28079           {
28080             "group": "Body",
28081             "type": "String",
28082             "allowedValues": [
28083               "\"yes\"",
28084               "\"no\""
28085             ],
28086             "optional": true,
28087             "field": "force_avp",
28088             "description": ""
28089           },
28090           {
28091             "group": "Body",
28092             "type": "String",
28093             "allowedValues": [
28094               "\"yes\"",
28095               "\"no\""
28096             ],
28097             "optional": true,
28098             "field": "icesupport",
28099             "description": ""
28100           },
28101           {
28102             "group": "Body",
28103             "type": "String",
28104             "allowedValues": [
28105               "\"yes\"",
28106               "\"no\""
28107             ],
28108             "optional": true,
28109             "field": "dtlsenable",
28110             "description": ""
28111           },
28112           {
28113             "group": "Body",
28114             "type": "String",
28115             "allowedValues": [
28116               "\"yes\"",
28117               "\"no\"",
28118               "\"fingerprint\"",
28119               "\"certificate\""
28120             ],
28121             "optional": true,
28122             "field": "dtlsverify",
28123             "description": ""
28124           },
28125           {
28126             "group": "Body",
28127             "type": "Integer",
28128             "optional": true,
28129             "field": "dtlsrekey",
28130             "description": ""
28131           },
28132           {
28133             "group": "Body",
28134             "type": "String",
28135             "optional": true,
28136             "field": "dtlscertfile",
28137             "description": ""
28138           },
28139           {
28140             "group": "Body",
28141             "type": "String",
28142             "optional": true,
28143             "field": "dtlsprivatekey",
28144             "description": ""
28145           },
28146           {
28147             "group": "Body",
28148             "type": "String",
28149             "optional": true,
28150             "field": "dtlscipher",
28151             "description": ""
28152           },
28153           {
28154             "group": "Body",
28155             "type": "String",
28156             "optional": true,
28157             "field": "dtlscafile",
28158             "description": ""
28159           },
28160           {
28161             "group": "Body",
28162             "type": "String",
28163             "optional": true,
28164             "field": "dtlscapath",
28165             "description": ""
28166           },
28167           {
28168             "group": "Body",
28169             "type": "String",
28170             "allowedValues": [
28171               "\"active\"",
28172               "\"passive\"",
28173               "\"actpass\""
28174             ],
28175             "optional": true,
28176             "field": "dtlssetup",
28177             "description": ""
28178           },
28179           {
28180             "group": "Body",
28181             "type": "String",
28182             "optional": true,
28183             "field": "dtlsfingerprint",
28184             "description": ""
28185           },
28186           {
28187             "group": "Body",
28188             "type": "String",
28189             "allowedValues": [
28190               "\"yes\"",
28191               "\"no\""
28192             ],
28193             "optional": true,
28194             "field": "usereqphone",
28195             "description": ""
28196           },
28197           {
28198             "group": "Body",
28199             "type": "String",
28200             "optional": true,
28201             "field": "recordonfeature",
28202             "description": ""
28203           },
28204           {
28205             "group": "Body",
28206             "type": "String",
28207             "optional": true,
28208             "field": "recordofffeature",
28209             "description": ""
28210           },
28211           {
28212             "group": "Body",
28213             "type": "Integer",
28214             "optional": true,
28215             "field": "call_limit",
28216             "description": ""
28217           },
28218           {
28219             "group": "Body",
28220             "type": "String",
28221             "allowedValues": [
28222               "\"yes\"",
28223               "\"no\""
28224             ],
28225             "optional": true,
28226             "field": "registertrying",
28227             "description": ""
28228           },
28229           {
28230             "group": "Body",
28231             "type": "String",
28232             "allowedValues": [
28233               "\"yes\"",
28234               "\"no\""
28235             ],
28236             "optional": true,
28237             "field": "subscribemwi",
28238             "description": ""
28239           },
28240           {
28241             "group": "Body",
28242             "type": "String",
28243             "optional": true,
28244             "field": "vmexten",
28245             "description": ""
28246           },
28247           {
28248             "group": "Body",
28249             "type": "String",
28250             "optional": true,
28251             "field": "mohinterpret",
28252             "description": ""
28253           },
28254           {
28255             "group": "Body",
28256             "type": "String",
28257             "optional": true,
28258             "field": "mohsuggest",
28259             "description": ""
28260           },
28261           {
28262             "group": "Body",
28263             "type": "String",
28264             "optional": true,
28265             "field": "parkinglot",
28266             "description": ""
28267           },
28268           {
28269             "group": "Body",
28270             "type": "String",
28271             "optional": true,
28272             "field": "description",
28273             "description": ""
28274           },
28275           {
28276             "group": "Body",
28277             "type": "String",
28278             "optional": true,
28279             "field": "host",
28280             "description": ""
28281           },
28282           {
28283             "group": "Body",
28284             "type": "String",
28285             "allowedValues": [
28286               "\"yes\"",
28287               "\"no\"",
28288               "\"nonat\"",
28289               "\"update\"",
28290               "\"update,nonat\""
28291             ],
28292             "optional": true,
28293             "field": "canreinvite",
28294             "description": ""
28295           },
28296           {
28297             "group": "Body",
28298             "type": "String",
28299             "optional": true,
28300             "field": "registry",
28301             "description": ""
28302           },
28303           {
28304             "group": "Body",
28305             "type": "String",
28306             "optional": true,
28307             "field": "otherFields",
28308             "description": ""
28309           },
28310           {
28311             "group": "Body",
28312             "type": "Boolean",
28313             "optional": false,
28314             "field": "active",
28315             "description": ""
28316           },
28317           {
28318             "group": "Body",
28319             "type": "String",
28320             "optional": true,
28321             "field": "t38pt_udptl",
28322             "description": ""
28323           }
28324         ]
28325       }
28326     },
28327     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28328     "version": "0.0.0",
28329     "filename": "server/api/trunk/index.js",
28330     "groupTitle": "Trunks"
28331   },
28332   {
28333     "type": "delete",
28334     "url": "/api/trunks/{id}",
28335     "title": "Deletes a trunk",
28336     "examples": [
28337       {
28338         "title": "Example usage:",
28339         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
28340         "type": "json"
28341       }
28342     ],
28343     "name": "Delete",
28344     "group": "Trunks",
28345     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28346     "version": "0.0.0",
28347     "filename": "server/api/trunk/index.js",
28348     "groupTitle": "Trunks"
28349   },
28350   {
28351     "type": "get",
28352     "url": "/api/trunks",
28353     "title": "Gets a list of Trunks",
28354     "examples": [
28355       {
28356         "title": "Example usage:",
28357         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
28358         "type": "json"
28359       }
28360     ],
28361     "name": "GetTrunks",
28362     "group": "Trunks",
28363     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28364     "version": "0.0.0",
28365     "filename": "server/api/trunk/index.js",
28366     "groupTitle": "Trunks"
28367   },
28368   {
28369     "type": "get",
28370     "url": "/api/trunks/{id}",
28371     "title": "Gets a single Trunk",
28372     "examples": [
28373       {
28374         "title": "Example usage:",
28375         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
28376         "type": "json"
28377       }
28378     ],
28379     "name": "ShowTrunks",
28380     "group": "Trunks",
28381     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28382     "version": "0.0.0",
28383     "filename": "server/api/trunk/index.js",
28384     "groupTitle": "Trunks"
28385   },
28386   {
28387     "type": "put",
28388     "url": "/api/trunks/{id}",
28389     "title": "Update an existing trunk",
28390     "examples": [
28391       {
28392         "title": "Example usage:",
28393         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
28394         "type": "json"
28395       }
28396     ],
28397     "name": "Update",
28398     "group": "Trunks",
28399     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28400     "version": "0.0.0",
28401     "filename": "server/api/trunk/index.js",
28402     "groupTitle": "Trunks"
28403   },
28404   {
28405     "type": "post",
28406     "url": "/api/userNotifications",
28407     "title": "Send notification to user",
28408     "examples": [
28409       {
28410         "title": "Example usage:",
28411         "content": "curl https://{domain}/api/userNotifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28412         "type": "json"
28413       }
28414     ],
28415     "name": "Send",
28416     "group": "UserNotifications",
28417     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28418     "version": "0.0.0",
28419     "filename": "server/api/userNotification/index.js",
28420     "groupTitle": "UserNotifications"
28421   },
28422   {
28423     "type": "post",
28424     "url": "/api/userProfile/resources",
28425     "title": "Creates a new User Profile Resource",
28426     "examples": [
28427       {
28428         "title": "Example usage:",
28429         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28430         "type": "json"
28431       }
28432     ],
28433     "name": "CreateUser_Profile_Resources",
28434     "group": "User_Profile_Resources",
28435     "parameter": {
28436       "fields": {
28437         "Body": [
28438           {
28439             "group": "Body",
28440             "type": "String",
28441             "optional": false,
28442             "field": "name",
28443             "description": ""
28444           },
28445           {
28446             "group": "Body",
28447             "type": "Integer",
28448             "optional": false,
28449             "field": "resourceId",
28450             "description": ""
28451           },
28452           {
28453             "group": "Body",
28454             "type": "String",
28455             "optional": false,
28456             "field": "type",
28457             "description": ""
28458           }
28459         ]
28460       }
28461     },
28462     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28463     "version": "0.0.0",
28464     "filename": "server/api/userProfileResource/index.js",
28465     "groupTitle": "User_Profile_Resources"
28466   },
28467   {
28468     "type": "delete",
28469     "url": "/api/userProfile/resources/{id}",
28470     "title": "Deletes a User Profile Resource",
28471     "examples": [
28472       {
28473         "title": "Example usage:",
28474         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
28475         "type": "json"
28476       }
28477     ],
28478     "name": "DeleteUser_Profile_Resources",
28479     "group": "User_Profile_Resources",
28480     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28481     "version": "0.0.0",
28482     "filename": "server/api/userProfileResource/index.js",
28483     "groupTitle": "User_Profile_Resources"
28484   },
28485   {
28486     "type": "get",
28487     "url": "/api/userProfile/resources/describe",
28488     "title": "Gets table info about User Profile Resources",
28489     "examples": [
28490       {
28491         "title": "Example usage:",
28492         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
28493         "type": "json"
28494       }
28495     ],
28496     "name": "DescribeUser_Profile_Resources",
28497     "group": "User_Profile_Resources",
28498     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28499     "version": "0.0.0",
28500     "filename": "server/api/userProfileResource/index.js",
28501     "groupTitle": "User_Profile_Resources"
28502   },
28503   {
28504     "type": "get",
28505     "url": "/api/userProfile/resources",
28506     "title": "Gets a list of User Profile Resources",
28507     "examples": [
28508       {
28509         "title": "Example usage:",
28510         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
28511         "type": "json"
28512       }
28513     ],
28514     "name": "GetUser_Profile_Resources",
28515     "group": "User_Profile_Resources",
28516     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28517     "version": "0.0.0",
28518     "filename": "server/api/userProfileResource/index.js",
28519     "groupTitle": "User_Profile_Resources"
28520   },
28521   {
28522     "type": "get",
28523     "url": "/api/userProfile/resources/{id}",
28524     "title": "Gets a single User Profile Resource",
28525     "examples": [
28526       {
28527         "title": "Example usage:",
28528         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
28529         "type": "json"
28530       }
28531     ],
28532     "name": "ShowUser_Profile_Resources",
28533     "group": "User_Profile_Resources",
28534     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28535     "version": "0.0.0",
28536     "filename": "server/api/userProfileResource/index.js",
28537     "groupTitle": "User_Profile_Resources"
28538   },
28539   {
28540     "type": "put",
28541     "url": "/api/userProfile/resources/{id}",
28542     "title": "Update an existing User Profile Resource",
28543     "examples": [
28544       {
28545         "title": "Example usage:",
28546         "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",
28547         "type": "json"
28548       }
28549     ],
28550     "name": "updateUser_Profile_Resources",
28551     "group": "User_Profile_Resources",
28552     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28553     "version": "0.0.0",
28554     "filename": "server/api/userProfileResource/index.js",
28555     "groupTitle": "User_Profile_Resources"
28556   },
28557   {
28558     "type": "post",
28559     "url": "/api/userProfile/sections",
28560     "title": "Creates a new User Profile Section",
28561     "examples": [
28562       {
28563         "title": "Example usage:",
28564         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28565         "type": "json"
28566       }
28567     ],
28568     "name": "CreateUser_Profile_Sections",
28569     "group": "User_Profile_Sections",
28570     "parameter": {
28571       "fields": {
28572         "Body": [
28573           {
28574             "group": "Body",
28575             "type": "String",
28576             "optional": false,
28577             "field": "name",
28578             "description": ""
28579           },
28580           {
28581             "group": "Body",
28582             "type": "String",
28583             "optional": false,
28584             "field": "category",
28585             "description": ""
28586           },
28587           {
28588             "group": "Body",
28589             "type": "Integer",
28590             "optional": false,
28591             "field": "sectionId",
28592             "description": ""
28593           },
28594           {
28595             "group": "Body",
28596             "type": "Boolean",
28597             "optional": true,
28598             "field": "enabled",
28599             "description": ""
28600           },
28601           {
28602             "group": "Body",
28603             "type": "Boolean",
28604             "optional": true,
28605             "field": "autoAssociation",
28606             "description": ""
28607           },
28608           {
28609             "group": "Body",
28610             "type": "String",
28611             "optional": true,
28612             "field": "crudPermissions",
28613             "description": ""
28614           }
28615         ]
28616       }
28617     },
28618     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28619     "version": "0.0.0",
28620     "filename": "server/api/userProfileSection/index.js",
28621     "groupTitle": "User_Profile_Sections"
28622   },
28623   {
28624     "type": "delete",
28625     "url": "/api/userProfile/sections/{id}",
28626     "title": "Deletes a User Profile Section",
28627     "examples": [
28628       {
28629         "title": "Example usage:",
28630         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
28631         "type": "json"
28632       }
28633     ],
28634     "name": "DeleteUser_Profile_Sections",
28635     "group": "User_Profile_Sections",
28636     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28637     "version": "0.0.0",
28638     "filename": "server/api/userProfileSection/index.js",
28639     "groupTitle": "User_Profile_Sections"
28640   },
28641   {
28642     "type": "get",
28643     "url": "/api/userProfile/sections/describe",
28644     "title": "Gets table info about User Profile Sections",
28645     "examples": [
28646       {
28647         "title": "Example usage:",
28648         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
28649         "type": "json"
28650       }
28651     ],
28652     "name": "DescribeUser_Profile_Sections",
28653     "group": "User_Profile_Sections",
28654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28655     "version": "0.0.0",
28656     "filename": "server/api/userProfileSection/index.js",
28657     "groupTitle": "User_Profile_Sections"
28658   },
28659   {
28660     "type": "get",
28661     "url": "/api/userProfile/sections",
28662     "title": "Gets a list of User Profile Sections",
28663     "examples": [
28664       {
28665         "title": "Example usage:",
28666         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
28667         "type": "json"
28668       }
28669     ],
28670     "name": "GetUser_Profile_Sections",
28671     "group": "User_Profile_Sections",
28672     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28673     "version": "0.0.0",
28674     "filename": "server/api/userProfileSection/index.js",
28675     "groupTitle": "User_Profile_Sections"
28676   },
28677   {
28678     "type": "get",
28679     "url": "/api/userProfile/sections/{id}",
28680     "title": "Gets a single User Profile Section",
28681     "examples": [
28682       {
28683         "title": "Example usage:",
28684         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
28685         "type": "json"
28686       }
28687     ],
28688     "name": "ShowUser_Profile_Sections",
28689     "group": "User_Profile_Sections",
28690     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28691     "version": "0.0.0",
28692     "filename": "server/api/userProfileSection/index.js",
28693     "groupTitle": "User_Profile_Sections"
28694   },
28695   {
28696     "type": "put",
28697     "url": "/api/userProfile/sections/{id}",
28698     "title": "Update an existing User Profile Section",
28699     "examples": [
28700       {
28701         "title": "Example usage:",
28702         "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",
28703         "type": "json"
28704       }
28705     ],
28706     "name": "updateUser_Profile_Sections",
28707     "group": "User_Profile_Sections",
28708     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28709     "version": "0.0.0",
28710     "filename": "server/api/userProfileSection/index.js",
28711     "groupTitle": "User_Profile_Sections"
28712   },
28713   {
28714     "type": "post",
28715     "url": "/api/userProfiles/{id}/resources",
28716     "title": "Add resources' permissions to User Profile",
28717     "examples": [
28718       {
28719         "title": "Example usage:",
28720         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28721         "type": "json"
28722       }
28723     ],
28724     "name": "AddResources",
28725     "group": "User_Profiles",
28726     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28727     "version": "0.0.0",
28728     "filename": "server/api/userProfile/index.js",
28729     "groupTitle": "User_Profiles"
28730   },
28731   {
28732     "type": "post",
28733     "url": "/api/userProfiles/{id}/sections",
28734     "title": "Add sections' permissions to User Profile",
28735     "examples": [
28736       {
28737         "title": "Example usage:",
28738         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28739         "type": "json"
28740       }
28741     ],
28742     "name": "AddSections",
28743     "group": "User_Profiles",
28744     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28745     "version": "0.0.0",
28746     "filename": "server/api/userProfile/index.js",
28747     "groupTitle": "User_Profiles"
28748   },
28749   {
28750     "type": "post",
28751     "url": "/api/userProfiles/clone",
28752     "title": "Clone an existing User Profile",
28753     "examples": [
28754       {
28755         "title": "Example usage:",
28756         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28757         "type": "json"
28758       }
28759     ],
28760     "name": "CloneUser_Profiles",
28761     "group": "User_Profiles",
28762     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28763     "version": "0.0.0",
28764     "filename": "server/api/userProfile/index.js",
28765     "groupTitle": "User_Profiles"
28766   },
28767   {
28768     "type": "post",
28769     "url": "/api/userProfiles",
28770     "title": "Creates a new User Profile",
28771     "examples": [
28772       {
28773         "title": "Example usage:",
28774         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
28775         "type": "json"
28776       }
28777     ],
28778     "name": "CreateUser_Profiles",
28779     "group": "User_Profiles",
28780     "parameter": {
28781       "fields": {
28782         "Body": [
28783           {
28784             "group": "Body",
28785             "type": "String",
28786             "optional": false,
28787             "field": "name",
28788             "description": ""
28789           },
28790           {
28791             "group": "Body",
28792             "type": "String",
28793             "optional": false,
28794             "field": "crudPermissions",
28795             "description": ""
28796           },
28797           {
28798             "group": "Body",
28799             "type": "String",
28800             "optional": true,
28801             "field": "description",
28802             "description": ""
28803           },
28804           {
28805             "group": "Body",
28806             "type": "Boolean",
28807             "optional": true,
28808             "field": "privacyEnabled",
28809             "description": ""
28810           },
28811           {
28812             "group": "Body",
28813             "type": "Boolean",
28814             "optional": true,
28815             "field": "downloadAttachments",
28816             "description": ""
28817           },
28818           {
28819             "group": "Body",
28820             "type": "Boolean",
28821             "optional": true,
28822             "field": "downloadCallySquareRecordings",
28823             "description": ""
28824           },
28825           {
28826             "group": "Body",
28827             "type": "Boolean",
28828             "optional": true,
28829             "field": "downloadContactManagerLists",
28830             "description": ""
28831           },
28832           {
28833             "group": "Body",
28834             "type": "Boolean",
28835             "optional": true,
28836             "field": "downloadJscriptySessions",
28837             "description": ""
28838           },
28839           {
28840             "group": "Body",
28841             "type": "Boolean",
28842             "optional": true,
28843             "field": "downloadOmnichannelInteractions",
28844             "description": ""
28845           },
28846           {
28847             "group": "Body",
28848             "type": "Boolean",
28849             "optional": true,
28850             "field": "downloadScreenRecordings",
28851             "description": ""
28852           },
28853           {
28854             "group": "Body",
28855             "type": "Boolean",
28856             "optional": true,
28857             "field": "downloadVoiceRecordings",
28858             "description": ""
28859           }
28860         ]
28861       }
28862     },
28863     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28864     "version": "0.0.0",
28865     "filename": "server/api/userProfile/index.js",
28866     "groupTitle": "User_Profiles"
28867   },
28868   {
28869     "type": "delete",
28870     "url": "/api/userProfiles/{id}",
28871     "title": "Deletes a User Profile",
28872     "examples": [
28873       {
28874         "title": "Example usage:",
28875         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28876         "type": "json"
28877       }
28878     ],
28879     "name": "DeleteUser_Profiles",
28880     "group": "User_Profiles",
28881     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28882     "version": "0.0.0",
28883     "filename": "server/api/userProfile/index.js",
28884     "groupTitle": "User_Profiles"
28885   },
28886   {
28887     "type": "get",
28888     "url": "/api/userProfiles/describe",
28889     "title": "Gets table info about User Profiles",
28890     "examples": [
28891       {
28892         "title": "Example usage:",
28893         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28894         "type": "json"
28895       }
28896     ],
28897     "name": "DescribeUser_Profiles",
28898     "group": "User_Profiles",
28899     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28900     "version": "0.0.0",
28901     "filename": "server/api/userProfile/index.js",
28902     "groupTitle": "User_Profiles"
28903   },
28904   {
28905     "type": "get",
28906     "url": "/api/userProfiles/{id}/resources?section={section}",
28907     "title": "Get Resources assigned to a Section",
28908     "examples": [
28909       {
28910         "title": "Example usage:",
28911         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28912         "type": "json"
28913       }
28914     ],
28915     "name": "GetResources",
28916     "group": "User_Profiles",
28917     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28918     "version": "0.0.0",
28919     "filename": "server/api/userProfile/index.js",
28920     "groupTitle": "User_Profiles"
28921   },
28922   {
28923     "type": "get",
28924     "url": "/api/userProfiles/{id}/sections",
28925     "title": "Get sections associated to a User Profile",
28926     "examples": [
28927       {
28928         "title": "Example usage:",
28929         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28930         "type": "json"
28931       }
28932     ],
28933     "name": "GetSections",
28934     "group": "User_Profiles",
28935     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28936     "version": "0.0.0",
28937     "filename": "server/api/userProfile/index.js",
28938     "groupTitle": "User_Profiles"
28939   },
28940   {
28941     "type": "get",
28942     "url": "/api/userProfiles",
28943     "title": "Gets a list of User Profiles",
28944     "examples": [
28945       {
28946         "title": "Example usage:",
28947         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28948         "type": "json"
28949       }
28950     ],
28951     "name": "GetUser_Profiles",
28952     "group": "User_Profiles",
28953     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28954     "version": "0.0.0",
28955     "filename": "server/api/userProfile/index.js",
28956     "groupTitle": "User_Profiles"
28957   },
28958   {
28959     "type": "delete",
28960     "url": "/api/userProfiles/{id}/resources",
28961     "title": "Removes resources' permissions from User Profile",
28962     "examples": [
28963       {
28964         "title": "Example usage:",
28965         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28966         "type": "json"
28967       }
28968     ],
28969     "name": "RemoveResources",
28970     "group": "User_Profiles",
28971     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28972     "version": "0.0.0",
28973     "filename": "server/api/userProfile/index.js",
28974     "groupTitle": "User_Profiles"
28975   },
28976   {
28977     "type": "delete",
28978     "url": "/api/userProfiles/{id}/sections",
28979     "title": "Removes sections' permissions from User Profile",
28980     "examples": [
28981       {
28982         "title": "Example usage:",
28983         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28984         "type": "json"
28985       }
28986     ],
28987     "name": "RemoveSections",
28988     "group": "User_Profiles",
28989     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28990     "version": "0.0.0",
28991     "filename": "server/api/userProfile/index.js",
28992     "groupTitle": "User_Profiles"
28993   },
28994   {
28995     "type": "get",
28996     "url": "/api/userProfiles/{id}",
28997     "title": "Gets a single User Profile",
28998     "examples": [
28999       {
29000         "title": "Example usage:",
29001         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
29002         "type": "json"
29003       }
29004     ],
29005     "name": "ShowUser_Profiles",
29006     "group": "User_Profiles",
29007     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29008     "version": "0.0.0",
29009     "filename": "server/api/userProfile/index.js",
29010     "groupTitle": "User_Profiles"
29011   },
29012   {
29013     "type": "put",
29014     "url": "/api/userProfiles/{id}",
29015     "title": "Update an existing User Profile",
29016     "examples": [
29017       {
29018         "title": "Example usage:",
29019         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29020         "type": "json"
29021       }
29022     ],
29023     "name": "updateUser_Profiles",
29024     "group": "User_Profiles",
29025     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29026     "version": "0.0.0",
29027     "filename": "server/api/userProfile/index.js",
29028     "groupTitle": "User_Profiles"
29029   },
29030   {
29031     "type": "post",
29032     "url": "/api/users/{id}/chat_interactions",
29033     "title": "Add chat interaction tabs to an agent",
29034     "examples": [
29035       {
29036         "title": "Example usage:",
29037         "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",
29038         "type": "json"
29039       }
29040     ],
29041     "name": "AddChatInteractions",
29042     "group": "Users",
29043     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29044     "version": "0.0.0",
29045     "filename": "server/api/user/index.js",
29046     "groupTitle": "Users"
29047   },
29048   {
29049     "type": "post",
29050     "url": "/api/users/{id}/chat_websites",
29051     "title": "Add a Chat Website to a user",
29052     "examples": [
29053       {
29054         "title": "Example usage:",
29055         "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",
29056         "type": "json"
29057       }
29058     ],
29059     "name": "AddChatWebsites",
29060     "group": "Users",
29061     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29062     "version": "0.0.0",
29063     "filename": "server/api/user/index.js",
29064     "groupTitle": "Users"
29065   },
29066   {
29067     "type": "post",
29068     "url": "/api/users/{id}/contacts",
29069     "title": "Add contacts to a user",
29070     "examples": [
29071       {
29072         "title": "Example usage:",
29073         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29074         "type": "json"
29075       }
29076     ],
29077     "name": "AddContacts",
29078     "group": "Users",
29079     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29080     "version": "0.0.0",
29081     "filename": "server/api/user/index.js",
29082     "groupTitle": "Users"
29083   },
29084   {
29085     "type": "post",
29086     "url": "/api/users/{id}/fax_accounts",
29087     "title": "Add a Fax Account to a user",
29088     "examples": [
29089       {
29090         "title": "Example usage:",
29091         "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",
29092         "type": "json"
29093       }
29094     ],
29095     "name": "AddFaxAccounts",
29096     "group": "Users",
29097     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29098     "version": "0.0.0",
29099     "filename": "server/api/user/index.js",
29100     "groupTitle": "Users"
29101   },
29102   {
29103     "type": "post",
29104     "url": "/api/users/{id}/fax_interactions",
29105     "title": "Add fax interaction tabs to an agent",
29106     "examples": [
29107       {
29108         "title": "Example usage:",
29109         "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",
29110         "type": "json"
29111       }
29112     ],
29113     "name": "AddFaxInteractions",
29114     "group": "Users",
29115     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29116     "version": "0.0.0",
29117     "filename": "server/api/user/index.js",
29118     "groupTitle": "Users"
29119   },
29120   {
29121     "type": "post",
29122     "url": "/api/users/{id}/mail_accounts",
29123     "title": "Add a Mail Account to a user",
29124     "examples": [
29125       {
29126         "title": "Example usage:",
29127         "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",
29128         "type": "json"
29129       }
29130     ],
29131     "name": "AddMailAccounts",
29132     "group": "Users",
29133     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29134     "version": "0.0.0",
29135     "filename": "server/api/user/index.js",
29136     "groupTitle": "Users"
29137   },
29138   {
29139     "type": "post",
29140     "url": "/api/users/{id}/mail_interactions",
29141     "title": "Add mail interaction tabs to an agent",
29142     "examples": [
29143       {
29144         "title": "Example usage:",
29145         "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",
29146         "type": "json"
29147       }
29148     ],
29149     "name": "AddMailInteractions",
29150     "group": "Users",
29151     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29152     "version": "0.0.0",
29153     "filename": "server/api/user/index.js",
29154     "groupTitle": "Users"
29155   },
29156   {
29157     "type": "post",
29158     "url": "/api/users/{id}/openchannel_accounts",
29159     "title": "Add a Open Channel Account to a user",
29160     "examples": [
29161       {
29162         "title": "Example usage:",
29163         "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",
29164         "type": "json"
29165       }
29166     ],
29167     "name": "AddOpenchannelAccounts",
29168     "group": "Users",
29169     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29170     "version": "0.0.0",
29171     "filename": "server/api/user/index.js",
29172     "groupTitle": "Users"
29173   },
29174   {
29175     "type": "post",
29176     "url": "/api/users/{id}/openchannel_interactions",
29177     "title": "Add openchannel interaction tabs to an agent",
29178     "examples": [
29179       {
29180         "title": "Example usage:",
29181         "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",
29182         "type": "json"
29183       }
29184     ],
29185     "name": "AddOpenchannelInteractions",
29186     "group": "Users",
29187     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29188     "version": "0.0.0",
29189     "filename": "server/api/user/index.js",
29190     "groupTitle": "Users"
29191   },
29192   {
29193     "type": "post",
29194     "url": "/api/users/{id}/queues",
29195     "title": "Add queues to an agent",
29196     "examples": [
29197       {
29198         "title": "Example usage:",
29199         "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",
29200         "type": "json"
29201       }
29202     ],
29203     "name": "AddQueues",
29204     "group": "Users",
29205     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29206     "version": "0.0.0",
29207     "filename": "server/api/user/index.js",
29208     "groupTitle": "Users"
29209   },
29210   {
29211     "type": "post",
29212     "url": "/api/users/{id}/sms_accounts",
29213     "title": "Add a Sms Account to a user",
29214     "examples": [
29215       {
29216         "title": "Example usage:",
29217         "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",
29218         "type": "json"
29219       }
29220     ],
29221     "name": "AddSmsAccounts",
29222     "group": "Users",
29223     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29224     "version": "0.0.0",
29225     "filename": "server/api/user/index.js",
29226     "groupTitle": "Users"
29227   },
29228   {
29229     "type": "post",
29230     "url": "/api/users/{id}/sms_interactions",
29231     "title": "Add sms interaction tabs to an agent",
29232     "examples": [
29233       {
29234         "title": "Example usage:",
29235         "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",
29236         "type": "json"
29237       }
29238     ],
29239     "name": "AddSmsInteractions",
29240     "group": "Users",
29241     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29242     "version": "0.0.0",
29243     "filename": "server/api/user/index.js",
29244     "groupTitle": "Users"
29245   },
29246   {
29247     "type": "post",
29248     "url": "/api/users/{id}/square_projects",
29249     "title": "Add a Square Project to a user",
29250     "examples": [
29251       {
29252         "title": "Example usage:",
29253         "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",
29254         "type": "json"
29255       }
29256     ],
29257     "name": "AddSquareProjects",
29258     "group": "Users",
29259     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29260     "version": "0.0.0",
29261     "filename": "server/api/user/index.js",
29262     "groupTitle": "Users"
29263   },
29264   {
29265     "type": "post",
29266     "url": "/api/users/{id}/teams",
29267     "title": "Add teams to an agent",
29268     "examples": [
29269       {
29270         "title": "Example usage:",
29271         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29272         "type": "json"
29273       }
29274     ],
29275     "name": "AddTeams",
29276     "group": "Users",
29277     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29278     "version": "0.0.0",
29279     "filename": "server/api/user/index.js",
29280     "groupTitle": "Users"
29281   },
29282   {
29283     "type": "post",
29284     "url": "/api/users/{id}/whatsapp_accounts",
29285     "title": "Add a Whatsapp Account to a user",
29286     "examples": [
29287       {
29288         "title": "Example usage:",
29289         "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",
29290         "type": "json"
29291       }
29292     ],
29293     "name": "AddWhatsappAccounts",
29294     "group": "Users",
29295     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29296     "version": "0.0.0",
29297     "filename": "server/api/user/index.js",
29298     "groupTitle": "Users"
29299   },
29300   {
29301     "type": "post",
29302     "url": "/api/users/{id}/whatsapp_interactions",
29303     "title": "Add Whatsapp interaction tabs to an agent",
29304     "examples": [
29305       {
29306         "title": "Example usage:",
29307         "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",
29308         "type": "json"
29309       }
29310     ],
29311     "name": "AddWhatsappInteractions",
29312     "group": "Users",
29313     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29314     "version": "0.0.0",
29315     "filename": "server/api/user/index.js",
29316     "groupTitle": "Users"
29317   },
29318   {
29319     "type": "put",
29320     "url": "/api/users/{id}/password",
29321     "title": "Change user password",
29322     "examples": [
29323       {
29324         "title": "Example usage:",
29325         "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",
29326         "type": "json"
29327       }
29328     ],
29329     "name": "ChangePwd",
29330     "group": "Users",
29331     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29332     "version": "0.0.0",
29333     "filename": "server/api/user/index.js",
29334     "groupTitle": "Users"
29335   },
29336   {
29337     "type": "post",
29338     "url": "/api/users",
29339     "title": "Create a new user",
29340     "examples": [
29341       {
29342         "title": "Example usage:",
29343         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29344         "type": "json"
29345       }
29346     ],
29347     "name": "Create",
29348     "group": "Users",
29349     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29350     "version": "0.0.0",
29351     "filename": "server/api/user/index.js",
29352     "groupTitle": "Users"
29353   },
29354   {
29355     "type": "post",
29356     "url": "/api/users/{id}/api_key",
29357     "title": "Create a new API access key for the user",
29358     "examples": [
29359       {
29360         "title": "Example usage:",
29361         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29362         "type": "json"
29363       }
29364     ],
29365     "name": "CreateApiKey",
29366     "group": "Users",
29367     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29368     "version": "0.0.0",
29369     "filename": "server/api/user/index.js",
29370     "groupTitle": "Users"
29371   },
29372   {
29373     "type": "delete",
29374     "url": "/api/users/{id}",
29375     "title": "Deletes a user",
29376     "examples": [
29377       {
29378         "title": "Example usage:",
29379         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29380         "type": "json"
29381       }
29382     ],
29383     "name": "Delete",
29384     "group": "Users",
29385     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29386     "version": "0.0.0",
29387     "filename": "server/api/user/index.js",
29388     "groupTitle": "Users"
29389   },
29390   {
29391     "type": "get",
29392     "url": "/api/users/describe",
29393     "title": "Gets table info about Users",
29394     "examples": [
29395       {
29396         "title": "Example usage:",
29397         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29398         "type": "json"
29399       }
29400     ],
29401     "name": "DescribeUsers",
29402     "group": "Users",
29403     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29404     "version": "0.0.0",
29405     "filename": "server/api/user/index.js",
29406     "groupTitle": "Users"
29407   },
29408   {
29409     "type": "get",
29410     "url": "/api/users/{id}/agents",
29411     "title": "GetAgents",
29412     "examples": [
29413       {
29414         "title": "Example usage:",
29415         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29416         "type": "json"
29417       }
29418     ],
29419     "name": "GetAgents",
29420     "group": "Users",
29421     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29422     "version": "0.0.0",
29423     "filename": "server/api/user/index.js",
29424     "groupTitle": "Users"
29425   },
29426   {
29427     "type": "get",
29428     "url": "/api/users/{id}/api_key",
29429     "title": "Get the API access key for the user",
29430     "examples": [
29431       {
29432         "title": "Example usage:",
29433         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29434         "type": "json"
29435       }
29436     ],
29437     "name": "GetApiKey",
29438     "group": "Users",
29439     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29440     "version": "0.0.0",
29441     "filename": "server/api/user/index.js",
29442     "groupTitle": "Users"
29443   },
29444   {
29445     "type": "get",
29446     "url": "/api/users/{id}/groups",
29447     "title": "GetChatGroups",
29448     "examples": [
29449       {
29450         "title": "Example usage:",
29451         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29452         "type": "json"
29453       }
29454     ],
29455     "name": "GetChatGroups",
29456     "group": "Users",
29457     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29458     "version": "0.0.0",
29459     "filename": "server/api/user/index.js",
29460     "groupTitle": "Users"
29461   },
29462   {
29463     "type": "get",
29464     "url": "/api/users/{id}/chat/interactions",
29465     "title": "GetChatInteractions",
29466     "examples": [
29467       {
29468         "title": "Example usage:",
29469         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29470         "type": "json"
29471       }
29472     ],
29473     "name": "GetChatInteractions",
29474     "group": "Users",
29475     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29476     "version": "0.0.0",
29477     "filename": "server/api/user/index.js",
29478     "groupTitle": "Users"
29479   },
29480   {
29481     "type": "get",
29482     "url": "/api/users/{id}/chat_websites",
29483     "title": "GetChatWebsites",
29484     "examples": [
29485       {
29486         "title": "Example usage:",
29487         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29488         "type": "json"
29489       }
29490     ],
29491     "name": "GetChatWebsites",
29492     "group": "Users",
29493     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29494     "version": "0.0.0",
29495     "filename": "server/api/user/index.js",
29496     "groupTitle": "Users"
29497   },
29498   {
29499     "type": "get",
29500     "url": "/api/users/{id}/contacts",
29501     "title": "GetContacts",
29502     "examples": [
29503       {
29504         "title": "Example usage:",
29505         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29506         "type": "json"
29507       }
29508     ],
29509     "name": "GetContacts",
29510     "group": "Users",
29511     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29512     "version": "0.0.0",
29513     "filename": "server/api/user/index.js",
29514     "groupTitle": "Users"
29515   },
29516   {
29517     "type": "get",
29518     "url": "/api/users/{id}/fax_accounts",
29519     "title": "GetFaxAccounts",
29520     "examples": [
29521       {
29522         "title": "Example usage:",
29523         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29524         "type": "json"
29525       }
29526     ],
29527     "name": "GetFaxAccounts",
29528     "group": "Users",
29529     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29530     "version": "0.0.0",
29531     "filename": "server/api/user/index.js",
29532     "groupTitle": "Users"
29533   },
29534   {
29535     "type": "get",
29536     "url": "/api/users/{id}/fax/interactions",
29537     "title": "GetFaxInteractions",
29538     "examples": [
29539       {
29540         "title": "Example usage:",
29541         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29542         "type": "json"
29543       }
29544     ],
29545     "name": "GetFaxInteractions",
29546     "group": "Users",
29547     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29548     "version": "0.0.0",
29549     "filename": "server/api/user/index.js",
29550     "groupTitle": "Users"
29551   },
29552   {
29553     "type": "get",
29554     "url": "/api/users/{id}/lists",
29555     "title": "GetLists",
29556     "examples": [
29557       {
29558         "title": "Example usage:",
29559         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29560         "type": "json"
29561       }
29562     ],
29563     "name": "GetLists",
29564     "group": "Users",
29565     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29566     "version": "0.0.0",
29567     "filename": "server/api/user/index.js",
29568     "groupTitle": "Users"
29569   },
29570   {
29571     "type": "get",
29572     "url": "/api/users/{id}/mail_accounts",
29573     "title": "GetMailAccounts",
29574     "examples": [
29575       {
29576         "title": "Example usage:",
29577         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29578         "type": "json"
29579       }
29580     ],
29581     "name": "GetMailAccounts",
29582     "group": "Users",
29583     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29584     "version": "0.0.0",
29585     "filename": "server/api/user/index.js",
29586     "groupTitle": "Users"
29587   },
29588   {
29589     "type": "get",
29590     "url": "/api/users/{id}/mail/interactions",
29591     "title": "GetMailInteractions",
29592     "examples": [
29593       {
29594         "title": "Example usage:",
29595         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29596         "type": "json"
29597       }
29598     ],
29599     "name": "GetMailInteractions",
29600     "group": "Users",
29601     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29602     "version": "0.0.0",
29603     "filename": "server/api/user/index.js",
29604     "groupTitle": "Users"
29605   },
29606   {
29607     "type": "get",
29608     "url": "/api/users/{id}/openchannel_accounts",
29609     "title": "GetOpenchannelAccounts",
29610     "examples": [
29611       {
29612         "title": "Example usage:",
29613         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29614         "type": "json"
29615       }
29616     ],
29617     "name": "GetOpenchannelAccounts",
29618     "group": "Users",
29619     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29620     "version": "0.0.0",
29621     "filename": "server/api/user/index.js",
29622     "groupTitle": "Users"
29623   },
29624   {
29625     "type": "get",
29626     "url": "/api/users/{id}/openchannel/interactions",
29627     "title": "GetOpenchannelInteractions",
29628     "examples": [
29629       {
29630         "title": "Example usage:",
29631         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29632         "type": "json"
29633       }
29634     ],
29635     "name": "GetOpenchannelInteractions",
29636     "group": "Users",
29637     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29638     "version": "0.0.0",
29639     "filename": "server/api/user/index.js",
29640     "groupTitle": "Users"
29641   },
29642   {
29643     "type": "get",
29644     "url": "/api/users/{id}/prefixes",
29645     "title": "GetPrefixes",
29646     "examples": [
29647       {
29648         "title": "Example usage:",
29649         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29650         "type": "json"
29651       }
29652     ],
29653     "name": "GetPrefixes",
29654     "group": "Users",
29655     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29656     "version": "0.0.0",
29657     "filename": "server/api/user/index.js",
29658     "groupTitle": "Users"
29659   },
29660   {
29661     "type": "get",
29662     "url": "/api/users/{id}/queues?channel={channel}",
29663     "title": "Gets Queues list",
29664     "examples": [
29665       {
29666         "title": "Example usage:",
29667         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29668         "type": "json"
29669       }
29670     ],
29671     "name": "GetQueues",
29672     "group": "Users",
29673     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29674     "version": "0.0.0",
29675     "filename": "server/api/user/index.js",
29676     "groupTitle": "Users"
29677   },
29678   {
29679     "type": "get",
29680     "url": "/api/users/{id}/recordings",
29681     "title": "GetRecordings",
29682     "examples": [
29683       {
29684         "title": "Example usage:",
29685         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29686         "type": "json"
29687       }
29688     ],
29689     "name": "GetRecordings",
29690     "group": "Users",
29691     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29692     "version": "0.0.0",
29693     "filename": "server/api/user/index.js",
29694     "groupTitle": "Users"
29695   },
29696   {
29697     "type": "get",
29698     "url": "/api/users/{id}/scheduled_calls",
29699     "title": "GetScheduledCalls",
29700     "examples": [
29701       {
29702         "title": "Example usage:",
29703         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29704         "type": "json"
29705       }
29706     ],
29707     "name": "GetScheduledCalls",
29708     "group": "Users",
29709     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29710     "version": "0.0.0",
29711     "filename": "server/api/user/index.js",
29712     "groupTitle": "Users"
29713   },
29714   {
29715     "type": "get",
29716     "url": "/api/users/{id}/screen_recordings",
29717     "title": "GetScreenRecordings",
29718     "examples": [
29719       {
29720         "title": "Example usage:",
29721         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29722         "type": "json"
29723       }
29724     ],
29725     "name": "GetScreenRecordings",
29726     "group": "Users",
29727     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29728     "version": "0.0.0",
29729     "filename": "server/api/user/index.js",
29730     "groupTitle": "Users"
29731   },
29732   {
29733     "type": "get",
29734     "url": "/api/users/{id}/sms_accounts",
29735     "title": "GetSmsAccounts",
29736     "examples": [
29737       {
29738         "title": "Example usage:",
29739         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29740         "type": "json"
29741       }
29742     ],
29743     "name": "GetSmsAccounts",
29744     "group": "Users",
29745     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29746     "version": "0.0.0",
29747     "filename": "server/api/user/index.js",
29748     "groupTitle": "Users"
29749   },
29750   {
29751     "type": "get",
29752     "url": "/api/users/{id}/sms/interactions",
29753     "title": "GetSmsInteractions",
29754     "examples": [
29755       {
29756         "title": "Example usage:",
29757         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29758         "type": "json"
29759       }
29760     ],
29761     "name": "GetSmsInteractions",
29762     "group": "Users",
29763     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29764     "version": "0.0.0",
29765     "filename": "server/api/user/index.js",
29766     "groupTitle": "Users"
29767   },
29768   {
29769     "type": "get",
29770     "url": "/api/users/{id}/square_projects",
29771     "title": "GetSquareProjects",
29772     "examples": [
29773       {
29774         "title": "Example usage:",
29775         "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29776         "type": "json"
29777       }
29778     ],
29779     "name": "GetSquareProjects",
29780     "group": "Users",
29781     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29782     "version": "0.0.0",
29783     "filename": "server/api/user/index.js",
29784     "groupTitle": "Users"
29785   },
29786   {
29787     "type": "get",
29788     "url": "/api/users/{id}/teams",
29789     "title": "GetTeams",
29790     "examples": [
29791       {
29792         "title": "Example usage:",
29793         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29794         "type": "json"
29795       }
29796     ],
29797     "name": "GetTeams",
29798     "group": "Users",
29799     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29800     "version": "0.0.0",
29801     "filename": "server/api/user/index.js",
29802     "groupTitle": "Users"
29803   },
29804   {
29805     "type": "get",
29806     "url": "/api/users",
29807     "title": "Gets a list of Users",
29808     "examples": [
29809       {
29810         "title": "Example usage:",
29811         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29812         "type": "json"
29813       }
29814     ],
29815     "name": "GetUsers",
29816     "group": "Users",
29817     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29818     "version": "0.0.0",
29819     "filename": "server/api/user/index.js",
29820     "groupTitle": "Users"
29821   },
29822   {
29823     "type": "get",
29824     "url": "/api/users/{id}/queues_rt",
29825     "title": "GetVoiceQueuesRt",
29826     "examples": [
29827       {
29828         "title": "Example usage:",
29829         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29830         "type": "json"
29831       }
29832     ],
29833     "name": "GetVoiceQueuesRt",
29834     "group": "Users",
29835     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29836     "version": "0.0.0",
29837     "filename": "server/api/user/index.js",
29838     "groupTitle": "Users"
29839   },
29840   {
29841     "type": "get",
29842     "url": "/api/users/{id}/whatsapp_accounts",
29843     "title": "GetWhatsappAccounts",
29844     "examples": [
29845       {
29846         "title": "Example usage:",
29847         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29848         "type": "json"
29849       }
29850     ],
29851     "name": "GetWhatsappAccounts",
29852     "group": "Users",
29853     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29854     "version": "0.0.0",
29855     "filename": "server/api/user/index.js",
29856     "groupTitle": "Users"
29857   },
29858   {
29859     "type": "get",
29860     "url": "/api/users/{id}/whatsapp/interactions",
29861     "title": "GetWhatsappInteractions",
29862     "examples": [
29863       {
29864         "title": "Example usage:",
29865         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29866         "type": "json"
29867       }
29868     ],
29869     "name": "GetWhatsappInteractions",
29870     "group": "Users",
29871     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29872     "version": "0.0.0",
29873     "filename": "server/api/user/index.js",
29874     "groupTitle": "Users"
29875   },
29876   {
29877     "type": "post",
29878     "url": "/api/users/{id}/login",
29879     "title": "Login",
29880     "examples": [
29881       {
29882         "title": "Example usage:",
29883         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
29884         "type": "json"
29885       }
29886     ],
29887     "name": "Login",
29888     "group": "Users",
29889     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29890     "version": "0.0.0",
29891     "filename": "server/api/user/index.js",
29892     "groupTitle": "Users"
29893   },
29894   {
29895     "type": "post",
29896     "url": "/api/users/{id}/logout",
29897     "title": "Logout",
29898     "examples": [
29899       {
29900         "title": "Example usage:",
29901         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29902         "type": "json"
29903       }
29904     ],
29905     "name": "Logout",
29906     "group": "Users",
29907     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29908     "version": "0.0.0",
29909     "filename": "server/api/user/index.js",
29910     "groupTitle": "Users"
29911   },
29912   {
29913     "type": "post",
29914     "url": "/api/users/{id}/pause",
29915     "title": "Pause",
29916     "examples": [
29917       {
29918         "title": "Example usage:",
29919         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29920         "type": "json"
29921       }
29922     ],
29923     "name": "Pause",
29924     "group": "Users",
29925     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29926     "version": "0.0.0",
29927     "filename": "server/api/user/index.js",
29928     "groupTitle": "Users"
29929   },
29930   {
29931     "type": "delete",
29932     "url": "/api/users/{id}/api_key",
29933     "title": "Remove API access key for the user",
29934     "examples": [
29935       {
29936         "title": "Example usage:",
29937         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29938         "type": "json"
29939       }
29940     ],
29941     "name": "RemoveApiKey",
29942     "group": "Users",
29943     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29944     "version": "0.0.0",
29945     "filename": "server/api/user/index.js",
29946     "groupTitle": "Users"
29947   },
29948   {
29949     "type": "delete",
29950     "url": "/api/users/{id}/chat_interactions",
29951     "title": "Removes interactions from an agent",
29952     "examples": [
29953       {
29954         "title": "Example usage:",
29955         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29956         "type": "json"
29957       }
29958     ],
29959     "name": "RemoveChatInteractions",
29960     "group": "Users",
29961     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29962     "version": "0.0.0",
29963     "filename": "server/api/user/index.js",
29964     "groupTitle": "Users"
29965   },
29966   {
29967     "type": "delete",
29968     "url": "/api/users/{id}/chat_websites",
29969     "title": "Removes a Chat Website from a user",
29970     "examples": [
29971       {
29972         "title": "Example usage:",
29973         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29974         "type": "json"
29975       }
29976     ],
29977     "name": "RemoveChatWebsites",
29978     "group": "Users",
29979     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29980     "version": "0.0.0",
29981     "filename": "server/api/user/index.js",
29982     "groupTitle": "Users"
29983   },
29984   {
29985     "type": "delete",
29986     "url": "/api/users/{id}/fax_accounts",
29987     "title": "Removes a Fax Account from a user",
29988     "examples": [
29989       {
29990         "title": "Example usage:",
29991         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29992         "type": "json"
29993       }
29994     ],
29995     "name": "RemoveFaxAccounts",
29996     "group": "Users",
29997     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29998     "version": "0.0.0",
29999     "filename": "server/api/user/index.js",
30000     "groupTitle": "Users"
30001   },
30002   {
30003     "type": "delete",
30004     "url": "/api/users/{id}/fax_interactions",
30005     "title": "Removes interactions from an agent",
30006     "examples": [
30007       {
30008         "title": "Example usage:",
30009         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30010         "type": "json"
30011       }
30012     ],
30013     "name": "RemoveFaxInteractions",
30014     "group": "Users",
30015     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30016     "version": "0.0.0",
30017     "filename": "server/api/user/index.js",
30018     "groupTitle": "Users"
30019   },
30020   {
30021     "type": "delete",
30022     "url": "/api/users/{id}/mail_accounts",
30023     "title": "Removes a Mail Account from a user",
30024     "examples": [
30025       {
30026         "title": "Example usage:",
30027         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30028         "type": "json"
30029       }
30030     ],
30031     "name": "RemoveMailAccounts",
30032     "group": "Users",
30033     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30034     "version": "0.0.0",
30035     "filename": "server/api/user/index.js",
30036     "groupTitle": "Users"
30037   },
30038   {
30039     "type": "delete",
30040     "url": "/api/users/{id}/mail_interactions",
30041     "title": "Removes interactions from an agent",
30042     "examples": [
30043       {
30044         "title": "Example usage:",
30045         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30046         "type": "json"
30047       }
30048     ],
30049     "name": "RemoveMailInteractions",
30050     "group": "Users",
30051     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30052     "version": "0.0.0",
30053     "filename": "server/api/user/index.js",
30054     "groupTitle": "Users"
30055   },
30056   {
30057     "type": "delete",
30058     "url": "/api/users/{id}/openchannel_accounts",
30059     "title": "Removes a Open Channel Account from a user",
30060     "examples": [
30061       {
30062         "title": "Example usage:",
30063         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30064         "type": "json"
30065       }
30066     ],
30067     "name": "RemoveOpenchannelAccounts",
30068     "group": "Users",
30069     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30070     "version": "0.0.0",
30071     "filename": "server/api/user/index.js",
30072     "groupTitle": "Users"
30073   },
30074   {
30075     "type": "delete",
30076     "url": "/api/users/{id}/openchannel_interactions",
30077     "title": "Removes openchannel interactions from an agent",
30078     "examples": [
30079       {
30080         "title": "Example usage:",
30081         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30082         "type": "json"
30083       }
30084     ],
30085     "name": "RemoveOpenchannelInteractions",
30086     "group": "Users",
30087     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30088     "version": "0.0.0",
30089     "filename": "server/api/user/index.js",
30090     "groupTitle": "Users"
30091   },
30092   {
30093     "type": "delete",
30094     "url": "/api/users/{id}/queues",
30095     "title": "Remove queues to an agent",
30096     "examples": [
30097       {
30098         "title": "Example usage:",
30099         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30100         "type": "json"
30101       }
30102     ],
30103     "name": "RemoveQueues",
30104     "group": "Users",
30105     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30106     "version": "0.0.0",
30107     "filename": "server/api/user/index.js",
30108     "groupTitle": "Users"
30109   },
30110   {
30111     "type": "delete",
30112     "url": "/api/users/{id}/sms_accounts",
30113     "title": "Removes a Sms Account from a user",
30114     "examples": [
30115       {
30116         "title": "Example usage:",
30117         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30118         "type": "json"
30119       }
30120     ],
30121     "name": "RemoveSmsAccounts",
30122     "group": "Users",
30123     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30124     "version": "0.0.0",
30125     "filename": "server/api/user/index.js",
30126     "groupTitle": "Users"
30127   },
30128   {
30129     "type": "delete",
30130     "url": "/api/users/{id}/sms_interactions",
30131     "title": "Removes interactions from an agent",
30132     "examples": [
30133       {
30134         "title": "Example usage:",
30135         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30136         "type": "json"
30137       }
30138     ],
30139     "name": "RemoveSmsInteractions",
30140     "group": "Users",
30141     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30142     "version": "0.0.0",
30143     "filename": "server/api/user/index.js",
30144     "groupTitle": "Users"
30145   },
30146   {
30147     "type": "delete",
30148     "url": "/api/users/{id}/square_projects",
30149     "title": "Removes a Square Project from a user",
30150     "examples": [
30151       {
30152         "title": "Example usage:",
30153         "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30154         "type": "json"
30155       }
30156     ],
30157     "name": "RemoveSquareProjects",
30158     "group": "Users",
30159     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30160     "version": "0.0.0",
30161     "filename": "server/api/user/index.js",
30162     "groupTitle": "Users"
30163   },
30164   {
30165     "type": "delete",
30166     "url": "/api/users/{id}/teams",
30167     "title": "Removes teams from an agent",
30168     "examples": [
30169       {
30170         "title": "Example usage:",
30171         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30172         "type": "json"
30173       }
30174     ],
30175     "name": "RemoveTeams",
30176     "group": "Users",
30177     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30178     "version": "0.0.0",
30179     "filename": "server/api/user/index.js",
30180     "groupTitle": "Users"
30181   },
30182   {
30183     "type": "delete",
30184     "url": "/api/users/{id}/whatsapp_accounts",
30185     "title": "Removes a Whatsapp Account from a user",
30186     "examples": [
30187       {
30188         "title": "Example usage:",
30189         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30190         "type": "json"
30191       }
30192     ],
30193     "name": "RemoveWhatsappAccounts",
30194     "group": "Users",
30195     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30196     "version": "0.0.0",
30197     "filename": "server/api/user/index.js",
30198     "groupTitle": "Users"
30199   },
30200   {
30201     "type": "delete",
30202     "url": "/api/users/{id}/whatsapp_interactions",
30203     "title": "Removes Whatsapp interactions from an agent",
30204     "examples": [
30205       {
30206         "title": "Example usage:",
30207         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30208         "type": "json"
30209       }
30210     ],
30211     "name": "RemoveWhatsappInteractions",
30212     "group": "Users",
30213     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30214     "version": "0.0.0",
30215     "filename": "server/api/user/index.js",
30216     "groupTitle": "Users"
30217   },
30218   {
30219     "type": "get",
30220     "url": "/api/users/{id}",
30221     "title": "Gets a single User",
30222     "examples": [
30223       {
30224         "title": "Example usage:",
30225         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
30226         "type": "json"
30227       }
30228     ],
30229     "name": "ShowUsers",
30230     "group": "Users",
30231     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30232     "version": "0.0.0",
30233     "filename": "server/api/user/index.js",
30234     "groupTitle": "Users"
30235   },
30236   {
30237     "type": "post",
30238     "url": "/api/users/{id}/unpause",
30239     "title": "Unpause",
30240     "examples": [
30241       {
30242         "title": "Example usage:",
30243         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
30244         "type": "json"
30245       }
30246     ],
30247     "name": "Unpause",
30248     "group": "Users",
30249     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30250     "version": "0.0.0",
30251     "filename": "server/api/user/index.js",
30252     "groupTitle": "Users"
30253   },
30254   {
30255     "type": "get",
30256     "url": "/api/users/whoami",
30257     "title": "WhoAmI",
30258     "examples": [
30259       {
30260         "title": "Example usage:",
30261         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
30262         "type": "json"
30263       }
30264     ],
30265     "name": "WhoAmI",
30266     "group": "Users",
30267     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30268     "version": "0.0.0",
30269     "filename": "server/api/user/index.js",
30270     "groupTitle": "Users"
30271   },
30272   {
30273     "type": "post",
30274     "url": "/api/users/{id}/avatar",
30275     "title": "Add avatar",
30276     "examples": [
30277       {
30278         "title": "Example usage:",
30279         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
30280         "type": "json"
30281       }
30282     ],
30283     "name": "addAvatar",
30284     "group": "Users",
30285     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30286     "version": "0.0.0",
30287     "filename": "server/api/user/index.js",
30288     "groupTitle": "Users"
30289   },
30290   {
30291     "type": "post",
30292     "url": "/api/users/create_many",
30293     "title": "Create Users",
30294     "examples": [
30295       {
30296         "title": "Example usage:",
30297         "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
30298         "type": "json"
30299       }
30300     ],
30301     "name": "bulkCreate",
30302     "group": "Users",
30303     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30304     "version": "0.0.0",
30305     "filename": "server/api/user/index.js",
30306     "groupTitle": "Users"
30307   },
30308   {
30309     "type": "get",
30310     "url": "/api/users/{id}/avatar",
30311     "title": "Get avatar",
30312     "examples": [
30313       {
30314         "title": "Example usage:",
30315         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
30316         "type": "json"
30317       }
30318     ],
30319     "name": "getAvatar",
30320     "group": "Users",
30321     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30322     "version": "0.0.0",
30323     "filename": "server/api/user/index.js",
30324     "groupTitle": "Users"
30325   },
30326   {
30327     "type": "get",
30328     "url": "/api/users/{id}/open_tabs",
30329     "title": "Get interactions opened tabs",
30330     "examples": [
30331       {
30332         "title": "Example usage:",
30333         "content": "curl https://{domain}/api/users/{id}/open_tabs -v -u {name}:{password} -X GET",
30334         "type": "json"
30335       }
30336     ],
30337     "name": "getOpenTabs",
30338     "group": "Users",
30339     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30340     "version": "0.0.0",
30341     "filename": "server/api/user/index.js",
30342     "groupTitle": "Users"
30343   },
30344   {
30345     "type": "get",
30346     "url": "/api/users/presence",
30347     "title": "Gets agent presence",
30348     "examples": [
30349       {
30350         "title": "Example usage:",
30351         "content": "curl https://{domain}/api/users/presence -v -u {name}:{password}  -X GET",
30352         "type": "json"
30353       }
30354     ],
30355     "name": "getPresence",
30356     "group": "Users",
30357     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30358     "version": "0.0.0",
30359     "filename": "server/api/user/index.js",
30360     "groupTitle": "Users"
30361   },
30362   {
30363     "type": "put",
30364     "url": "/api/users/{id}",
30365     "title": "Update an existing User",
30366     "examples": [
30367       {
30368         "title": "Example usage:",
30369         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30370         "type": "json"
30371       }
30372     ],
30373     "name": "updateUsers",
30374     "group": "Users",
30375     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30376     "version": "0.0.0",
30377     "filename": "server/api/user/index.js",
30378     "groupTitle": "Users"
30379   },
30380   {
30381     "type": "post",
30382     "url": "/api/variables",
30383     "title": "Creates a new Variable",
30384     "examples": [
30385       {
30386         "title": "Example usage:",
30387         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30388         "type": "json"
30389       }
30390     ],
30391     "name": "CreateVariables",
30392     "group": "Variables",
30393     "parameter": {
30394       "fields": {
30395         "Body": [
30396           {
30397             "group": "Body",
30398             "type": "String",
30399             "optional": false,
30400             "field": "name",
30401             "description": ""
30402           },
30403           {
30404             "group": "Body",
30405             "type": "String",
30406             "optional": true,
30407             "field": "description",
30408             "description": ""
30409           }
30410         ]
30411       }
30412     },
30413     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30414     "version": "0.0.0",
30415     "filename": "server/api/variable/index.js",
30416     "groupTitle": "Variables"
30417   },
30418   {
30419     "type": "delete",
30420     "url": "/api/variables/{id}",
30421     "title": "Deletes a Variable",
30422     "examples": [
30423       {
30424         "title": "Example usage:",
30425         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30426         "type": "json"
30427       }
30428     ],
30429     "name": "DeleteVariables",
30430     "group": "Variables",
30431     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30432     "version": "0.0.0",
30433     "filename": "server/api/variable/index.js",
30434     "groupTitle": "Variables"
30435   },
30436   {
30437     "type": "get",
30438     "url": "/api/variables",
30439     "title": "Gets a list of Variables",
30440     "examples": [
30441       {
30442         "title": "Example usage:",
30443         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30444         "type": "json"
30445       }
30446     ],
30447     "name": "GetVariables",
30448     "group": "Variables",
30449     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30450     "version": "0.0.0",
30451     "filename": "server/api/variable/index.js",
30452     "groupTitle": "Variables"
30453   },
30454   {
30455     "type": "get",
30456     "url": "/api/variables/{id}",
30457     "title": "Gets a single Variable",
30458     "examples": [
30459       {
30460         "title": "Example usage:",
30461         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30462         "type": "json"
30463       }
30464     ],
30465     "name": "ShowVariables",
30466     "group": "Variables",
30467     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30468     "version": "0.0.0",
30469     "filename": "server/api/variable/index.js",
30470     "groupTitle": "Variables"
30471   },
30472   {
30473     "type": "put",
30474     "url": "/api/variables/{id}",
30475     "title": "Update an existing Variable",
30476     "examples": [
30477       {
30478         "title": "Example usage:",
30479         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30480         "type": "json"
30481       }
30482     ],
30483     "name": "updateVariables",
30484     "group": "Variables",
30485     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30486     "version": "0.0.0",
30487     "filename": "server/api/variable/index.js",
30488     "groupTitle": "Variables"
30489   },
30490   {
30491     "type": "get",
30492     "url": "/api/version/fetch",
30493     "title": "Fetch git version",
30494     "examples": [
30495       {
30496         "title": "Example usage:",
30497         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30498         "type": "json"
30499       }
30500     ],
30501     "name": "FetchVersion",
30502     "group": "Version",
30503     "description": "<p>Motion run the following command: git fetch origin master</p>",
30504     "version": "0.0.0",
30505     "filename": "server/api/version/index.js",
30506     "groupTitle": "Version"
30507   },
30508   {
30509     "type": "get",
30510     "url": "/api/version",
30511     "title": "Gets version",
30512     "examples": [
30513       {
30514         "title": "Example usage:",
30515         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30516         "type": "json"
30517       }
30518     ],
30519     "name": "GetVersion",
30520     "group": "Version",
30521     "description": "<p>Motion returns the current and latest motion version.</p>",
30522     "version": "0.0.0",
30523     "filename": "server/api/version/index.js",
30524     "groupTitle": "Version"
30525   },
30526   {
30527     "type": "get",
30528     "url": "/api/version/migrations",
30529     "title": "Launch database migrations",
30530     "examples": [
30531       {
30532         "title": "Example usage:",
30533         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30534         "type": "json"
30535       }
30536     ],
30537     "name": "MigrateVersion",
30538     "group": "Version",
30539     "description": "<p>Motion launch the database migrations, according to the application version</p>",
30540     "version": "0.0.0",
30541     "filename": "server/api/version/index.js",
30542     "groupTitle": "Version"
30543   },
30544   {
30545     "type": "get",
30546     "url": "/api/version/pull",
30547     "title": "Pull git version",
30548     "examples": [
30549       {
30550         "title": "Example usage:",
30551         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30552         "type": "json"
30553       }
30554     ],
30555     "name": "PullVersion",
30556     "group": "Version",
30557     "description": "<p>Motion run the following command: git pull</p>",
30558     "version": "0.0.0",
30559     "filename": "server/api/version/index.js",
30560     "groupTitle": "Version"
30561   },
30562   {
30563     "type": "get",
30564     "url": "/api/version/reset",
30565     "title": "Reset git version",
30566     "examples": [
30567       {
30568         "title": "Example usage:",
30569         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30570         "type": "json"
30571       }
30572     ],
30573     "name": "ResetVersion",
30574     "group": "Version",
30575     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30576     "version": "0.0.0",
30577     "filename": "server/api/version/index.js",
30578     "groupTitle": "Version"
30579   },
30580   {
30581     "type": "get",
30582     "url": "/api/version/restart",
30583     "title": "Restart motion2 after update",
30584     "examples": [
30585       {
30586         "title": "Example usage:",
30587         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30588         "type": "json"
30589       }
30590     ],
30591     "name": "RestartVersion",
30592     "group": "Version",
30593     "description": "<p>Motion run the following command: pm2 restart motion</p>",
30594     "version": "0.0.0",
30595     "filename": "server/api/version/index.js",
30596     "groupTitle": "Version"
30597   },
30598   {
30599     "type": "get",
30600     "url": "/api/voice/agents/reports/describe",
30601     "title": "Gets table info about Agent Reports",
30602     "examples": [
30603       {
30604         "title": "Example usage:",
30605         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30606         "type": "json"
30607       }
30608     ],
30609     "name": "DescribeAgent_Reports",
30610     "group": "Voice_Agent_Reports",
30611     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30612     "version": "0.0.0",
30613     "filename": "server/api/voiceAgentReport/index.js",
30614     "groupTitle": "Voice_Agent_Reports"
30615   },
30616   {
30617     "type": "get",
30618     "url": "/api/voice/agents/reports",
30619     "title": "Gets a list of Agent Reports",
30620     "examples": [
30621       {
30622         "title": "Example usage:",
30623         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30624         "type": "json"
30625       }
30626     ],
30627     "name": "GetAgent_Reports",
30628     "group": "Voice_Agent_Reports",
30629     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30630     "version": "0.0.0",
30631     "filename": "server/api/voiceAgentReport/index.js",
30632     "groupTitle": "Voice_Agent_Reports"
30633   },
30634   {
30635     "type": "get",
30636     "url": "/api/voice/agents/reports/{id}",
30637     "title": "Gets a single Agent Report",
30638     "examples": [
30639       {
30640         "title": "Example usage:",
30641         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30642         "type": "json"
30643       }
30644     ],
30645     "name": "ShowAgent_Reports",
30646     "group": "Voice_Agent_Reports",
30647     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30648     "version": "0.0.0",
30649     "filename": "server/api/voiceAgentReport/index.js",
30650     "groupTitle": "Voice_Agent_Reports"
30651   },
30652   {
30653     "type": "get",
30654     "url": "/api/voice/calls/reports/describe",
30655     "title": "Gets table info about Call Reports",
30656     "examples": [
30657       {
30658         "title": "Example usage:",
30659         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30660         "type": "json"
30661       }
30662     ],
30663     "name": "DescribeCall_Reports",
30664     "group": "Voice_Call_Reports",
30665     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30666     "version": "0.0.0",
30667     "filename": "server/api/voiceCallReport/index.js",
30668     "groupTitle": "Voice_Call_Reports"
30669   },
30670   {
30671     "type": "get",
30672     "url": "/api/voice/calls/reports",
30673     "title": "Gets a list of Call Reports",
30674     "examples": [
30675       {
30676         "title": "Example usage:",
30677         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30678         "type": "json"
30679       }
30680     ],
30681     "name": "GetCall_Reports",
30682     "group": "Voice_Call_Reports",
30683     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30684     "version": "0.0.0",
30685     "filename": "server/api/voiceCallReport/index.js",
30686     "groupTitle": "Voice_Call_Reports"
30687   },
30688   {
30689     "type": "get",
30690     "url": "/api/voice/calls/reports/{id}",
30691     "title": "Gets a single Call Report",
30692     "examples": [
30693       {
30694         "title": "Example usage:",
30695         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30696         "type": "json"
30697       }
30698     ],
30699     "name": "ShowCall_Reports",
30700     "group": "Voice_Call_Reports",
30701     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30702     "version": "0.0.0",
30703     "filename": "server/api/voiceCallReport/index.js",
30704     "groupTitle": "Voice_Call_Reports"
30705   },
30706   {
30707     "type": "put",
30708     "url": "/api/voice/calls/reports/{id}",
30709     "title": "Update a single cdr",
30710     "examples": [
30711       {
30712         "title": "Example usage:",
30713         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30714         "type": "json"
30715       }
30716     ],
30717     "name": "update",
30718     "group": "Voice_Call_Reports",
30719     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30720     "version": "0.0.0",
30721     "filename": "server/api/voiceCallReport/index.js",
30722     "groupTitle": "Voice_Call_Reports"
30723   },
30724   {
30725     "type": "post",
30726     "url": "/api/voice/chanspy",
30727     "title": "Creates a new ChanSpy",
30728     "examples": [
30729       {
30730         "title": "Example usage:",
30731         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30732         "type": "json"
30733       }
30734     ],
30735     "name": "CreateChanSpy",
30736     "group": "Voice_ChanSpy",
30737     "parameter": {
30738       "fields": {
30739         "Body": [
30740           {
30741             "group": "Body",
30742             "type": "String",
30743             "optional": true,
30744             "field": "name",
30745             "description": ""
30746           },
30747           {
30748             "group": "Body",
30749             "type": "String",
30750             "optional": false,
30751             "field": "prefix",
30752             "description": ""
30753           },
30754           {
30755             "group": "Body",
30756             "type": "String",
30757             "optional": true,
30758             "field": "options",
30759             "description": ""
30760           },
30761           {
30762             "group": "Body",
30763             "type": "Boolean",
30764             "optional": true,
30765             "field": "auth",
30766             "description": ""
30767           },
30768           {
30769             "group": "Body",
30770             "type": "String",
30771             "optional": true,
30772             "field": "password",
30773             "description": ""
30774           },
30775           {
30776             "group": "Body",
30777             "type": "Boolean",
30778             "optional": true,
30779             "field": "record",
30780             "description": ""
30781           },
30782           {
30783             "group": "Body",
30784             "type": "String",
30785             "optional": true,
30786             "field": "recordingFormat",
30787             "description": ""
30788           },
30789           {
30790             "group": "Body",
30791             "type": "String",
30792             "optional": true,
30793             "field": "description",
30794             "description": ""
30795           }
30796         ]
30797       }
30798     },
30799     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30800     "version": "0.0.0",
30801     "filename": "server/api/voiceChanSpy/index.js",
30802     "groupTitle": "Voice_ChanSpy"
30803   },
30804   {
30805     "type": "delete",
30806     "url": "/api/voice/chanspy/{id}",
30807     "title": "Deletes a ChanSpy",
30808     "examples": [
30809       {
30810         "title": "Example usage:",
30811         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30812         "type": "json"
30813       }
30814     ],
30815     "name": "DeleteChanSpy",
30816     "group": "Voice_ChanSpy",
30817     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30818     "version": "0.0.0",
30819     "filename": "server/api/voiceChanSpy/index.js",
30820     "groupTitle": "Voice_ChanSpy"
30821   },
30822   {
30823     "type": "get",
30824     "url": "/api/voice/chanspy",
30825     "title": "Gets a list of ChanSpy",
30826     "examples": [
30827       {
30828         "title": "Example usage:",
30829         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30830         "type": "json"
30831       }
30832     ],
30833     "name": "GetChanSpy",
30834     "group": "Voice_ChanSpy",
30835     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30836     "version": "0.0.0",
30837     "filename": "server/api/voiceChanSpy/index.js",
30838     "groupTitle": "Voice_ChanSpy"
30839   },
30840   {
30841     "type": "get",
30842     "url": "/api/voice/chanspy/{id}",
30843     "title": "Gets a single ChanSpy",
30844     "examples": [
30845       {
30846         "title": "Example usage:",
30847         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30848         "type": "json"
30849       }
30850     ],
30851     "name": "ShowChanSpy",
30852     "group": "Voice_ChanSpy",
30853     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/voiceChanSpy/index.js",
30856     "groupTitle": "Voice_ChanSpy"
30857   },
30858   {
30859     "type": "put",
30860     "url": "/api/voice/chanspy/{id}",
30861     "title": "Update an existing ChanSpy",
30862     "examples": [
30863       {
30864         "title": "Example usage:",
30865         "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",
30866         "type": "json"
30867       }
30868     ],
30869     "name": "updateChanSpy",
30870     "group": "Voice_ChanSpy",
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/voiceChanSpy/index.js",
30874     "groupTitle": "Voice_ChanSpy"
30875   },
30876   {
30877     "type": "post",
30878     "url": "/api/voice/contexts",
30879     "title": "Create a new context",
30880     "examples": [
30881       {
30882         "title": "Example usage:",
30883         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30884         "type": "json"
30885       }
30886     ],
30887     "name": "Create",
30888     "group": "Voice_Contexts",
30889     "parameter": {
30890       "fields": {
30891         "Body": [
30892           {
30893             "group": "Body",
30894             "type": "String",
30895             "optional": true,
30896             "field": "name",
30897             "description": ""
30898           },
30899           {
30900             "group": "Body",
30901             "type": "String",
30902             "optional": true,
30903             "field": "description",
30904             "description": ""
30905           },
30906           {
30907             "group": "Body",
30908             "type": "Boolean",
30909             "optional": true,
30910             "field": "defaultEntry",
30911             "description": ""
30912           }
30913         ]
30914       }
30915     },
30916     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30917     "version": "0.0.0",
30918     "filename": "server/api/voiceContext/index.js",
30919     "groupTitle": "Voice_Contexts"
30920   },
30921   {
30922     "type": "delete",
30923     "url": "/api/voice/contexts/{id}",
30924     "title": "Deletes a context",
30925     "examples": [
30926       {
30927         "title": "Example usage:",
30928         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30929         "type": "json"
30930       }
30931     ],
30932     "name": "Delete",
30933     "group": "Voice_Contexts",
30934     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30935     "version": "0.0.0",
30936     "filename": "server/api/voiceContext/index.js",
30937     "groupTitle": "Voice_Contexts"
30938   },
30939   {
30940     "type": "get",
30941     "url": "/api/voice/contexts",
30942     "title": "Gets a list of Contexts",
30943     "examples": [
30944       {
30945         "title": "Example usage:",
30946         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30947         "type": "json"
30948       }
30949     ],
30950     "name": "GetContexts",
30951     "group": "Voice_Contexts",
30952     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30953     "version": "0.0.0",
30954     "filename": "server/api/voiceContext/index.js",
30955     "groupTitle": "Voice_Contexts"
30956   },
30957   {
30958     "type": "get",
30959     "url": "/api/voice/contexts/{id}",
30960     "title": "Gets a single Context",
30961     "examples": [
30962       {
30963         "title": "Example usage:",
30964         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30965         "type": "json"
30966       }
30967     ],
30968     "name": "ShowContexts",
30969     "group": "Voice_Contexts",
30970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30971     "version": "0.0.0",
30972     "filename": "server/api/voiceContext/index.js",
30973     "groupTitle": "Voice_Contexts"
30974   },
30975   {
30976     "type": "put",
30977     "url": "/api/voice/contexts/{id}",
30978     "title": "Update an existing context",
30979     "examples": [
30980       {
30981         "title": "Example usage:",
30982         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30983         "type": "json"
30984       }
30985     ],
30986     "name": "Update",
30987     "group": "Voice_Contexts",
30988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30989     "version": "0.0.0",
30990     "filename": "server/api/voiceContext/index.js",
30991     "groupTitle": "Voice_Contexts"
30992   },
30993   {
30994     "type": "get",
30995     "url": "/api/voice/dials/reports/describe",
30996     "title": "Gets table info about Dial Reports",
30997     "examples": [
30998       {
30999         "title": "Example usage:",
31000         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
31001         "type": "json"
31002       }
31003     ],
31004     "name": "DescribeDial_Reports",
31005     "group": "Voice_Dial_Reports",
31006     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31007     "version": "0.0.0",
31008     "filename": "server/api/voiceDialReport/index.js",
31009     "groupTitle": "Voice_Dial_Reports"
31010   },
31011   {
31012     "type": "get",
31013     "url": "/api/voice/dials/reports",
31014     "title": "Gets a list of Dial Reports",
31015     "examples": [
31016       {
31017         "title": "Example usage:",
31018         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
31019         "type": "json"
31020       }
31021     ],
31022     "name": "GetDial_Reports",
31023     "group": "Voice_Dial_Reports",
31024     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31025     "version": "0.0.0",
31026     "filename": "server/api/voiceDialReport/index.js",
31027     "groupTitle": "Voice_Dial_Reports"
31028   },
31029   {
31030     "type": "get",
31031     "url": "/api/voice/dials/reports/{id}",
31032     "title": "Gets a single Dial Report",
31033     "examples": [
31034       {
31035         "title": "Example usage:",
31036         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
31037         "type": "json"
31038       }
31039     ],
31040     "name": "ShowDial_Reports",
31041     "group": "Voice_Dial_Reports",
31042     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31043     "version": "0.0.0",
31044     "filename": "server/api/voiceDialReport/index.js",
31045     "groupTitle": "Voice_Dial_Reports"
31046   },
31047   {
31048     "type": "delete",
31049     "url": "/api/voice/extensions/{id}",
31050     "title": "Deletes a Extension",
31051     "examples": [
31052       {
31053         "title": "Example usage:",
31054         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
31055         "type": "json"
31056       }
31057     ],
31058     "name": "DeleteExtensions",
31059     "group": "Voice_Extensions",
31060     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31061     "version": "0.0.0",
31062     "filename": "server/api/voiceExtension/index.js",
31063     "groupTitle": "Voice_Extensions"
31064   },
31065   {
31066     "type": "get",
31067     "url": "/api/voice/extensions",
31068     "title": "Gets a list of Extensions",
31069     "examples": [
31070       {
31071         "title": "Example usage:",
31072         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
31073         "type": "json"
31074       }
31075     ],
31076     "name": "GetExtensions",
31077     "group": "Voice_Extensions",
31078     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31079     "version": "0.0.0",
31080     "filename": "server/api/voiceExtension/index.js",
31081     "groupTitle": "Voice_Extensions"
31082   },
31083   {
31084     "type": "get",
31085     "url": "/api/voice/extensions/{id}",
31086     "title": "Gets a single Extension",
31087     "examples": [
31088       {
31089         "title": "Example usage:",
31090         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
31091         "type": "json"
31092       }
31093     ],
31094     "name": "ShowExtensions",
31095     "group": "Voice_Extensions",
31096     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31097     "version": "0.0.0",
31098     "filename": "server/api/voiceExtension/index.js",
31099     "groupTitle": "Voice_Extensions"
31100   },
31101   {
31102     "type": "post",
31103     "url": "/api/voice/extensions",
31104     "title": "Create new applications",
31105     "examples": [
31106       {
31107         "title": "Example usage:",
31108         "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",
31109         "type": "json"
31110       }
31111     ],
31112     "name": "addApplications",
31113     "group": "Voice_Extensions",
31114     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31115     "version": "0.0.0",
31116     "filename": "server/api/voiceExtension/index.js",
31117     "groupTitle": "Voice_Extensions"
31118   },
31119   {
31120     "type": "post",
31121     "url": "/api/voice/extensions",
31122     "title": "Create an extension",
31123     "examples": [
31124       {
31125         "title": "Example usage:",
31126         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31127         "type": "json"
31128       }
31129     ],
31130     "name": "create",
31131     "group": "Voice_Extensions",
31132     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31133     "version": "0.0.0",
31134     "filename": "server/api/voiceExtension/index.js",
31135     "groupTitle": "Voice_Extensions"
31136   },
31137   {
31138     "type": "put",
31139     "url": "/api/voice/extensions/{id}",
31140     "title": "Update an extension",
31141     "examples": [
31142       {
31143         "title": "Example usage:",
31144         "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",
31145         "type": "json"
31146       }
31147     ],
31148     "name": "update",
31149     "group": "Voice_Extensions",
31150     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31151     "version": "0.0.0",
31152     "filename": "server/api/voiceExtension/index.js",
31153     "groupTitle": "Voice_Extensions"
31154   },
31155   {
31156     "type": "post",
31157     "url": "/api/voice/mohs",
31158     "title": "Create a new a new MOH",
31159     "examples": [
31160       {
31161         "title": "Example usage:",
31162         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31163         "type": "json"
31164       }
31165     ],
31166     "name": "AddMoh",
31167     "group": "Voice_MOHs",
31168     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31169     "version": "0.0.0",
31170     "filename": "server/api/voiceMusicOnHold/index.js",
31171     "groupTitle": "Voice_MOHs"
31172   },
31173   {
31174     "type": "post",
31175     "url": "/api/voice/mohs/{id}/sounds",
31176     "title": "Add sound to MOH",
31177     "examples": [
31178       {
31179         "title": "Example usage:",
31180         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31181         "type": "json"
31182       }
31183     ],
31184     "name": "AddSound",
31185     "group": "Voice_MOHs",
31186     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31187     "version": "0.0.0",
31188     "filename": "server/api/voiceMusicOnHold/index.js",
31189     "groupTitle": "Voice_MOHs"
31190   },
31191   {
31192     "type": "delete",
31193     "url": "/api/voice/mohs/{id}",
31194     "title": "Deletes an MOH",
31195     "examples": [
31196       {
31197         "title": "Example usage:",
31198         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
31199         "type": "json"
31200       }
31201     ],
31202     "name": "DestroyMoh",
31203     "group": "Voice_MOHs",
31204     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31205     "version": "0.0.0",
31206     "filename": "server/api/voiceMusicOnHold/index.js",
31207     "groupTitle": "Voice_MOHs"
31208   },
31209   {
31210     "type": "get",
31211     "url": "/api/voice/mohs",
31212     "title": "Gets a list of Music On Holds",
31213     "examples": [
31214       {
31215         "title": "Example usage:",
31216         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
31217         "type": "json"
31218       }
31219     ],
31220     "name": "GetMusic_On_Holds",
31221     "group": "Voice_MOHs",
31222     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31223     "version": "0.0.0",
31224     "filename": "server/api/voiceMusicOnHold/index.js",
31225     "groupTitle": "Voice_MOHs"
31226   },
31227   {
31228     "type": "get",
31229     "url": "/api/voice/mohs/{id}/sounds",
31230     "title": "Gets sounds from MOH",
31231     "examples": [
31232       {
31233         "title": "Example usage:",
31234         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
31235         "type": "json"
31236       }
31237     ],
31238     "name": "GetSounds",
31239     "group": "Voice_MOHs",
31240     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31241     "version": "0.0.0",
31242     "filename": "server/api/voiceMusicOnHold/index.js",
31243     "groupTitle": "Voice_MOHs"
31244   },
31245   {
31246     "type": "delete",
31247     "url": "/api/voice/mohs/{id}/sounds/{id2}",
31248     "title": "Remove sound from MOH",
31249     "examples": [
31250       {
31251         "title": "Example usage:",
31252         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
31253         "type": "json"
31254       }
31255     ],
31256     "name": "RemoveSound",
31257     "group": "Voice_MOHs",
31258     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31259     "version": "0.0.0",
31260     "filename": "server/api/voiceMusicOnHold/index.js",
31261     "groupTitle": "Voice_MOHs"
31262   },
31263   {
31264     "type": "get",
31265     "url": "/api/voice/mohs/{id}",
31266     "title": "Gets a single Music On Hold",
31267     "examples": [
31268       {
31269         "title": "Example usage:",
31270         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
31271         "type": "json"
31272       }
31273     ],
31274     "name": "ShowMusic_On_Holds",
31275     "group": "Voice_MOHs",
31276     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31277     "version": "0.0.0",
31278     "filename": "server/api/voiceMusicOnHold/index.js",
31279     "groupTitle": "Voice_MOHs"
31280   },
31281   {
31282     "type": "put",
31283     "url": "/api/voice/mohs/{id}",
31284     "title": "Update an existing Music On Hold",
31285     "examples": [
31286       {
31287         "title": "Example usage:",
31288         "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",
31289         "type": "json"
31290       }
31291     ],
31292     "name": "updateMusic_On_Holds",
31293     "group": "Voice_MOHs",
31294     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31295     "version": "0.0.0",
31296     "filename": "server/api/voiceMusicOnHold/index.js",
31297     "groupTitle": "Voice_MOHs"
31298   },
31299   {
31300     "type": "post",
31301     "url": "/api/voice/mails",
31302     "title": "Creates a new Mail",
31303     "examples": [
31304       {
31305         "title": "Example usage:",
31306         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31307         "type": "json"
31308       }
31309     ],
31310     "name": "CreateMails",
31311     "group": "Voice_Mails",
31312     "parameter": {
31313       "fields": {
31314         "Body": [
31315           {
31316             "group": "Body",
31317             "type": "String",
31318             "optional": true,
31319             "field": "customer_id",
31320             "description": ""
31321           },
31322           {
31323             "group": "Body",
31324             "type": "String",
31325             "optional": true,
31326             "field": "context",
31327             "description": ""
31328           },
31329           {
31330             "group": "Body",
31331             "type": "String",
31332             "optional": false,
31333             "field": "mailbox",
31334             "description": ""
31335           },
31336           {
31337             "group": "Body",
31338             "type": "String",
31339             "optional": true,
31340             "field": "password",
31341             "description": ""
31342           },
31343           {
31344             "group": "Body",
31345             "type": "String",
31346             "optional": true,
31347             "field": "fullname",
31348             "description": ""
31349           },
31350           {
31351             "group": "Body",
31352             "type": "String",
31353             "optional": true,
31354             "field": "email",
31355             "description": ""
31356           },
31357           {
31358             "group": "Body",
31359             "type": "String",
31360             "optional": true,
31361             "field": "pager",
31362             "description": ""
31363           },
31364           {
31365             "group": "Body",
31366             "type": "String",
31367             "optional": true,
31368             "field": "tz",
31369             "description": ""
31370           },
31371           {
31372             "group": "Body",
31373             "type": "String",
31374             "allowedValues": [
31375               "\"yes\"",
31376               "\"no\""
31377             ],
31378             "optional": false,
31379             "field": "attach",
31380             "description": ""
31381           },
31382           {
31383             "group": "Body",
31384             "type": "String",
31385             "allowedValues": [
31386               "\"yes\"",
31387               "\"no\""
31388             ],
31389             "optional": false,
31390             "field": "saycid",
31391             "description": ""
31392           },
31393           {
31394             "group": "Body",
31395             "type": "String",
31396             "optional": true,
31397             "field": "dialout",
31398             "description": ""
31399           },
31400           {
31401             "group": "Body",
31402             "type": "String",
31403             "optional": true,
31404             "field": "callback",
31405             "description": ""
31406           },
31407           {
31408             "group": "Body",
31409             "type": "String",
31410             "allowedValues": [
31411               "\"yes\"",
31412               "\"no\""
31413             ],
31414             "optional": false,
31415             "field": "review",
31416             "description": ""
31417           },
31418           {
31419             "group": "Body",
31420             "type": "String",
31421             "allowedValues": [
31422               "\"yes\"",
31423               "\"no\""
31424             ],
31425             "optional": false,
31426             "field": "operator",
31427             "description": ""
31428           },
31429           {
31430             "group": "Body",
31431             "type": "String",
31432             "allowedValues": [
31433               "\"yes\"",
31434               "\"no\""
31435             ],
31436             "optional": false,
31437             "field": "envelope",
31438             "description": ""
31439           },
31440           {
31441             "group": "Body",
31442             "type": "String",
31443             "allowedValues": [
31444               "\"yes\"",
31445               "\"no\""
31446             ],
31447             "optional": false,
31448             "field": "sayduration",
31449             "description": ""
31450           },
31451           {
31452             "group": "Body",
31453             "type": "String",
31454             "optional": false,
31455             "field": "saydurationm",
31456             "description": ""
31457           },
31458           {
31459             "group": "Body",
31460             "type": "String",
31461             "allowedValues": [
31462               "\"yes\"",
31463               "\"no\""
31464             ],
31465             "optional": false,
31466             "field": "sendvoicemail",
31467             "description": ""
31468           },
31469           {
31470             "group": "Body",
31471             "type": "String",
31472             "allowedValues": [
31473               "\"yes\"",
31474               "\"no\""
31475             ],
31476             "optional": false,
31477             "field": "delete",
31478             "description": ""
31479           },
31480           {
31481             "group": "Body",
31482             "type": "String",
31483             "allowedValues": [
31484               "\"yes\"",
31485               "\"no\""
31486             ],
31487             "optional": false,
31488             "field": "nextaftercmd",
31489             "description": ""
31490           },
31491           {
31492             "group": "Body",
31493             "type": "String",
31494             "allowedValues": [
31495               "\"yes\"",
31496               "\"no\""
31497             ],
31498             "optional": false,
31499             "field": "forcename",
31500             "description": ""
31501           },
31502           {
31503             "group": "Body",
31504             "type": "String",
31505             "allowedValues": [
31506               "\"yes\"",
31507               "\"no\""
31508             ],
31509             "optional": false,
31510             "field": "forcegreetings",
31511             "description": ""
31512           },
31513           {
31514             "group": "Body",
31515             "type": "String",
31516             "allowedValues": [
31517               "\"yes\"",
31518               "\"no\""
31519             ],
31520             "optional": false,
31521             "field": "hidefromdir",
31522             "description": ""
31523           },
31524           {
31525             "group": "Body",
31526             "type": "String",
31527             "optional": true,
31528             "field": "stamp",
31529             "description": ""
31530           },
31531           {
31532             "group": "Body",
31533             "type": "String",
31534             "optional": true,
31535             "field": "emailsubject",
31536             "description": ""
31537           },
31538           {
31539             "group": "Body",
31540             "type": "String",
31541             "optional": true,
31542             "field": "emailbody",
31543             "description": ""
31544           },
31545           {
31546             "group": "Body",
31547             "type": "Integer",
31548             "optional": false,
31549             "field": "maxsecs",
31550             "description": ""
31551           },
31552           {
31553             "group": "Body",
31554             "type": "Integer",
31555             "optional": false,
31556             "field": "maxmsg",
31557             "description": ""
31558           },
31559           {
31560             "group": "Body",
31561             "type": "Virtual",
31562             "optional": true,
31563             "field": "name",
31564             "description": ""
31565           }
31566         ]
31567       }
31568     },
31569     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31570     "version": "0.0.0",
31571     "filename": "server/api/voiceMail/index.js",
31572     "groupTitle": "Voice_Mails"
31573   },
31574   {
31575     "type": "delete",
31576     "url": "/api/voice/mails/{id}",
31577     "title": "Deletes a Mail",
31578     "examples": [
31579       {
31580         "title": "Example usage:",
31581         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31582         "type": "json"
31583       }
31584     ],
31585     "name": "DeleteMails",
31586     "group": "Voice_Mails",
31587     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31588     "version": "0.0.0",
31589     "filename": "server/api/voiceMail/index.js",
31590     "groupTitle": "Voice_Mails"
31591   },
31592   {
31593     "type": "get",
31594     "url": "/api/voice/mails",
31595     "title": "Gets a list of Mails",
31596     "examples": [
31597       {
31598         "title": "Example usage:",
31599         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31600         "type": "json"
31601       }
31602     ],
31603     "name": "GetMails",
31604     "group": "Voice_Mails",
31605     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31606     "version": "0.0.0",
31607     "filename": "server/api/voiceMail/index.js",
31608     "groupTitle": "Voice_Mails"
31609   },
31610   {
31611     "type": "get",
31612     "url": "/api/voice/mails/{id}",
31613     "title": "Gets a single Mail",
31614     "examples": [
31615       {
31616         "title": "Example usage:",
31617         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31618         "type": "json"
31619       }
31620     ],
31621     "name": "ShowMails",
31622     "group": "Voice_Mails",
31623     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31624     "version": "0.0.0",
31625     "filename": "server/api/voiceMail/index.js",
31626     "groupTitle": "Voice_Mails"
31627   },
31628   {
31629     "type": "get",
31630     "url": "/api/voice/mails/{id}/messages",
31631     "title": "Gets voice mail messages",
31632     "examples": [
31633       {
31634         "title": "Example usage:",
31635         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31636         "type": "json"
31637       }
31638     ],
31639     "name": "getMessages",
31640     "group": "Voice_Mails",
31641     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31642     "version": "0.0.0",
31643     "filename": "server/api/voiceMail/index.js",
31644     "groupTitle": "Voice_Mails"
31645   },
31646   {
31647     "type": "put",
31648     "url": "/api/voice/mails/{id}",
31649     "title": "Update an existing Mail",
31650     "examples": [
31651       {
31652         "title": "Example usage:",
31653         "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",
31654         "type": "json"
31655       }
31656     ],
31657     "name": "updateMails",
31658     "group": "Voice_Mails",
31659     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31660     "version": "0.0.0",
31661     "filename": "server/api/voiceMail/index.js",
31662     "groupTitle": "Voice_Mails"
31663   },
31664   {
31665     "type": "post",
31666     "url": "/api/voice/mails/messages",
31667     "title": "Creates a new Message",
31668     "examples": [
31669       {
31670         "title": "Example usage:",
31671         "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",
31672         "type": "json"
31673       }
31674     ],
31675     "name": "CreateMessages",
31676     "group": "Voice_Messages",
31677     "parameter": {
31678       "fields": {
31679         "Body": [
31680           {
31681             "group": "Body",
31682             "type": "Virtual",
31683             "optional": true,
31684             "field": "name",
31685             "description": ""
31686           },
31687           {
31688             "group": "Body",
31689             "type": "Integer",
31690             "optional": false,
31691             "field": "msgnum",
31692             "description": ""
31693           },
31694           {
31695             "group": "Body",
31696             "type": "String",
31697             "optional": true,
31698             "field": "dir",
31699             "description": ""
31700           },
31701           {
31702             "group": "Body",
31703             "type": "String",
31704             "optional": true,
31705             "field": "context",
31706             "description": ""
31707           },
31708           {
31709             "group": "Body",
31710             "type": "String",
31711             "optional": true,
31712             "field": "macrocontext",
31713             "description": ""
31714           },
31715           {
31716             "group": "Body",
31717             "type": "String",
31718             "optional": true,
31719             "field": "callerid",
31720             "description": ""
31721           },
31722           {
31723             "group": "Body",
31724             "type": "String",
31725             "optional": true,
31726             "field": "origtime",
31727             "description": ""
31728           },
31729           {
31730             "group": "Body",
31731             "type": "String",
31732             "optional": true,
31733             "field": "duration",
31734             "description": ""
31735           },
31736           {
31737             "group": "Body",
31738             "type": "String",
31739             "optional": true,
31740             "field": "mailboxuser",
31741             "description": ""
31742           },
31743           {
31744             "group": "Body",
31745             "type": "String",
31746             "optional": true,
31747             "field": "mailboxcontext",
31748             "description": ""
31749           },
31750           {
31751             "group": "Body",
31752             "type": "Blob",
31753             "optional": true,
31754             "field": "recording",
31755             "description": ""
31756           },
31757           {
31758             "group": "Body",
31759             "type": "String",
31760             "optional": true,
31761             "field": "flag",
31762             "description": ""
31763           },
31764           {
31765             "group": "Body",
31766             "type": "String",
31767             "optional": true,
31768             "field": "msg_id",
31769             "description": ""
31770           },
31771           {
31772             "group": "Body",
31773             "type": "String",
31774             "optional": true,
31775             "field": "stamp",
31776             "description": ""
31777           }
31778         ]
31779       }
31780     },
31781     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31782     "version": "0.0.0",
31783     "filename": "server/api/voiceMailMessage/index.js",
31784     "groupTitle": "Voice_Messages"
31785   },
31786   {
31787     "type": "delete",
31788     "url": "/api/voice/mails/messages/{id}",
31789     "title": "Deletes a Message",
31790     "examples": [
31791       {
31792         "title": "Example usage:",
31793         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31794         "type": "json"
31795       }
31796     ],
31797     "name": "DeleteMessages",
31798     "group": "Voice_Messages",
31799     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31800     "version": "0.0.0",
31801     "filename": "server/api/voiceMailMessage/index.js",
31802     "groupTitle": "Voice_Messages"
31803   },
31804   {
31805     "type": "get",
31806     "url": "/api/voice/mails/messages",
31807     "title": "Gets a list of Messages",
31808     "examples": [
31809       {
31810         "title": "Example usage:",
31811         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31812         "type": "json"
31813       }
31814     ],
31815     "name": "GetMessages",
31816     "group": "Voice_Messages",
31817     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31818     "version": "0.0.0",
31819     "filename": "server/api/voiceMailMessage/index.js",
31820     "groupTitle": "Voice_Messages"
31821   },
31822   {
31823     "type": "get",
31824     "url": "/api/voice/mails/messages/{id}",
31825     "title": "Gets a single Message",
31826     "examples": [
31827       {
31828         "title": "Example usage:",
31829         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31830         "type": "json"
31831       }
31832     ],
31833     "name": "ShowMessages",
31834     "group": "Voice_Messages",
31835     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31836     "version": "0.0.0",
31837     "filename": "server/api/voiceMailMessage/index.js",
31838     "groupTitle": "Voice_Messages"
31839   },
31840   {
31841     "type": "get",
31842     "url": "voice/mails/messages/{id}/download",
31843     "title": "Download Voice Message",
31844     "examples": [
31845       {
31846         "title": "Example usage:",
31847         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31848         "type": "json"
31849       }
31850     ],
31851     "name": "download",
31852     "group": "Voice_Messages",
31853     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31854     "version": "0.0.0",
31855     "filename": "server/api/voiceMailMessage/index.js",
31856     "groupTitle": "Voice_Messages"
31857   },
31858   {
31859     "type": "put",
31860     "url": "/api/voice/mails/messages/{id}",
31861     "title": "Update an existing Message",
31862     "examples": [
31863       {
31864         "title": "Example usage:",
31865         "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",
31866         "type": "json"
31867       }
31868     ],
31869     "name": "updateMessages",
31870     "group": "Voice_Messages",
31871     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31872     "version": "0.0.0",
31873     "filename": "server/api/voiceMailMessage/index.js",
31874     "groupTitle": "Voice_Messages"
31875   },
31876   {
31877     "type": "post",
31878     "url": "/api/voice/prefixes/{id}/users",
31879     "title": "Add agents to a prefix",
31880     "examples": [
31881       {
31882         "title": "Example usage:",
31883         "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",
31884         "type": "json"
31885       }
31886     ],
31887     "name": "AddAgents",
31888     "group": "Voice_Prefixes",
31889     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31890     "version": "0.0.0",
31891     "filename": "server/api/voicePrefix/index.js",
31892     "groupTitle": "Voice_Prefixes"
31893   },
31894   {
31895     "type": "delete",
31896     "url": "/api/voice/prefixes/{id}",
31897     "title": "Deletes a Prefix",
31898     "examples": [
31899       {
31900         "title": "Example usage:",
31901         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31902         "type": "json"
31903       }
31904     ],
31905     "name": "DeletePrefixes",
31906     "group": "Voice_Prefixes",
31907     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31908     "version": "0.0.0",
31909     "filename": "server/api/voicePrefix/index.js",
31910     "groupTitle": "Voice_Prefixes"
31911   },
31912   {
31913     "type": "get",
31914     "url": "/api/voice/prefixes/describe",
31915     "title": "Gets table info about Prefixes",
31916     "examples": [
31917       {
31918         "title": "Example usage:",
31919         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31920         "type": "json"
31921       }
31922     ],
31923     "name": "DescribePrefixes",
31924     "group": "Voice_Prefixes",
31925     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31926     "version": "0.0.0",
31927     "filename": "server/api/voicePrefix/index.js",
31928     "groupTitle": "Voice_Prefixes"
31929   },
31930   {
31931     "type": "get",
31932     "url": "/api/voice/prefixes/{id}/users",
31933     "title": "Gets agents from prefix",
31934     "examples": [
31935       {
31936         "title": "Example usage:",
31937         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31938         "type": "json"
31939       }
31940     ],
31941     "name": "GetAgents",
31942     "group": "Voice_Prefixes",
31943     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31944     "version": "0.0.0",
31945     "filename": "server/api/voicePrefix/index.js",
31946     "groupTitle": "Voice_Prefixes"
31947   },
31948   {
31949     "type": "get",
31950     "url": "/api/voice/prefixes",
31951     "title": "Gets a list of Prefixes",
31952     "examples": [
31953       {
31954         "title": "Example usage:",
31955         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31956         "type": "json"
31957       }
31958     ],
31959     "name": "GetPrefixes",
31960     "group": "Voice_Prefixes",
31961     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31962     "version": "0.0.0",
31963     "filename": "server/api/voicePrefix/index.js",
31964     "groupTitle": "Voice_Prefixes"
31965   },
31966   {
31967     "type": "delete",
31968     "url": "/api/voice/prefixes/{id}/users",
31969     "title": "Removes agents from a prefix",
31970     "examples": [
31971       {
31972         "title": "Example usage:",
31973         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31974         "type": "json"
31975       }
31976     ],
31977     "name": "RemoveAgents",
31978     "group": "Voice_Prefixes",
31979     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31980     "version": "0.0.0",
31981     "filename": "server/api/voicePrefix/index.js",
31982     "groupTitle": "Voice_Prefixes"
31983   },
31984   {
31985     "type": "get",
31986     "url": "/api/voice/prefixes/{id}",
31987     "title": "Gets a single Prefix",
31988     "examples": [
31989       {
31990         "title": "Example usage:",
31991         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31992         "type": "json"
31993       }
31994     ],
31995     "name": "ShowPrefixes",
31996     "group": "Voice_Prefixes",
31997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31998     "version": "0.0.0",
31999     "filename": "server/api/voicePrefix/index.js",
32000     "groupTitle": "Voice_Prefixes"
32001   },
32002   {
32003     "type": "put",
32004     "url": "/api/voice/prefixes/{id}",
32005     "title": "Update an existing prefix",
32006     "examples": [
32007       {
32008         "title": "Example usage:",
32009         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
32010         "type": "json"
32011       }
32012     ],
32013     "name": "Update",
32014     "group": "Voice_Prefixes",
32015     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32016     "version": "0.0.0",
32017     "filename": "server/api/voicePrefix/index.js",
32018     "groupTitle": "Voice_Prefixes"
32019   },
32020   {
32021     "type": "post",
32022     "url": "/api/voice/prefixes",
32023     "title": "Create a prefix",
32024     "examples": [
32025       {
32026         "title": "Example usage:",
32027         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
32028         "type": "json"
32029       }
32030     ],
32031     "name": "create",
32032     "group": "Voice_Prefixes",
32033     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32034     "version": "0.0.0",
32035     "filename": "server/api/voicePrefix/index.js",
32036     "groupTitle": "Voice_Prefixes"
32037   },
32038   {
32039     "type": "get",
32040     "url": "/api/voice/queues/reports/describe",
32041     "title": "Gets table info about Queue Reports",
32042     "examples": [
32043       {
32044         "title": "Example usage:",
32045         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
32046         "type": "json"
32047       }
32048     ],
32049     "name": "DescribeQueue_Reports",
32050     "group": "Voice_Queue_Reports",
32051     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32052     "version": "0.0.0",
32053     "filename": "server/api/voiceQueueReport/index.js",
32054     "groupTitle": "Voice_Queue_Reports"
32055   },
32056   {
32057     "type": "get",
32058     "url": "/api/voice/queues/reports",
32059     "title": "Gets a list of Queue Reports",
32060     "examples": [
32061       {
32062         "title": "Example usage:",
32063         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
32064         "type": "json"
32065       }
32066     ],
32067     "name": "GetQueue_Reports",
32068     "group": "Voice_Queue_Reports",
32069     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32070     "version": "0.0.0",
32071     "filename": "server/api/voiceQueueReport/index.js",
32072     "groupTitle": "Voice_Queue_Reports"
32073   },
32074   {
32075     "type": "get",
32076     "url": "/api/voice/queues/reports/{id}",
32077     "title": "Gets a single Queue Report",
32078     "examples": [
32079       {
32080         "title": "Example usage:",
32081         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
32082         "type": "json"
32083       }
32084     ],
32085     "name": "ShowQueue_Reports",
32086     "group": "Voice_Queue_Reports",
32087     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32088     "version": "0.0.0",
32089     "filename": "server/api/voiceQueueReport/index.js",
32090     "groupTitle": "Voice_Queue_Reports"
32091   },
32092   {
32093     "type": "get",
32094     "url": "/api/voice/queues/reports/index",
32095     "title": "Get Voice Queues Report",
32096     "examples": [
32097       {
32098         "title": "Example usage:",
32099         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
32100         "type": "json"
32101       }
32102     ],
32103     "name": "getVoiceQueuesReport",
32104     "group": "Voice_Queue_Reports",
32105     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32106     "version": "0.0.0",
32107     "filename": "server/api/voiceQueueReport/index.js",
32108     "groupTitle": "Voice_Queue_Reports"
32109   },
32110   {
32111     "type": "post",
32112     "url": "/api/voice/queues/{id}/users",
32113     "title": "Add agents to queue",
32114     "examples": [
32115       {
32116         "title": "Example usage:",
32117         "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",
32118         "type": "json"
32119       }
32120     ],
32121     "name": "AddAgents",
32122     "group": "Voice_Queues",
32123     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32124     "version": "0.0.0",
32125     "filename": "server/api/voiceQueue/index.js",
32126     "groupTitle": "Voice_Queues"
32127   },
32128   {
32129     "type": "post",
32130     "url": "/api/voice/queues/{id}/blacklists",
32131     "title": "Add blacklists to a queue",
32132     "examples": [
32133       {
32134         "title": "Example usage:",
32135         "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",
32136         "type": "json"
32137       }
32138     ],
32139     "name": "AddBlackLists",
32140     "group": "Voice_Queues",
32141     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32142     "version": "0.0.0",
32143     "filename": "server/api/voiceQueue/index.js",
32144     "groupTitle": "Voice_Queues"
32145   },
32146   {
32147     "type": "post",
32148     "url": "/api/voice/queues/{id}/lists",
32149     "title": "Add lists to a queue",
32150     "examples": [
32151       {
32152         "title": "Example usage:",
32153         "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",
32154         "type": "json"
32155       }
32156     ],
32157     "name": "AddLists",
32158     "group": "Voice_Queues",
32159     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32160     "version": "0.0.0",
32161     "filename": "server/api/voiceQueue/index.js",
32162     "groupTitle": "Voice_Queues"
32163   },
32164   {
32165     "type": "post",
32166     "url": "/api/voice/queues/{id}/teams",
32167     "title": "Add teams to queue",
32168     "examples": [
32169       {
32170         "title": "Example usage:",
32171         "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",
32172         "type": "json"
32173       }
32174     ],
32175     "name": "AddTeams",
32176     "group": "Voice_Queues",
32177     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32178     "version": "0.0.0",
32179     "filename": "server/api/voiceQueue/index.js",
32180     "groupTitle": "Voice_Queues"
32181   },
32182   {
32183     "type": "post",
32184     "url": "/api/voice/queues/clone",
32185     "title": "Clone an existing Queue",
32186     "examples": [
32187       {
32188         "title": "Example usage:",
32189         "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",
32190         "type": "json"
32191       }
32192     ],
32193     "name": "CloneQueues",
32194     "group": "Voice_Queues",
32195     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32196     "version": "0.0.0",
32197     "filename": "server/api/voiceQueue/index.js",
32198     "groupTitle": "Voice_Queues"
32199   },
32200   {
32201     "type": "post",
32202     "url": "/api/voice/queues",
32203     "title": "Creates a new Queue",
32204     "examples": [
32205       {
32206         "title": "Example usage:",
32207         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32208         "type": "json"
32209       }
32210     ],
32211     "name": "CreateQueues",
32212     "group": "Voice_Queues",
32213     "parameter": {
32214       "fields": {
32215         "Body": [
32216           {
32217             "group": "Body",
32218             "type": "String",
32219             "optional": false,
32220             "field": "name",
32221             "description": ""
32222           },
32223           {
32224             "group": "Body",
32225             "type": "String",
32226             "allowedValues": [
32227               "\"inbound\"",
32228               "\"outbound\""
32229             ],
32230             "optional": false,
32231             "field": "type",
32232             "description": ""
32233           },
32234           {
32235             "group": "Body",
32236             "type": "String",
32237             "optional": true,
32238             "field": "musiconhold",
32239             "description": ""
32240           },
32241           {
32242             "group": "Body",
32243             "type": "String",
32244             "optional": true,
32245             "field": "announce",
32246             "description": ""
32247           },
32248           {
32249             "group": "Body",
32250             "type": "String",
32251             "allowedValues": [
32252               "\"rr\"",
32253               "\"ringall\"",
32254               "\"leastrecent\"",
32255               "\"fewestcalls\"",
32256               "\"random\"",
32257               "\"rrmemory\"",
32258               "\"linear\"",
32259               "\"wrandom\"",
32260               "\"rrordered\""
32261             ],
32262             "optional": false,
32263             "field": "strategy",
32264             "description": ""
32265           },
32266           {
32267             "group": "Body",
32268             "type": "Integer",
32269             "optional": true,
32270             "field": "servicelevel",
32271             "description": ""
32272           },
32273           {
32274             "group": "Body",
32275             "type": "String",
32276             "optional": true,
32277             "field": "context",
32278             "description": ""
32279           },
32280           {
32281             "group": "Body",
32282             "type": "Integer",
32283             "optional": true,
32284             "field": "penaltymemberslimit",
32285             "description": ""
32286           },
32287           {
32288             "group": "Body",
32289             "type": "Integer",
32290             "optional": true,
32291             "field": "timeout",
32292             "description": ""
32293           },
32294           {
32295             "group": "Body",
32296             "type": "Integer",
32297             "optional": true,
32298             "field": "retry",
32299             "description": ""
32300           },
32301           {
32302             "group": "Body",
32303             "type": "String",
32304             "optional": true,
32305             "field": "timeoutpriority",
32306             "description": ""
32307           },
32308           {
32309             "group": "Body",
32310             "type": "Integer",
32311             "optional": true,
32312             "field": "weight",
32313             "description": ""
32314           },
32315           {
32316             "group": "Body",
32317             "type": "Integer",
32318             "optional": true,
32319             "field": "wrapuptime",
32320             "description": ""
32321           },
32322           {
32323             "group": "Body",
32324             "type": "String",
32325             "allowedValues": [
32326               "\"yes\"",
32327               "\"no\""
32328             ],
32329             "optional": true,
32330             "field": "autofill",
32331             "description": ""
32332           },
32333           {
32334             "group": "Body",
32335             "type": "String",
32336             "allowedValues": [
32337               "\"yes\"",
32338               "\"no\"",
32339               "\"all\""
32340             ],
32341             "optional": true,
32342             "field": "autopause",
32343             "description": ""
32344           },
32345           {
32346             "group": "Body",
32347             "type": "Integer",
32348             "optional": true,
32349             "field": "autopausedelay",
32350             "description": ""
32351           },
32352           {
32353             "group": "Body",
32354             "type": "String",
32355             "allowedValues": [
32356               "\"yes\"",
32357               "\"no\""
32358             ],
32359             "optional": true,
32360             "field": "autopausebusy",
32361             "description": ""
32362           },
32363           {
32364             "group": "Body",
32365             "type": "String",
32366             "allowedValues": [
32367               "\"yes\"",
32368               "\"no\""
32369             ],
32370             "optional": true,
32371             "field": "autopauseunavail",
32372             "description": ""
32373           },
32374           {
32375             "group": "Body",
32376             "type": "Integer",
32377             "optional": true,
32378             "field": "maxlen",
32379             "description": ""
32380           },
32381           {
32382             "group": "Body",
32383             "type": "String",
32384             "allowedValues": [
32385               "\"yes\"",
32386               "\"no\""
32387             ],
32388             "optional": true,
32389             "field": "setinterfacevar",
32390             "description": ""
32391           },
32392           {
32393             "group": "Body",
32394             "type": "String",
32395             "allowedValues": [
32396               "\"yes\"",
32397               "\"no\""
32398             ],
32399             "optional": true,
32400             "field": "setqueueentryvar",
32401             "description": ""
32402           },
32403           {
32404             "group": "Body",
32405             "type": "String",
32406             "allowedValues": [
32407               "\"yes\"",
32408               "\"no\""
32409             ],
32410             "optional": true,
32411             "field": "setqueuevar",
32412             "description": ""
32413           },
32414           {
32415             "group": "Body",
32416             "type": "String",
32417             "allowedValues": [
32418               "\"yes\"",
32419               "\"no\""
32420             ],
32421             "optional": true,
32422             "field": "eventmemberstatus",
32423             "description": ""
32424           },
32425           {
32426             "group": "Body",
32427             "type": "String",
32428             "optional": true,
32429             "field": "membermacro",
32430             "description": ""
32431           },
32432           {
32433             "group": "Body",
32434             "type": "String",
32435             "optional": true,
32436             "field": "membergosub",
32437             "description": ""
32438           },
32439           {
32440             "group": "Body",
32441             "type": "Integer",
32442             "optional": true,
32443             "field": "announce_frequency",
32444             "description": ""
32445           },
32446           {
32447             "group": "Body",
32448             "type": "Integer",
32449             "optional": true,
32450             "field": "min_announce_frequency",
32451             "description": ""
32452           },
32453           {
32454             "group": "Body",
32455             "type": "Integer",
32456             "optional": true,
32457             "field": "periodic_announce_frequency",
32458             "description": ""
32459           },
32460           {
32461             "group": "Body",
32462             "type": "String",
32463             "allowedValues": [
32464               "\"yes\"",
32465               "\"no\""
32466             ],
32467             "optional": true,
32468             "field": "random_periodic_announce",
32469             "description": ""
32470           },
32471           {
32472             "group": "Body",
32473             "type": "String",
32474             "allowedValues": [
32475               "\"yes\"",
32476               "\"no\""
32477             ],
32478             "optional": true,
32479             "field": "relative_periodic_announce",
32480             "description": ""
32481           },
32482           {
32483             "group": "Body",
32484             "type": "String",
32485             "allowedValues": [
32486               "\"yes\"",
32487               "\"no\"",
32488               "\"once\""
32489             ],
32490             "optional": true,
32491             "field": "announce_holdtime",
32492             "description": ""
32493           },
32494           {
32495             "group": "Body",
32496             "type": "String",
32497             "optional": true,
32498             "field": "announce_position",
32499             "description": ""
32500           },
32501           {
32502             "group": "Body",
32503             "type": "String",
32504             "allowedValues": [
32505               "\"yes\"",
32506               "\"no\""
32507             ],
32508             "optional": true,
32509             "field": "announce_to_first_user",
32510             "description": ""
32511           },
32512           {
32513             "group": "Body",
32514             "type": "Integer",
32515             "optional": true,
32516             "field": "announce_position_limit",
32517             "description": ""
32518           },
32519           {
32520             "group": "Body",
32521             "type": "String",
32522             "allowedValues": [
32523               "\"0\"",
32524               "\"5\"",
32525               "\"10\"",
32526               "\"15\"",
32527               "\"20\"",
32528               "\"30\""
32529             ],
32530             "optional": true,
32531             "field": "announce_round_seconds",
32532             "description": ""
32533           },
32534           {
32535             "group": "Body",
32536             "type": "String",
32537             "optional": true,
32538             "field": "monitor_format",
32539             "description": ""
32540           },
32541           {
32542             "group": "Body",
32543             "type": "String",
32544             "optional": true,
32545             "field": "monitor_type",
32546             "description": ""
32547           },
32548           {
32549             "group": "Body",
32550             "type": "String",
32551             "optional": true,
32552             "field": "queue_youarenext",
32553             "description": ""
32554           },
32555           {
32556             "group": "Body",
32557             "type": "String",
32558             "optional": true,
32559             "field": "queue_thereare",
32560             "description": ""
32561           },
32562           {
32563             "group": "Body",
32564             "type": "String",
32565             "optional": true,
32566             "field": "queue_callswaiting",
32567             "description": ""
32568           },
32569           {
32570             "group": "Body",
32571             "type": "String",
32572             "optional": true,
32573             "field": "queue_holdtime",
32574             "description": ""
32575           },
32576           {
32577             "group": "Body",
32578             "type": "String",
32579             "optional": true,
32580             "field": "queue_minute",
32581             "description": ""
32582           },
32583           {
32584             "group": "Body",
32585             "type": "String",
32586             "optional": true,
32587             "field": "queue_minutes",
32588             "description": ""
32589           },
32590           {
32591             "group": "Body",
32592             "type": "String",
32593             "optional": true,
32594             "field": "queue_seconds",
32595             "description": ""
32596           },
32597           {
32598             "group": "Body",
32599             "type": "String",
32600             "optional": true,
32601             "field": "queue_thankyou",
32602             "description": ""
32603           },
32604           {
32605             "group": "Body",
32606             "type": "String",
32607             "optional": true,
32608             "field": "queue_reporthold",
32609             "description": ""
32610           },
32611           {
32612             "group": "Body",
32613             "type": "String",
32614             "optional": true,
32615             "field": "queue_quantity1",
32616             "description": ""
32617           },
32618           {
32619             "group": "Body",
32620             "type": "String",
32621             "optional": true,
32622             "field": "queue_quantity2",
32623             "description": ""
32624           },
32625           {
32626             "group": "Body",
32627             "type": "String",
32628             "optional": true,
32629             "field": "queue_periodic_announce",
32630             "description": ""
32631           },
32632           {
32633             "group": "Body",
32634             "type": "String",
32635             "optional": true,
32636             "field": "queue_less_than",
32637             "description": ""
32638           },
32639           {
32640             "group": "Body",
32641             "type": "Text",
32642             "optional": true,
32643             "field": "periodic_announce",
32644             "description": ""
32645           },
32646           {
32647             "group": "Body",
32648             "type": "String",
32649             "optional": true,
32650             "field": "joinempty",
32651             "description": ""
32652           },
32653           {
32654             "group": "Body",
32655             "type": "String",
32656             "optional": true,
32657             "field": "leavewhenempty",
32658             "description": ""
32659           },
32660           {
32661             "group": "Body",
32662             "type": "String",
32663             "allowedValues": [
32664               "\"yes\"",
32665               "\"no\""
32666             ],
32667             "optional": true,
32668             "field": "reportholdtime",
32669             "description": ""
32670           },
32671           {
32672             "group": "Body",
32673             "type": "String",
32674             "allowedValues": [
32675               "\"yes\"",
32676               "\"no\""
32677             ],
32678             "optional": true,
32679             "field": "ringinuse",
32680             "description": ""
32681           },
32682           {
32683             "group": "Body",
32684             "type": "Integer",
32685             "optional": true,
32686             "field": "memberdelay",
32687             "description": ""
32688           },
32689           {
32690             "group": "Body",
32691             "type": "String",
32692             "allowedValues": [
32693               "\"yes\"",
32694               "\"no\""
32695             ],
32696             "optional": true,
32697             "field": "timeoutrestart",
32698             "description": ""
32699           },
32700           {
32701             "group": "Body",
32702             "type": "String",
32703             "optional": true,
32704             "field": "defaultrule",
32705             "description": ""
32706           },
32707           {
32708             "group": "Body",
32709             "type": "String",
32710             "optional": true,
32711             "field": "description",
32712             "description": ""
32713           },
32714           {
32715             "group": "Body",
32716             "type": "Boolean",
32717             "optional": true,
32718             "field": "acw",
32719             "description": ""
32720           },
32721           {
32722             "group": "Body",
32723             "type": "Integer",
32724             "optional": true,
32725             "field": "acwTimeout",
32726             "description": ""
32727           },
32728           {
32729             "group": "Body",
32730             "type": "Boolean",
32731             "optional": true,
32732             "field": "dialActive",
32733             "description": "<p>Active/Disactive Campaign</p>"
32734           },
32735           {
32736             "group": "Body",
32737             "type": "String",
32738             "allowedValues": [
32739               "\"preview\"",
32740               "\"progressive\"",
32741               "\"power\"",
32742               "\"predictive\"",
32743               "\"booked\""
32744             ],
32745             "optional": true,
32746             "field": "dialMethod",
32747             "description": "<p>Dial Method.</p>"
32748           },
32749           {
32750             "group": "Body",
32751             "type": "Integer",
32752             "optional": true,
32753             "field": "dialLimitChannel",
32754             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32755           },
32756           {
32757             "group": "Body",
32758             "type": "Integer",
32759             "optional": true,
32760             "field": "dialLimitQueue",
32761             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32762           },
32763           {
32764             "group": "Body",
32765             "type": "Float",
32766             "optional": true,
32767             "field": "dialPowerLevel",
32768             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32769           },
32770           {
32771             "group": "Body",
32772             "type": "String",
32773             "allowedValues": [
32774               "\"agentBusyFactor\"",
32775               "\"dropRate\""
32776             ],
32777             "optional": true,
32778             "field": "dialPredictiveOptimization",
32779             "description": "<p>Only for predictive method.</p>"
32780           },
32781           {
32782             "group": "Body",
32783             "type": "Float",
32784             "optional": true,
32785             "field": "dialPredictiveOptimizationPercentage",
32786             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32787           },
32788           {
32789             "group": "Body",
32790             "type": "Integer",
32791             "optional": true,
32792             "field": "dialPredictiveInterval",
32793             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32794           },
32795           {
32796             "group": "Body",
32797             "type": "String",
32798             "optional": true,
32799             "field": "dialOriginateCallerIdName",
32800             "description": ""
32801           },
32802           {
32803             "group": "Body",
32804             "type": "String",
32805             "optional": true,
32806             "field": "dialOriginateCallerIdNumber",
32807             "description": ""
32808           },
32809           {
32810             "group": "Body",
32811             "type": "Integer",
32812             "optional": true,
32813             "field": "dialOriginateTimeout",
32814             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32815           },
32816           {
32817             "group": "Body",
32818             "type": "String",
32819             "optional": true,
32820             "field": "dialQueueOptions",
32821             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32822           },
32823           {
32824             "group": "Body",
32825             "type": "Integer",
32826             "optional": true,
32827             "field": "dialQueueTimeout",
32828             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32829           },
32830           {
32831             "group": "Body",
32832             "type": "String",
32833             "optional": true,
32834             "field": "dialQueueProject",
32835             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32836           },
32837           {
32838             "group": "Body",
32839             "type": "Integer",
32840             "optional": true,
32841             "field": "dialCongestionMaxRetry",
32842             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32843           },
32844           {
32845             "group": "Body",
32846             "type": "Integer",
32847             "optional": true,
32848             "field": "dialCongestionRetryFrequency",
32849             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32850           },
32851           {
32852             "group": "Body",
32853             "type": "Integer",
32854             "optional": true,
32855             "field": "dialBusyMaxRetry",
32856             "description": "<p>#Busy Retry (min:1, max:999)</p>"
32857           },
32858           {
32859             "group": "Body",
32860             "type": "Integer",
32861             "optional": true,
32862             "field": "dialBusyRetryFrequency",
32863             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32864           },
32865           {
32866             "group": "Body",
32867             "type": "Integer",
32868             "optional": true,
32869             "field": "dialNoAnswerMaxRetry",
32870             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32871           },
32872           {
32873             "group": "Body",
32874             "type": "Integer",
32875             "optional": true,
32876             "field": "dialNoAnswerRetryFrequency",
32877             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32878           },
32879           {
32880             "group": "Body",
32881             "type": "Integer",
32882             "optional": true,
32883             "field": "dialGlobalMaxRetry",
32884             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32885           },
32886           {
32887             "group": "Body",
32888             "type": "String",
32889             "optional": true,
32890             "field": "dialTimezone",
32891             "description": ""
32892           },
32893           {
32894             "group": "Body",
32895             "type": "String",
32896             "optional": true,
32897             "field": "dialGlobalInterval",
32898             "description": ""
32899           },
32900           {
32901             "group": "Body",
32902             "type": "String",
32903             "optional": true,
32904             "field": "dialPrefix",
32905             "description": ""
32906           },
32907           {
32908             "group": "Body",
32909             "type": "String",
32910             "allowedValues": [
32911               "\"always\"",
32912               "\"never\"",
32913               "\"onlyIfOpen\""
32914             ],
32915             "optional": true,
32916             "field": "dialCheckDuplicateType",
32917             "description": ""
32918           },
32919           {
32920             "group": "Body",
32921             "type": "Boolean",
32922             "optional": true,
32923             "field": "dialAMDActive",
32924             "description": "<p>Active/Disactive AMD</p>"
32925           },
32926           {
32927             "group": "Body",
32928             "type": "Integer",
32929             "optional": true,
32930             "field": "dialAMDInitialSilence",
32931             "description": "<p>#AMD Initial Silence</p>"
32932           },
32933           {
32934             "group": "Body",
32935             "type": "Integer",
32936             "optional": true,
32937             "field": "dialAMDGreeting",
32938             "description": "<p>#AMD Greeting</p>"
32939           },
32940           {
32941             "group": "Body",
32942             "type": "Integer",
32943             "optional": true,
32944             "field": "dialAMDAfterGreetingSilence",
32945             "description": "<p>#AMD After Greeting Silence</p>"
32946           },
32947           {
32948             "group": "Body",
32949             "type": "Integer",
32950             "optional": true,
32951             "field": "dialAMDTotalAnalysisTime",
32952             "description": "<p>#AMD Total Analysis Time</p>"
32953           },
32954           {
32955             "group": "Body",
32956             "type": "Integer",
32957             "optional": true,
32958             "field": "dialAMDMinWordLength",
32959             "description": "<p>#AMD Min Word Length</p>"
32960           },
32961           {
32962             "group": "Body",
32963             "type": "Integer",
32964             "optional": true,
32965             "field": "dialAMDBetweenWordsSilence",
32966             "description": "<p>#AMD Between Words Silence</p>"
32967           },
32968           {
32969             "group": "Body",
32970             "type": "Integer",
32971             "optional": true,
32972             "field": "dialAMDMaximumNumberOfWords",
32973             "description": "<p>#AMD Maximum Number Of Words</p>"
32974           },
32975           {
32976             "group": "Body",
32977             "type": "Integer",
32978             "optional": true,
32979             "field": "dialAMDSilenceThreshold",
32980             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32981           },
32982           {
32983             "group": "Body",
32984             "type": "Integer",
32985             "optional": true,
32986             "field": "dialAMDMaximumWordLength",
32987             "description": "<p>#AMD Maximum Word Length</p>"
32988           },
32989           {
32990             "group": "Body",
32991             "type": "Integer",
32992             "optional": true,
32993             "field": "dialRecallMeTimeout",
32994             "description": "<p>#RecallMe Timeout (min:1)</p>"
32995           },
32996           {
32997             "group": "Body",
32998             "type": "Boolean",
32999             "optional": true,
33000             "field": "dialRecallInQueue",
33001             "description": "<p>Active/Disactive Recall In Queue</p>"
33002           },
33003           {
33004             "group": "Body",
33005             "type": "String",
33006             "allowedValues": [
33007               "\"DESC\"",
33008               "\"ASC\""
33009             ],
33010             "optional": true,
33011             "field": "dialOrderByScheduledAt",
33012             "description": ""
33013           },
33014           {
33015             "group": "Body",
33016             "type": "String",
33017             "optional": true,
33018             "field": "dialQueueProject2",
33019             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
33020           },
33021           {
33022             "group": "Body",
33023             "type": "Boolean",
33024             "optional": true,
33025             "field": "dialAgiAfterHangupClient",
33026             "description": ""
33027           },
33028           {
33029             "group": "Body",
33030             "type": "Boolean",
33031             "optional": true,
33032             "field": "dialAgiAfterHangupAgent",
33033             "description": ""
33034           },
33035           {
33036             "group": "Body",
33037             "type": "Integer",
33038             "optional": true,
33039             "field": "dialRandomLastDigitCallerIdNumber",
33040             "description": "<p>Random Last Digit (min:1, max:15)</p>"
33041           },
33042           {
33043             "group": "Body",
33044             "type": "Integer",
33045             "optional": true,
33046             "field": "dialCutDigit",
33047             "description": "<p>Cut Digit (min:1, max:15)</p>"
33048           },
33049           {
33050             "group": "Body",
33051             "type": "Integer",
33052             "optional": true,
33053             "field": "dialNoSuchNumberMaxRetry",
33054             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
33055           },
33056           {
33057             "group": "Body",
33058             "type": "Integer",
33059             "optional": true,
33060             "field": "dialNoSuchNumberRetryFrequency",
33061             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
33062           },
33063           {
33064             "group": "Body",
33065             "type": "Integer",
33066             "optional": true,
33067             "field": "dialDropMaxRetry",
33068             "description": "<p>#Drop Retry (min:1, max:999)</p>"
33069           },
33070           {
33071             "group": "Body",
33072             "type": "Integer",
33073             "optional": true,
33074             "field": "dialDropRetryFrequency",
33075             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
33076           },
33077           {
33078             "group": "Body",
33079             "type": "Integer",
33080             "optional": true,
33081             "field": "dialAbandonedMaxRetry",
33082             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
33083           },
33084           {
33085             "group": "Body",
33086             "type": "Integer",
33087             "optional": true,
33088             "field": "dialAbandonedRetryFrequency",
33089             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
33090           },
33091           {
33092             "group": "Body",
33093             "type": "Integer",
33094             "optional": true,
33095             "field": "dialMachineMaxRetry",
33096             "description": "<p>#Machine Retry (min:1, max:999)</p>"
33097           },
33098           {
33099             "group": "Body",
33100             "type": "Integer",
33101             "optional": true,
33102             "field": "dialMachineRetryFrequency",
33103             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
33104           },
33105           {
33106             "group": "Body",
33107             "type": "Integer",
33108             "optional": true,
33109             "field": "dialAgentRejectMaxRetry",
33110             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
33111           },
33112           {
33113             "group": "Body",
33114             "type": "Integer",
33115             "optional": true,
33116             "field": "dialAgentRejectRetryFrequency",
33117             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
33118           },
33119           {
33120             "group": "Body",
33121             "type": "Integer",
33122             "optional": true,
33123             "field": "callAdditionalPhoneAfterMin",
33124             "description": "<p>Minutes to wait to call next additional phone number</p>"
33125           },
33126           {
33127             "group": "Body",
33128             "type": "Integer",
33129             "optional": true,
33130             "field": "mandatoryDispositionPauseId",
33131             "description": "<p>Status to put when mandatory disposition is enabled</p>"
33132           },
33133           {
33134             "group": "Body",
33135             "type": "Boolean",
33136             "optional": true,
33137             "field": "mandatoryDisposition",
33138             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
33139           },
33140           {
33141             "group": "Body",
33142             "type": "Integer",
33143             "optional": true,
33144             "field": "dialPredictiveIntervalMaxThreshold",
33145             "description": ""
33146           },
33147           {
33148             "group": "Body",
33149             "type": "Integer",
33150             "optional": true,
33151             "field": "dialPredictiveIntervalMinThreshold",
33152             "description": ""
33153           }
33154         ]
33155       }
33156     },
33157     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33158     "version": "0.0.0",
33159     "filename": "server/api/voiceQueue/index.js",
33160     "groupTitle": "Voice_Queues"
33161   },
33162   {
33163     "type": "delete",
33164     "url": "/api/voice/queues/{id}",
33165     "title": "Deletes a Queue",
33166     "examples": [
33167       {
33168         "title": "Example usage:",
33169         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
33170         "type": "json"
33171       }
33172     ],
33173     "name": "DeleteQueues",
33174     "group": "Voice_Queues",
33175     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33176     "version": "0.0.0",
33177     "filename": "server/api/voiceQueue/index.js",
33178     "groupTitle": "Voice_Queues"
33179   },
33180   {
33181     "type": "get",
33182     "url": "/api/voice/queues/{id}/users",
33183     "title": "Gets queue agents",
33184     "examples": [
33185       {
33186         "title": "Example usage:",
33187         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
33188         "type": "json"
33189       }
33190     ],
33191     "name": "GetAgents",
33192     "group": "Voice_Queues",
33193     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33194     "version": "0.0.0",
33195     "filename": "server/api/voiceQueue/index.js",
33196     "groupTitle": "Voice_Queues"
33197   },
33198   {
33199     "type": "get",
33200     "url": "/api/voice/queues/{id}/blacklists",
33201     "title": "Get queue blacklists",
33202     "examples": [
33203       {
33204         "title": "Example usage:",
33205         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
33206         "type": "json"
33207       }
33208     ],
33209     "name": "GetBlackLists",
33210     "group": "Voice_Queues",
33211     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33212     "version": "0.0.0",
33213     "filename": "server/api/voiceQueue/index.js",
33214     "groupTitle": "Voice_Queues"
33215   },
33216   {
33217     "type": "get",
33218     "url": "/api/voice/queues/{id}/finals",
33219     "title": "Gets queue hopper finals",
33220     "examples": [
33221       {
33222         "title": "Example usage:",
33223         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
33224         "type": "json"
33225       }
33226     ],
33227     "name": "GetHopperFinals",
33228     "group": "Voice_Queues",
33229     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33230     "version": "0.0.0",
33231     "filename": "server/api/voiceQueue/index.js",
33232     "groupTitle": "Voice_Queues"
33233   },
33234   {
33235     "type": "get",
33236     "url": "/api/voice/queues/{id}/hopper_histories",
33237     "title": "Gets queue hopper histories",
33238     "examples": [
33239       {
33240         "title": "Example usage:",
33241         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
33242         "type": "json"
33243       }
33244     ],
33245     "name": "GetHopperHistories",
33246     "group": "Voice_Queues",
33247     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33248     "version": "0.0.0",
33249     "filename": "server/api/voiceQueue/index.js",
33250     "groupTitle": "Voice_Queues"
33251   },
33252   {
33253     "type": "get",
33254     "url": "/api/voice/queues/{id}/hoppers",
33255     "title": "Gets queue hoppers",
33256     "examples": [
33257       {
33258         "title": "Example usage:",
33259         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
33260         "type": "json"
33261       }
33262     ],
33263     "name": "GetHoppers",
33264     "group": "Voice_Queues",
33265     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33266     "version": "0.0.0",
33267     "filename": "server/api/voiceQueue/index.js",
33268     "groupTitle": "Voice_Queues"
33269   },
33270   {
33271     "type": "get",
33272     "url": "/api/voice/queues/{id}/lists",
33273     "title": "Get queue lists",
33274     "examples": [
33275       {
33276         "title": "Example usage:",
33277         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
33278         "type": "json"
33279       }
33280     ],
33281     "name": "GetLists",
33282     "group": "Voice_Queues",
33283     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33284     "version": "0.0.0",
33285     "filename": "server/api/voiceQueue/index.js",
33286     "groupTitle": "Voice_Queues"
33287   },
33288   {
33289     "type": "get",
33290     "url": "/api/voice/queues/{id}/members",
33291     "title": "Gets queue members",
33292     "examples": [
33293       {
33294         "title": "Example usage:",
33295         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
33296         "type": "json"
33297       }
33298     ],
33299     "name": "GetMembers",
33300     "group": "Voice_Queues",
33301     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33302     "version": "0.0.0",
33303     "filename": "server/api/voiceQueue/index.js",
33304     "groupTitle": "Voice_Queues"
33305   },
33306   {
33307     "type": "get",
33308     "url": "/api/voice/queues",
33309     "title": "Gets a list of Queues",
33310     "examples": [
33311       {
33312         "title": "Example usage:",
33313         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
33314         "type": "json"
33315       }
33316     ],
33317     "name": "GetQueues",
33318     "group": "Voice_Queues",
33319     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33320     "version": "0.0.0",
33321     "filename": "server/api/voiceQueue/index.js",
33322     "groupTitle": "Voice_Queues"
33323   },
33324   {
33325     "type": "get",
33326     "url": "/api/voice/queues/{id}/teams",
33327     "title": "Gets queue team",
33328     "examples": [
33329       {
33330         "title": "Example usage:",
33331         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
33332         "type": "json"
33333       }
33334     ],
33335     "name": "GetTeams",
33336     "group": "Voice_Queues",
33337     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33338     "version": "0.0.0",
33339     "filename": "server/api/voiceQueue/index.js",
33340     "groupTitle": "Voice_Queues"
33341   },
33342   {
33343     "type": "delete",
33344     "url": "/api/voice/queues/{id}/users",
33345     "title": "Removes agents from a queue",
33346     "examples": [
33347       {
33348         "title": "Example usage:",
33349         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33350         "type": "json"
33351       }
33352     ],
33353     "name": "RemoveAgents",
33354     "group": "Voice_Queues",
33355     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33356     "version": "0.0.0",
33357     "filename": "server/api/voiceQueue/index.js",
33358     "groupTitle": "Voice_Queues"
33359   },
33360   {
33361     "type": "delete",
33362     "url": "/api/voice/queues/{id}/blacklists",
33363     "title": "Remove blacklists from a queue",
33364     "examples": [
33365       {
33366         "title": "Example usage:",
33367         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33368         "type": "json"
33369       }
33370     ],
33371     "name": "RemoveBlackLists",
33372     "group": "Voice_Queues",
33373     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33374     "version": "0.0.0",
33375     "filename": "server/api/voiceQueue/index.js",
33376     "groupTitle": "Voice_Queues"
33377   },
33378   {
33379     "type": "delete",
33380     "url": "/api/voice/queues/{id}/lists",
33381     "title": "Remove lists from a queue",
33382     "examples": [
33383       {
33384         "title": "Example usage:",
33385         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33386         "type": "json"
33387       }
33388     ],
33389     "name": "RemoveLists",
33390     "group": "Voice_Queues",
33391     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33392     "version": "0.0.0",
33393     "filename": "server/api/voiceQueue/index.js",
33394     "groupTitle": "Voice_Queues"
33395   },
33396   {
33397     "type": "get",
33398     "url": "/api/voice/queues/{id}",
33399     "title": "Gets a single Queue",
33400     "examples": [
33401       {
33402         "title": "Example usage:",
33403         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33404         "type": "json"
33405       }
33406     ],
33407     "name": "ShowQueues",
33408     "group": "Voice_Queues",
33409     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33410     "version": "0.0.0",
33411     "filename": "server/api/voiceQueue/index.js",
33412     "groupTitle": "Voice_Queues"
33413   },
33414   {
33415     "type": "get",
33416     "url": "/api/voice/queues/{id}/blacks",
33417     "title": "Gets queue hopper blacks",
33418     "examples": [
33419       {
33420         "title": "Example usage:",
33421         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
33422         "type": "json"
33423       }
33424     ],
33425     "name": "getHopperBlacks",
33426     "group": "Voice_Queues",
33427     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33428     "version": "0.0.0",
33429     "filename": "server/api/voiceQueue/index.js",
33430     "groupTitle": "Voice_Queues"
33431   },
33432   {
33433     "type": "put",
33434     "url": "/api/voice/queues/{id}",
33435     "title": "Update an existing Queue",
33436     "examples": [
33437       {
33438         "title": "Example usage:",
33439         "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",
33440         "type": "json"
33441       }
33442     ],
33443     "name": "updateQueues",
33444     "group": "Voice_Queues",
33445     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33446     "version": "0.0.0",
33447     "filename": "server/api/voiceQueue/index.js",
33448     "groupTitle": "Voice_Queues"
33449   },
33450   {
33451     "type": "post",
33452     "url": "/api/voice/recordings",
33453     "title": "Creates a new Recording",
33454     "examples": [
33455       {
33456         "title": "Example usage:",
33457         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33458         "type": "json"
33459       }
33460     ],
33461     "name": "CreateRecordings",
33462     "group": "Voice_Recordings",
33463     "parameter": {
33464       "fields": {
33465         "Body": [
33466           {
33467             "group": "Body",
33468             "type": "Virtual",
33469             "optional": true,
33470             "field": "format",
33471             "description": ""
33472           },
33473           {
33474             "group": "Body",
33475             "type": "String",
33476             "optional": true,
33477             "field": "uniqueid",
33478             "description": ""
33479           },
33480           {
33481             "group": "Body",
33482             "type": "String",
33483             "optional": true,
33484             "field": "channel",
33485             "description": ""
33486           },
33487           {
33488             "group": "Body",
33489             "type": "String",
33490             "optional": true,
33491             "field": "membername",
33492             "description": ""
33493           },
33494           {
33495             "group": "Body",
33496             "type": "String",
33497             "optional": true,
33498             "field": "calleridnum",
33499             "description": ""
33500           },
33501           {
33502             "group": "Body",
33503             "type": "String",
33504             "optional": true,
33505             "field": "calleridname",
33506             "description": ""
33507           },
33508           {
33509             "group": "Body",
33510             "type": "String",
33511             "optional": true,
33512             "field": "connectedlinenum",
33513             "description": ""
33514           },
33515           {
33516             "group": "Body",
33517             "type": "String",
33518             "optional": true,
33519             "field": "connectedlinename",
33520             "description": ""
33521           },
33522           {
33523             "group": "Body",
33524             "type": "String",
33525             "optional": true,
33526             "field": "accountcode",
33527             "description": ""
33528           },
33529           {
33530             "group": "Body",
33531             "type": "String",
33532             "optional": true,
33533             "field": "context",
33534             "description": ""
33535           },
33536           {
33537             "group": "Body",
33538             "type": "String",
33539             "optional": true,
33540             "field": "exten",
33541             "description": ""
33542           },
33543           {
33544             "group": "Body",
33545             "type": "String",
33546             "optional": true,
33547             "field": "value",
33548             "description": ""
33549           },
33550           {
33551             "group": "Body",
33552             "type": "String",
33553             "optional": true,
33554             "field": "type",
33555             "description": ""
33556           },
33557           {
33558             "group": "Body",
33559             "type": "Integer",
33560             "optional": true,
33561             "field": "rating",
33562             "description": ""
33563           },
33564           {
33565             "group": "Body",
33566             "type": "String",
33567             "optional": true,
33568             "field": "queue",
33569             "description": ""
33570           },
33571           {
33572             "group": "Body",
33573             "type": "String",
33574             "optional": true,
33575             "field": "userDisposition",
33576             "description": ""
33577           },
33578           {
33579             "group": "Body",
33580             "type": "String",
33581             "optional": true,
33582             "field": "userSecondDisposition",
33583             "description": ""
33584           },
33585           {
33586             "group": "Body",
33587             "type": "String",
33588             "optional": true,
33589             "field": "userThirdDisposition",
33590             "description": ""
33591           },
33592           {
33593             "group": "Body",
33594             "type": "Text",
33595             "optional": true,
33596             "field": "location",
33597             "description": ""
33598           },
33599           {
33600             "group": "Body",
33601             "type": "String",
33602             "optional": true,
33603             "field": "transcribeName",
33604             "description": ""
33605           },
33606           {
33607             "group": "Body",
33608             "type": "String",
33609             "optional": true,
33610             "field": "transcribeStatus",
33611             "description": ""
33612           },
33613           {
33614             "group": "Body",
33615             "type": "Text",
33616             "optional": true,
33617             "field": "fileUri",
33618             "description": ""
33619           },
33620           {
33621             "group": "Body",
33622             "type": "Text",
33623             "optional": true,
33624             "field": "fileText",
33625             "description": ""
33626           },
33627           {
33628             "group": "Body",
33629             "type": "Text",
33630             "optional": true,
33631             "field": "failureReason",
33632             "description": ""
33633           },
33634           {
33635             "group": "Body",
33636             "type": "String",
33637             "optional": true,
33638             "field": "sentiment",
33639             "description": ""
33640           },
33641           {
33642             "group": "Body",
33643             "type": "Float",
33644             "optional": true,
33645             "field": "sPositive",
33646             "description": ""
33647           },
33648           {
33649             "group": "Body",
33650             "type": "Float",
33651             "optional": true,
33652             "field": "sNegative",
33653             "description": ""
33654           },
33655           {
33656             "group": "Body",
33657             "type": "Float",
33658             "optional": true,
33659             "field": "sNeutral",
33660             "description": ""
33661           },
33662           {
33663             "group": "Body",
33664             "type": "Float",
33665             "optional": true,
33666             "field": "sMixed",
33667             "description": ""
33668           },
33669           {
33670             "group": "Body",
33671             "type": "Boolean",
33672             "optional": true,
33673             "field": "tempSentiment",
33674             "description": ""
33675           },
33676           {
33677             "group": "Body",
33678             "type": "String",
33679             "optional": true,
33680             "field": "createdAt",
33681             "description": ""
33682           },
33683           {
33684             "group": "Body",
33685             "type": "String",
33686             "optional": true,
33687             "field": "updatedAt",
33688             "description": ""
33689           }
33690         ]
33691       }
33692     },
33693     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33694     "version": "0.0.0",
33695     "filename": "server/api/voiceRecording/index.js",
33696     "groupTitle": "Voice_Recordings"
33697   },
33698   {
33699     "type": "get",
33700     "url": "/api/voice/recordings/describe",
33701     "title": "Gets table info about Recordings",
33702     "examples": [
33703       {
33704         "title": "Example usage:",
33705         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33706         "type": "json"
33707       }
33708     ],
33709     "name": "DescribeRecordings",
33710     "group": "Voice_Recordings",
33711     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33712     "version": "0.0.0",
33713     "filename": "server/api/voiceRecording/index.js",
33714     "groupTitle": "Voice_Recordings"
33715   },
33716   {
33717     "type": "get",
33718     "url": "/api/voice/recordings",
33719     "title": "Gets a list of Recordings",
33720     "examples": [
33721       {
33722         "title": "Example usage:",
33723         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33724         "type": "json"
33725       }
33726     ],
33727     "name": "GetRecordings",
33728     "group": "Voice_Recordings",
33729     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33730     "version": "0.0.0",
33731     "filename": "server/api/voiceRecording/index.js",
33732     "groupTitle": "Voice_Recordings"
33733   },
33734   {
33735     "type": "get",
33736     "url": "/api/voice/recordings/{id}",
33737     "title": "Gets a single Recording",
33738     "examples": [
33739       {
33740         "title": "Example usage:",
33741         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33742         "type": "json"
33743       }
33744     ],
33745     "name": "ShowRecordings",
33746     "group": "Voice_Recordings",
33747     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33748     "version": "0.0.0",
33749     "filename": "server/api/voiceRecording/index.js",
33750     "groupTitle": "Voice_Recordings"
33751   },
33752   {
33753     "type": "delete",
33754     "url": "/api/voice/recordings/{id}",
33755     "title": "Delete voice recording",
33756     "examples": [
33757       {
33758         "title": "Example usage:",
33759         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33760         "type": "json"
33761       }
33762     ],
33763     "name": "destroy",
33764     "group": "Voice_Recordings",
33765     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33766     "version": "0.0.0",
33767     "filename": "server/api/voiceRecording/index.js",
33768     "groupTitle": "Voice_Recordings"
33769   },
33770   {
33771     "type": "get",
33772     "url": "/api/voice/recordings/{id}/download",
33773     "title": "Download Recording",
33774     "examples": [
33775       {
33776         "title": "Example usage:",
33777         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33778         "type": "json"
33779       }
33780     ],
33781     "name": "download",
33782     "group": "Voice_Recordings",
33783     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33784     "version": "0.0.0",
33785     "filename": "server/api/voiceRecording/index.js",
33786     "groupTitle": "Voice_Recordings"
33787   },
33788   {
33789     "type": "get",
33790     "url": "/api/voice/recordings/{id}/downloads",
33791     "title": "Download Recording",
33792     "examples": [
33793       {
33794         "title": "Example usage:",
33795         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33796         "type": "json"
33797       }
33798     ],
33799     "name": "downloads",
33800     "group": "Voice_Recordings",
33801     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33802     "version": "0.0.0",
33803     "filename": "server/api/voiceRecording/index.js",
33804     "groupTitle": "Voice_Recordings"
33805   },
33806   {
33807     "type": "post",
33808     "url": "/api/voice/recordings/{id}/transcribe",
33809     "title": "Run Transcribe Recording",
33810     "examples": [
33811       {
33812         "title": "Example usage:",
33813         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
33814         "type": "json"
33815       }
33816     ],
33817     "name": "transcribe",
33818     "group": "Voice_Recordings",
33819     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33820     "version": "0.0.0",
33821     "filename": "server/api/voiceRecording/index.js",
33822     "groupTitle": "Voice_Recordings"
33823   },
33824   {
33825     "type": "get",
33826     "url": "/api/voice/recordings/{id}/transcribe",
33827     "title": "Run Transcribe Recording",
33828     "examples": [
33829       {
33830         "title": "Example usage:",
33831         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
33832         "type": "json"
33833       }
33834     ],
33835     "name": "transcribe",
33836     "group": "Voice_Recordings",
33837     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33838     "version": "0.0.0",
33839     "filename": "server/api/voiceRecording/index.js",
33840     "groupTitle": "Voice_Recordings"
33841   },
33842   {
33843     "type": "put",
33844     "url": "/api/voice/recordings/{id}",
33845     "title": "Update an existing Recording",
33846     "examples": [
33847       {
33848         "title": "Example usage:",
33849         "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",
33850         "type": "json"
33851       }
33852     ],
33853     "name": "updateRecordings",
33854     "group": "Voice_Recordings",
33855     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33856     "version": "0.0.0",
33857     "filename": "server/api/voiceRecording/index.js",
33858     "groupTitle": "Voice_Recordings"
33859   },
33860   {
33861     "type": "post",
33862     "url": "/api/voice/transfers/reports",
33863     "title": "Creates a new Transfer Report",
33864     "examples": [
33865       {
33866         "title": "Example usage:",
33867         "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",
33868         "type": "json"
33869       }
33870     ],
33871     "name": "CreateTransfer_Reports",
33872     "group": "Voice_Transfer_Reports",
33873     "parameter": {
33874       "fields": {
33875         "Body": [
33876           {
33877             "group": "Body",
33878             "type": "String",
33879             "allowedValues": [
33880               "\"blind\"",
33881               "\"attended\""
33882             ],
33883             "optional": true,
33884             "field": "type",
33885             "description": ""
33886           },
33887           {
33888             "group": "Body",
33889             "type": "String",
33890             "optional": true,
33891             "field": "result",
33892             "description": ""
33893           },
33894           {
33895             "group": "Body",
33896             "type": "String",
33897             "optional": true,
33898             "field": "transfererchannel",
33899             "description": ""
33900           },
33901           {
33902             "group": "Body",
33903             "type": "String",
33904             "optional": true,
33905             "field": "transferercalleridnum",
33906             "description": ""
33907           },
33908           {
33909             "group": "Body",
33910             "type": "String",
33911             "optional": true,
33912             "field": "transferercalleridname",
33913             "description": ""
33914           },
33915           {
33916             "group": "Body",
33917             "type": "String",
33918             "optional": true,
33919             "field": "transfererconnectedlinenum",
33920             "description": ""
33921           },
33922           {
33923             "group": "Body",
33924             "type": "String",
33925             "optional": true,
33926             "field": "transfererconnectedlinename",
33927             "description": ""
33928           },
33929           {
33930             "group": "Body",
33931             "type": "String",
33932             "optional": true,
33933             "field": "transfereraccountcode",
33934             "description": ""
33935           },
33936           {
33937             "group": "Body",
33938             "type": "String",
33939             "optional": true,
33940             "field": "transferercontext",
33941             "description": ""
33942           },
33943           {
33944             "group": "Body",
33945             "type": "String",
33946             "optional": true,
33947             "field": "transfererexten",
33948             "description": ""
33949           },
33950           {
33951             "group": "Body",
33952             "type": "String",
33953             "optional": true,
33954             "field": "transfererlinkedid",
33955             "description": ""
33956           },
33957           {
33958             "group": "Body",
33959             "type": "String",
33960             "optional": true,
33961             "field": "transfereechannel",
33962             "description": ""
33963           },
33964           {
33965             "group": "Body",
33966             "type": "String",
33967             "optional": true,
33968             "field": "transfereecalleridnum",
33969             "description": ""
33970           },
33971           {
33972             "group": "Body",
33973             "type": "String",
33974             "optional": true,
33975             "field": "transfereecalleridname",
33976             "description": ""
33977           },
33978           {
33979             "group": "Body",
33980             "type": "String",
33981             "optional": true,
33982             "field": "transfereeconnectedlinenum",
33983             "description": ""
33984           },
33985           {
33986             "group": "Body",
33987             "type": "String",
33988             "optional": true,
33989             "field": "transfereeconnectedlinename",
33990             "description": ""
33991           },
33992           {
33993             "group": "Body",
33994             "type": "String",
33995             "optional": true,
33996             "field": "transfereeaccountcode",
33997             "description": ""
33998           },
33999           {
34000             "group": "Body",
34001             "type": "String",
34002             "optional": true,
34003             "field": "transfereecontext",
34004             "description": ""
34005           },
34006           {
34007             "group": "Body",
34008             "type": "String",
34009             "optional": true,
34010             "field": "transfereeexten",
34011             "description": ""
34012           },
34013           {
34014             "group": "Body",
34015             "type": "String",
34016             "optional": true,
34017             "field": "transfereelinkedid",
34018             "description": ""
34019           },
34020           {
34021             "group": "Body",
34022             "type": "String",
34023             "allowedValues": [
34024               "\"Yes\"",
34025               "\"No\""
34026             ],
34027             "optional": true,
34028             "field": "isexternal",
34029             "description": ""
34030           },
34031           {
34032             "group": "Body",
34033             "type": "String",
34034             "optional": true,
34035             "field": "context",
34036             "description": ""
34037           },
34038           {
34039             "group": "Body",
34040             "type": "String",
34041             "optional": true,
34042             "field": "extension",
34043             "description": ""
34044           }
34045         ]
34046       }
34047     },
34048     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34049     "version": "0.0.0",
34050     "filename": "server/api/voiceTransferReport/index.js",
34051     "groupTitle": "Voice_Transfer_Reports"
34052   },
34053   {
34054     "type": "delete",
34055     "url": "/api/voice/transfers/reports/{id}",
34056     "title": "Deletes a Transfer Report",
34057     "examples": [
34058       {
34059         "title": "Example usage:",
34060         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
34061         "type": "json"
34062       }
34063     ],
34064     "name": "DeleteTransfer_Reports",
34065     "group": "Voice_Transfer_Reports",
34066     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34067     "version": "0.0.0",
34068     "filename": "server/api/voiceTransferReport/index.js",
34069     "groupTitle": "Voice_Transfer_Reports"
34070   },
34071   {
34072     "type": "get",
34073     "url": "/api/voice/transfers/reports/describe",
34074     "title": "Gets table info about Transfer Reports",
34075     "examples": [
34076       {
34077         "title": "Example usage:",
34078         "content": "curl https://{domain}/api/voice/transfers/reports/describe -v -u {name}:{password}",
34079         "type": "json"
34080       }
34081     ],
34082     "name": "DescribeTransfer_Reports",
34083     "group": "Voice_Transfer_Reports",
34084     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34085     "version": "0.0.0",
34086     "filename": "server/api/voiceTransferReport/index.js",
34087     "groupTitle": "Voice_Transfer_Reports"
34088   },
34089   {
34090     "type": "get",
34091     "url": "/api/voice/transfers/reports",
34092     "title": "Gets a list of Transfer Reports",
34093     "examples": [
34094       {
34095         "title": "Example usage:",
34096         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
34097         "type": "json"
34098       }
34099     ],
34100     "name": "GetTransfer_Reports",
34101     "group": "Voice_Transfer_Reports",
34102     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34103     "version": "0.0.0",
34104     "filename": "server/api/voiceTransferReport/index.js",
34105     "groupTitle": "Voice_Transfer_Reports"
34106   },
34107   {
34108     "type": "get",
34109     "url": "/api/voice/transfers/reports/{id}",
34110     "title": "Gets a single Transfer Report",
34111     "examples": [
34112       {
34113         "title": "Example usage:",
34114         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
34115         "type": "json"
34116       }
34117     ],
34118     "name": "ShowTransfer_Reports",
34119     "group": "Voice_Transfer_Reports",
34120     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34121     "version": "0.0.0",
34122     "filename": "server/api/voiceTransferReport/index.js",
34123     "groupTitle": "Voice_Transfer_Reports"
34124   },
34125   {
34126     "type": "put",
34127     "url": "/api/voice/transfers/reports/{id}",
34128     "title": "Update an existing Transfer Report",
34129     "examples": [
34130       {
34131         "title": "Example usage:",
34132         "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",
34133         "type": "json"
34134       }
34135     ],
34136     "name": "updateTransfer_Reports",
34137     "group": "Voice_Transfer_Reports",
34138     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34139     "version": "0.0.0",
34140     "filename": "server/api/voiceTransferReport/index.js",
34141     "groupTitle": "Voice_Transfer_Reports"
34142   },
34143   {
34144     "type": "post",
34145     "url": "/api/integrations/vtiger/accounts",
34146     "title": "Creates a new Vtiger Account",
34147     "examples": [
34148       {
34149         "title": "Example usage:",
34150         "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",
34151         "type": "json"
34152       }
34153     ],
34154     "name": "CreateVtiger_Accounts",
34155     "group": "Vtiger_Accounts",
34156     "parameter": {
34157       "fields": {
34158         "Body": [
34159           {
34160             "group": "Body",
34161             "type": "String",
34162             "optional": false,
34163             "field": "name",
34164             "description": ""
34165           },
34166           {
34167             "group": "Body",
34168             "type": "String",
34169             "optional": true,
34170             "field": "description",
34171             "description": ""
34172           },
34173           {
34174             "group": "Body",
34175             "type": "String",
34176             "optional": false,
34177             "field": "username",
34178             "description": ""
34179           },
34180           {
34181             "group": "Body",
34182             "type": "String",
34183             "optional": false,
34184             "field": "moduleName",
34185             "description": ""
34186           },
34187           {
34188             "group": "Body",
34189             "type": "String",
34190             "optional": false,
34191             "field": "remoteUri",
34192             "description": ""
34193           },
34194           {
34195             "group": "Body",
34196             "type": "String",
34197             "optional": false,
34198             "field": "serverUrl",
34199             "description": ""
34200           },
34201           {
34202             "group": "Body",
34203             "type": "String",
34204             "optional": false,
34205             "field": "accessKey",
34206             "description": ""
34207           }
34208         ]
34209       }
34210     },
34211     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34212     "version": "0.0.0",
34213     "filename": "server/api/intVtigerAccount/index.js",
34214     "groupTitle": "Vtiger_Accounts"
34215   },
34216   {
34217     "type": "delete",
34218     "url": "/api/integrations/vtiger/accounts/{id}",
34219     "title": "Deletes a Vtiger Account",
34220     "examples": [
34221       {
34222         "title": "Example usage:",
34223         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
34224         "type": "json"
34225       }
34226     ],
34227     "name": "DeleteVtiger_Accounts",
34228     "group": "Vtiger_Accounts",
34229     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34230     "version": "0.0.0",
34231     "filename": "server/api/intVtigerAccount/index.js",
34232     "groupTitle": "Vtiger_Accounts"
34233   },
34234   {
34235     "type": "get",
34236     "url": "/api/integrations/vtiger/accounts",
34237     "title": "Gets a list of Vtiger Accounts",
34238     "examples": [
34239       {
34240         "title": "Example usage:",
34241         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
34242         "type": "json"
34243       }
34244     ],
34245     "name": "GetVtiger_Accounts",
34246     "group": "Vtiger_Accounts",
34247     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34248     "version": "0.0.0",
34249     "filename": "server/api/intVtigerAccount/index.js",
34250     "groupTitle": "Vtiger_Accounts"
34251   },
34252   {
34253     "type": "get",
34254     "url": "/api/integrations/vtiger/accounts/{id}",
34255     "title": "Gets a single Vtiger Account",
34256     "examples": [
34257       {
34258         "title": "Example usage:",
34259         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
34260         "type": "json"
34261       }
34262     ],
34263     "name": "ShowVtiger_Accounts",
34264     "group": "Vtiger_Accounts",
34265     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34266     "version": "0.0.0",
34267     "filename": "server/api/intVtigerAccount/index.js",
34268     "groupTitle": "Vtiger_Accounts"
34269   },
34270   {
34271     "type": "post",
34272     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34273     "title": "Creates new configuration",
34274     "examples": [
34275       {
34276         "title": "Example usage:",
34277         "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",
34278         "type": "json"
34279       }
34280     ],
34281     "name": "addConfiguration",
34282     "group": "Vtiger_Accounts",
34283     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34284     "version": "0.0.0",
34285     "filename": "server/api/intVtigerAccount/index.js",
34286     "groupTitle": "Vtiger_Accounts"
34287   },
34288   {
34289     "type": "get",
34290     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
34291     "title": "Gets account configurations",
34292     "examples": [
34293       {
34294         "title": "Example usage:",
34295         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
34296         "type": "json"
34297       }
34298     ],
34299     "name": "getConfigurations",
34300     "group": "Vtiger_Accounts",
34301     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34302     "version": "0.0.0",
34303     "filename": "server/api/intVtigerAccount/index.js",
34304     "groupTitle": "Vtiger_Accounts"
34305   },
34306   {
34307     "type": "get",
34308     "url": "/api/integrations/vtiger/accounts/{id}/fields",
34309     "title": "Gets account fields",
34310     "examples": [
34311       {
34312         "title": "Example usage:",
34313         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
34314         "type": "json"
34315       }
34316     ],
34317     "name": "getFields",
34318     "group": "Vtiger_Accounts",
34319     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34320     "version": "0.0.0",
34321     "filename": "server/api/intVtigerAccount/index.js",
34322     "groupTitle": "Vtiger_Accounts"
34323   },
34324   {
34325     "type": "put",
34326     "url": "/api/integrations/vtiger/accounts/{id}",
34327     "title": "Update an existing Vtiger Account",
34328     "examples": [
34329       {
34330         "title": "Example usage:",
34331         "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",
34332         "type": "json"
34333       }
34334     ],
34335     "name": "updateVtiger_Accounts",
34336     "group": "Vtiger_Accounts",
34337     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34338     "version": "0.0.0",
34339     "filename": "server/api/intVtigerAccount/index.js",
34340     "groupTitle": "Vtiger_Accounts"
34341   },
34342   {
34343     "type": "post",
34344     "url": "/api/integrations/vtiger/configurations",
34345     "title": "Creates a new Vtiger Configuration",
34346     "examples": [
34347       {
34348         "title": "Example usage:",
34349         "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",
34350         "type": "json"
34351       }
34352     ],
34353     "name": "CreateVtiger_Configurations",
34354     "group": "Vtiger_Configurations",
34355     "parameter": {
34356       "fields": {
34357         "Body": [
34358           {
34359             "group": "Body",
34360             "type": "String",
34361             "optional": true,
34362             "field": "name",
34363             "description": ""
34364           },
34365           {
34366             "group": "Body",
34367             "type": "String",
34368             "optional": true,
34369             "field": "description",
34370             "description": ""
34371           }
34372         ]
34373       }
34374     },
34375     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34376     "version": "0.0.0",
34377     "filename": "server/api/intVtigerConfiguration/index.js",
34378     "groupTitle": "Vtiger_Configurations"
34379   },
34380   {
34381     "type": "delete",
34382     "url": "/api/integrations/vtiger/configurations/{id}",
34383     "title": "Deletes a Vtiger Configuration",
34384     "examples": [
34385       {
34386         "title": "Example usage:",
34387         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34388         "type": "json"
34389       }
34390     ],
34391     "name": "DeleteVtiger_Configurations",
34392     "group": "Vtiger_Configurations",
34393     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34394     "version": "0.0.0",
34395     "filename": "server/api/intVtigerConfiguration/index.js",
34396     "groupTitle": "Vtiger_Configurations"
34397   },
34398   {
34399     "type": "get",
34400     "url": "/api/integrations/vtiger/configurations",
34401     "title": "Gets a list of Vtiger Configurations",
34402     "examples": [
34403       {
34404         "title": "Example usage:",
34405         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34406         "type": "json"
34407       }
34408     ],
34409     "name": "GetVtiger_Configurations",
34410     "group": "Vtiger_Configurations",
34411     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34412     "version": "0.0.0",
34413     "filename": "server/api/intVtigerConfiguration/index.js",
34414     "groupTitle": "Vtiger_Configurations"
34415   },
34416   {
34417     "type": "get",
34418     "url": "/api/integrations/vtiger/configurations/{id}",
34419     "title": "Gets a single Vtiger Configuration",
34420     "examples": [
34421       {
34422         "title": "Example usage:",
34423         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34424         "type": "json"
34425       }
34426     ],
34427     "name": "ShowVtiger_Configurations",
34428     "group": "Vtiger_Configurations",
34429     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34430     "version": "0.0.0",
34431     "filename": "server/api/intVtigerConfiguration/index.js",
34432     "groupTitle": "Vtiger_Configurations"
34433   },
34434   {
34435     "type": "get",
34436     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34437     "title": "Gets configurations descriptions",
34438     "examples": [
34439       {
34440         "title": "Example usage:",
34441         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34442         "type": "json"
34443       }
34444     ],
34445     "name": "getDescriptions",
34446     "group": "Vtiger_Configurations",
34447     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34448     "version": "0.0.0",
34449     "filename": "server/api/intVtigerConfiguration/index.js",
34450     "groupTitle": "Vtiger_Configurations"
34451   },
34452   {
34453     "type": "get",
34454     "url": "/api/integrations/vtiger/configurations/{id}/fields",
34455     "title": "Gets configurations fields",
34456     "examples": [
34457       {
34458         "title": "Example usage:",
34459         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34460         "type": "json"
34461       }
34462     ],
34463     "name": "getFields",
34464     "group": "Vtiger_Configurations",
34465     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34466     "version": "0.0.0",
34467     "filename": "server/api/intVtigerConfiguration/index.js",
34468     "groupTitle": "Vtiger_Configurations"
34469   },
34470   {
34471     "type": "get",
34472     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34473     "title": "Gets configurations subjects",
34474     "examples": [
34475       {
34476         "title": "Example usage:",
34477         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34478         "type": "json"
34479       }
34480     ],
34481     "name": "getSubjects",
34482     "group": "Vtiger_Configurations",
34483     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34484     "version": "0.0.0",
34485     "filename": "server/api/intVtigerConfiguration/index.js",
34486     "groupTitle": "Vtiger_Configurations"
34487   },
34488   {
34489     "type": "put",
34490     "url": "/api/integrations/vtiger/configurations/{id}",
34491     "title": "Update an existing Vtiger Configuration",
34492     "examples": [
34493       {
34494         "title": "Example usage:",
34495         "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",
34496         "type": "json"
34497       }
34498     ],
34499     "name": "updateVtiger_Configurations",
34500     "group": "Vtiger_Configurations",
34501     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34502     "version": "0.0.0",
34503     "filename": "server/api/intVtigerConfiguration/index.js",
34504     "groupTitle": "Vtiger_Configurations"
34505   },
34506   {
34507     "type": "post",
34508     "url": "/api/integrations/vtiger/fields",
34509     "title": "Creates a new Vtiger Field",
34510     "examples": [
34511       {
34512         "title": "Example usage:",
34513         "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",
34514         "type": "json"
34515       }
34516     ],
34517     "name": "CreateVtiger_Fields",
34518     "group": "Vtiger_Fields",
34519     "parameter": {
34520       "fields": {
34521         "Body": [
34522           {
34523             "group": "Body",
34524             "type": "String",
34525             "allowedValues": [
34526               "\"string\"",
34527               "\"variable\"",
34528               "\"customVariable\"",
34529               "\"keyValue\"",
34530               "\"picklist\""
34531             ],
34532             "optional": true,
34533             "field": "type",
34534             "description": ""
34535           },
34536           {
34537             "group": "Body",
34538             "type": "String",
34539             "optional": true,
34540             "field": "content",
34541             "description": ""
34542           },
34543           {
34544             "group": "Body",
34545             "type": "String",
34546             "optional": true,
34547             "field": "key",
34548             "description": ""
34549           },
34550           {
34551             "group": "Body",
34552             "type": "String",
34553             "allowedValues": [
34554               "\"string\"",
34555               "\"variable\"",
34556               "\"customVariable\""
34557             ],
34558             "optional": true,
34559             "field": "keyType",
34560             "description": ""
34561           },
34562           {
34563             "group": "Body",
34564             "type": "String",
34565             "optional": true,
34566             "field": "keyContent",
34567             "description": ""
34568           },
34569           {
34570             "group": "Body",
34571             "type": "String",
34572             "optional": true,
34573             "field": "idField",
34574             "description": ""
34575           },
34576           {
34577             "group": "Body",
34578             "type": "String",
34579             "optional": true,
34580             "field": "nameField",
34581             "description": ""
34582           },
34583           {
34584             "group": "Body",
34585             "type": "Boolean",
34586             "optional": true,
34587             "field": "customField",
34588             "description": ""
34589           },
34590           {
34591             "group": "Body",
34592             "type": "String",
34593             "optional": true,
34594             "field": "variableName",
34595             "description": ""
34596           }
34597         ]
34598       }
34599     },
34600     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34601     "version": "0.0.0",
34602     "filename": "server/api/intVtigerField/index.js",
34603     "groupTitle": "Vtiger_Fields"
34604   },
34605   {
34606     "type": "delete",
34607     "url": "/api/integrations/vtiger/fields/{id}",
34608     "title": "Deletes a Vtiger Field",
34609     "examples": [
34610       {
34611         "title": "Example usage:",
34612         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34613         "type": "json"
34614       }
34615     ],
34616     "name": "DeleteVtiger_Fields",
34617     "group": "Vtiger_Fields",
34618     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34619     "version": "0.0.0",
34620     "filename": "server/api/intVtigerField/index.js",
34621     "groupTitle": "Vtiger_Fields"
34622   },
34623   {
34624     "type": "get",
34625     "url": "/api/integrations/vtiger/fields",
34626     "title": "Gets a list of Vtiger Fields",
34627     "examples": [
34628       {
34629         "title": "Example usage:",
34630         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34631         "type": "json"
34632       }
34633     ],
34634     "name": "GetVtiger_Fields",
34635     "group": "Vtiger_Fields",
34636     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34637     "version": "0.0.0",
34638     "filename": "server/api/intVtigerField/index.js",
34639     "groupTitle": "Vtiger_Fields"
34640   },
34641   {
34642     "type": "get",
34643     "url": "/api/integrations/vtiger/fields/{id}",
34644     "title": "Gets a single Vtiger Field",
34645     "examples": [
34646       {
34647         "title": "Example usage:",
34648         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34649         "type": "json"
34650       }
34651     ],
34652     "name": "ShowVtiger_Fields",
34653     "group": "Vtiger_Fields",
34654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34655     "version": "0.0.0",
34656     "filename": "server/api/intVtigerField/index.js",
34657     "groupTitle": "Vtiger_Fields"
34658   },
34659   {
34660     "type": "put",
34661     "url": "/api/integrations/vtiger/fields/{id}",
34662     "title": "Update an existing Vtiger Field",
34663     "examples": [
34664       {
34665         "title": "Example usage:",
34666         "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",
34667         "type": "json"
34668       }
34669     ],
34670     "name": "updateVtiger_Fields",
34671     "group": "Vtiger_Fields",
34672     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34673     "version": "0.0.0",
34674     "filename": "server/api/intVtigerField/index.js",
34675     "groupTitle": "Vtiger_Fields"
34676   },
34677   {
34678     "type": "post",
34679     "url": "/api/webbar/answer",
34680     "title": "answer webrtc call",
34681     "examples": [
34682       {
34683         "title": "Example usage:",
34684         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34685         "type": "json"
34686       }
34687     ],
34688     "name": "Web_Bar_answer",
34689     "group": "WebBar",
34690     "parameter": {
34691       "fields": {
34692         "Body": [
34693           {
34694             "group": "Body",
34695             "type": "String",
34696             "optional": false,
34697             "field": "sessionId",
34698             "description": ""
34699           },
34700           {
34701             "group": "Body",
34702             "type": "number",
34703             "optional": false,
34704             "field": "userId",
34705             "description": ""
34706           }
34707         ]
34708       }
34709     },
34710     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34711     "version": "0.0.0",
34712     "filename": "server/api/webbar/index.js",
34713     "groupTitle": "WebBar"
34714   },
34715   {
34716     "type": "post",
34717     "url": "/api/webbar/calls",
34718     "title": "webrtc call list",
34719     "examples": [
34720       {
34721         "title": "Example usage:",
34722         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34723         "type": "json"
34724       }
34725     ],
34726     "name": "Web_Bar_calls",
34727     "group": "WebBar",
34728     "parameter": {
34729       "fields": {
34730         "Body": [
34731           {
34732             "group": "Body",
34733             "type": "number",
34734             "optional": false,
34735             "field": "userId",
34736             "description": ""
34737           }
34738         ]
34739       }
34740     },
34741     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34742     "version": "0.0.0",
34743     "filename": "server/api/webbar/index.js",
34744     "groupTitle": "WebBar"
34745   },
34746   {
34747     "type": "post",
34748     "url": "/api/webbar/hangup",
34749     "title": "hangup webrtc call",
34750     "examples": [
34751       {
34752         "title": "Example usage:",
34753         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34754         "type": "json"
34755       }
34756     ],
34757     "name": "Web_Bar_hangup",
34758     "group": "WebBar",
34759     "parameter": {
34760       "fields": {
34761         "Body": [
34762           {
34763             "group": "Body",
34764             "type": "String",
34765             "optional": false,
34766             "field": "sessionId",
34767             "description": ""
34768           },
34769           {
34770             "group": "Body",
34771             "type": "number",
34772             "optional": false,
34773             "field": "userId",
34774             "description": ""
34775           }
34776         ]
34777       }
34778     },
34779     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34780     "version": "0.0.0",
34781     "filename": "server/api/webbar/index.js",
34782     "groupTitle": "WebBar"
34783   },
34784   {
34785     "type": "post",
34786     "url": "/api/webbar/hold",
34787     "title": "hold webrtc call",
34788     "examples": [
34789       {
34790         "title": "Example usage:",
34791         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34792         "type": "json"
34793       }
34794     ],
34795     "name": "Web_Bar_hold",
34796     "group": "WebBar",
34797     "parameter": {
34798       "fields": {
34799         "Body": [
34800           {
34801             "group": "Body",
34802             "type": "String",
34803             "optional": true,
34804             "field": "sessionId",
34805             "description": ""
34806           },
34807           {
34808             "group": "Body",
34809             "type": "number",
34810             "optional": false,
34811             "field": "userId",
34812             "description": ""
34813           }
34814         ]
34815       }
34816     },
34817     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34818     "version": "0.0.0",
34819     "filename": "server/api/webbar/index.js",
34820     "groupTitle": "WebBar"
34821   },
34822   {
34823     "type": "post",
34824     "url": "/api/webbar/unhold",
34825     "title": "unhold webrtc call",
34826     "examples": [
34827       {
34828         "title": "Example usage:",
34829         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34830         "type": "json"
34831       }
34832     ],
34833     "name": "Web_Bar_hold",
34834     "group": "WebBar",
34835     "parameter": {
34836       "fields": {
34837         "Body": [
34838           {
34839             "group": "Body",
34840             "type": "String",
34841             "optional": false,
34842             "field": "sessionId",
34843             "description": ""
34844           },
34845           {
34846             "group": "Body",
34847             "type": "number",
34848             "optional": false,
34849             "field": "userId",
34850             "description": ""
34851           }
34852         ]
34853       }
34854     },
34855     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34856     "version": "0.0.0",
34857     "filename": "server/api/webbar/index.js",
34858     "groupTitle": "WebBar"
34859   },
34860   {
34861     "type": "post",
34862     "url": "/api/webbar/originate",
34863     "title": "Originate new webrtc call",
34864     "examples": [
34865       {
34866         "title": "Example usage:",
34867         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
34868         "type": "json"
34869       }
34870     ],
34871     "name": "Web_Bar_originate",
34872     "group": "WebBar",
34873     "parameter": {
34874       "fields": {
34875         "Body": [
34876           {
34877             "group": "Body",
34878             "type": "String",
34879             "optional": false,
34880             "field": "callNumber",
34881             "description": ""
34882           },
34883           {
34884             "group": "Body",
34885             "type": "number",
34886             "optional": false,
34887             "field": "userId",
34888             "description": ""
34889           },
34890           {
34891             "group": "Body",
34892             "type": "String",
34893             "optional": false,
34894             "field": "callerId",
34895             "description": ""
34896           },
34897           {
34898             "group": "Body",
34899             "type": "String",
34900             "optional": false,
34901             "field": "callbackUrl",
34902             "description": ""
34903           }
34904         ]
34905       }
34906     },
34907     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34908     "version": "0.0.0",
34909     "filename": "server/api/webbar/index.js",
34910     "groupTitle": "WebBar"
34911   },
34912   {
34913     "type": "post",
34914     "url": "/api/webbar/transfer",
34915     "title": "blind transfer webrtc call",
34916     "examples": [
34917       {
34918         "title": "Example usage:",
34919         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34920         "type": "json"
34921       }
34922     ],
34923     "name": "Web_Bar_transfer",
34924     "group": "WebBar",
34925     "parameter": {
34926       "fields": {
34927         "Body": [
34928           {
34929             "group": "Body",
34930             "type": "number",
34931             "optional": false,
34932             "field": "userId",
34933             "description": ""
34934           },
34935           {
34936             "group": "Body",
34937             "type": "string",
34938             "optional": false,
34939             "field": "sessionId",
34940             "description": ""
34941           },
34942           {
34943             "group": "Body",
34944             "type": "string",
34945             "optional": false,
34946             "field": "transferNumber",
34947             "description": ""
34948           }
34949         ]
34950       }
34951     },
34952     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34953     "version": "0.0.0",
34954     "filename": "server/api/webbar/index.js",
34955     "groupTitle": "WebBar"
34956   },
34957   {
34958     "type": "post",
34959     "url": "/api/whatsapp/accounts/{id}/users",
34960     "title": "Add agents to a whatsapp account",
34961     "examples": [
34962       {
34963         "title": "Example usage:",
34964         "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",
34965         "type": "json"
34966       }
34967     ],
34968     "name": "AddAgents",
34969     "group": "Whatsapp_Accounts",
34970     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34971     "version": "0.0.0",
34972     "filename": "server/api/whatsappAccount/index.js",
34973     "groupTitle": "Whatsapp_Accounts"
34974   },
34975   {
34976     "type": "post",
34977     "url": "/api/whatsapp/accounts",
34978     "title": "Creates a new Account",
34979     "examples": [
34980       {
34981         "title": "Example usage:",
34982         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34983         "type": "json"
34984       }
34985     ],
34986     "name": "CreateAccounts",
34987     "group": "Whatsapp_Accounts",
34988     "parameter": {
34989       "fields": {
34990         "Body": [
34991           {
34992             "group": "Body",
34993             "type": "String",
34994             "optional": false,
34995             "field": "name",
34996             "description": ""
34997           },
34998           {
34999             "group": "Body",
35000             "type": "String",
35001             "optional": false,
35002             "field": "key",
35003             "description": ""
35004           },
35005           {
35006             "group": "Body",
35007             "type": "String",
35008             "optional": false,
35009             "field": "remote",
35010             "description": ""
35011           },
35012           {
35013             "group": "Body",
35014             "type": "String",
35015             "optional": true,
35016             "field": "token",
35017             "description": ""
35018           },
35019           {
35020             "group": "Body",
35021             "type": "String",
35022             "optional": true,
35023             "field": "phone",
35024             "description": ""
35025           },
35026           {
35027             "group": "Body",
35028             "type": "String",
35029             "allowedValues": [
35030               "\"twilio\""
35031             ],
35032             "optional": true,
35033             "field": "type",
35034             "description": ""
35035           },
35036           {
35037             "group": "Body",
35038             "type": "String",
35039             "optional": true,
35040             "field": "accountSid",
35041             "description": ""
35042           },
35043           {
35044             "group": "Body",
35045             "type": "String",
35046             "optional": true,
35047             "field": "authToken",
35048             "description": ""
35049           },
35050           {
35051             "group": "Body",
35052             "type": "Text",
35053             "optional": true,
35054             "field": "notificationTemplate",
35055             "description": ""
35056           },
35057           {
35058             "group": "Body",
35059             "type": "Boolean",
35060             "optional": true,
35061             "field": "notificationSound",
35062             "description": ""
35063           },
35064           {
35065             "group": "Body",
35066             "type": "Boolean",
35067             "optional": true,
35068             "field": "notificationShake",
35069             "description": ""
35070           },
35071           {
35072             "group": "Body",
35073             "type": "Integer",
35074             "optional": true,
35075             "field": "waitForTheAssignedAgent",
35076             "description": ""
35077           },
35078           {
35079             "group": "Body",
35080             "type": "Boolean",
35081             "optional": true,
35082             "field": "queueTransfer",
35083             "description": ""
35084           },
35085           {
35086             "group": "Body",
35087             "type": "Integer",
35088             "optional": true,
35089             "field": "queueTransferTimeout",
35090             "description": ""
35091           },
35092           {
35093             "group": "Body",
35094             "type": "Boolean",
35095             "optional": true,
35096             "field": "agentTransfer",
35097             "description": ""
35098           },
35099           {
35100             "group": "Body",
35101             "type": "Integer",
35102             "optional": true,
35103             "field": "agentTransferTimeout",
35104             "description": ""
35105           },
35106           {
35107             "group": "Body",
35108             "type": "Integer",
35109             "optional": true,
35110             "field": "mandatoryDispositionPauseId",
35111             "description": "<p>Status to put when mandatory disposition is enabled</p>"
35112           },
35113           {
35114             "group": "Body",
35115             "type": "Boolean",
35116             "optional": true,
35117             "field": "mandatoryDisposition",
35118             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
35119           },
35120           {
35121             "group": "Body",
35122             "type": "String",
35123             "optional": true,
35124             "field": "description",
35125             "description": ""
35126           }
35127         ]
35128       }
35129     },
35130     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35131     "version": "0.0.0",
35132     "filename": "server/api/whatsappAccount/index.js",
35133     "groupTitle": "Whatsapp_Accounts"
35134   },
35135   {
35136     "type": "delete",
35137     "url": "/api/whatsapp/accounts/{id}",
35138     "title": "Deletes a Account",
35139     "examples": [
35140       {
35141         "title": "Example usage:",
35142         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
35143         "type": "json"
35144       }
35145     ],
35146     "name": "DeleteAccounts",
35147     "group": "Whatsapp_Accounts",
35148     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35149     "version": "0.0.0",
35150     "filename": "server/api/whatsappAccount/index.js",
35151     "groupTitle": "Whatsapp_Accounts"
35152   },
35153   {
35154     "type": "get",
35155     "url": "/api/whatsapp/accounts/describe",
35156     "title": "Gets table info about Accounts",
35157     "examples": [
35158       {
35159         "title": "Example usage:",
35160         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
35161         "type": "json"
35162       }
35163     ],
35164     "name": "DescribeAccounts",
35165     "group": "Whatsapp_Accounts",
35166     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35167     "version": "0.0.0",
35168     "filename": "server/api/whatsappAccount/index.js",
35169     "groupTitle": "Whatsapp_Accounts"
35170   },
35171   {
35172     "type": "get",
35173     "url": "/api/whatsapp/accounts",
35174     "title": "Gets a list of Accounts",
35175     "examples": [
35176       {
35177         "title": "Example usage:",
35178         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
35179         "type": "json"
35180       }
35181     ],
35182     "name": "GetAccounts",
35183     "group": "Whatsapp_Accounts",
35184     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35185     "version": "0.0.0",
35186     "filename": "server/api/whatsappAccount/index.js",
35187     "groupTitle": "Whatsapp_Accounts"
35188   },
35189   {
35190     "type": "get",
35191     "url": "/api/whatsapp/accounts/{id}/users",
35192     "title": "Gets agents from whatsapp account",
35193     "examples": [
35194       {
35195         "title": "Example usage:",
35196         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
35197         "type": "json"
35198       }
35199     ],
35200     "name": "GetAgents",
35201     "group": "Whatsapp_Accounts",
35202     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35203     "version": "0.0.0",
35204     "filename": "server/api/whatsappAccount/index.js",
35205     "groupTitle": "Whatsapp_Accounts"
35206   },
35207   {
35208     "type": "delete",
35209     "url": "/api/whatsapp/accounts/{id}/users",
35210     "title": "Removes agents from a whatsapp account",
35211     "examples": [
35212       {
35213         "title": "Example usage:",
35214         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35215         "type": "json"
35216       }
35217     ],
35218     "name": "RemoveAgents",
35219     "group": "Whatsapp_Accounts",
35220     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35221     "version": "0.0.0",
35222     "filename": "server/api/whatsappAccount/index.js",
35223     "groupTitle": "Whatsapp_Accounts"
35224   },
35225   {
35226     "type": "delete",
35227     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35228     "title": "Removes canned answers from account",
35229     "examples": [
35230       {
35231         "title": "Example usage:",
35232         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35233         "type": "json"
35234       }
35235     ],
35236     "name": "RemoveAnswers",
35237     "group": "Whatsapp_Accounts",
35238     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35239     "version": "0.0.0",
35240     "filename": "server/api/whatsappAccount/index.js",
35241     "groupTitle": "Whatsapp_Accounts"
35242   },
35243   {
35244     "type": "delete",
35245     "url": "/api/whatsapp/accounts/{id}/dispositions",
35246     "title": "Removes dispositions from account",
35247     "examples": [
35248       {
35249         "title": "Example usage:",
35250         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35251         "type": "json"
35252       }
35253     ],
35254     "name": "RemoveDispositions",
35255     "group": "Whatsapp_Accounts",
35256     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35257     "version": "0.0.0",
35258     "filename": "server/api/whatsappAccount/index.js",
35259     "groupTitle": "Whatsapp_Accounts"
35260   },
35261   {
35262     "type": "get",
35263     "url": "/api/whatsapp/accounts/{id}",
35264     "title": "Gets a single Account",
35265     "examples": [
35266       {
35267         "title": "Example usage:",
35268         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
35269         "type": "json"
35270       }
35271     ],
35272     "name": "ShowAccounts",
35273     "group": "Whatsapp_Accounts",
35274     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35275     "version": "0.0.0",
35276     "filename": "server/api/whatsappAccount/index.js",
35277     "groupTitle": "Whatsapp_Accounts"
35278   },
35279   {
35280     "type": "put",
35281     "url": "/api/whatsapp/messages/{id}/accept",
35282     "title": "Accepts message",
35283     "examples": [
35284       {
35285         "title": "Example usage:",
35286         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35287         "type": "json"
35288       }
35289     ],
35290     "name": "acceptMessage",
35291     "group": "Whatsapp_Accounts",
35292     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35293     "version": "0.0.0",
35294     "filename": "server/api/whatsappMessage/index.js",
35295     "groupTitle": "Whatsapp_Accounts"
35296   },
35297   {
35298     "type": "post",
35299     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35300     "title": "Creates new canned answer",
35301     "examples": [
35302       {
35303         "title": "Example usage:",
35304         "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",
35305         "type": "json"
35306       }
35307     ],
35308     "name": "addAnswer",
35309     "group": "Whatsapp_Accounts",
35310     "parameter": {
35311       "fields": {
35312         "Body": [
35313           {
35314             "group": "Body",
35315             "type": "String",
35316             "optional": false,
35317             "field": "key",
35318             "description": ""
35319           },
35320           {
35321             "group": "Body",
35322             "type": "Text",
35323             "optional": false,
35324             "field": "value",
35325             "description": ""
35326           },
35327           {
35328             "group": "Body",
35329             "type": "String",
35330             "optional": true,
35331             "field": "description",
35332             "description": ""
35333           },
35334           {
35335             "group": "Body",
35336             "type": "Virtual",
35337             "optional": true,
35338             "field": "name",
35339             "description": ""
35340           }
35341         ]
35342       }
35343     },
35344     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35345     "version": "0.0.0",
35346     "filename": "server/api/whatsappAccount/index.js",
35347     "groupTitle": "Whatsapp_Accounts"
35348   },
35349   {
35350     "type": "post",
35351     "url": "/api/whatsapp/accounts/{id}/applications",
35352     "title": "Creates new applications",
35353     "examples": [
35354       {
35355         "title": "Example usage:",
35356         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35357         "type": "json"
35358       }
35359     ],
35360     "name": "addApplications",
35361     "group": "Whatsapp_Accounts",
35362     "parameter": {
35363       "fields": {
35364         "Body": [
35365           {
35366             "group": "Body",
35367             "type": "Integer",
35368             "optional": false,
35369             "field": "priority",
35370             "description": ""
35371           },
35372           {
35373             "group": "Body",
35374             "type": "String",
35375             "optional": false,
35376             "field": "app",
35377             "description": ""
35378           },
35379           {
35380             "group": "Body",
35381             "type": "Text",
35382             "optional": true,
35383             "field": "appdata",
35384             "description": ""
35385           },
35386           {
35387             "group": "Body",
35388             "type": "String",
35389             "optional": true,
35390             "field": "description",
35391             "description": ""
35392           },
35393           {
35394             "group": "Body",
35395             "type": "String",
35396             "optional": true,
35397             "field": "interval",
35398             "description": ""
35399           }
35400         ]
35401       }
35402     },
35403     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35404     "version": "0.0.0",
35405     "filename": "server/api/whatsappAccount/index.js",
35406     "groupTitle": "Whatsapp_Accounts"
35407   },
35408   {
35409     "type": "post",
35410     "url": "/api/whatsapp/accounts/{id}/dispositions",
35411     "title": "Creates new disposition",
35412     "examples": [
35413       {
35414         "title": "Example usage:",
35415         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35416         "type": "json"
35417       }
35418     ],
35419     "name": "addDisposition",
35420     "group": "Whatsapp_Accounts",
35421     "parameter": {
35422       "fields": {
35423         "Body": [
35424           {
35425             "group": "Body",
35426             "type": "String",
35427             "optional": false,
35428             "field": "name",
35429             "description": ""
35430           },
35431           {
35432             "group": "Body",
35433             "type": "String",
35434             "allowedValues": [
35435               "\"first\"",
35436               "\"second\"",
35437               "\"third\""
35438             ],
35439             "optional": false,
35440             "field": "level",
35441             "description": ""
35442           },
35443           {
35444             "group": "Body",
35445             "type": "String",
35446             "optional": true,
35447             "field": "description",
35448             "description": ""
35449           }
35450         ]
35451       }
35452     },
35453     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35454     "version": "0.0.0",
35455     "filename": "server/api/whatsappAccount/index.js",
35456     "groupTitle": "Whatsapp_Accounts"
35457   },
35458   {
35459     "type": "get",
35460     "url": "/api/whatsapp/accounts/{id}/canned_answers",
35461     "title": "Gets account canned answers",
35462     "examples": [
35463       {
35464         "title": "Example usage:",
35465         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
35466         "type": "json"
35467       }
35468     ],
35469     "name": "getAnswers",
35470     "group": "Whatsapp_Accounts",
35471     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35472     "version": "0.0.0",
35473     "filename": "server/api/whatsappAccount/index.js",
35474     "groupTitle": "Whatsapp_Accounts"
35475   },
35476   {
35477     "type": "get",
35478     "url": "/api/whatsapp/accounts/{id}/applications",
35479     "title": "Gets account applications",
35480     "examples": [
35481       {
35482         "title": "Example usage:",
35483         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
35484         "type": "json"
35485       }
35486     ],
35487     "name": "getApplications",
35488     "group": "Whatsapp_Accounts",
35489     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35490     "version": "0.0.0",
35491     "filename": "server/api/whatsappAccount/index.js",
35492     "groupTitle": "Whatsapp_Accounts"
35493   },
35494   {
35495     "type": "get",
35496     "url": "/api/whatsapp/accounts/{id}/dispositions",
35497     "title": "Gets account dispositions",
35498     "examples": [
35499       {
35500         "title": "Example usage:",
35501         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
35502         "type": "json"
35503       }
35504     ],
35505     "name": "getDispositions",
35506     "group": "Whatsapp_Accounts",
35507     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35508     "version": "0.0.0",
35509     "filename": "server/api/whatsappAccount/index.js",
35510     "groupTitle": "Whatsapp_Accounts"
35511   },
35512   {
35513     "type": "post",
35514     "url": "/api/whatsapp/accounts/{id}/notify",
35515     "title": "Notify new message",
35516     "examples": [
35517       {
35518         "title": "Example usage:",
35519         "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",
35520         "type": "json"
35521       }
35522     ],
35523     "name": "notify",
35524     "group": "Whatsapp_Accounts",
35525     "description": "<p>Motion 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>",
35526     "version": "0.0.0",
35527     "filename": "server/api/whatsappAccount/index.js",
35528     "groupTitle": "Whatsapp_Accounts"
35529   },
35530   {
35531     "type": "put",
35532     "url": "/api/whatsapp/messages/{id}/reject",
35533     "title": "Rejects message",
35534     "examples": [
35535       {
35536         "title": "Example usage:",
35537         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
35538         "type": "json"
35539       }
35540     ],
35541     "name": "rejectMessage",
35542     "group": "Whatsapp_Accounts",
35543     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35544     "version": "0.0.0",
35545     "filename": "server/api/whatsappMessage/index.js",
35546     "groupTitle": "Whatsapp_Accounts"
35547   },
35548   {
35549     "type": "post",
35550     "url": "/api/whatsapp/accounts/{id}/send",
35551     "title": "Send new whatsapp message",
35552     "examples": [
35553       {
35554         "title": "Example usage:",
35555         "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",
35556         "type": "json"
35557       }
35558     ],
35559     "name": "sendWhatsapp",
35560     "group": "Whatsapp_Accounts",
35561     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35562     "version": "0.0.0",
35563     "filename": "server/api/whatsappAccount/index.js",
35564     "groupTitle": "Whatsapp_Accounts"
35565   },
35566   {
35567     "type": "post",
35568     "url": "/api/whatsapp/messages/{id}/status",
35569     "title": "Receive message status",
35570     "examples": [
35571       {
35572         "title": "Example usage:",
35573         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
35574         "type": "json"
35575       }
35576     ],
35577     "name": "statusMessage",
35578     "group": "Whatsapp_Accounts",
35579     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35580     "version": "0.0.0",
35581     "filename": "server/api/whatsappMessage/index.js",
35582     "groupTitle": "Whatsapp_Accounts"
35583   },
35584   {
35585     "type": "put",
35586     "url": "/api/whatsapp/accounts/{id}",
35587     "title": "Update an existing Account",
35588     "examples": [
35589       {
35590         "title": "Example usage:",
35591         "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",
35592         "type": "json"
35593       }
35594     ],
35595     "name": "updateAccounts",
35596     "group": "Whatsapp_Accounts",
35597     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35598     "version": "0.0.0",
35599     "filename": "server/api/whatsappAccount/index.js",
35600     "groupTitle": "Whatsapp_Accounts"
35601   },
35602   {
35603     "type": "post",
35604     "url": "/api/whatsapp/applications",
35605     "title": "Creates a new Application",
35606     "examples": [
35607       {
35608         "title": "Example usage:",
35609         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35610         "type": "json"
35611       }
35612     ],
35613     "name": "CreateApplications",
35614     "group": "Whatsapp_Applications",
35615     "parameter": {
35616       "fields": {
35617         "Body": [
35618           {
35619             "group": "Body",
35620             "type": "Integer",
35621             "optional": false,
35622             "field": "priority",
35623             "description": ""
35624           },
35625           {
35626             "group": "Body",
35627             "type": "String",
35628             "optional": false,
35629             "field": "app",
35630             "description": ""
35631           },
35632           {
35633             "group": "Body",
35634             "type": "Text",
35635             "optional": true,
35636             "field": "appdata",
35637             "description": ""
35638           },
35639           {
35640             "group": "Body",
35641             "type": "String",
35642             "optional": true,
35643             "field": "description",
35644             "description": ""
35645           },
35646           {
35647             "group": "Body",
35648             "type": "String",
35649             "optional": true,
35650             "field": "interval",
35651             "description": ""
35652           }
35653         ]
35654       }
35655     },
35656     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35657     "version": "0.0.0",
35658     "filename": "server/api/whatsappApplication/index.js",
35659     "groupTitle": "Whatsapp_Applications"
35660   },
35661   {
35662     "type": "delete",
35663     "url": "/api/whatsapp/applications/{id}",
35664     "title": "Deletes a Application",
35665     "examples": [
35666       {
35667         "title": "Example usage:",
35668         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
35669         "type": "json"
35670       }
35671     ],
35672     "name": "DeleteApplications",
35673     "group": "Whatsapp_Applications",
35674     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35675     "version": "0.0.0",
35676     "filename": "server/api/whatsappApplication/index.js",
35677     "groupTitle": "Whatsapp_Applications"
35678   },
35679   {
35680     "type": "get",
35681     "url": "/api/whatsapp/applications",
35682     "title": "Gets a list of Applications",
35683     "examples": [
35684       {
35685         "title": "Example usage:",
35686         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
35687         "type": "json"
35688       }
35689     ],
35690     "name": "GetApplications",
35691     "group": "Whatsapp_Applications",
35692     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35693     "version": "0.0.0",
35694     "filename": "server/api/whatsappApplication/index.js",
35695     "groupTitle": "Whatsapp_Applications"
35696   },
35697   {
35698     "type": "get",
35699     "url": "/api/whatsapp/applications/{id}",
35700     "title": "Gets a single Application",
35701     "examples": [
35702       {
35703         "title": "Example usage:",
35704         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
35705         "type": "json"
35706       }
35707     ],
35708     "name": "ShowApplications",
35709     "group": "Whatsapp_Applications",
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/whatsappApplication/index.js",
35713     "groupTitle": "Whatsapp_Applications"
35714   },
35715   {
35716     "type": "put",
35717     "url": "/api/whatsapp/applications/{id}",
35718     "title": "Update an existing Application",
35719     "examples": [
35720       {
35721         "title": "Example usage:",
35722         "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",
35723         "type": "json"
35724       }
35725     ],
35726     "name": "updateApplications",
35727     "group": "Whatsapp_Applications",
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/whatsappApplication/index.js",
35731     "groupTitle": "Whatsapp_Applications"
35732   },
35733   {
35734     "type": "post",
35735     "url": "/api/whatsapp/interactions/{id}/tags",
35736     "title": "Add tags to the interaction",
35737     "examples": [
35738       {
35739         "title": "Example usage:",
35740         "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",
35741         "type": "json"
35742       }
35743     ],
35744     "name": "AddTags",
35745     "group": "Whatsapp_Interactions",
35746     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35747     "version": "0.0.0",
35748     "filename": "server/api/whatsappInteraction/index.js",
35749     "groupTitle": "Whatsapp_Interactions"
35750   },
35751   {
35752     "type": "post",
35753     "url": "/api/whatsapp/interactions",
35754     "title": "Creates a new Interaction",
35755     "examples": [
35756       {
35757         "title": "Example usage:",
35758         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35759         "type": "json"
35760       }
35761     ],
35762     "name": "CreateInteractions",
35763     "group": "Whatsapp_Interactions",
35764     "parameter": {
35765       "fields": {
35766         "Body": [
35767           {
35768             "group": "Body",
35769             "type": "Boolean",
35770             "optional": true,
35771             "field": "closed",
35772             "description": ""
35773           },
35774           {
35775             "group": "Body",
35776             "type": "String",
35777             "optional": true,
35778             "field": "closedAt",
35779             "description": ""
35780           },
35781           {
35782             "group": "Body",
35783             "type": "String",
35784             "optional": true,
35785             "field": "disposition",
35786             "description": ""
35787           },
35788           {
35789             "group": "Body",
35790             "type": "String",
35791             "optional": true,
35792             "field": "secondDisposition",
35793             "description": ""
35794           },
35795           {
35796             "group": "Body",
35797             "type": "String",
35798             "optional": true,
35799             "field": "thirdDisposition",
35800             "description": ""
35801           },
35802           {
35803             "group": "Body",
35804             "type": "String",
35805             "optional": true,
35806             "field": "note",
35807             "description": ""
35808           },
35809           {
35810             "group": "Body",
35811             "type": "String",
35812             "optional": true,
35813             "field": "phone",
35814             "description": ""
35815           },
35816           {
35817             "group": "Body",
35818             "type": "String",
35819             "optional": true,
35820             "field": "read1stAt",
35821             "description": ""
35822           },
35823           {
35824             "group": "Body",
35825             "type": "String",
35826             "allowedValues": [
35827               "\"in\"",
35828               "\"out\""
35829             ],
35830             "optional": false,
35831             "field": "firstMsgDirection",
35832             "description": ""
35833           },
35834           {
35835             "group": "Body",
35836             "type": "String",
35837             "optional": true,
35838             "field": "lastMsgAt",
35839             "description": ""
35840           },
35841           {
35842             "group": "Body",
35843             "type": "String",
35844             "allowedValues": [
35845               "\"in\"",
35846               "\"out\""
35847             ],
35848             "optional": false,
35849             "field": "lastMsgDirection",
35850             "description": ""
35851           }
35852         ]
35853       }
35854     },
35855     "description": "<p>Motion will return a HTTP status code <code>201</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/whatsappInteraction/index.js",
35858     "groupTitle": "Whatsapp_Interactions"
35859   },
35860   {
35861     "type": "delete",
35862     "url": "/api/whatsapp/interactions/{id}",
35863     "title": "Deletes a Interaction",
35864     "examples": [
35865       {
35866         "title": "Example usage:",
35867         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
35868         "type": "json"
35869       }
35870     ],
35871     "name": "DeleteInteractions",
35872     "group": "Whatsapp_Interactions",
35873     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35874     "version": "0.0.0",
35875     "filename": "server/api/whatsappInteraction/index.js",
35876     "groupTitle": "Whatsapp_Interactions"
35877   },
35878   {
35879     "type": "get",
35880     "url": "/api/whatsapp/interactions/describe",
35881     "title": "Gets table info about Interactions",
35882     "examples": [
35883       {
35884         "title": "Example usage:",
35885         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
35886         "type": "json"
35887       }
35888     ],
35889     "name": "DescribeInteractions",
35890     "group": "Whatsapp_Interactions",
35891     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35892     "version": "0.0.0",
35893     "filename": "server/api/whatsappInteraction/index.js",
35894     "groupTitle": "Whatsapp_Interactions"
35895   },
35896   {
35897     "type": "get",
35898     "url": "/api/whatsapp/interactions",
35899     "title": "Gets a list of Interactions",
35900     "examples": [
35901       {
35902         "title": "Example usage:",
35903         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35904         "type": "json"
35905       }
35906     ],
35907     "name": "GetInteractions",
35908     "group": "Whatsapp_Interactions",
35909     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35910     "version": "0.0.0",
35911     "filename": "server/api/whatsappInteraction/index.js",
35912     "groupTitle": "Whatsapp_Interactions"
35913   },
35914   {
35915     "type": "delete",
35916     "url": "/api/whatsapp/interactions/{id}/tags",
35917     "title": "Removes tags from interaction",
35918     "examples": [
35919       {
35920         "title": "Example usage:",
35921         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35922         "type": "json"
35923       }
35924     ],
35925     "name": "RemoveTags",
35926     "group": "Whatsapp_Interactions",
35927     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35928     "version": "0.0.0",
35929     "filename": "server/api/whatsappInteraction/index.js",
35930     "groupTitle": "Whatsapp_Interactions"
35931   },
35932   {
35933     "type": "get",
35934     "url": "/api/whatsapp/interactions/{id}",
35935     "title": "Gets a single Interaction",
35936     "examples": [
35937       {
35938         "title": "Example usage:",
35939         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35940         "type": "json"
35941       }
35942     ],
35943     "name": "ShowInteractions",
35944     "group": "Whatsapp_Interactions",
35945     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35946     "version": "0.0.0",
35947     "filename": "server/api/whatsappInteraction/index.js",
35948     "groupTitle": "Whatsapp_Interactions"
35949   },
35950   {
35951     "type": "post",
35952     "url": "/api/whatsapp/interactions/{id}/messages",
35953     "title": "Creates new messages",
35954     "examples": [
35955       {
35956         "title": "Example usage:",
35957         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35958         "type": "json"
35959       }
35960     ],
35961     "name": "addMessage",
35962     "group": "Whatsapp_Interactions",
35963     "parameter": {
35964       "fields": {
35965         "Body": [
35966           {
35967             "group": "Body",
35968             "type": "Text",
35969             "optional": false,
35970             "field": "body",
35971             "description": ""
35972           },
35973           {
35974             "group": "Body",
35975             "type": "Boolean",
35976             "optional": true,
35977             "field": "read",
35978             "description": ""
35979           },
35980           {
35981             "group": "Body",
35982             "type": "String",
35983             "allowedValues": [
35984               "\"in\"",
35985               "\"out\""
35986             ],
35987             "optional": false,
35988             "field": "direction",
35989             "description": ""
35990           },
35991           {
35992             "group": "Body",
35993             "type": "String",
35994             "optional": true,
35995             "field": "messageId",
35996             "description": ""
35997           },
35998           {
35999             "group": "Body",
36000             "type": "String",
36001             "optional": true,
36002             "field": "phone",
36003             "description": ""
36004           },
36005           {
36006             "group": "Body",
36007             "type": "String",
36008             "optional": true,
36009             "field": "readAt",
36010             "description": ""
36011           },
36012           {
36013             "group": "Body",
36014             "type": "Boolean",
36015             "optional": true,
36016             "field": "secret",
36017             "description": ""
36018           },
36019           {
36020             "group": "Body",
36021             "type": "String",
36022             "optional": true,
36023             "field": "providerName",
36024             "description": ""
36025           },
36026           {
36027             "group": "Body",
36028             "type": "Text",
36029             "optional": true,
36030             "field": "providerResponse",
36031             "description": ""
36032           }
36033         ]
36034       }
36035     },
36036     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36037     "version": "0.0.0",
36038     "filename": "server/api/whatsappInteraction/index.js",
36039     "groupTitle": "Whatsapp_Interactions"
36040   },
36041   {
36042     "type": "get",
36043     "url": "/api/whatsapp/interactions/{id}/download",
36044     "title": "Gets interaction",
36045     "examples": [
36046       {
36047         "title": "Example usage:",
36048         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
36049         "type": "json"
36050       }
36051     ],
36052     "name": "download",
36053     "group": "Whatsapp_Interactions",
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/whatsappInteraction/index.js",
36057     "groupTitle": "Whatsapp_Interactions"
36058   },
36059   {
36060     "type": "get",
36061     "url": "/api/whatsapp/interactions/{id}/messages",
36062     "title": "Gets interaction messages",
36063     "examples": [
36064       {
36065         "title": "Example usage:",
36066         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
36067         "type": "json"
36068       }
36069     ],
36070     "name": "getMessages",
36071     "group": "Whatsapp_Interactions",
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/whatsappInteraction/index.js",
36075     "groupTitle": "Whatsapp_Interactions"
36076   },
36077   {
36078     "type": "put",
36079     "url": "/api/whatsapp/interactions/{id}",
36080     "title": "Update an existing Interaction",
36081     "examples": [
36082       {
36083         "title": "Example usage:",
36084         "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",
36085         "type": "json"
36086       }
36087     ],
36088     "name": "updateInteractions",
36089     "group": "Whatsapp_Interactions",
36090     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36091     "version": "0.0.0",
36092     "filename": "server/api/whatsappInteraction/index.js",
36093     "groupTitle": "Whatsapp_Interactions"
36094   },
36095   {
36096     "type": "post",
36097     "url": "/api/whatsapp/messages",
36098     "title": "Creates a new Message",
36099     "examples": [
36100       {
36101         "title": "Example usage:",
36102         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36103         "type": "json"
36104       }
36105     ],
36106     "name": "CreateMessages",
36107     "group": "Whatsapp_Messages",
36108     "parameter": {
36109       "fields": {
36110         "Body": [
36111           {
36112             "group": "Body",
36113             "type": "Text",
36114             "optional": false,
36115             "field": "body",
36116             "description": ""
36117           },
36118           {
36119             "group": "Body",
36120             "type": "Boolean",
36121             "optional": true,
36122             "field": "read",
36123             "description": ""
36124           },
36125           {
36126             "group": "Body",
36127             "type": "String",
36128             "allowedValues": [
36129               "\"in\"",
36130               "\"out\""
36131             ],
36132             "optional": false,
36133             "field": "direction",
36134             "description": ""
36135           },
36136           {
36137             "group": "Body",
36138             "type": "String",
36139             "optional": true,
36140             "field": "messageId",
36141             "description": ""
36142           },
36143           {
36144             "group": "Body",
36145             "type": "String",
36146             "optional": true,
36147             "field": "phone",
36148             "description": ""
36149           },
36150           {
36151             "group": "Body",
36152             "type": "String",
36153             "optional": true,
36154             "field": "readAt",
36155             "description": ""
36156           },
36157           {
36158             "group": "Body",
36159             "type": "Boolean",
36160             "optional": true,
36161             "field": "secret",
36162             "description": ""
36163           },
36164           {
36165             "group": "Body",
36166             "type": "String",
36167             "optional": true,
36168             "field": "providerName",
36169             "description": ""
36170           },
36171           {
36172             "group": "Body",
36173             "type": "Text",
36174             "optional": true,
36175             "field": "providerResponse",
36176             "description": ""
36177           }
36178         ]
36179       }
36180     },
36181     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36182     "version": "0.0.0",
36183     "filename": "server/api/whatsappMessage/index.js",
36184     "groupTitle": "Whatsapp_Messages"
36185   },
36186   {
36187     "type": "delete",
36188     "url": "/api/whatsapp/messages/{id}",
36189     "title": "Deletes a Message",
36190     "examples": [
36191       {
36192         "title": "Example usage:",
36193         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
36194         "type": "json"
36195       }
36196     ],
36197     "name": "DeleteMessages",
36198     "group": "Whatsapp_Messages",
36199     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36200     "version": "0.0.0",
36201     "filename": "server/api/whatsappMessage/index.js",
36202     "groupTitle": "Whatsapp_Messages"
36203   },
36204   {
36205     "type": "get",
36206     "url": "/api/whatsapp/messages/describe",
36207     "title": "Gets table info about Messages",
36208     "examples": [
36209       {
36210         "title": "Example usage:",
36211         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
36212         "type": "json"
36213       }
36214     ],
36215     "name": "DescribeMessages",
36216     "group": "Whatsapp_Messages",
36217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36218     "version": "0.0.0",
36219     "filename": "server/api/whatsappMessage/index.js",
36220     "groupTitle": "Whatsapp_Messages"
36221   },
36222   {
36223     "type": "get",
36224     "url": "/api/whatsapp/messages",
36225     "title": "Gets a list of Messages",
36226     "examples": [
36227       {
36228         "title": "Example usage:",
36229         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
36230         "type": "json"
36231       }
36232     ],
36233     "name": "GetMessages",
36234     "group": "Whatsapp_Messages",
36235     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36236     "version": "0.0.0",
36237     "filename": "server/api/whatsappMessage/index.js",
36238     "groupTitle": "Whatsapp_Messages"
36239   },
36240   {
36241     "type": "get",
36242     "url": "/api/whatsapp/messages/{id}",
36243     "title": "Gets a single Message",
36244     "examples": [
36245       {
36246         "title": "Example usage:",
36247         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
36248         "type": "json"
36249       }
36250     ],
36251     "name": "ShowMessages",
36252     "group": "Whatsapp_Messages",
36253     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36254     "version": "0.0.0",
36255     "filename": "server/api/whatsappMessage/index.js",
36256     "groupTitle": "Whatsapp_Messages"
36257   },
36258   {
36259     "type": "put",
36260     "url": "/api/whatsapp/messages/{id}",
36261     "title": "Update an existing Message",
36262     "examples": [
36263       {
36264         "title": "Example usage:",
36265         "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",
36266         "type": "json"
36267       }
36268     ],
36269     "name": "updateMessages",
36270     "group": "Whatsapp_Messages",
36271     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36272     "version": "0.0.0",
36273     "filename": "server/api/whatsappMessage/index.js",
36274     "groupTitle": "Whatsapp_Messages"
36275   },
36276   {
36277     "type": "post",
36278     "url": "/api/whatsapp/reports/queue",
36279     "title": "Creates a new Whatsapp Queue Report",
36280     "examples": [
36281       {
36282         "title": "Example usage:",
36283         "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",
36284         "type": "json"
36285       }
36286     ],
36287     "name": "CreateWhatsapp_Queue_Reports",
36288     "group": "Whatsapp_Queue_Reports",
36289     "parameter": {
36290       "fields": {
36291         "Body": [
36292           {
36293             "group": "Body",
36294             "type": "String",
36295             "optional": false,
36296             "field": "uniqueid",
36297             "description": ""
36298           },
36299           {
36300             "group": "Body",
36301             "type": "String",
36302             "optional": true,
36303             "field": "from",
36304             "description": ""
36305           },
36306           {
36307             "group": "Body",
36308             "type": "String",
36309             "optional": true,
36310             "field": "joinAt",
36311             "description": ""
36312           },
36313           {
36314             "group": "Body",
36315             "type": "String",
36316             "optional": true,
36317             "field": "leaveAt",
36318             "description": ""
36319           },
36320           {
36321             "group": "Body",
36322             "type": "String",
36323             "optional": true,
36324             "field": "acceptAt",
36325             "description": ""
36326           },
36327           {
36328             "group": "Body",
36329             "type": "String",
36330             "optional": true,
36331             "field": "exitAt",
36332             "description": ""
36333           },
36334           {
36335             "group": "Body",
36336             "type": "String",
36337             "optional": true,
36338             "field": "reason",
36339             "description": ""
36340           }
36341         ]
36342       }
36343     },
36344     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36345     "version": "0.0.0",
36346     "filename": "server/api/whatsappQueueReport/index.js",
36347     "groupTitle": "Whatsapp_Queue_Reports"
36348   },
36349   {
36350     "type": "delete",
36351     "url": "/api/whatsapp/reports/queue/{id}",
36352     "title": "Deletes a Whatsapp Queue Report",
36353     "examples": [
36354       {
36355         "title": "Example usage:",
36356         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
36357         "type": "json"
36358       }
36359     ],
36360     "name": "DeleteWhatsapp_Queue_Reports",
36361     "group": "Whatsapp_Queue_Reports",
36362     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36363     "version": "0.0.0",
36364     "filename": "server/api/whatsappQueueReport/index.js",
36365     "groupTitle": "Whatsapp_Queue_Reports"
36366   },
36367   {
36368     "type": "get",
36369     "url": "/api/whatsapp/reports/queue/describe",
36370     "title": "Gets table info about Whatsapp Queue Reports",
36371     "examples": [
36372       {
36373         "title": "Example usage:",
36374         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
36375         "type": "json"
36376       }
36377     ],
36378     "name": "DescribeWhatsapp_Queue_Reports",
36379     "group": "Whatsapp_Queue_Reports",
36380     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36381     "version": "0.0.0",
36382     "filename": "server/api/whatsappQueueReport/index.js",
36383     "groupTitle": "Whatsapp_Queue_Reports"
36384   },
36385   {
36386     "type": "get",
36387     "url": "/api/whatsapp/reports/queue",
36388     "title": "Gets a list of Whatsapp Queue Reports",
36389     "examples": [
36390       {
36391         "title": "Example usage:",
36392         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
36393         "type": "json"
36394       }
36395     ],
36396     "name": "GetWhatsapp_Queue_Reports",
36397     "group": "Whatsapp_Queue_Reports",
36398     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36399     "version": "0.0.0",
36400     "filename": "server/api/whatsappQueueReport/index.js",
36401     "groupTitle": "Whatsapp_Queue_Reports"
36402   },
36403   {
36404     "type": "get",
36405     "url": "/api/whatsapp/reports/queue/{id}",
36406     "title": "Gets a single Whatsapp Queue Report",
36407     "examples": [
36408       {
36409         "title": "Example usage:",
36410         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
36411         "type": "json"
36412       }
36413     ],
36414     "name": "ShowWhatsapp_Queue_Reports",
36415     "group": "Whatsapp_Queue_Reports",
36416     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36417     "version": "0.0.0",
36418     "filename": "server/api/whatsappQueueReport/index.js",
36419     "groupTitle": "Whatsapp_Queue_Reports"
36420   },
36421   {
36422     "type": "put",
36423     "url": "/api/whatsapp/reports/queue/{id}",
36424     "title": "Update an existing Whatsapp Queue Report",
36425     "examples": [
36426       {
36427         "title": "Example usage:",
36428         "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",
36429         "type": "json"
36430       }
36431     ],
36432     "name": "updateWhatsapp_Queue_Reports",
36433     "group": "Whatsapp_Queue_Reports",
36434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36435     "version": "0.0.0",
36436     "filename": "server/api/whatsappQueueReport/index.js",
36437     "groupTitle": "Whatsapp_Queue_Reports"
36438   },
36439   {
36440     "type": "post",
36441     "url": "/api/whatsapp/queues/{id}/users",
36442     "title": "Add agents to a queue",
36443     "examples": [
36444       {
36445         "title": "Example usage:",
36446         "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",
36447         "type": "json"
36448       }
36449     ],
36450     "name": "AddAgents",
36451     "group": "Whatsapp_Queues",
36452     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36453     "version": "0.0.0",
36454     "filename": "server/api/whatsappQueue/index.js",
36455     "groupTitle": "Whatsapp_Queues"
36456   },
36457   {
36458     "type": "post",
36459     "url": "/api/whatsapp/queues/{id}/teams",
36460     "title": "Add teams to a queue",
36461     "examples": [
36462       {
36463         "title": "Example usage:",
36464         "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",
36465         "type": "json"
36466       }
36467     ],
36468     "name": "AddTeams",
36469     "group": "Whatsapp_Queues",
36470     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36471     "version": "0.0.0",
36472     "filename": "server/api/whatsappQueue/index.js",
36473     "groupTitle": "Whatsapp_Queues"
36474   },
36475   {
36476     "type": "post",
36477     "url": "/api/whatsapp/queues",
36478     "title": "Creates a new Queue",
36479     "examples": [
36480       {
36481         "title": "Example usage:",
36482         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
36483         "type": "json"
36484       }
36485     ],
36486     "name": "CreateQueues",
36487     "group": "Whatsapp_Queues",
36488     "parameter": {
36489       "fields": {
36490         "Body": [
36491           {
36492             "group": "Body",
36493             "type": "String",
36494             "optional": true,
36495             "field": "name",
36496             "description": ""
36497           },
36498           {
36499             "group": "Body",
36500             "type": "Integer",
36501             "optional": true,
36502             "field": "timeout",
36503             "description": ""
36504           },
36505           {
36506             "group": "Body",
36507             "type": "String",
36508             "allowedValues": [
36509               "\"rrmemory\"",
36510               "\"beepall\"",
36511               "\"roundrobin\""
36512             ],
36513             "optional": true,
36514             "field": "strategy",
36515             "description": ""
36516           },
36517           {
36518             "group": "Body",
36519             "type": "String",
36520             "optional": true,
36521             "field": "description",
36522             "description": ""
36523           }
36524         ]
36525       }
36526     },
36527     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36528     "version": "0.0.0",
36529     "filename": "server/api/whatsappQueue/index.js",
36530     "groupTitle": "Whatsapp_Queues"
36531   },
36532   {
36533     "type": "delete",
36534     "url": "/api/whatsapp/queues/{id}",
36535     "title": "Deletes a Queue",
36536     "examples": [
36537       {
36538         "title": "Example usage:",
36539         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
36540         "type": "json"
36541       }
36542     ],
36543     "name": "DeleteQueues",
36544     "group": "Whatsapp_Queues",
36545     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36546     "version": "0.0.0",
36547     "filename": "server/api/whatsappQueue/index.js",
36548     "groupTitle": "Whatsapp_Queues"
36549   },
36550   {
36551     "type": "get",
36552     "url": "/api/whatsapp/queues/describe",
36553     "title": "Gets table info about Queues",
36554     "examples": [
36555       {
36556         "title": "Example usage:",
36557         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
36558         "type": "json"
36559       }
36560     ],
36561     "name": "DescribeQueues",
36562     "group": "Whatsapp_Queues",
36563     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36564     "version": "0.0.0",
36565     "filename": "server/api/whatsappQueue/index.js",
36566     "groupTitle": "Whatsapp_Queues"
36567   },
36568   {
36569     "type": "get",
36570     "url": "/api/whatsapp/queues/{id}/users",
36571     "title": "Gets queue agents",
36572     "examples": [
36573       {
36574         "title": "Example usage:",
36575         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
36576         "type": "json"
36577       }
36578     ],
36579     "name": "GetAgents",
36580     "group": "Whatsapp_Queues",
36581     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36582     "version": "0.0.0",
36583     "filename": "server/api/whatsappQueue/index.js",
36584     "groupTitle": "Whatsapp_Queues"
36585   },
36586   {
36587     "type": "get",
36588     "url": "/api/whatsapp/queues/{id}/members",
36589     "title": "GetMembers",
36590     "examples": [
36591       {
36592         "title": "Example usage:",
36593         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
36594         "type": "json"
36595       }
36596     ],
36597     "name": "GetMembers",
36598     "group": "Whatsapp_Queues",
36599     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36600     "version": "0.0.0",
36601     "filename": "server/api/whatsappQueue/index.js",
36602     "groupTitle": "Whatsapp_Queues"
36603   },
36604   {
36605     "type": "get",
36606     "url": "/api/whatsapp/queues",
36607     "title": "Gets a list of Queues",
36608     "examples": [
36609       {
36610         "title": "Example usage:",
36611         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
36612         "type": "json"
36613       }
36614     ],
36615     "name": "GetQueues",
36616     "group": "Whatsapp_Queues",
36617     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36618     "version": "0.0.0",
36619     "filename": "server/api/whatsappQueue/index.js",
36620     "groupTitle": "Whatsapp_Queues"
36621   },
36622   {
36623     "type": "get",
36624     "url": "/api/whatsapp/queues/{id}/teams",
36625     "title": "Gets queues list",
36626     "examples": [
36627       {
36628         "title": "Example usage:",
36629         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
36630         "type": "json"
36631       }
36632     ],
36633     "name": "GetTeams",
36634     "group": "Whatsapp_Queues",
36635     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36636     "version": "0.0.0",
36637     "filename": "server/api/whatsappQueue/index.js",
36638     "groupTitle": "Whatsapp_Queues"
36639   },
36640   {
36641     "type": "delete",
36642     "url": "/api/whatsapp/queues/{id}/users",
36643     "title": "Removes agents from a queue",
36644     "examples": [
36645       {
36646         "title": "Example usage:",
36647         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
36648         "type": "json"
36649       }
36650     ],
36651     "name": "RemoveAgents",
36652     "group": "Whatsapp_Queues",
36653     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36654     "version": "0.0.0",
36655     "filename": "server/api/whatsappQueue/index.js",
36656     "groupTitle": "Whatsapp_Queues"
36657   },
36658   {
36659     "type": "get",
36660     "url": "/api/whatsapp/queues/{id}",
36661     "title": "Gets a single Queue",
36662     "examples": [
36663       {
36664         "title": "Example usage:",
36665         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
36666         "type": "json"
36667       }
36668     ],
36669     "name": "ShowQueues",
36670     "group": "Whatsapp_Queues",
36671     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36672     "version": "0.0.0",
36673     "filename": "server/api/whatsappQueue/index.js",
36674     "groupTitle": "Whatsapp_Queues"
36675   },
36676   {
36677     "type": "put",
36678     "url": "/api/whatsapp/queues/{id}",
36679     "title": "Update an existing Queue",
36680     "examples": [
36681       {
36682         "title": "Example usage:",
36683         "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",
36684         "type": "json"
36685       }
36686     ],
36687     "name": "updateQueues",
36688     "group": "Whatsapp_Queues",
36689     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36690     "version": "0.0.0",
36691     "filename": "server/api/whatsappQueue/index.js",
36692     "groupTitle": "Whatsapp_Queues"
36693   },
36694   {
36695     "type": "post",
36696     "url": "/api/whatsapp/reports/transfer",
36697     "title": "Creates a new Whatsapp Transfer Report",
36698     "examples": [
36699       {
36700         "title": "Example usage:",
36701         "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",
36702         "type": "json"
36703       }
36704     ],
36705     "name": "CreateWhatsapp_Transfer_Reports",
36706     "group": "Whatsapp_Transfer_Reports",
36707     "parameter": {
36708       "fields": {
36709         "Body": [
36710           {
36711             "group": "Body",
36712             "type": "String",
36713             "optional": false,
36714             "field": "uniqueid",
36715             "description": ""
36716           },
36717           {
36718             "group": "Body",
36719             "type": "String",
36720             "allowedValues": [
36721               "\"account\"",
36722               "\"agent\"",
36723               "\"queue\""
36724             ],
36725             "optional": false,
36726             "field": "type",
36727             "description": ""
36728           },
36729           {
36730             "group": "Body",
36731             "type": "String",
36732             "optional": true,
36733             "field": "transferredAt",
36734             "description": ""
36735           }
36736         ]
36737       }
36738     },
36739     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36740     "version": "0.0.0",
36741     "filename": "server/api/whatsappTransferReport/index.js",
36742     "groupTitle": "Whatsapp_Transfer_Reports"
36743   },
36744   {
36745     "type": "delete",
36746     "url": "/api/whatsapp/reports/transfer/{id}",
36747     "title": "Deletes a Whatsapp Transfer Report",
36748     "examples": [
36749       {
36750         "title": "Example usage:",
36751         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
36752         "type": "json"
36753       }
36754     ],
36755     "name": "DeleteWhatsapp_Transfer_Reports",
36756     "group": "Whatsapp_Transfer_Reports",
36757     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36758     "version": "0.0.0",
36759     "filename": "server/api/whatsappTransferReport/index.js",
36760     "groupTitle": "Whatsapp_Transfer_Reports"
36761   },
36762   {
36763     "type": "get",
36764     "url": "/api/whatsapp/reports/transfer/describe",
36765     "title": "Gets table info about Whatsapp Transfer Reports",
36766     "examples": [
36767       {
36768         "title": "Example usage:",
36769         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
36770         "type": "json"
36771       }
36772     ],
36773     "name": "DescribeWhatsapp_Transfer_Reports",
36774     "group": "Whatsapp_Transfer_Reports",
36775     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36776     "version": "0.0.0",
36777     "filename": "server/api/whatsappTransferReport/index.js",
36778     "groupTitle": "Whatsapp_Transfer_Reports"
36779   },
36780   {
36781     "type": "get",
36782     "url": "/api/whatsapp/reports/transfer",
36783     "title": "Gets a list of Whatsapp Transfer Reports",
36784     "examples": [
36785       {
36786         "title": "Example usage:",
36787         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
36788         "type": "json"
36789       }
36790     ],
36791     "name": "GetWhatsapp_Transfer_Reports",
36792     "group": "Whatsapp_Transfer_Reports",
36793     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36794     "version": "0.0.0",
36795     "filename": "server/api/whatsappTransferReport/index.js",
36796     "groupTitle": "Whatsapp_Transfer_Reports"
36797   },
36798   {
36799     "type": "get",
36800     "url": "/api/whatsapp/reports/transfer/{id}",
36801     "title": "Gets a single Whatsapp Transfer Report",
36802     "examples": [
36803       {
36804         "title": "Example usage:",
36805         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
36806         "type": "json"
36807       }
36808     ],
36809     "name": "ShowWhatsapp_Transfer_Reports",
36810     "group": "Whatsapp_Transfer_Reports",
36811     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36812     "version": "0.0.0",
36813     "filename": "server/api/whatsappTransferReport/index.js",
36814     "groupTitle": "Whatsapp_Transfer_Reports"
36815   },
36816   {
36817     "type": "put",
36818     "url": "/api/whatsapp/reports/transfer/{id}",
36819     "title": "Update an existing Whatsapp Transfer Report",
36820     "examples": [
36821       {
36822         "title": "Example usage:",
36823         "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",
36824         "type": "json"
36825       }
36826     ],
36827     "name": "updateWhatsapp_Transfer_Reports",
36828     "group": "Whatsapp_Transfer_Reports",
36829     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36830     "version": "0.0.0",
36831     "filename": "server/api/whatsappTransferReport/index.js",
36832     "groupTitle": "Whatsapp_Transfer_Reports"
36833   },
36834   {
36835     "type": "post",
36836     "url": "/api/integrations/zendesk/accounts",
36837     "title": "Creates a new Zendesk Account",
36838     "examples": [
36839       {
36840         "title": "Example usage:",
36841         "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",
36842         "type": "json"
36843       }
36844     ],
36845     "name": "CreateZendesk_Accounts",
36846     "group": "Zendesk_Accounts",
36847     "parameter": {
36848       "fields": {
36849         "Body": [
36850           {
36851             "group": "Body",
36852             "type": "String",
36853             "optional": true,
36854             "field": "name",
36855             "description": ""
36856           },
36857           {
36858             "group": "Body",
36859             "type": "String",
36860             "optional": true,
36861             "field": "description",
36862             "description": ""
36863           },
36864           {
36865             "group": "Body",
36866             "type": "String",
36867             "optional": true,
36868             "field": "username",
36869             "description": ""
36870           },
36871           {
36872             "group": "Body",
36873             "type": "String",
36874             "optional": true,
36875             "field": "password",
36876             "description": ""
36877           },
36878           {
36879             "group": "Body",
36880             "type": "String",
36881             "optional": true,
36882             "field": "token",
36883             "description": ""
36884           },
36885           {
36886             "group": "Body",
36887             "type": "String",
36888             "optional": true,
36889             "field": "remoteUri",
36890             "description": ""
36891           },
36892           {
36893             "group": "Body",
36894             "type": "String",
36895             "allowedValues": [
36896               "\"password\"",
36897               "\"token\""
36898             ],
36899             "optional": true,
36900             "field": "authType",
36901             "description": ""
36902           },
36903           {
36904             "group": "Body",
36905             "type": "String",
36906             "optional": false,
36907             "field": "serverUrl",
36908             "description": ""
36909           },
36910           {
36911             "group": "Body",
36912             "type": "String",
36913             "allowedValues": [
36914               "\"integrationTab\"",
36915               "\"newTab\""
36916             ],
36917             "optional": true,
36918             "field": "type",
36919             "description": ""
36920           }
36921         ]
36922       }
36923     },
36924     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36925     "version": "0.0.0",
36926     "filename": "server/api/intZendeskAccount/index.js",
36927     "groupTitle": "Zendesk_Accounts"
36928   },
36929   {
36930     "type": "delete",
36931     "url": "/api/integrations/zendesk/accounts/{id}",
36932     "title": "Deletes a Zendesk Account",
36933     "examples": [
36934       {
36935         "title": "Example usage:",
36936         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36937         "type": "json"
36938       }
36939     ],
36940     "name": "DeleteZendesk_Accounts",
36941     "group": "Zendesk_Accounts",
36942     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36943     "version": "0.0.0",
36944     "filename": "server/api/intZendeskAccount/index.js",
36945     "groupTitle": "Zendesk_Accounts"
36946   },
36947   {
36948     "type": "get",
36949     "url": "/api/integrations/zendesk/accounts",
36950     "title": "Gets a list of Zendesk Accounts",
36951     "examples": [
36952       {
36953         "title": "Example usage:",
36954         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36955         "type": "json"
36956       }
36957     ],
36958     "name": "GetZendesk_Accounts",
36959     "group": "Zendesk_Accounts",
36960     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36961     "version": "0.0.0",
36962     "filename": "server/api/intZendeskAccount/index.js",
36963     "groupTitle": "Zendesk_Accounts"
36964   },
36965   {
36966     "type": "get",
36967     "url": "/api/integrations/zendesk/accounts/{id}",
36968     "title": "Gets a single Zendesk Account",
36969     "examples": [
36970       {
36971         "title": "Example usage:",
36972         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36973         "type": "json"
36974       }
36975     ],
36976     "name": "ShowZendesk_Accounts",
36977     "group": "Zendesk_Accounts",
36978     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36979     "version": "0.0.0",
36980     "filename": "server/api/intZendeskAccount/index.js",
36981     "groupTitle": "Zendesk_Accounts"
36982   },
36983   {
36984     "type": "post",
36985     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36986     "title": "Creates new configuration",
36987     "examples": [
36988       {
36989         "title": "Example usage:",
36990         "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",
36991         "type": "json"
36992       }
36993     ],
36994     "name": "addConfiguration",
36995     "group": "Zendesk_Accounts",
36996     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36997     "version": "0.0.0",
36998     "filename": "server/api/intZendeskAccount/index.js",
36999     "groupTitle": "Zendesk_Accounts"
37000   },
37001   {
37002     "type": "get",
37003     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
37004     "title": "Gets account configurations",
37005     "examples": [
37006       {
37007         "title": "Example usage:",
37008         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37009         "type": "json"
37010       }
37011     ],
37012     "name": "getConfigurations",
37013     "group": "Zendesk_Accounts",
37014     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37015     "version": "0.0.0",
37016     "filename": "server/api/intZendeskAccount/index.js",
37017     "groupTitle": "Zendesk_Accounts"
37018   },
37019   {
37020     "type": "get",
37021     "url": "/api/integrations/zendesk/accounts/{id}/fields",
37022     "title": "Gets account fields",
37023     "examples": [
37024       {
37025         "title": "Example usage:",
37026         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
37027         "type": "json"
37028       }
37029     ],
37030     "name": "getFields",
37031     "group": "Zendesk_Accounts",
37032     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37033     "version": "0.0.0",
37034     "filename": "server/api/intZendeskAccount/index.js",
37035     "groupTitle": "Zendesk_Accounts"
37036   },
37037   {
37038     "type": "put",
37039     "url": "/api/integrations/zendesk/accounts/{id}",
37040     "title": "Update an existing Zendesk Account",
37041     "examples": [
37042       {
37043         "title": "Example usage:",
37044         "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",
37045         "type": "json"
37046       }
37047     ],
37048     "name": "updateZendesk_Accounts",
37049     "group": "Zendesk_Accounts",
37050     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37051     "version": "0.0.0",
37052     "filename": "server/api/intZendeskAccount/index.js",
37053     "groupTitle": "Zendesk_Accounts"
37054   },
37055   {
37056     "type": "post",
37057     "url": "/api/integrations/zendesk/configurations",
37058     "title": "Creates a new Zendesk Configuration",
37059     "examples": [
37060       {
37061         "title": "Example usage:",
37062         "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",
37063         "type": "json"
37064       }
37065     ],
37066     "name": "CreateZendesk_Configurations",
37067     "group": "Zendesk_Configurations",
37068     "parameter": {
37069       "fields": {
37070         "Body": [
37071           {
37072             "group": "Body",
37073             "type": "String",
37074             "optional": true,
37075             "field": "name",
37076             "description": ""
37077           },
37078           {
37079             "group": "Body",
37080             "type": "String",
37081             "optional": true,
37082             "field": "description",
37083             "description": ""
37084           }
37085         ]
37086       }
37087     },
37088     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37089     "version": "0.0.0",
37090     "filename": "server/api/intZendeskConfiguration/index.js",
37091     "groupTitle": "Zendesk_Configurations"
37092   },
37093   {
37094     "type": "delete",
37095     "url": "/api/integrations/zendesk/configurations/{id}",
37096     "title": "Deletes a Zendesk Configuration",
37097     "examples": [
37098       {
37099         "title": "Example usage:",
37100         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
37101         "type": "json"
37102       }
37103     ],
37104     "name": "DeleteZendesk_Configurations",
37105     "group": "Zendesk_Configurations",
37106     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37107     "version": "0.0.0",
37108     "filename": "server/api/intZendeskConfiguration/index.js",
37109     "groupTitle": "Zendesk_Configurations"
37110   },
37111   {
37112     "type": "get",
37113     "url": "/api/integrations/zendesk/configurations",
37114     "title": "Gets a list of Zendesk Configurations",
37115     "examples": [
37116       {
37117         "title": "Example usage:",
37118         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
37119         "type": "json"
37120       }
37121     ],
37122     "name": "GetZendesk_Configurations",
37123     "group": "Zendesk_Configurations",
37124     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37125     "version": "0.0.0",
37126     "filename": "server/api/intZendeskConfiguration/index.js",
37127     "groupTitle": "Zendesk_Configurations"
37128   },
37129   {
37130     "type": "get",
37131     "url": "/api/integrations/zendesk/configurations/{id}",
37132     "title": "Gets a single Zendesk Configuration",
37133     "examples": [
37134       {
37135         "title": "Example usage:",
37136         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
37137         "type": "json"
37138       }
37139     ],
37140     "name": "ShowZendesk_Configurations",
37141     "group": "Zendesk_Configurations",
37142     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37143     "version": "0.0.0",
37144     "filename": "server/api/intZendeskConfiguration/index.js",
37145     "groupTitle": "Zendesk_Configurations"
37146   },
37147   {
37148     "type": "get",
37149     "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
37150     "title": "Gets configurations descriptions",
37151     "examples": [
37152       {
37153         "title": "Example usage:",
37154         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37155         "type": "json"
37156       }
37157     ],
37158     "name": "getDescriptions",
37159     "group": "Zendesk_Configurations",
37160     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37161     "version": "0.0.0",
37162     "filename": "server/api/intZendeskConfiguration/index.js",
37163     "groupTitle": "Zendesk_Configurations"
37164   },
37165   {
37166     "type": "get",
37167     "url": "/api/integrations/zendesk/configurations/{id}/fields",
37168     "title": "Gets configurations fields",
37169     "examples": [
37170       {
37171         "title": "Example usage:",
37172         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
37173         "type": "json"
37174       }
37175     ],
37176     "name": "getFields",
37177     "group": "Zendesk_Configurations",
37178     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37179     "version": "0.0.0",
37180     "filename": "server/api/intZendeskConfiguration/index.js",
37181     "groupTitle": "Zendesk_Configurations"
37182   },
37183   {
37184     "type": "get",
37185     "url": "/api/integrations/zendesk/configurations/{id}/subjects",
37186     "title": "Gets configurations subjects",
37187     "examples": [
37188       {
37189         "title": "Example usage:",
37190         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37191         "type": "json"
37192       }
37193     ],
37194     "name": "getSubjects",
37195     "group": "Zendesk_Configurations",
37196     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37197     "version": "0.0.0",
37198     "filename": "server/api/intZendeskConfiguration/index.js",
37199     "groupTitle": "Zendesk_Configurations"
37200   },
37201   {
37202     "type": "get",
37203     "url": "/api/integrations/zendesk/configurations/{id}/tags",
37204     "title": "Gets configurations tags",
37205     "examples": [
37206       {
37207         "title": "Example usage:",
37208         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
37209         "type": "json"
37210       }
37211     ],
37212     "name": "getTags",
37213     "group": "Zendesk_Configurations",
37214     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37215     "version": "0.0.0",
37216     "filename": "server/api/intZendeskConfiguration/index.js",
37217     "groupTitle": "Zendesk_Configurations"
37218   },
37219   {
37220     "type": "post",
37221     "url": "/api/integrations/zendesk/configurations/{id}/tags",
37222     "title": "Sets new tags",
37223     "examples": [
37224       {
37225         "title": "Example usage:",
37226         "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",
37227         "type": "json"
37228       }
37229     ],
37230     "name": "setTags",
37231     "group": "Zendesk_Configurations",
37232     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37233     "version": "0.0.0",
37234     "filename": "server/api/intZendeskConfiguration/index.js",
37235     "groupTitle": "Zendesk_Configurations"
37236   },
37237   {
37238     "type": "put",
37239     "url": "/api/integrations/zendesk/configurations/{id}",
37240     "title": "Update an existing Zendesk Configuration",
37241     "examples": [
37242       {
37243         "title": "Example usage:",
37244         "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",
37245         "type": "json"
37246       }
37247     ],
37248     "name": "updateZendesk_Configurations",
37249     "group": "Zendesk_Configurations",
37250     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37251     "version": "0.0.0",
37252     "filename": "server/api/intZendeskConfiguration/index.js",
37253     "groupTitle": "Zendesk_Configurations"
37254   },
37255   {
37256     "type": "post",
37257     "url": "/api/integrations/zendesk/fields",
37258     "title": "Creates a new Zendesk Field",
37259     "examples": [
37260       {
37261         "title": "Example usage:",
37262         "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",
37263         "type": "json"
37264       }
37265     ],
37266     "name": "CreateZendesk_Fields",
37267     "group": "Zendesk_Fields",
37268     "parameter": {
37269       "fields": {
37270         "Body": [
37271           {
37272             "group": "Body",
37273             "type": "String",
37274             "allowedValues": [
37275               "\"string\"",
37276               "\"variable\"",
37277               "\"customVariable\"",
37278               "\"keyValue\"",
37279               "\"picklist\""
37280             ],
37281             "optional": true,
37282             "field": "type",
37283             "description": ""
37284           },
37285           {
37286             "group": "Body",
37287             "type": "String",
37288             "optional": true,
37289             "field": "content",
37290             "description": ""
37291           },
37292           {
37293             "group": "Body",
37294             "type": "String",
37295             "optional": true,
37296             "field": "key",
37297             "description": ""
37298           },
37299           {
37300             "group": "Body",
37301             "type": "String",
37302             "allowedValues": [
37303               "\"string\"",
37304               "\"variable\"",
37305               "\"customVariable\""
37306             ],
37307             "optional": true,
37308             "field": "keyType",
37309             "description": ""
37310           },
37311           {
37312             "group": "Body",
37313             "type": "String",
37314             "optional": true,
37315             "field": "keyContent",
37316             "description": ""
37317           },
37318           {
37319             "group": "Body",
37320             "type": "String",
37321             "optional": true,
37322             "field": "idField",
37323             "description": ""
37324           },
37325           {
37326             "group": "Body",
37327             "type": "String",
37328             "optional": true,
37329             "field": "nameField",
37330             "description": ""
37331           },
37332           {
37333             "group": "Body",
37334             "type": "Boolean",
37335             "optional": true,
37336             "field": "customField",
37337             "description": ""
37338           },
37339           {
37340             "group": "Body",
37341             "type": "String",
37342             "optional": true,
37343             "field": "variableName",
37344             "description": ""
37345           }
37346         ]
37347       }
37348     },
37349     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37350     "version": "0.0.0",
37351     "filename": "server/api/intZendeskField/index.js",
37352     "groupTitle": "Zendesk_Fields"
37353   },
37354   {
37355     "type": "delete",
37356     "url": "/api/integrations/zendesk/fields/{id}",
37357     "title": "Deletes a Zendesk Field",
37358     "examples": [
37359       {
37360         "title": "Example usage:",
37361         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
37362         "type": "json"
37363       }
37364     ],
37365     "name": "DeleteZendesk_Fields",
37366     "group": "Zendesk_Fields",
37367     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37368     "version": "0.0.0",
37369     "filename": "server/api/intZendeskField/index.js",
37370     "groupTitle": "Zendesk_Fields"
37371   },
37372   {
37373     "type": "get",
37374     "url": "/api/integrations/zendesk/fields",
37375     "title": "Gets a list of Zendesk Fields",
37376     "examples": [
37377       {
37378         "title": "Example usage:",
37379         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
37380         "type": "json"
37381       }
37382     ],
37383     "name": "GetZendesk_Fields",
37384     "group": "Zendesk_Fields",
37385     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37386     "version": "0.0.0",
37387     "filename": "server/api/intZendeskField/index.js",
37388     "groupTitle": "Zendesk_Fields"
37389   },
37390   {
37391     "type": "get",
37392     "url": "/api/integrations/zendesk/fields/{id}",
37393     "title": "Gets a single Zendesk Field",
37394     "examples": [
37395       {
37396         "title": "Example usage:",
37397         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
37398         "type": "json"
37399       }
37400     ],
37401     "name": "ShowZendesk_Fields",
37402     "group": "Zendesk_Fields",
37403     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37404     "version": "0.0.0",
37405     "filename": "server/api/intZendeskField/index.js",
37406     "groupTitle": "Zendesk_Fields"
37407   },
37408   {
37409     "type": "put",
37410     "url": "/api/integrations/zendesk/fields/{id}",
37411     "title": "Update an existing Zendesk Field",
37412     "examples": [
37413       {
37414         "title": "Example usage:",
37415         "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",
37416         "type": "json"
37417       }
37418     ],
37419     "name": "updateZendesk_Fields",
37420     "group": "Zendesk_Fields",
37421     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37422     "version": "0.0.0",
37423     "filename": "server/api/intZendeskField/index.js",
37424     "groupTitle": "Zendesk_Fields"
37425   },
37426   {
37427     "type": "post",
37428     "url": "/api/integrations/zoho/accounts",
37429     "title": "Creates a new Zoho Account",
37430     "examples": [
37431       {
37432         "title": "Example usage:",
37433         "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",
37434         "type": "json"
37435       }
37436     ],
37437     "name": "CreateZoho_Accounts",
37438     "group": "Zoho_Accounts",
37439     "parameter": {
37440       "fields": {
37441         "Body": [
37442           {
37443             "group": "Body",
37444             "type": "String",
37445             "optional": true,
37446             "field": "name",
37447             "description": ""
37448           },
37449           {
37450             "group": "Body",
37451             "type": "String",
37452             "optional": true,
37453             "field": "description",
37454             "description": ""
37455           },
37456           {
37457             "group": "Body",
37458             "type": "String",
37459             "optional": true,
37460             "field": "host",
37461             "description": ""
37462           },
37463           {
37464             "group": "Body",
37465             "type": "String",
37466             "optional": true,
37467             "field": "zone",
37468             "description": ""
37469           },
37470           {
37471             "group": "Body",
37472             "type": "String",
37473             "optional": true,
37474             "field": "clientId",
37475             "description": ""
37476           },
37477           {
37478             "group": "Body",
37479             "type": "String",
37480             "optional": true,
37481             "field": "clientSecret",
37482             "description": ""
37483           },
37484           {
37485             "group": "Body",
37486             "type": "String",
37487             "optional": false,
37488             "field": "serverUrl",
37489             "description": ""
37490           },
37491           {
37492             "group": "Body",
37493             "type": "String",
37494             "optional": true,
37495             "field": "code",
37496             "description": ""
37497           },
37498           {
37499             "group": "Body",
37500             "type": "String",
37501             "optional": true,
37502             "field": "refreshToken",
37503             "description": ""
37504           }
37505         ]
37506       }
37507     },
37508     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37509     "version": "0.0.0",
37510     "filename": "server/api/intZohoAccount/index.js",
37511     "groupTitle": "Zoho_Accounts"
37512   },
37513   {
37514     "type": "delete",
37515     "url": "/api/integrations/zoho/accounts/{id}",
37516     "title": "Deletes a Zoho Account",
37517     "examples": [
37518       {
37519         "title": "Example usage:",
37520         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
37521         "type": "json"
37522       }
37523     ],
37524     "name": "DeleteZoho_Accounts",
37525     "group": "Zoho_Accounts",
37526     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37527     "version": "0.0.0",
37528     "filename": "server/api/intZohoAccount/index.js",
37529     "groupTitle": "Zoho_Accounts"
37530   },
37531   {
37532     "type": "get",
37533     "url": "/api/integrations/zoho/accounts",
37534     "title": "Gets a list of Zoho Accounts",
37535     "examples": [
37536       {
37537         "title": "Example usage:",
37538         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
37539         "type": "json"
37540       }
37541     ],
37542     "name": "GetZoho_Accounts",
37543     "group": "Zoho_Accounts",
37544     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37545     "version": "0.0.0",
37546     "filename": "server/api/intZohoAccount/index.js",
37547     "groupTitle": "Zoho_Accounts"
37548   },
37549   {
37550     "type": "get",
37551     "url": "/api/integrations/zoho/accounts/{id}",
37552     "title": "Gets a single Zoho Account",
37553     "examples": [
37554       {
37555         "title": "Example usage:",
37556         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
37557         "type": "json"
37558       }
37559     ],
37560     "name": "ShowZoho_Accounts",
37561     "group": "Zoho_Accounts",
37562     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37563     "version": "0.0.0",
37564     "filename": "server/api/intZohoAccount/index.js",
37565     "groupTitle": "Zoho_Accounts"
37566   },
37567   {
37568     "type": "post",
37569     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37570     "title": "Creates new configuration",
37571     "examples": [
37572       {
37573         "title": "Example usage:",
37574         "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",
37575         "type": "json"
37576       }
37577     ],
37578     "name": "addConfiguration",
37579     "group": "Zoho_Accounts",
37580     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37581     "version": "0.0.0",
37582     "filename": "server/api/intZohoAccount/index.js",
37583     "groupTitle": "Zoho_Accounts"
37584   },
37585   {
37586     "type": "get",
37587     "url": "/api/integrations/zoho/accounts/{id}/configurations",
37588     "title": "Gets account configurations",
37589     "examples": [
37590       {
37591         "title": "Example usage:",
37592         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
37593         "type": "json"
37594       }
37595     ],
37596     "name": "getConfigurations",
37597     "group": "Zoho_Accounts",
37598     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37599     "version": "0.0.0",
37600     "filename": "server/api/intZohoAccount/index.js",
37601     "groupTitle": "Zoho_Accounts"
37602   },
37603   {
37604     "type": "get",
37605     "url": "/api/integrations/zoho/accounts/{id}/fields",
37606     "title": "Gets account fields",
37607     "examples": [
37608       {
37609         "title": "Example usage:",
37610         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
37611         "type": "json"
37612       }
37613     ],
37614     "name": "getFields",
37615     "group": "Zoho_Accounts",
37616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37617     "version": "0.0.0",
37618     "filename": "server/api/intZohoAccount/index.js",
37619     "groupTitle": "Zoho_Accounts"
37620   },
37621   {
37622     "type": "put",
37623     "url": "/api/integrations/zoho/accounts/{id}",
37624     "title": "Update an existing Zoho Account",
37625     "examples": [
37626       {
37627         "title": "Example usage:",
37628         "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",
37629         "type": "json"
37630       }
37631     ],
37632     "name": "updateZoho_Accounts",
37633     "group": "Zoho_Accounts",
37634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37635     "version": "0.0.0",
37636     "filename": "server/api/intZohoAccount/index.js",
37637     "groupTitle": "Zoho_Accounts"
37638   },
37639   {
37640     "type": "post",
37641     "url": "/api/integrations/zoho/configurations",
37642     "title": "Creates a new Zoho Configuration",
37643     "examples": [
37644       {
37645         "title": "Example usage:",
37646         "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",
37647         "type": "json"
37648       }
37649     ],
37650     "name": "CreateZoho_Configurations",
37651     "group": "Zoho_Configurations",
37652     "parameter": {
37653       "fields": {
37654         "Body": [
37655           {
37656             "group": "Body",
37657             "type": "String",
37658             "optional": true,
37659             "field": "name",
37660             "description": ""
37661           },
37662           {
37663             "group": "Body",
37664             "type": "String",
37665             "allowedValues": [
37666               "\"lead\"",
37667               "\"contact\"",
37668               "\"nothing\""
37669             ],
37670             "optional": true,
37671             "field": "moduleCreate",
37672             "description": ""
37673           },
37674           {
37675             "group": "Body",
37676             "type": "String",
37677             "allowedValues": [
37678               "\"contact_lead\"",
37679               "\"contact\"",
37680               "\"lead\""
37681             ],
37682             "optional": true,
37683             "field": "moduleSearch",
37684             "description": ""
37685           },
37686           {
37687             "group": "Body",
37688             "type": "String",
37689             "optional": true,
37690             "field": "description",
37691             "description": ""
37692           }
37693         ]
37694       }
37695     },
37696     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37697     "version": "0.0.0",
37698     "filename": "server/api/intZohoConfiguration/index.js",
37699     "groupTitle": "Zoho_Configurations"
37700   },
37701   {
37702     "type": "delete",
37703     "url": "/api/integrations/zoho/configurations/{id}",
37704     "title": "Deletes a Zoho Configuration",
37705     "examples": [
37706       {
37707         "title": "Example usage:",
37708         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
37709         "type": "json"
37710       }
37711     ],
37712     "name": "DeleteZoho_Configurations",
37713     "group": "Zoho_Configurations",
37714     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37715     "version": "0.0.0",
37716     "filename": "server/api/intZohoConfiguration/index.js",
37717     "groupTitle": "Zoho_Configurations"
37718   },
37719   {
37720     "type": "get",
37721     "url": "/api/integrations/zoho/configurations",
37722     "title": "Gets a list of Zoho Configurations",
37723     "examples": [
37724       {
37725         "title": "Example usage:",
37726         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
37727         "type": "json"
37728       }
37729     ],
37730     "name": "GetZoho_Configurations",
37731     "group": "Zoho_Configurations",
37732     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37733     "version": "0.0.0",
37734     "filename": "server/api/intZohoConfiguration/index.js",
37735     "groupTitle": "Zoho_Configurations"
37736   },
37737   {
37738     "type": "get",
37739     "url": "/api/integrations/zoho/configurations/{id}",
37740     "title": "Gets a single Zoho Configuration",
37741     "examples": [
37742       {
37743         "title": "Example usage:",
37744         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
37745         "type": "json"
37746       }
37747     ],
37748     "name": "ShowZoho_Configurations",
37749     "group": "Zoho_Configurations",
37750     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37751     "version": "0.0.0",
37752     "filename": "server/api/intZohoConfiguration/index.js",
37753     "groupTitle": "Zoho_Configurations"
37754   },
37755   {
37756     "type": "get",
37757     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
37758     "title": "Gets configurations descriptions",
37759     "examples": [
37760       {
37761         "title": "Example usage:",
37762         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
37763         "type": "json"
37764       }
37765     ],
37766     "name": "getDescriptions",
37767     "group": "Zoho_Configurations",
37768     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37769     "version": "0.0.0",
37770     "filename": "server/api/intZohoConfiguration/index.js",
37771     "groupTitle": "Zoho_Configurations"
37772   },
37773   {
37774     "type": "get",
37775     "url": "/api/integrations/zoho/configurations/{id}/fields",
37776     "title": "Gets configurations fields",
37777     "examples": [
37778       {
37779         "title": "Example usage:",
37780         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
37781         "type": "json"
37782       }
37783     ],
37784     "name": "getFields",
37785     "group": "Zoho_Configurations",
37786     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37787     "version": "0.0.0",
37788     "filename": "server/api/intZohoConfiguration/index.js",
37789     "groupTitle": "Zoho_Configurations"
37790   },
37791   {
37792     "type": "get",
37793     "url": "/api/integrations/zoho/configurations/{id}/subjects",
37794     "title": "Gets configurations subjects",
37795     "examples": [
37796       {
37797         "title": "Example usage:",
37798         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
37799         "type": "json"
37800       }
37801     ],
37802     "name": "getSubjects",
37803     "group": "Zoho_Configurations",
37804     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37805     "version": "0.0.0",
37806     "filename": "server/api/intZohoConfiguration/index.js",
37807     "groupTitle": "Zoho_Configurations"
37808   },
37809   {
37810     "type": "put",
37811     "url": "/api/integrations/zoho/configurations/{id}",
37812     "title": "Update an existing Zoho Configuration",
37813     "examples": [
37814       {
37815         "title": "Example usage:",
37816         "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",
37817         "type": "json"
37818       }
37819     ],
37820     "name": "updateZoho_Configurations",
37821     "group": "Zoho_Configurations",
37822     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37823     "version": "0.0.0",
37824     "filename": "server/api/intZohoConfiguration/index.js",
37825     "groupTitle": "Zoho_Configurations"
37826   },
37827   {
37828     "type": "post",
37829     "url": "/api/integrations/zoho/fields",
37830     "title": "Creates a new Zoho Field",
37831     "examples": [
37832       {
37833         "title": "Example usage:",
37834         "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",
37835         "type": "json"
37836       }
37837     ],
37838     "name": "CreateZoho_Fields",
37839     "group": "Zoho_Fields",
37840     "parameter": {
37841       "fields": {
37842         "Body": [
37843           {
37844             "group": "Body",
37845             "type": "String",
37846             "allowedValues": [
37847               "\"string\"",
37848               "\"variable\"",
37849               "\"customVariable\"",
37850               "\"keyValue\"",
37851               "\"picklist\""
37852             ],
37853             "optional": true,
37854             "field": "type",
37855             "description": ""
37856           },
37857           {
37858             "group": "Body",
37859             "type": "String",
37860             "optional": true,
37861             "field": "content",
37862             "description": ""
37863           },
37864           {
37865             "group": "Body",
37866             "type": "String",
37867             "optional": true,
37868             "field": "key",
37869             "description": ""
37870           },
37871           {
37872             "group": "Body",
37873             "type": "String",
37874             "allowedValues": [
37875               "\"string\"",
37876               "\"variable\"",
37877               "\"customVariable\""
37878             ],
37879             "optional": true,
37880             "field": "keyType",
37881             "description": ""
37882           },
37883           {
37884             "group": "Body",
37885             "type": "String",
37886             "optional": true,
37887             "field": "keyContent",
37888             "description": ""
37889           },
37890           {
37891             "group": "Body",
37892             "type": "String",
37893             "optional": true,
37894             "field": "idField",
37895             "description": ""
37896           },
37897           {
37898             "group": "Body",
37899             "type": "String",
37900             "optional": true,
37901             "field": "nameField",
37902             "description": ""
37903           },
37904           {
37905             "group": "Body",
37906             "type": "Boolean",
37907             "optional": true,
37908             "field": "customField",
37909             "description": ""
37910           },
37911           {
37912             "group": "Body",
37913             "type": "String",
37914             "optional": true,
37915             "field": "variableName",
37916             "description": ""
37917           }
37918         ]
37919       }
37920     },
37921     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37922     "version": "0.0.0",
37923     "filename": "server/api/intZohoField/index.js",
37924     "groupTitle": "Zoho_Fields"
37925   },
37926   {
37927     "type": "delete",
37928     "url": "/api/integrations/zoho/fields/{id}",
37929     "title": "Deletes a Zoho Field",
37930     "examples": [
37931       {
37932         "title": "Example usage:",
37933         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37934         "type": "json"
37935       }
37936     ],
37937     "name": "DeleteZoho_Fields",
37938     "group": "Zoho_Fields",
37939     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37940     "version": "0.0.0",
37941     "filename": "server/api/intZohoField/index.js",
37942     "groupTitle": "Zoho_Fields"
37943   },
37944   {
37945     "type": "get",
37946     "url": "/api/integrations/zoho/fields",
37947     "title": "Gets a list of Zoho Fields",
37948     "examples": [
37949       {
37950         "title": "Example usage:",
37951         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37952         "type": "json"
37953       }
37954     ],
37955     "name": "GetZoho_Fields",
37956     "group": "Zoho_Fields",
37957     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37958     "version": "0.0.0",
37959     "filename": "server/api/intZohoField/index.js",
37960     "groupTitle": "Zoho_Fields"
37961   },
37962   {
37963     "type": "get",
37964     "url": "/api/integrations/zoho/fields/{id}",
37965     "title": "Gets a single Zoho Field",
37966     "examples": [
37967       {
37968         "title": "Example usage:",
37969         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37970         "type": "json"
37971       }
37972     ],
37973     "name": "ShowZoho_Fields",
37974     "group": "Zoho_Fields",
37975     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37976     "version": "0.0.0",
37977     "filename": "server/api/intZohoField/index.js",
37978     "groupTitle": "Zoho_Fields"
37979   },
37980   {
37981     "type": "put",
37982     "url": "/api/integrations/zoho/fields/{id}",
37983     "title": "Update an existing Zoho Field",
37984     "examples": [
37985       {
37986         "title": "Example usage:",
37987         "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",
37988         "type": "json"
37989       }
37990     ],
37991     "name": "updateZoho_Fields",
37992     "group": "Zoho_Fields",
37993     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37994     "version": "0.0.0",
37995     "filename": "server/api/intZohoField/index.js",
37996     "groupTitle": "Zoho_Fields"
37997   },
37998   {
37999     "type": "post",
38000     "url": "/api/cdr",
38001     "title": "Creates a new Cdr",
38002     "examples": [
38003       {
38004         "title": "Example usage:",
38005         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38006         "type": "json"
38007       }
38008     ],
38009     "name": "CreateCdrs",
38010     "group": "cdr",
38011     "parameter": {
38012       "fields": {
38013         "Body": [
38014           {
38015             "group": "Body",
38016             "type": "String",
38017             "optional": false,
38018             "field": "calldate",
38019             "description": ""
38020           },
38021           {
38022             "group": "Body",
38023             "type": "String",
38024             "optional": true,
38025             "field": "clid",
38026             "description": ""
38027           },
38028           {
38029             "group": "Body",
38030             "type": "String",
38031             "optional": true,
38032             "field": "src",
38033             "description": ""
38034           },
38035           {
38036             "group": "Body",
38037             "type": "String",
38038             "optional": true,
38039             "field": "dst",
38040             "description": ""
38041           },
38042           {
38043             "group": "Body",
38044             "type": "String",
38045             "optional": true,
38046             "field": "dcontext",
38047             "description": ""
38048           },
38049           {
38050             "group": "Body",
38051             "type": "String",
38052             "optional": true,
38053             "field": "channel",
38054             "description": ""
38055           },
38056           {
38057             "group": "Body",
38058             "type": "String",
38059             "optional": true,
38060             "field": "dstchannel",
38061             "description": ""
38062           },
38063           {
38064             "group": "Body",
38065             "type": "String",
38066             "optional": true,
38067             "field": "lastapp",
38068             "description": ""
38069           },
38070           {
38071             "group": "Body",
38072             "type": "String",
38073             "optional": true,
38074             "field": "lastdata",
38075             "description": ""
38076           },
38077           {
38078             "group": "Body",
38079             "type": "Integer",
38080             "optional": false,
38081             "field": "duration",
38082             "description": ""
38083           },
38084           {
38085             "group": "Body",
38086             "type": "Integer",
38087             "optional": false,
38088             "field": "billsec",
38089             "description": ""
38090           },
38091           {
38092             "group": "Body",
38093             "type": "String",
38094             "optional": true,
38095             "field": "disposition",
38096             "description": ""
38097           },
38098           {
38099             "group": "Body",
38100             "type": "Integer",
38101             "optional": false,
38102             "field": "amaflags",
38103             "description": ""
38104           },
38105           {
38106             "group": "Body",
38107             "type": "String",
38108             "optional": true,
38109             "field": "accountcode",
38110             "description": ""
38111           },
38112           {
38113             "group": "Body",
38114             "type": "String",
38115             "optional": true,
38116             "field": "userfield",
38117             "description": ""
38118           },
38119           {
38120             "group": "Body",
38121             "type": "String",
38122             "optional": true,
38123             "field": "uniqueid",
38124             "description": ""
38125           },
38126           {
38127             "group": "Body",
38128             "type": "String",
38129             "optional": true,
38130             "field": "linkedid",
38131             "description": ""
38132           },
38133           {
38134             "group": "Body",
38135             "type": "String",
38136             "optional": true,
38137             "field": "sequence",
38138             "description": ""
38139           },
38140           {
38141             "group": "Body",
38142             "type": "String",
38143             "optional": true,
38144             "field": "peeraccount",
38145             "description": ""
38146           },
38147           {
38148             "group": "Body",
38149             "type": "String",
38150             "optional": true,
38151             "field": "type",
38152             "description": ""
38153           },
38154           {
38155             "group": "Body",
38156             "type": "String",
38157             "optional": true,
38158             "field": "tag",
38159             "description": ""
38160           }
38161         ]
38162       }
38163     },
38164     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38165     "version": "0.0.0",
38166     "filename": "server/api/cdr/index.js",
38167     "groupTitle": "cdr"
38168   },
38169   {
38170     "type": "delete",
38171     "url": "/api/cdr/{id}",
38172     "title": "Deletes a Cdr",
38173     "examples": [
38174       {
38175         "title": "Example usage:",
38176         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
38177         "type": "json"
38178       }
38179     ],
38180     "name": "DeleteCdrs",
38181     "group": "cdr",
38182     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38183     "version": "0.0.0",
38184     "filename": "server/api/cdr/index.js",
38185     "groupTitle": "cdr"
38186   },
38187   {
38188     "type": "get",
38189     "url": "/api/cdr/describe",
38190     "title": "Gets table info about Cdrs",
38191     "examples": [
38192       {
38193         "title": "Example usage:",
38194         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
38195         "type": "json"
38196       }
38197     ],
38198     "name": "DescribeCdrs",
38199     "group": "cdr",
38200     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38201     "version": "0.0.0",
38202     "filename": "server/api/cdr/index.js",
38203     "groupTitle": "cdr"
38204   },
38205   {
38206     "type": "get",
38207     "url": "/api/cdr",
38208     "title": "Gets a list of Cdrs",
38209     "examples": [
38210       {
38211         "title": "Example usage:",
38212         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
38213         "type": "json"
38214       }
38215     ],
38216     "name": "GetCdrs",
38217     "group": "cdr",
38218     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38219     "version": "0.0.0",
38220     "filename": "server/api/cdr/index.js",
38221     "groupTitle": "cdr"
38222   },
38223   {
38224     "type": "get",
38225     "url": "/api/cdr/{id}",
38226     "title": "Gets a single Cdr",
38227     "examples": [
38228       {
38229         "title": "Example usage:",
38230         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
38231         "type": "json"
38232       }
38233     ],
38234     "name": "ShowCdrs",
38235     "group": "cdr",
38236     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38237     "version": "0.0.0",
38238     "filename": "server/api/cdr/index.js",
38239     "groupTitle": "cdr"
38240   },
38241   {
38242     "type": "put",
38243     "url": "/api/cdr/{id}",
38244     "title": "Update an existing Cdr",
38245     "examples": [
38246       {
38247         "title": "Example usage:",
38248         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38249         "type": "json"
38250       }
38251     ],
38252     "name": "updateCdrs",
38253     "group": "cdr",
38254     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38255     "version": "0.0.0",
38256     "filename": "server/api/cdr/index.js",
38257     "groupTitle": "cdr"
38258   },
38259   {
38260     "type": "post",
38261     "url": "/api/voiceQueuesLog",
38262     "title": "Creates a new VoiceQueuesLog",
38263     "examples": [
38264       {
38265         "title": "Example usage:",
38266         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
38267         "type": "json"
38268       }
38269     ],
38270     "name": "CreateVoiceQueuesLogs",
38271     "group": "voiceQueuesLog",
38272     "parameter": {
38273       "fields": {
38274         "Body": [
38275           {
38276             "group": "Body",
38277             "type": "String",
38278             "optional": true,
38279             "field": "time",
38280             "description": ""
38281           },
38282           {
38283             "group": "Body",
38284             "type": "String",
38285             "optional": false,
38286             "field": "callid",
38287             "description": ""
38288           },
38289           {
38290             "group": "Body",
38291             "type": "String",
38292             "optional": false,
38293             "field": "queuename",
38294             "description": ""
38295           },
38296           {
38297             "group": "Body",
38298             "type": "String",
38299             "optional": false,
38300             "field": "agent",
38301             "description": ""
38302           },
38303           {
38304             "group": "Body",
38305             "type": "String",
38306             "optional": false,
38307             "field": "event",
38308             "description": ""
38309           },
38310           {
38311             "group": "Body",
38312             "type": "String",
38313             "optional": false,
38314             "field": "data",
38315             "description": ""
38316           },
38317           {
38318             "group": "Body",
38319             "type": "String",
38320             "optional": false,
38321             "field": "data1",
38322             "description": ""
38323           },
38324           {
38325             "group": "Body",
38326             "type": "String",
38327             "optional": false,
38328             "field": "data2",
38329             "description": ""
38330           },
38331           {
38332             "group": "Body",
38333             "type": "String",
38334             "optional": false,
38335             "field": "data3",
38336             "description": ""
38337           },
38338           {
38339             "group": "Body",
38340             "type": "String",
38341             "optional": false,
38342             "field": "data4",
38343             "description": ""
38344           },
38345           {
38346             "group": "Body",
38347             "type": "String",
38348             "optional": false,
38349             "field": "data5",
38350             "description": ""
38351           },
38352           {
38353             "group": "Body",
38354             "type": "String",
38355             "optional": false,
38356             "field": "dtm",
38357             "description": ""
38358           }
38359         ]
38360       }
38361     },
38362     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38363     "version": "0.0.0",
38364     "filename": "server/api/voiceQueuesLog/index.js",
38365     "groupTitle": "voiceQueuesLog"
38366   },
38367   {
38368     "type": "delete",
38369     "url": "/api/voiceQueuesLog/{id}",
38370     "title": "Deletes a VoiceQueuesLog",
38371     "examples": [
38372       {
38373         "title": "Example usage:",
38374         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
38375         "type": "json"
38376       }
38377     ],
38378     "name": "DeleteVoiceQueuesLogs",
38379     "group": "voiceQueuesLog",
38380     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38381     "version": "0.0.0",
38382     "filename": "server/api/voiceQueuesLog/index.js",
38383     "groupTitle": "voiceQueuesLog"
38384   },
38385   {
38386     "type": "get",
38387     "url": "/api/voiceQueuesLog",
38388     "title": "Gets a list of VoiceQueuesLogs",
38389     "examples": [
38390       {
38391         "title": "Example usage:",
38392         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
38393         "type": "json"
38394       }
38395     ],
38396     "name": "GetVoiceQueuesLogs",
38397     "group": "voiceQueuesLog",
38398     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
38399     "version": "0.0.0",
38400     "filename": "server/api/voiceQueuesLog/index.js",
38401     "groupTitle": "voiceQueuesLog"
38402   },
38403   {
38404     "type": "get",
38405     "url": "/api/voiceQueuesLog/{id}",
38406     "title": "Gets a single VoiceQueuesLog",
38407     "examples": [
38408       {
38409         "title": "Example usage:",
38410         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
38411         "type": "json"
38412       }
38413     ],
38414     "name": "ShowVoiceQueuesLogs",
38415     "group": "voiceQueuesLog",
38416     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38417     "version": "0.0.0",
38418     "filename": "server/api/voiceQueuesLog/index.js",
38419     "groupTitle": "voiceQueuesLog"
38420   },
38421   {
38422     "type": "put",
38423     "url": "/api/voiceQueuesLog/{id}",
38424     "title": "Update an existing VoiceQueuesLog",
38425     "examples": [
38426       {
38427         "title": "Example usage:",
38428         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
38429         "type": "json"
38430       }
38431     ],
38432     "name": "updateVoiceQueuesLogs",
38433     "group": "voiceQueuesLog",
38434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
38435     "version": "0.0.0",
38436     "filename": "server/api/voiceQueuesLog/index.js",
38437     "groupTitle": "voiceQueuesLog"
38438   }
38439 ]