apidoc/api_data.json

   1 [
   2   {
   3     "type": "delete",
   4     "url": "/api/actions/{id}",
   5     "title": "Deletes a Action",
   6     "examples": [
   7       {
   8         "title": "Example usage:",
   9         "content": "curl https://{domain}/api/actions/{id} -v -u {name}:{password} -X DELETE",
  10         "type": "json"
  11       }
  12     ],
  13     "name": "DeleteActions",
  14     "group": "Actions",
  15     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  16     "version": "0.0.0",
  17     "filename": "server/api/action/index.js",
  18     "groupTitle": "Actions"
  19   },
  20   {
  21     "type": "put",
  22     "url": "/api/actions/{id}",
  23     "title": "Update an existing Action",
  24     "examples": [
  25       {
  26         "title": "Example usage:",
  27         "content": "curl https://{domain}/api/actions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
  28         "type": "json"
  29       }
  30     ],
  31     "name": "updateActions",
  32     "group": "Actions",
  33     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
  34     "version": "0.0.0",
  35     "filename": "server/api/action/index.js",
  36     "groupTitle": "Actions"
  37   },
  38   {
  39     "type": "post",
  40     "url": "/api/analytics/custom_reports",
  41     "title": "Creates a new Analytic Custom Report",
  42     "examples": [
  43       {
  44         "title": "Example usage:",
  45         "content": "curl https://{domain}/api/analytics/custom_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
  46         "type": "json"
  47       }
  48     ],
  49     "name": "CreateAnalytic_Custom_Reports",
  50     "group": "Analytic_Custom_Reports",
  51     "parameter": {
  52       "fields": {
  53         "Body": [
  54           {
  55             "group": "Body",
  56             "type": "String",
  57             "optional": false,
  58             "field": "name",
  59             "description": ""
  60           },
  61           {
  62             "group": "Body",
  63             "type": "String",
  64             "optional": true,
  65             "field": "description",
  66             "description": ""
  67           },
  68           {
  69             "group": "Body",
  70             "type": "String",
  71             "optional": true,
  72             "field": "parent",
  73             "description": ""
  74           },
  75           {
  76             "group": "Body",
  77             "type": "String",
  78             "optional": true,
  79             "field": "table",
  80             "description": ""
  81           },
  82           {
  83             "group": "Body",
  84             "type": "Text",
  85             "optional": true,
  86             "field": "conditions",
  87             "description": ""
  88           },
  89           {
  90             "group": "Body",
  91             "type": "Text",
  92             "optional": true,
  93             "field": "joins",
  94             "description": ""
  95           }
  96         ]
  97       }
  98     },
  99     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 100     "version": "0.0.0",
 101     "filename": "server/api/analyticCustomReport/index.js",
 102     "groupTitle": "Analytic_Custom_Reports"
 103   },
 104   {
 105     "type": "delete",
 106     "url": "/api/analytics/custom_reports/{id}",
 107     "title": "Deletes a Analytic Custom Report",
 108     "examples": [
 109       {
 110         "title": "Example usage:",
 111         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password} -X DELETE",
 112         "type": "json"
 113       }
 114     ],
 115     "name": "DeleteAnalytic_Custom_Reports",
 116     "group": "Analytic_Custom_Reports",
 117     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 118     "version": "0.0.0",
 119     "filename": "server/api/analyticCustomReport/index.js",
 120     "groupTitle": "Analytic_Custom_Reports"
 121   },
 122   {
 123     "type": "get",
 124     "url": "/api/analytics/custom_reports",
 125     "title": "Gets a list of Analytic Custom Reports",
 126     "examples": [
 127       {
 128         "title": "Example usage:",
 129         "content": "curl https://{domain}/api/analytics/custom_reports -v -u {name}:{password}",
 130         "type": "json"
 131       }
 132     ],
 133     "name": "GetAnalytic_Custom_Reports",
 134     "group": "Analytic_Custom_Reports",
 135     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/custom_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/custom_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/custom_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/custom_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/custom_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 136     "version": "0.0.0",
 137     "filename": "server/api/analyticCustomReport/index.js",
 138     "groupTitle": "Analytic_Custom_Reports"
 139   },
 140   {
 141     "type": "get",
 142     "url": "/api/analytics/custom_reports/{id}",
 143     "title": "Gets a single Analytic Custom Report",
 144     "examples": [
 145       {
 146         "title": "Example usage:",
 147         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -v -u {name}:{password}",
 148         "type": "json"
 149       }
 150     ],
 151     "name": "ShowAnalytic_Custom_Reports",
 152     "group": "Analytic_Custom_Reports",
 153     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 154     "version": "0.0.0",
 155     "filename": "server/api/analyticCustomReport/index.js",
 156     "groupTitle": "Analytic_Custom_Reports"
 157   },
 158   {
 159     "type": "get",
 160     "url": "/api/analytics/custom_reports/{id}/preview",
 161     "title": "Report Preview",
 162     "examples": [
 163       {
 164         "title": "Example usage:",
 165         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/preview -v -u {name}:{password} -X GET",
 166         "type": "json"
 167       }
 168     ],
 169     "name": "preview",
 170     "group": "Analytic_Custom_Reports",
 171     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 172     "version": "0.0.0",
 173     "filename": "server/api/analyticCustomReport/index.js",
 174     "groupTitle": "Analytic_Custom_Reports"
 175   },
 176   {
 177     "type": "get",
 178     "url": "/api/analytics/custom_reports/{id}/query",
 179     "title": "Report Query SQL",
 180     "examples": [
 181       {
 182         "title": "Example usage:",
 183         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/query -v -u {name}:{password} -X GET",
 184         "type": "json"
 185       }
 186     ],
 187     "name": "query",
 188     "group": "Analytic_Custom_Reports",
 189     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 190     "version": "0.0.0",
 191     "filename": "server/api/analyticCustomReport/index.js",
 192     "groupTitle": "Analytic_Custom_Reports"
 193   },
 194   {
 195     "type": "get",
 196     "url": "/api/analytics/custom_reports/{id}/run",
 197     "title": "Report Run",
 198     "examples": [
 199       {
 200         "title": "Example usage:",
 201         "content": "curl https://{domain}/api/analytics/custom_reports/{id}/run -v -u {name}:{password} -X GET",
 202         "type": "json"
 203       }
 204     ],
 205     "name": "run",
 206     "group": "Analytic_Custom_Reports",
 207     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 208     "version": "0.0.0",
 209     "filename": "server/api/analyticCustomReport/index.js",
 210     "groupTitle": "Analytic_Custom_Reports"
 211   },
 212   {
 213     "type": "put",
 214     "url": "/api/analytics/custom_reports/{id}",
 215     "title": "Update an existing Analytic Custom Report",
 216     "examples": [
 217       {
 218         "title": "Example usage:",
 219         "content": "curl https://{domain}/api/analytics/custom_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 220         "type": "json"
 221       }
 222     ],
 223     "name": "updateAnalytic_Custom_Reports",
 224     "group": "Analytic_Custom_Reports",
 225     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 226     "version": "0.0.0",
 227     "filename": "server/api/analyticCustomReport/index.js",
 228     "groupTitle": "Analytic_Custom_Reports"
 229   },
 230   {
 231     "type": "post",
 232     "url": "/api/analytics/default_reports",
 233     "title": "Creates a new Analytic Default Report",
 234     "examples": [
 235       {
 236         "title": "Example usage:",
 237         "content": "curl https://{domain}/api/analytics/default_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 238         "type": "json"
 239       }
 240     ],
 241     "name": "CreateAnalytic_Default_Reports",
 242     "group": "Analytic_Default_Reports",
 243     "parameter": {
 244       "fields": {
 245         "Body": [
 246           {
 247             "group": "Body",
 248             "type": "String",
 249             "optional": false,
 250             "field": "name",
 251             "description": ""
 252           },
 253           {
 254             "group": "Body",
 255             "type": "String",
 256             "optional": true,
 257             "field": "description",
 258             "description": ""
 259           },
 260           {
 261             "group": "Body",
 262             "type": "String",
 263             "optional": true,
 264             "field": "parent",
 265             "description": ""
 266           },
 267           {
 268             "group": "Body",
 269             "type": "String",
 270             "optional": true,
 271             "field": "table",
 272             "description": ""
 273           },
 274           {
 275             "group": "Body",
 276             "type": "Text",
 277             "optional": true,
 278             "field": "conditions",
 279             "description": ""
 280           },
 281           {
 282             "group": "Body",
 283             "type": "Text",
 284             "optional": true,
 285             "field": "joins",
 286             "description": ""
 287           }
 288         ]
 289       }
 290     },
 291     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 292     "version": "0.0.0",
 293     "filename": "server/api/analyticDefaultReport/index.js",
 294     "groupTitle": "Analytic_Default_Reports"
 295   },
 296   {
 297     "type": "delete",
 298     "url": "/api/analytics/default_reports/{id}",
 299     "title": "Deletes a Analytic Default Report",
 300     "examples": [
 301       {
 302         "title": "Example usage:",
 303         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password} -X DELETE",
 304         "type": "json"
 305       }
 306     ],
 307     "name": "DeleteAnalytic_Default_Reports",
 308     "group": "Analytic_Default_Reports",
 309     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 310     "version": "0.0.0",
 311     "filename": "server/api/analyticDefaultReport/index.js",
 312     "groupTitle": "Analytic_Default_Reports"
 313   },
 314   {
 315     "type": "get",
 316     "url": "/api/analytics/default_reports",
 317     "title": "Gets a list of Analytic Default Reports",
 318     "examples": [
 319       {
 320         "title": "Example usage:",
 321         "content": "curl https://{domain}/api/analytics/default_reports -v -u {name}:{password}",
 322         "type": "json"
 323       }
 324     ],
 325     "name": "GetAnalytic_Default_Reports",
 326     "group": "Analytic_Default_Reports",
 327     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/default_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/default_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/default_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/default_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/default_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 328     "version": "0.0.0",
 329     "filename": "server/api/analyticDefaultReport/index.js",
 330     "groupTitle": "Analytic_Default_Reports"
 331   },
 332   {
 333     "type": "get",
 334     "url": "/api/analytics/default_reports/{id}",
 335     "title": "Gets a single Analytic Default Report",
 336     "examples": [
 337       {
 338         "title": "Example usage:",
 339         "content": "curl https://{domain}/api/analytics/default_reports/{id} -v -u {name}:{password}",
 340         "type": "json"
 341       }
 342     ],
 343     "name": "ShowAnalytic_Default_Reports",
 344     "group": "Analytic_Default_Reports",
 345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 346     "version": "0.0.0",
 347     "filename": "server/api/analyticDefaultReport/index.js",
 348     "groupTitle": "Analytic_Default_Reports"
 349   },
 350   {
 351     "type": "get",
 352     "url": "/api/analytics/default_reports/{id}/preview",
 353     "title": "Report Preview",
 354     "examples": [
 355       {
 356         "title": "Example usage:",
 357         "content": "curl https://{domain}/api/analytics/default_reports/{id}/preview -v -u {name}:{password} -X GET",
 358         "type": "json"
 359       }
 360     ],
 361     "name": "preview",
 362     "group": "Analytic_Default_Reports",
 363     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 364     "version": "0.0.0",
 365     "filename": "server/api/analyticDefaultReport/index.js",
 366     "groupTitle": "Analytic_Default_Reports"
 367   },
 368   {
 369     "type": "get",
 370     "url": "/api/analytics/default_reports/{id}/query",
 371     "title": "Report Query SQL",
 372     "examples": [
 373       {
 374         "title": "Example usage:",
 375         "content": "curl https://{domain}/api/analytics/default_reports/{id}/query -v -u {name}:{password} -X GET",
 376         "type": "json"
 377       }
 378     ],
 379     "name": "query",
 380     "group": "Analytic_Default_Reports",
 381     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 382     "version": "0.0.0",
 383     "filename": "server/api/analyticDefaultReport/index.js",
 384     "groupTitle": "Analytic_Default_Reports"
 385   },
 386   {
 387     "type": "get",
 388     "url": "/api/analytics/default_reports/{id}/run",
 389     "title": "Report Run",
 390     "examples": [
 391       {
 392         "title": "Example usage:",
 393         "content": "curl https://{domain}/api/analytics/default_reports/{id}/run -v -u {name}:{password} -X GET",
 394         "type": "json"
 395       }
 396     ],
 397     "name": "run",
 398     "group": "Analytic_Default_Reports",
 399     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 400     "version": "0.0.0",
 401     "filename": "server/api/analyticDefaultReport/index.js",
 402     "groupTitle": "Analytic_Default_Reports"
 403   },
 404   {
 405     "type": "put",
 406     "url": "/api/analytics/default_reports/{id}",
 407     "title": "Update an existing Analytic Default Report",
 408     "examples": [
 409       {
 410         "title": "Example usage:",
 411         "content": "curl https://{domain}/api/analytics/default_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 412         "type": "json"
 413       }
 414     ],
 415     "name": "updateAnalytic_Default_Reports",
 416     "group": "Analytic_Default_Reports",
 417     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 418     "version": "0.0.0",
 419     "filename": "server/api/analyticDefaultReport/index.js",
 420     "groupTitle": "Analytic_Default_Reports"
 421   },
 422   {
 423     "type": "post",
 424     "url": "/api/analytics/extracted_reports",
 425     "title": "Creates a new Analytic Extracted Report",
 426     "examples": [
 427       {
 428         "title": "Example usage:",
 429         "content": "curl https://{domain}/api/analytics/extracted_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 430         "type": "json"
 431       }
 432     ],
 433     "name": "CreateAnalytic_Extacted_Reports",
 434     "group": "Analytic_Extracted_Reports",
 435     "parameter": {
 436       "fields": {
 437         "Body": [
 438           {
 439             "group": "Body",
 440             "type": "String",
 441             "optional": false,
 442             "field": "name",
 443             "description": ""
 444           },
 445           {
 446             "group": "Body",
 447             "type": "String",
 448             "optional": false,
 449             "field": "basename",
 450             "description": ""
 451           },
 452           {
 453             "group": "Body",
 454             "type": "String",
 455             "allowedValues": [
 456               "\"csv\"",
 457               "\"pdf\"",
 458               "\"xlsx\""
 459             ],
 460             "optional": false,
 461             "field": "output",
 462             "description": ""
 463           },
 464           {
 465             "group": "Body",
 466             "type": "String",
 467             "optional": false,
 468             "field": "savename",
 469             "description": ""
 470           },
 471           {
 472             "group": "Body",
 473             "type": "String",
 474             "optional": true,
 475             "field": "startDate",
 476             "description": ""
 477           },
 478           {
 479             "group": "Body",
 480             "type": "String",
 481             "optional": true,
 482             "field": "endDate",
 483             "description": ""
 484           },
 485           {
 486             "group": "Body",
 487             "type": "String",
 488             "optional": true,
 489             "field": "status",
 490             "description": ""
 491           },
 492           {
 493             "group": "Body",
 494             "type": "String",
 495             "allowedValues": [
 496               "\"manual\"",
 497               "\"scheduled\""
 498             ],
 499             "optional": false,
 500             "field": "type",
 501             "description": ""
 502           },
 503           {
 504             "group": "Body",
 505             "type": "Integer",
 506             "optional": true,
 507             "field": "reportId",
 508             "description": ""
 509           },
 510           {
 511             "group": "Body",
 512             "type": "String",
 513             "optional": true,
 514             "field": "reportType",
 515             "description": ""
 516           }
 517         ]
 518       }
 519     },
 520     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 521     "version": "0.0.0",
 522     "filename": "server/api/analyticExtractedReport/index.js",
 523     "groupTitle": "Analytic_Extracted_Reports"
 524   },
 525   {
 526     "type": "delete",
 527     "url": "/api/analytics/extracted_reports/{id}",
 528     "title": "Deletes a Analytic Extracted Report",
 529     "examples": [
 530       {
 531         "title": "Example usage:",
 532         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password} -X DELETE",
 533         "type": "json"
 534       }
 535     ],
 536     "name": "DeleteAnalytic_Extacted_Reports",
 537     "group": "Analytic_Extracted_Reports",
 538     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 539     "version": "0.0.0",
 540     "filename": "server/api/analyticExtractedReport/index.js",
 541     "groupTitle": "Analytic_Extracted_Reports"
 542   },
 543   {
 544     "type": "get",
 545     "url": "/api/analytics/extracted_reports",
 546     "title": "Gets a list of Analytic Extacted Reports",
 547     "examples": [
 548       {
 549         "title": "Example usage:",
 550         "content": "curl https://{domain}/api/analytics/extracted_reports -v -u {name}:{password}",
 551         "type": "json"
 552       }
 553     ],
 554     "name": "GetAnalytic_Extacted_Reports",
 555     "group": "Analytic_Extracted_Reports",
 556     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/extracted_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/extracted_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/extracted_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/extracted_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/extracted_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 557     "version": "0.0.0",
 558     "filename": "server/api/analyticExtractedReport/index.js",
 559     "groupTitle": "Analytic_Extracted_Reports"
 560   },
 561   {
 562     "type": "get",
 563     "url": "/api/analytics/extracted_reports/{id}",
 564     "title": "Gets a single Analytic Extracted Report",
 565     "examples": [
 566       {
 567         "title": "Example usage:",
 568         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -v -u {name}:{password}",
 569         "type": "json"
 570       }
 571     ],
 572     "name": "ShowAnalytic_Extacted_Reports",
 573     "group": "Analytic_Extracted_Reports",
 574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 575     "version": "0.0.0",
 576     "filename": "server/api/analyticExtractedReport/index.js",
 577     "groupTitle": "Analytic_Extracted_Reports"
 578   },
 579   {
 580     "type": "get",
 581     "url": "/api/analytics/extracted_reports/{id}/download",
 582     "title": "Download Extracted Report",
 583     "examples": [
 584       {
 585         "title": "Example usage:",
 586         "content": "curl https://{domain}/api/analytics/extracted_reports/{id}/download -v -u {name}:{password} -X GET",
 587         "type": "json"
 588       }
 589     ],
 590     "name": "download",
 591     "group": "Analytic_Extracted_Reports",
 592     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 593     "version": "0.0.0",
 594     "filename": "server/api/analyticExtractedReport/index.js",
 595     "groupTitle": "Analytic_Extracted_Reports"
 596   },
 597   {
 598     "type": "put",
 599     "url": "/api/analytics/extracted_reports/{id}",
 600     "title": "Update an existing Analytic Extracted Report",
 601     "examples": [
 602       {
 603         "title": "Example usage:",
 604         "content": "curl https://{domain}/api/analytics/extracted_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 605         "type": "json"
 606       }
 607     ],
 608     "name": "updateAnalytic_Extacted_Reports",
 609     "group": "Analytic_Extracted_Reports",
 610     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 611     "version": "0.0.0",
 612     "filename": "server/api/analyticExtractedReport/index.js",
 613     "groupTitle": "Analytic_Extracted_Reports"
 614   },
 615   {
 616     "type": "post",
 617     "url": "/api/analytics/field_reports/create_many",
 618     "title": "Creates many Analytic Field Reports",
 619     "examples": [
 620       {
 621         "title": "Example usage:",
 622         "content": "curl https://{domain}/api/analytics/field_reports/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 623         "type": "json"
 624       }
 625     ],
 626     "name": "BulkCreateAnalytic_Field_Reports",
 627     "group": "Analytic_Field_Reports",
 628     "parameter": {
 629       "fields": {
 630         "Body": [
 631           {
 632             "group": "Body",
 633             "type": "Text",
 634             "optional": true,
 635             "field": "field",
 636             "description": ""
 637           },
 638           {
 639             "group": "Body",
 640             "type": "String",
 641             "optional": true,
 642             "field": "alias",
 643             "description": ""
 644           },
 645           {
 646             "group": "Body",
 647             "type": "String",
 648             "optional": true,
 649             "field": "function",
 650             "description": ""
 651           },
 652           {
 653             "group": "Body",
 654             "type": "String",
 655             "optional": true,
 656             "field": "format",
 657             "description": ""
 658           },
 659           {
 660             "group": "Body",
 661             "type": "Boolean",
 662             "optional": true,
 663             "field": "groupBy",
 664             "description": ""
 665           },
 666           {
 667             "group": "Body",
 668             "type": "String",
 669             "optional": true,
 670             "field": "orderBy",
 671             "description": ""
 672           },
 673           {
 674             "group": "Body",
 675             "type": "Boolean",
 676             "optional": true,
 677             "field": "custom",
 678             "description": ""
 679           }
 680         ]
 681       }
 682     },
 683     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 684     "version": "0.0.0",
 685     "filename": "server/api/analyticFieldReport/index.js",
 686     "groupTitle": "Analytic_Field_Reports"
 687   },
 688   {
 689     "type": "delete",
 690     "url": "/api/analytics/field_reports/destroy_many?ids={ids}",
 691     "title": "Deletes many Analytic Field Reports",
 692     "examples": [
 693       {
 694         "title": "Example usage:",
 695         "content": "curl https://{domain}/api/analytics/field_reports/destroy_many?ids=1&ids=2&ids=3 -v -u {name}:{password} -X DELETE",
 696         "type": "json"
 697       }
 698     ],
 699     "name": "BulkDeleteAnalytic_Field_Reports",
 700     "group": "Analytic_Field_Reports",
 701     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 702     "version": "0.0.0",
 703     "filename": "server/api/analyticFieldReport/index.js",
 704     "groupTitle": "Analytic_Field_Reports"
 705   },
 706   {
 707     "type": "post",
 708     "url": "/api/analytics/field_reports",
 709     "title": "Creates a new Analytic Field Report",
 710     "examples": [
 711       {
 712         "title": "Example usage:",
 713         "content": "curl https://{domain}/api/analytics/field_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 714         "type": "json"
 715       }
 716     ],
 717     "name": "CreateAnalytic_Field_Reports",
 718     "group": "Analytic_Field_Reports",
 719     "parameter": {
 720       "fields": {
 721         "Body": [
 722           {
 723             "group": "Body",
 724             "type": "Text",
 725             "optional": true,
 726             "field": "field",
 727             "description": ""
 728           },
 729           {
 730             "group": "Body",
 731             "type": "String",
 732             "optional": true,
 733             "field": "alias",
 734             "description": ""
 735           },
 736           {
 737             "group": "Body",
 738             "type": "String",
 739             "optional": true,
 740             "field": "function",
 741             "description": ""
 742           },
 743           {
 744             "group": "Body",
 745             "type": "String",
 746             "optional": true,
 747             "field": "format",
 748             "description": ""
 749           },
 750           {
 751             "group": "Body",
 752             "type": "Boolean",
 753             "optional": true,
 754             "field": "groupBy",
 755             "description": ""
 756           },
 757           {
 758             "group": "Body",
 759             "type": "String",
 760             "optional": true,
 761             "field": "orderBy",
 762             "description": ""
 763           },
 764           {
 765             "group": "Body",
 766             "type": "Boolean",
 767             "optional": true,
 768             "field": "custom",
 769             "description": ""
 770           }
 771         ]
 772       }
 773     },
 774     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 775     "version": "0.0.0",
 776     "filename": "server/api/analyticFieldReport/index.js",
 777     "groupTitle": "Analytic_Field_Reports"
 778   },
 779   {
 780     "type": "delete",
 781     "url": "/api/analytics/field_reports/{id}",
 782     "title": "Deletes a Analytic Field Report",
 783     "examples": [
 784       {
 785         "title": "Example usage:",
 786         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password} -X DELETE",
 787         "type": "json"
 788       }
 789     ],
 790     "name": "DeleteAnalytic_Field_Reports",
 791     "group": "Analytic_Field_Reports",
 792     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 793     "version": "0.0.0",
 794     "filename": "server/api/analyticFieldReport/index.js",
 795     "groupTitle": "Analytic_Field_Reports"
 796   },
 797   {
 798     "type": "get",
 799     "url": "/api/analytics/field_reports",
 800     "title": "Gets a list of Analytic Field Reports",
 801     "examples": [
 802       {
 803         "title": "Example usage:",
 804         "content": "curl https://{domain}/api/analytics/field_reports -v -u {name}:{password}",
 805         "type": "json"
 806       }
 807     ],
 808     "name": "GetAnalytic_Field_Reports",
 809     "group": "Analytic_Field_Reports",
 810     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/field_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/field_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/field_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/field_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/field_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 811     "version": "0.0.0",
 812     "filename": "server/api/analyticFieldReport/index.js",
 813     "groupTitle": "Analytic_Field_Reports"
 814   },
 815   {
 816     "type": "get",
 817     "url": "/api/analytics/field_reports/{id}",
 818     "title": "Gets a single Analytic Field Report",
 819     "examples": [
 820       {
 821         "title": "Example usage:",
 822         "content": "curl https://{domain}/api/analytics/field_reports/{id} -v -u {name}:{password}",
 823         "type": "json"
 824       }
 825     ],
 826     "name": "ShowAnalytic_Field_Reports",
 827     "group": "Analytic_Field_Reports",
 828     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 829     "version": "0.0.0",
 830     "filename": "server/api/analyticFieldReport/index.js",
 831     "groupTitle": "Analytic_Field_Reports"
 832   },
 833   {
 834     "type": "post",
 835     "url": "/api/analytics/field_reports/{id}/create_many",
 836     "title": "Rewrite fields set",
 837     "examples": [
 838       {
 839         "title": "Example usage:",
 840         "content": "curl https://{domain}/api/analytics/field_reports/{id}/create_many -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
 841         "type": "json"
 842       }
 843     ],
 844     "name": "addFields",
 845     "group": "Analytic_Field_Reports",
 846     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 847     "version": "0.0.0",
 848     "filename": "server/api/analyticFieldReport/index.js",
 849     "groupTitle": "Analytic_Field_Reports"
 850   },
 851   {
 852     "type": "put",
 853     "url": "/api/analytics/field_reports/{id}",
 854     "title": "Update an existing Analytic Field Report",
 855     "examples": [
 856       {
 857         "title": "Example usage:",
 858         "content": "curl https://{domain}/api/analytics/field_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 859         "type": "json"
 860       }
 861     ],
 862     "name": "updateAnalytic_Field_Reports",
 863     "group": "Analytic_Field_Reports",
 864     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 865     "version": "0.0.0",
 866     "filename": "server/api/analyticFieldReport/index.js",
 867     "groupTitle": "Analytic_Field_Reports"
 868   },
 869   {
 870     "type": "post",
 871     "url": "/api/analytics/metrics",
 872     "title": "Creates a new Analytic Metrics",
 873     "examples": [
 874       {
 875         "title": "Example usage:",
 876         "content": "curl https://{domain}/api/analytics/metrics -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
 877         "type": "json"
 878       }
 879     ],
 880     "name": "CreateAnalytic_Metric",
 881     "group": "Analytic_Metrics",
 882     "parameter": {
 883       "fields": {
 884         "Body": [
 885           {
 886             "group": "Body",
 887             "type": "String",
 888             "optional": false,
 889             "field": "name",
 890             "description": ""
 891           },
 892           {
 893             "group": "Body",
 894             "type": "String",
 895             "optional": true,
 896             "field": "table",
 897             "description": ""
 898           },
 899           {
 900             "group": "Body",
 901             "type": "Text",
 902             "optional": true,
 903             "field": "metric",
 904             "description": ""
 905           },
 906           {
 907             "group": "Body",
 908             "type": "String",
 909             "optional": true,
 910             "field": "description",
 911             "description": ""
 912           }
 913         ]
 914       }
 915     },
 916     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 917     "version": "0.0.0",
 918     "filename": "server/api/analyticMetric/index.js",
 919     "groupTitle": "Analytic_Metrics"
 920   },
 921   {
 922     "type": "delete",
 923     "url": "/api/analytics/metrics/{id}",
 924     "title": "Deletes a Analytic Metrics",
 925     "examples": [
 926       {
 927         "title": "Example usage:",
 928         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password} -X DELETE",
 929         "type": "json"
 930       }
 931     ],
 932     "name": "DeleteAnalytic_Metric",
 933     "group": "Analytic_Metrics",
 934     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 935     "version": "0.0.0",
 936     "filename": "server/api/analyticMetric/index.js",
 937     "groupTitle": "Analytic_Metrics"
 938   },
 939   {
 940     "type": "get",
 941     "url": "/api/analytics/metrics",
 942     "title": "Gets a list of Analytic Metric",
 943     "examples": [
 944       {
 945         "title": "Example usage:",
 946         "content": "curl https://{domain}/api/analytics/metrics -v -u {name}:{password}",
 947         "type": "json"
 948       }
 949     ],
 950     "name": "GetAnalytic_Metric",
 951     "group": "Analytic_Metrics",
 952     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/metrics?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/metrics?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/metrics?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/metrics?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/metrics?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
 953     "version": "0.0.0",
 954     "filename": "server/api/analyticMetric/index.js",
 955     "groupTitle": "Analytic_Metrics"
 956   },
 957   {
 958     "type": "get",
 959     "url": "/api/analytics/metrics/{id}",
 960     "title": "Gets a single Analytic Metrics",
 961     "examples": [
 962       {
 963         "title": "Example usage:",
 964         "content": "curl https://{domain}/api/analytics/metrics/{id} -v -u {name}:{password}",
 965         "type": "json"
 966       }
 967     ],
 968     "name": "ShowAnalytic_Metric",
 969     "group": "Analytic_Metrics",
 970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 971     "version": "0.0.0",
 972     "filename": "server/api/analyticMetric/index.js",
 973     "groupTitle": "Analytic_Metrics"
 974   },
 975   {
 976     "type": "put",
 977     "url": "/api/analytics/metrics/{id}",
 978     "title": "Update an existing Analytic Metrics",
 979     "examples": [
 980       {
 981         "title": "Example usage:",
 982         "content": "curl https://{domain}/api/analytics/metrics/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
 983         "type": "json"
 984       }
 985     ],
 986     "name": "updateAnalytic_Metric",
 987     "group": "Analytic_Metrics",
 988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
 989     "version": "0.0.0",
 990     "filename": "server/api/analyticMetric/index.js",
 991     "groupTitle": "Analytic_Metrics"
 992   },
 993   {
 994     "type": "post",
 995     "url": "/api/analytics/tree_reports",
 996     "title": "Creates a new Analytic Tree Report",
 997     "examples": [
 998       {
 999         "title": "Example usage:",
1000         "content": "curl https://{domain}/api/analytics/tree_reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1001         "type": "json"
1002       }
1003     ],
1004     "name": "CreateAnalytic_Tree_Reports",
1005     "group": "Analytic_Tree_Reports",
1006     "parameter": {
1007       "fields": {
1008         "Body": [
1009           {
1010             "group": "Body",
1011             "type": "Text",
1012             "optional": false,
1013             "field": "tree",
1014             "description": ""
1015           }
1016         ]
1017       }
1018     },
1019     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1020     "version": "0.0.0",
1021     "filename": "server/api/analyticTreeReport/index.js",
1022     "groupTitle": "Analytic_Tree_Reports"
1023   },
1024   {
1025     "type": "delete",
1026     "url": "/api/analytics/tree_reports/{id}",
1027     "title": "Deletes a Analytic Tree Report",
1028     "examples": [
1029       {
1030         "title": "Example usage:",
1031         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password} -X DELETE",
1032         "type": "json"
1033       }
1034     ],
1035     "name": "DeleteAnalytic_Tree_Reports",
1036     "group": "Analytic_Tree_Reports",
1037     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1038     "version": "0.0.0",
1039     "filename": "server/api/analyticTreeReport/index.js",
1040     "groupTitle": "Analytic_Tree_Reports"
1041   },
1042   {
1043     "type": "get",
1044     "url": "/api/analytics/tree_reports",
1045     "title": "Gets a list of Analytic Tree Reports",
1046     "examples": [
1047       {
1048         "title": "Example usage:",
1049         "content": "curl https://{domain}/api/analytics/tree_reports -v -u {name}:{password}",
1050         "type": "json"
1051       }
1052     ],
1053     "name": "GetAnalytic_Tree_Reports",
1054     "group": "Analytic_Tree_Reports",
1055     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/analytics/tree_reports?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/analytics/tree_reports?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/analytics/tree_reports?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/analytics/tree_reports?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/analytics/tree_reports?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1056     "version": "0.0.0",
1057     "filename": "server/api/analyticTreeReport/index.js",
1058     "groupTitle": "Analytic_Tree_Reports"
1059   },
1060   {
1061     "type": "get",
1062     "url": "/api/analytics/tree_reports/{id}",
1063     "title": "Gets a single Analytic Tree Report",
1064     "examples": [
1065       {
1066         "title": "Example usage:",
1067         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -v -u {name}:{password}",
1068         "type": "json"
1069       }
1070     ],
1071     "name": "ShowAnalytic_Tree_Reports",
1072     "group": "Analytic_Tree_Reports",
1073     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1074     "version": "0.0.0",
1075     "filename": "server/api/analyticTreeReport/index.js",
1076     "groupTitle": "Analytic_Tree_Reports"
1077   },
1078   {
1079     "type": "put",
1080     "url": "/api/analytics/tree_reports/{id}",
1081     "title": "Update an existing Analytic Tree Report",
1082     "examples": [
1083       {
1084         "title": "Example usage:",
1085         "content": "curl https://{domain}/api/analytics/tree_reports/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1086         "type": "json"
1087       }
1088     ],
1089     "name": "updateAnalytic_Tree_Reports",
1090     "group": "Analytic_Tree_Reports",
1091     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1092     "version": "0.0.0",
1093     "filename": "server/api/analyticTreeReport/index.js",
1094     "groupTitle": "Analytic_Tree_Reports"
1095   },
1096   {
1097     "type": "post",
1098     "url": "/api/attachments/clone",
1099     "title": "Clone an existing Attachment",
1100     "examples": [
1101       {
1102         "title": "Example usage:",
1103         "content": "curl https://{domain}/api/attachments/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1104         "type": "json"
1105       }
1106     ],
1107     "name": "CloneAttachments",
1108     "group": "Attachments",
1109     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1110     "version": "0.0.0",
1111     "filename": "server/api/attachment/index.js",
1112     "groupTitle": "Attachments"
1113   },
1114   {
1115     "type": "delete",
1116     "url": "/api/attachments/{id}",
1117     "title": "Deletes a Attachment",
1118     "examples": [
1119       {
1120         "title": "Example usage:",
1121         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password} -X DELETE",
1122         "type": "json"
1123       }
1124     ],
1125     "name": "DeleteAttachments",
1126     "group": "Attachments",
1127     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1128     "version": "0.0.0",
1129     "filename": "server/api/attachment/index.js",
1130     "groupTitle": "Attachments"
1131   },
1132   {
1133     "type": "get",
1134     "url": "/api/attachments",
1135     "title": "Gets a list of Attachments",
1136     "examples": [
1137       {
1138         "title": "Example usage:",
1139         "content": "curl https://{domain}/api/attachments -v -u {name}:{password}",
1140         "type": "json"
1141       }
1142     ],
1143     "name": "GetAttachments",
1144     "group": "Attachments",
1145     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/attachments?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/attachments?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/attachments?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/attachments?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/attachments?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1146     "version": "0.0.0",
1147     "filename": "server/api/attachment/index.js",
1148     "groupTitle": "Attachments"
1149   },
1150   {
1151     "type": "get",
1152     "url": "/api/attachments/{id}",
1153     "title": "Gets a single Attachment",
1154     "examples": [
1155       {
1156         "title": "Example usage:",
1157         "content": "curl https://{domain}/api/attachments/{id} -v -u {name}:{password}",
1158         "type": "json"
1159       }
1160     ],
1161     "name": "ShowAttachments",
1162     "group": "Attachments",
1163     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1164     "version": "0.0.0",
1165     "filename": "server/api/attachment/index.js",
1166     "groupTitle": "Attachments"
1167   },
1168   {
1169     "type": "post",
1170     "url": "/api/attachments",
1171     "title": "Add attachment",
1172     "examples": [
1173       {
1174         "title": "Example usage:",
1175         "content": "curl https://{domain}/api/attachments -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
1176         "type": "json"
1177       }
1178     ],
1179     "name": "create",
1180     "group": "Attachments",
1181     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1182     "version": "0.0.0",
1183     "filename": "server/api/attachment/index.js",
1184     "groupTitle": "Attachments"
1185   },
1186   {
1187     "type": "get",
1188     "url": "/api/attachments/:id/download",
1189     "title": "Download attachment",
1190     "examples": [
1191       {
1192         "title": "Example usage:",
1193         "content": "curl https://{domain}/api/attachments/:id/download -v -u {name}:{password} -X GET",
1194         "type": "json"
1195       }
1196     ],
1197     "name": "download",
1198     "group": "Attachments",
1199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1200     "version": "0.0.0",
1201     "filename": "server/api/attachment/index.js",
1202     "groupTitle": "Attachments"
1203   },
1204   {
1205     "type": "get",
1206     "url": "/api/chat/interactions/{id}/attachment_download",
1207     "title": "Download attachment",
1208     "examples": [
1209       {
1210         "title": "Example usage:",
1211         "content": "curl https://{domain}/api/chat/interactions/{id}/attachment_download -v -u {name}:{password} -X GET",
1212         "type": "json"
1213       }
1214     ],
1215     "name": "show",
1216     "group": "Attachments",
1217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1218     "version": "0.0.0",
1219     "filename": "server/api/chatInteraction/index.js",
1220     "groupTitle": "Attachments"
1221   },
1222   {
1223     "type": "put",
1224     "url": "/api/attachments/{id}",
1225     "title": "Update an existing Attachment",
1226     "examples": [
1227       {
1228         "title": "Example usage:",
1229         "content": "curl https://{domain}/api/attachments/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1230         "type": "json"
1231       }
1232     ],
1233     "name": "updateAttachments",
1234     "group": "Attachments",
1235     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1236     "version": "0.0.0",
1237     "filename": "server/api/attachment/index.js",
1238     "groupTitle": "Attachments"
1239   },
1240   {
1241     "type": "post",
1242     "url": "/api/auth/local/forgot",
1243     "title": "Creates a new password reset token",
1244     "examples": [
1245       {
1246         "title": "Example usage:",
1247         "content": "curl https://{domain}/api/auth/local/forgot -d '{\"email\": \"john.doe@xcally.com\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1248         "type": "json"
1249       }
1250     ],
1251     "name": "Local_Forgot_Password",
1252     "group": "Authentication",
1253     "parameter": {
1254       "fields": {
1255         "Body": [
1256           {
1257             "group": "Body",
1258             "type": "String",
1259             "optional": false,
1260             "field": "email",
1261             "description": ""
1262           }
1263         ]
1264       }
1265     },
1266     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1267     "version": "0.0.0",
1268     "filename": "server/api/authLocal/index.js",
1269     "groupTitle": "Authentication"
1270   },
1271   {
1272     "type": "post",
1273     "url": "/api/auth/local/reset/:token",
1274     "title": "Reset user password",
1275     "examples": [
1276       {
1277         "title": "Example usage:",
1278         "content": "curl https://{domain}/api/auth/local/reset/94b422c1fkdjhg766a198da6997yu6gcc963641d -d '{\"password\": \"My_newP@ssw0rd\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1279         "type": "json"
1280       }
1281     ],
1282     "name": "Local_Reset_Password",
1283     "group": "Authentication",
1284     "parameter": {
1285       "fields": {
1286         "Body": [
1287           {
1288             "group": "Body",
1289             "type": "String",
1290             "optional": false,
1291             "field": "password",
1292             "description": ""
1293           }
1294         ]
1295       }
1296     },
1297     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1298     "version": "0.0.0",
1299     "filename": "server/api/authLocal/index.js",
1300     "groupTitle": "Authentication"
1301   },
1302   {
1303     "type": "post",
1304     "url": "/api/auth/local",
1305     "title": "Creates a new User token",
1306     "examples": [
1307       {
1308         "title": "Example usage:",
1309         "content": "curl https://{domain}/api/auth/local -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1310         "type": "json"
1311       }
1312     ],
1313     "name": "Local_login",
1314     "group": "Authentication",
1315     "parameter": {
1316       "fields": {
1317         "Body": [
1318           {
1319             "group": "Body",
1320             "type": "String",
1321             "optional": false,
1322             "field": "name",
1323             "description": ""
1324           },
1325           {
1326             "group": "Body",
1327             "type": "String",
1328             "optional": false,
1329             "field": "password",
1330             "description": ""
1331           }
1332         ]
1333       }
1334     },
1335     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1336     "version": "0.0.0",
1337     "filename": "server/api/authLocal/index.js",
1338     "groupTitle": "Authentication"
1339   },
1340   {
1341     "type": "post",
1342     "url": "/api/auth/google",
1343     "title": "Creates a new User token",
1344     "examples": [
1345       {
1346         "title": "Example usage:",
1347         "content": "curl https://{domain}/api/auth/google -d '{\"name\": \"john.doe\", \"password\": \"password\"}' \\\n -H \"Content-Type: application/json\" -X POST",
1348         "type": "json"
1349       }
1350     ],
1351     "name": "Local_login",
1352     "group": "Authentication",
1353     "parameter": {
1354       "fields": {
1355         "Body": [
1356           {
1357             "group": "Body",
1358             "type": "String",
1359             "optional": false,
1360             "field": "name",
1361             "description": ""
1362           },
1363           {
1364             "group": "Body",
1365             "type": "String",
1366             "optional": false,
1367             "field": "password",
1368             "description": ""
1369           }
1370         ]
1371       }
1372     },
1373     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1374     "version": "0.0.0",
1375     "filename": "server/api/authGoogle/index.js",
1376     "groupTitle": "Authentication"
1377   },
1378   {
1379     "type": "post",
1380     "url": "/api/automations",
1381     "title": "Creates a new Automation",
1382     "examples": [
1383       {
1384         "title": "Example usage:",
1385         "content": "curl https://{domain}/api/automations -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1386         "type": "json"
1387       }
1388     ],
1389     "name": "CreateAutomations",
1390     "group": "Automations",
1391     "parameter": {
1392       "fields": {
1393         "Body": [
1394           {
1395             "group": "Body",
1396             "type": "String",
1397             "optional": false,
1398             "field": "name",
1399             "description": ""
1400           },
1401           {
1402             "group": "Body",
1403             "type": "String",
1404             "optional": true,
1405             "field": "channel",
1406             "description": ""
1407           },
1408           {
1409             "group": "Body",
1410             "type": "String",
1411             "optional": true,
1412             "field": "description",
1413             "description": ""
1414           },
1415           {
1416             "group": "Body",
1417             "type": "Boolean",
1418             "optional": true,
1419             "field": "status",
1420             "description": ""
1421           },
1422           {
1423             "group": "Body",
1424             "type": "Integer",
1425             "optional": true,
1426             "field": "timeout",
1427             "description": ""
1428           }
1429         ]
1430       }
1431     },
1432     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1433     "version": "0.0.0",
1434     "filename": "server/api/automation/index.js",
1435     "groupTitle": "Automations"
1436   },
1437   {
1438     "type": "delete",
1439     "url": "/api/automations/{id}",
1440     "title": "Deletes a Automation",
1441     "examples": [
1442       {
1443         "title": "Example usage:",
1444         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password} -X DELETE",
1445         "type": "json"
1446       }
1447     ],
1448     "name": "DeleteAutomations",
1449     "group": "Automations",
1450     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1451     "version": "0.0.0",
1452     "filename": "server/api/automation/index.js",
1453     "groupTitle": "Automations"
1454   },
1455   {
1456     "type": "get",
1457     "url": "/api/automations",
1458     "title": "Gets a list of Automations",
1459     "examples": [
1460       {
1461         "title": "Example usage:",
1462         "content": "curl https://{domain}/api/automations -v -u {name}:{password}",
1463         "type": "json"
1464       }
1465     ],
1466     "name": "GetAutomations",
1467     "group": "Automations",
1468     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/automations?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/automations?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/automations?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/automations?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/automations?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1469     "version": "0.0.0",
1470     "filename": "server/api/automation/index.js",
1471     "groupTitle": "Automations"
1472   },
1473   {
1474     "type": "get",
1475     "url": "/api/automations/{id}",
1476     "title": "Gets a single Automation",
1477     "examples": [
1478       {
1479         "title": "Example usage:",
1480         "content": "curl https://{domain}/api/automations/{id} -v -u {name}:{password}",
1481         "type": "json"
1482       }
1483     ],
1484     "name": "ShowAutomations",
1485     "group": "Automations",
1486     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1487     "version": "0.0.0",
1488     "filename": "server/api/automation/index.js",
1489     "groupTitle": "Automations"
1490   },
1491   {
1492     "type": "post",
1493     "url": "/api/automations/{id}/actions",
1494     "title": "Creates new actions",
1495     "examples": [
1496       {
1497         "title": "Example usage:",
1498         "content": "curl https://{domain}/api/automations/{id}/actions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1499         "type": "json"
1500       }
1501     ],
1502     "name": "addActions",
1503     "group": "Automations",
1504     "parameter": {
1505       "fields": {
1506         "Body": [
1507           {
1508             "group": "Body",
1509             "type": "Virtual",
1510             "optional": true,
1511             "field": "name",
1512             "description": ""
1513           },
1514           {
1515             "group": "Body",
1516             "type": "String",
1517             "optional": false,
1518             "field": "action",
1519             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
1520           },
1521           {
1522             "group": "Body",
1523             "type": "String",
1524             "optional": true,
1525             "field": "data1",
1526             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
1527           },
1528           {
1529             "group": "Body",
1530             "type": "String",
1531             "optional": true,
1532             "field": "data2",
1533             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
1534           },
1535           {
1536             "group": "Body",
1537             "type": "String",
1538             "optional": true,
1539             "field": "data3",
1540             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
1541           },
1542           {
1543             "group": "Body",
1544             "type": "String",
1545             "optional": true,
1546             "field": "data4",
1547             "description": ""
1548           },
1549           {
1550             "group": "Body",
1551             "type": "String",
1552             "optional": true,
1553             "field": "data5",
1554             "description": ""
1555           },
1556           {
1557             "group": "Body",
1558             "type": "String",
1559             "optional": true,
1560             "field": "data6",
1561             "description": ""
1562           },
1563           {
1564             "group": "Body",
1565             "type": "Text",
1566             "optional": true,
1567             "field": "data7",
1568             "description": ""
1569           }
1570         ]
1571       }
1572     },
1573     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1574     "version": "0.0.0",
1575     "filename": "server/api/automation/index.js",
1576     "groupTitle": "Automations"
1577   },
1578   {
1579     "type": "post",
1580     "url": "/api/automations/{id}/conditions",
1581     "title": "Creates new conditions",
1582     "examples": [
1583       {
1584         "title": "Example usage:",
1585         "content": "curl https://{domain}/api/automations/{id}/conditions -d '[{\"firstName\": \"John Doe\", \"email\": \"john.doe@xcally.com\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1586         "type": "json"
1587       }
1588     ],
1589     "name": "addConditions",
1590     "group": "Automations",
1591     "parameter": {
1592       "fields": {
1593         "Body": [
1594           {
1595             "group": "Body",
1596             "type": "Virtual",
1597             "optional": true,
1598             "field": "name",
1599             "description": ""
1600           },
1601           {
1602             "group": "Body",
1603             "type": "String",
1604             "optional": false,
1605             "field": "field",
1606             "description": ""
1607           },
1608           {
1609             "group": "Body",
1610             "type": "String",
1611             "optional": false,
1612             "field": "operator",
1613             "description": ""
1614           },
1615           {
1616             "group": "Body",
1617             "type": "String",
1618             "optional": false,
1619             "field": "value",
1620             "description": ""
1621           }
1622         ]
1623       }
1624     },
1625     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1626     "version": "0.0.0",
1627     "filename": "server/api/automation/index.js",
1628     "groupTitle": "Automations"
1629   },
1630   {
1631     "type": "get",
1632     "url": "/api/automations/{id}/actions",
1633     "title": "Gets Automation Actions",
1634     "examples": [
1635       {
1636         "title": "Example usage:",
1637         "content": "curl https://{domain}/api/automations/{id}/actions -v -u {name}:{password} -X GET",
1638         "type": "json"
1639       }
1640     ],
1641     "name": "getActions",
1642     "group": "Automations",
1643     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1644     "version": "0.0.0",
1645     "filename": "server/api/automation/index.js",
1646     "groupTitle": "Automations"
1647   },
1648   {
1649     "type": "get",
1650     "url": "/api/automations/{id}/conditions",
1651     "title": "Gets Automation Conditions",
1652     "examples": [
1653       {
1654         "title": "Example usage:",
1655         "content": "curl https://{domain}/api/automations/{id}/conditions -v -u {name}:{password} -X GET",
1656         "type": "json"
1657       }
1658     ],
1659     "name": "getConditions",
1660     "group": "Automations",
1661     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1662     "version": "0.0.0",
1663     "filename": "server/api/automation/index.js",
1664     "groupTitle": "Automations"
1665   },
1666   {
1667     "type": "put",
1668     "url": "/api/automations/{id}",
1669     "title": "Update an existing Automation",
1670     "examples": [
1671       {
1672         "title": "Example usage:",
1673         "content": "curl https://{domain}/api/automations/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1674         "type": "json"
1675       }
1676     ],
1677     "name": "updateAutomations",
1678     "group": "Automations",
1679     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1680     "version": "0.0.0",
1681     "filename": "server/api/automation/index.js",
1682     "groupTitle": "Automations"
1683   },
1684   {
1685     "type": "post",
1686     "url": "/api/canned_answers",
1687     "title": "Create a new canned answer",
1688     "examples": [
1689       {
1690         "title": "Example usage:",
1691         "content": "curl https://{domain}/api/canned_answers -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1692         "type": "json"
1693       }
1694     ],
1695     "name": "Create",
1696     "group": "Canned_Answers",
1697     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1698     "version": "0.0.0",
1699     "filename": "server/api/cannedAnswer/index.js",
1700     "groupTitle": "Canned_Answers"
1701   },
1702   {
1703     "type": "delete",
1704     "url": "/api/canned_answers/{id}",
1705     "title": "Deletes a Canned Answer",
1706     "examples": [
1707       {
1708         "title": "Example usage:",
1709         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password} -X DELETE",
1710         "type": "json"
1711       }
1712     ],
1713     "name": "DeleteCanned_Answers",
1714     "group": "Canned_Answers",
1715     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1716     "version": "0.0.0",
1717     "filename": "server/api/cannedAnswer/index.js",
1718     "groupTitle": "Canned_Answers"
1719   },
1720   {
1721     "type": "get",
1722     "url": "/api/canned_answers",
1723     "title": "Gets a list of Canned Answers",
1724     "examples": [
1725       {
1726         "title": "Example usage:",
1727         "content": "curl https://{domain}/api/canned_answers -v -u {name}:{password}",
1728         "type": "json"
1729       }
1730     ],
1731     "name": "GetCanned_Answers",
1732     "group": "Canned_Answers",
1733     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/canned_answers?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/canned_answers?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/canned_answers?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/canned_answers?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/canned_answers?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1734     "version": "0.0.0",
1735     "filename": "server/api/cannedAnswer/index.js",
1736     "groupTitle": "Canned_Answers"
1737   },
1738   {
1739     "type": "get",
1740     "url": "/api/canned_answers/{id}",
1741     "title": "Gets a single Canned Answer",
1742     "examples": [
1743       {
1744         "title": "Example usage:",
1745         "content": "curl https://{domain}/api/canned_answers/{id} -v -u {name}:{password}",
1746         "type": "json"
1747       }
1748     ],
1749     "name": "ShowCanned_Answers",
1750     "group": "Canned_Answers",
1751     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1752     "version": "0.0.0",
1753     "filename": "server/api/cannedAnswer/index.js",
1754     "groupTitle": "Canned_Answers"
1755   },
1756   {
1757     "type": "put",
1758     "url": "/api/canned_answers/{id}",
1759     "title": "Update an existing Canned Answer",
1760     "examples": [
1761       {
1762         "title": "Example usage:",
1763         "content": "curl https://{domain}/api/canned_answers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1764         "type": "json"
1765       }
1766     ],
1767     "name": "updateCanned_Answers",
1768     "group": "Canned_Answers",
1769     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1770     "version": "0.0.0",
1771     "filename": "server/api/cannedAnswer/index.js",
1772     "groupTitle": "Canned_Answers"
1773   },
1774   {
1775     "type": "get",
1776     "url": "/chat/internal/users",
1777     "title": "Gets Users Last Messages",
1778     "examples": [
1779       {
1780         "title": "Example usage:",
1781         "content": "curl https://{domain}/chat/internal/users -v -u {name}:{password}  -X GET",
1782         "type": "json"
1783       }
1784     ],
1785     "name": "getLastUsersMessages",
1786     "group": "ChatInternalMessage",
1787     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1788     "version": "0.0.0",
1789     "filename": "server/api/chatInternalMessage/index.js",
1790     "groupTitle": "ChatInternalMessage"
1791   },
1792   {
1793     "type": "delete",
1794     "url": "/api/chat/applications/{id}",
1795     "title": "Deletes a Application",
1796     "examples": [
1797       {
1798         "title": "Example usage:",
1799         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password} -X DELETE",
1800         "type": "json"
1801       }
1802     ],
1803     "name": "DeleteApplications",
1804     "group": "Chat_Applications",
1805     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1806     "version": "0.0.0",
1807     "filename": "server/api/chatApplication/index.js",
1808     "groupTitle": "Chat_Applications"
1809   },
1810   {
1811     "type": "get",
1812     "url": "/api/chat/applications/{id}",
1813     "title": "Gets a single Application",
1814     "examples": [
1815       {
1816         "title": "Example usage:",
1817         "content": "curl https://{domain}/api/chat/applications/{id} -v -u {name}:{password}",
1818         "type": "json"
1819       }
1820     ],
1821     "name": "ShowApplications",
1822     "group": "Chat_Applications",
1823     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1824     "version": "0.0.0",
1825     "filename": "server/api/chatApplication/index.js",
1826     "groupTitle": "Chat_Applications"
1827   },
1828   {
1829     "type": "put",
1830     "url": "/api/chat/applications/{id}",
1831     "title": "Update an existing Application",
1832     "examples": [
1833       {
1834         "title": "Example usage:",
1835         "content": "curl https://{domain}/api/chat/applications/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
1836         "type": "json"
1837       }
1838     ],
1839     "name": "updateApplications",
1840     "group": "Chat_Applications",
1841     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1842     "version": "0.0.0",
1843     "filename": "server/api/chatApplication/index.js",
1844     "groupTitle": "Chat_Applications"
1845   },
1846   {
1847     "type": "post",
1848     "url": "/api/chat/groups",
1849     "title": "Creates a new Group",
1850     "examples": [
1851       {
1852         "title": "Example usage:",
1853         "content": "curl https://{domain}/api/chat/groups -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
1854         "type": "json"
1855       }
1856     ],
1857     "name": "CreateGroups",
1858     "group": "Chat_Groups",
1859     "parameter": {
1860       "fields": {
1861         "Body": [
1862           {
1863             "group": "Body",
1864             "type": "String",
1865             "optional": false,
1866             "field": "name",
1867             "description": ""
1868           },
1869           {
1870             "group": "Body",
1871             "type": "String",
1872             "optional": true,
1873             "field": "description",
1874             "description": ""
1875           },
1876           {
1877             "group": "Body",
1878             "type": "Boolean",
1879             "optional": true,
1880             "field": "write",
1881             "description": ""
1882           }
1883         ]
1884       }
1885     },
1886     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1887     "version": "0.0.0",
1888     "filename": "server/api/chatGroup/index.js",
1889     "groupTitle": "Chat_Groups"
1890   },
1891   {
1892     "type": "delete",
1893     "url": "/api/chat/groups/{id}",
1894     "title": "Deletes a Group",
1895     "examples": [
1896       {
1897         "title": "Example usage:",
1898         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password} -X DELETE",
1899         "type": "json"
1900       }
1901     ],
1902     "name": "DeleteGroups",
1903     "group": "Chat_Groups",
1904     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1905     "version": "0.0.0",
1906     "filename": "server/api/chatGroup/index.js",
1907     "groupTitle": "Chat_Groups"
1908   },
1909   {
1910     "type": "get",
1911     "url": "/api/chat/groups/describe",
1912     "title": "Gets table info about Groups",
1913     "examples": [
1914       {
1915         "title": "Example usage:",
1916         "content": "curl https://{domain}/api/chat/groups/describe -v -u {name}:{password}",
1917         "type": "json"
1918       }
1919     ],
1920     "name": "DescribeGroups",
1921     "group": "Chat_Groups",
1922     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1923     "version": "0.0.0",
1924     "filename": "server/api/chatGroup/index.js",
1925     "groupTitle": "Chat_Groups"
1926   },
1927   {
1928     "type": "get",
1929     "url": "/api/chat/groups",
1930     "title": "Gets a list of Groups",
1931     "examples": [
1932       {
1933         "title": "Example usage:",
1934         "content": "curl https://{domain}/api/chat/groups -v -u {name}:{password}",
1935         "type": "json"
1936       }
1937     ],
1938     "name": "GetGroups",
1939     "group": "Chat_Groups",
1940     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/groups?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/groups?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/groups?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/groups?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/groups?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
1941     "version": "0.0.0",
1942     "filename": "server/api/chatGroup/index.js",
1943     "groupTitle": "Chat_Groups"
1944   },
1945   {
1946     "type": "delete",
1947     "url": "/api/chat/groups/{id}/members",
1948     "title": "Removes members from a group",
1949     "examples": [
1950       {
1951         "title": "Example usage:",
1952         "content": "curl https://{domain}/api/chat/groups/{id}/members?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
1953         "type": "json"
1954       }
1955     ],
1956     "name": "RemoveMembers",
1957     "group": "Chat_Groups",
1958     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1959     "version": "0.0.0",
1960     "filename": "server/api/chatGroup/index.js",
1961     "groupTitle": "Chat_Groups"
1962   },
1963   {
1964     "type": "get",
1965     "url": "/api/chat/groups/{id}",
1966     "title": "Gets a single Group",
1967     "examples": [
1968       {
1969         "title": "Example usage:",
1970         "content": "curl https://{domain}/api/chat/groups/{id} -v -u {name}:{password}",
1971         "type": "json"
1972       }
1973     ],
1974     "name": "ShowGroups",
1975     "group": "Chat_Groups",
1976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1977     "version": "0.0.0",
1978     "filename": "server/api/chatGroup/index.js",
1979     "groupTitle": "Chat_Groups"
1980   },
1981   {
1982     "type": "post",
1983     "url": "/api/chat/groups/{id}/members",
1984     "title": "Add members to chat group",
1985     "examples": [
1986       {
1987         "title": "Example usage:",
1988         "content": "curl https://{domain}/api/chat/groups/{id}/members -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
1989         "type": "json"
1990       }
1991     ],
1992     "name": "addMembers",
1993     "group": "Chat_Groups",
1994     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
1995     "version": "0.0.0",
1996     "filename": "server/api/chatGroup/index.js",
1997     "groupTitle": "Chat_Groups"
1998   },
1999   {
2000     "type": "post",
2001     "url": "/api/chat/groups/{id}/messages",
2002     "title": "Creates a new group message",
2003     "examples": [
2004       {
2005         "title": "Example usage:",
2006         "content": "curl https://{domain}/api/chat/groups/{id}/messages -d '{\"body\": \"Hi operator!\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2007         "type": "json"
2008       }
2009     ],
2010     "name": "addMessage",
2011     "group": "Chat_Groups",
2012     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2013     "version": "0.0.0",
2014     "filename": "server/api/chatGroup/index.js",
2015     "groupTitle": "Chat_Groups"
2016   },
2017   {
2018     "type": "get",
2019     "url": "/api/chat/groups/{id}/members",
2020     "title": "Gets Members",
2021     "examples": [
2022       {
2023         "title": "Example usage:",
2024         "content": "curl https://{domain}/api/chat/groups/{id}/members -v -u {name}:{password} -X GET",
2025         "type": "json"
2026       }
2027     ],
2028     "name": "getMembers",
2029     "group": "Chat_Groups",
2030     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2031     "version": "0.0.0",
2032     "filename": "server/api/chatGroup/index.js",
2033     "groupTitle": "Chat_Groups"
2034   },
2035   {
2036     "type": "get",
2037     "url": "/api/chat/groups/{id}/messages",
2038     "title": "Gets Messages",
2039     "examples": [
2040       {
2041         "title": "Example usage:",
2042         "content": "curl https://{domain}/api/chat/groups/{id}/messages -v -u {name}:{password} -X GET",
2043         "type": "json"
2044       }
2045     ],
2046     "name": "getMessages",
2047     "group": "Chat_Groups",
2048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2049     "version": "0.0.0",
2050     "filename": "server/api/chatGroup/index.js",
2051     "groupTitle": "Chat_Groups"
2052   },
2053   {
2054     "type": "get",
2055     "url": "/api/chat/groups/{id}/unread",
2056     "title": "Get unread chat group messages",
2057     "examples": [
2058       {
2059         "title": "Example usage:",
2060         "content": "curl https://{domain}/api/chat/groups/{id}/unread -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
2061         "type": "json"
2062       }
2063     ],
2064     "name": "getUread",
2065     "group": "Chat_Groups",
2066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2067     "version": "0.0.0",
2068     "filename": "server/api/chatGroup/index.js",
2069     "groupTitle": "Chat_Groups"
2070   },
2071   {
2072     "type": "put",
2073     "url": "/api/chat/groups/{id}",
2074     "title": "Update an existing Group",
2075     "examples": [
2076       {
2077         "title": "Example usage:",
2078         "content": "curl https://{domain}/api/chat/groups/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
2079         "type": "json"
2080       }
2081     ],
2082     "name": "updateGroups",
2083     "group": "Chat_Groups",
2084     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2085     "version": "0.0.0",
2086     "filename": "server/api/chatGroup/index.js",
2087     "groupTitle": "Chat_Groups"
2088   },
2089   {
2090     "type": "post",
2091     "url": "/api/chat/interactions/{id}/tags",
2092     "title": "Add tags to the interaction",
2093     "examples": [
2094       {
2095         "title": "Example usage:",
2096         "content": "curl https://{domain}/api/chat/interaction/{id}/tags -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2097         "type": "json"
2098       }
2099     ],
2100     "name": "AddTags",
2101     "group": "Chat_Interactions",
2102     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2103     "version": "0.0.0",
2104     "filename": "server/api/chatInteraction/index.js",
2105     "groupTitle": "Chat_Interactions"
2106   },
2107   {
2108     "type": "post",
2109     "url": "/api/chat/interactions",
2110     "title": "Creates a new Interaction",
2111     "examples": [
2112       {
2113         "title": "Example usage:",
2114         "content": "curl https://{domain}/api/chat/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2115         "type": "json"
2116       }
2117     ],
2118     "name": "CreateInteractions",
2119     "group": "Chat_Interactions",
2120     "parameter": {
2121       "fields": {
2122         "Body": [
2123           {
2124             "group": "Body",
2125             "type": "Boolean",
2126             "optional": true,
2127             "field": "closed",
2128             "description": ""
2129           },
2130           {
2131             "group": "Body",
2132             "type": "Integer",
2133             "optional": true,
2134             "field": "ratingValue",
2135             "description": ""
2136           },
2137           {
2138             "group": "Body",
2139             "type": "String",
2140             "allowedValues": [
2141               "\"star\"",
2142               "\"thumb\""
2143             ],
2144             "optional": true,
2145             "field": "ratingType",
2146             "description": ""
2147           },
2148           {
2149             "group": "Body",
2150             "type": "Text",
2151             "optional": true,
2152             "field": "ratingMessage",
2153             "description": ""
2154           },
2155           {
2156             "group": "Body",
2157             "type": "Text",
2158             "optional": true,
2159             "field": "pathTranscript",
2160             "description": ""
2161           },
2162           {
2163             "group": "Body",
2164             "type": "String",
2165             "optional": true,
2166             "field": "mailTranscript",
2167             "description": ""
2168           },
2169           {
2170             "group": "Body",
2171             "type": "String",
2172             "optional": true,
2173             "field": "closedAt",
2174             "description": ""
2175           },
2176           {
2177             "group": "Body",
2178             "type": "String",
2179             "optional": true,
2180             "field": "disposition",
2181             "description": ""
2182           },
2183           {
2184             "group": "Body",
2185             "type": "String",
2186             "optional": true,
2187             "field": "secondDisposition",
2188             "description": ""
2189           },
2190           {
2191             "group": "Body",
2192             "type": "String",
2193             "optional": true,
2194             "field": "thirdDisposition",
2195             "description": ""
2196           },
2197           {
2198             "group": "Body",
2199             "type": "String",
2200             "optional": true,
2201             "field": "note",
2202             "description": ""
2203           },
2204           {
2205             "group": "Body",
2206             "type": "String",
2207             "optional": true,
2208             "field": "browserName",
2209             "description": ""
2210           },
2211           {
2212             "group": "Body",
2213             "type": "String",
2214             "optional": true,
2215             "field": "browserVersion",
2216             "description": ""
2217           },
2218           {
2219             "group": "Body",
2220             "type": "String",
2221             "optional": true,
2222             "field": "osName",
2223             "description": ""
2224           },
2225           {
2226             "group": "Body",
2227             "type": "String",
2228             "optional": true,
2229             "field": "osVersion",
2230             "description": ""
2231           },
2232           {
2233             "group": "Body",
2234             "type": "String",
2235             "optional": true,
2236             "field": "deviceModel",
2237             "description": ""
2238           },
2239           {
2240             "group": "Body",
2241             "type": "String",
2242             "optional": true,
2243             "field": "deviceVendor",
2244             "description": ""
2245           },
2246           {
2247             "group": "Body",
2248             "type": "String",
2249             "optional": true,
2250             "field": "deviceType",
2251             "description": ""
2252           },
2253           {
2254             "group": "Body",
2255             "type": "Text",
2256             "optional": true,
2257             "field": "referer",
2258             "description": ""
2259           },
2260           {
2261             "group": "Body",
2262             "type": "String",
2263             "optional": true,
2264             "field": "customerIp",
2265             "description": ""
2266           },
2267           {
2268             "group": "Body",
2269             "type": "Text",
2270             "optional": true,
2271             "field": "formData",
2272             "description": ""
2273           },
2274           {
2275             "group": "Body",
2276             "type": "String",
2277             "optional": true,
2278             "field": "read1stAt",
2279             "description": ""
2280           },
2281           {
2282             "group": "Body",
2283             "type": "String",
2284             "optional": true,
2285             "field": "lastMsgAt",
2286             "description": ""
2287           },
2288           {
2289             "group": "Body",
2290             "type": "String",
2291             "allowedValues": [
2292               "\"in\"",
2293               "\"out\""
2294             ],
2295             "optional": false,
2296             "field": "lastMsgDirection",
2297             "description": ""
2298           },
2299           {
2300             "group": "Body",
2301             "type": "String",
2302             "optional": true,
2303             "field": "closeReason",
2304             "description": ""
2305           },
2306           {
2307             "group": "Body",
2308             "type": "String",
2309             "optional": true,
2310             "field": "customerPort",
2311             "description": ""
2312           },
2313           {
2314             "group": "Body",
2315             "type": "Text",
2316             "optional": true,
2317             "field": "vidaooSessionId",
2318             "description": ""
2319           }
2320         ]
2321       }
2322     },
2323     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2324     "version": "0.0.0",
2325     "filename": "server/api/chatInteraction/index.js",
2326     "groupTitle": "Chat_Interactions"
2327   },
2328   {
2329     "type": "delete",
2330     "url": "/api/chat/interactions/{id}",
2331     "title": "Deletes a Interaction",
2332     "examples": [
2333       {
2334         "title": "Example usage:",
2335         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2336         "type": "json"
2337       }
2338     ],
2339     "name": "DeleteInteractions",
2340     "group": "Chat_Interactions",
2341     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2342     "version": "0.0.0",
2343     "filename": "server/api/chatInteraction/index.js",
2344     "groupTitle": "Chat_Interactions"
2345   },
2346   {
2347     "type": "get",
2348     "url": "/api/chat/interactions/describe",
2349     "title": "Gets table info about Interactions",
2350     "examples": [
2351       {
2352         "title": "Example usage:",
2353         "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2354         "type": "json"
2355       }
2356     ],
2357     "name": "DescribeInteractions",
2358     "group": "Chat_Interactions",
2359     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2360     "version": "0.0.0",
2361     "filename": "server/api/chatInteraction/index.js",
2362     "groupTitle": "Chat_Interactions"
2363   },
2364   {
2365     "type": "get",
2366     "url": "/api/chat/interactions",
2367     "title": "Gets a list of Interactions",
2368     "examples": [
2369       {
2370         "title": "Example usage:",
2371         "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2372         "type": "json"
2373       }
2374     ],
2375     "name": "GetInteractions",
2376     "group": "Chat_Interactions",
2377     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/chat/interactions?fields=id,name</code></p> <h2>Filtering</h2> <p>You can perform exact-match filtering on any of a model's fields by using the field name as the key and supplying it with a value. These parameters accept a comma-separated list.</p> <p>A call returning a result set for records with <code>name</code> of <code>john.doe</code> or <code>jane.miller</code>.</p> <p><code>GET /api/chat/interactions?name=john.doe,jane.miller</code></p> <p>If you use the key <code>filter</code> the result will be filtered by the value you specify.</p> <p><code>GET /api/chat/interactions?filter=john</code></p> <h2>Sorting</h2> <p>To sort a result set based on one or several fields you can utilize the <code>sort</code> parameter. This parameters accepts a comma-separated list.</p> <p>Results will be sorted in the order of the fields provided. The default sorting order for fields is ascending. Fields can be sorted in descending order by prefixing them with a dash (<code>-</code>).</p> <p>A call sorting a result by <code>id</code> ascending and then <code>name</code> descending would look like this.</p> <p><code>GET /api/chat/interactions?sort=id,-name</code></p> <h2>Offset and Limit</h2> <p>Query results are always paged. Motion leverages the <code>offset</code> and <code>limit</code> parameters to facilitate this.</p> <p>When the neither of these parameters are explicitly supplied the handler will assume the a default <code>limit</code> of <code>100</code>.</p> <p><code>offset</code> is a number indicating the start position in the result set you want to return.</p> <p><code>limit</code> is a number indicating how many records past the start position you want returned.</p> <p>A call with a result set starting at <code>5</code> and returning no more than <code>25</code> records would look like this.</p> <p><code>GET /api/chat/interactions?offset=5&amp;limit=25</code></p> <p>If there were <code>50</code> records in total, the returned <code>Content-Range</code> header would look like this.</p> <p><code>Content-Range: 5-30/50</code></p>",
2378     "version": "0.0.0",
2379     "filename": "server/api/chatInteraction/index.js",
2380     "groupTitle": "Chat_Interactions"
2381   },
2382   {
2383     "type": "delete",
2384     "url": "/api/chat/interactions/{id}/tags",
2385     "title": "Removes tags from interaction",
2386     "examples": [
2387       {
2388         "title": "Example usage:",
2389         "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2390         "type": "json"
2391       }
2392     ],
2393     "name": "RemoveTags",
2394     "group": "Chat_Interactions",
2395     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2396     "version": "0.0.0",
2397     "filename": "server/api/chatInteraction/index.js",
2398     "groupTitle": "Chat_Interactions"
2399   },
2400   {
2401     "type": "get",
2402     "url": "/api/chat/interactions/{id}",
2403     "title": "Gets a single Interaction",
2404     "examples": [
2405       {
2406         "title": "Example usage:",
2407         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2408         "type": "json"
2409       }
2410     ],
2411     "name": "ShowInteractions",
2412     "group": "Chat_Interactions",
2413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2414     "version": "0.0.0",
2415     "filename": "server/api/chatInteraction/index.js",
2416     "groupTitle": "Chat_Interactions"
2417   },
2418   {
2419     "type": "put",
2420     "url": "/api/chat/interactions/{id}/abandon",
2421     "title": "Abandon interaction",
2422     "examples": [
2423       {
2424         "title": "Example usage:",
2425         "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2426         "type": "json"
2427       }
2428     ],
2429     "name": "abandon",
2430     "group": "Chat_Interactions",
2431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <p>This API is used to set as abandon an interaction and stop the routing.</p>",
2432     "version": "0.0.0",
2433     "filename": "server/api/chatInteraction/index.js",
2434     "groupTitle": "Chat_Interactions"
2435   },
2436   {
2437     "type": "post",
2438     "url": "/api/chat/interactions/{id}/messages",
2439     "title": "Creates new messages",
2440     "examples": [
2441       {
2442         "title": "Example usage:",
2443         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2444         "type": "json"
2445       }
2446     ],
2447     "name": "addMessage",
2448     "group": "Chat_Interactions",
2449     "parameter": {
2450       "fields": {
2451         "Body": [
2452           {
2453             "group": "Body",
2454             "type": "Text",
2455             "optional": false,
2456             "field": "body",
2457             "description": ""
2458           },
2459           {
2460             "group": "Body",
2461             "type": "Boolean",
2462             "optional": true,
2463             "field": "read",
2464             "description": ""
2465           },
2466           {
2467             "group": "Body",
2468             "type": "Boolean",
2469             "optional": true,
2470             "field": "secret",
2471             "description": ""
2472           },
2473           {
2474             "group": "Body",
2475             "type": "String",
2476             "allowedValues": [
2477               "\"in\"",
2478               "\"out\""
2479             ],
2480             "optional": false,
2481             "field": "direction",
2482             "description": ""
2483           },
2484           {
2485             "group": "Body",
2486             "type": "String",
2487             "optional": true,
2488             "field": "readAt",
2489             "description": ""
2490           }
2491         ]
2492       }
2493     },
2494     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2495     "version": "0.0.0",
2496     "filename": "server/api/chatInteraction/index.js",
2497     "groupTitle": "Chat_Interactions"
2498   },
2499   {
2500     "type": "put",
2501     "url": "/api/chat/interactions/{id}/close",
2502     "title": "Close Interaction",
2503     "examples": [
2504       {
2505         "title": "Example usage:",
2506         "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2507         "type": "json"
2508       }
2509     ],
2510     "name": "addMessage",
2511     "group": "Chat_Interactions",
2512     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2513     "version": "0.0.0",
2514     "filename": "server/api/chatInteraction/index.js",
2515     "groupTitle": "Chat_Interactions"
2516   },
2517   {
2518     "type": "post",
2519     "url": "/api/chat/interactions/{id}/attachment_upload",
2520     "title": "Add attachment",
2521     "examples": [
2522       {
2523         "title": "Example usage:",
2524         "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",
2525         "type": "json"
2526       }
2527     ],
2528     "name": "attachmentUpload",
2529     "group": "Chat_Interactions",
2530     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2531     "version": "0.0.0",
2532     "filename": "server/api/chatInteraction/index.js",
2533     "groupTitle": "Chat_Interactions"
2534   },
2535   {
2536     "type": "post",
2537     "url": "/api/chat/interactions/{id}/vidaoo",
2538     "title": "Create Vidaoo Session",
2539     "examples": [
2540       {
2541         "title": "Example usage:",
2542         "content": "curl https://{domain}/api/chat/interactions/{id}/vidaoo  -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2543         "type": "json"
2544       }
2545     ],
2546     "name": "createVidaooSession",
2547     "group": "Chat_Interactions",
2548     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2549     "version": "0.0.0",
2550     "filename": "server/api/chatInteraction/index.js",
2551     "groupTitle": "Chat_Interactions"
2552   },
2553   {
2554     "type": "put",
2555     "url": "/api/chat/interactions/{id}/custom_update",
2556     "title": "Update interaction",
2557     "examples": [
2558       {
2559         "title": "Example usage:",
2560         "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",
2561         "type": "json"
2562       }
2563     ],
2564     "name": "customUpdate",
2565     "group": "Chat_Interactions",
2566     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2567     "version": "0.0.0",
2568     "filename": "server/api/chatInteraction/index.js",
2569     "groupTitle": "Chat_Interactions"
2570   },
2571   {
2572     "type": "get",
2573     "url": "/api/chat/interactions/{id}/download",
2574     "title": "Gets interaction",
2575     "examples": [
2576       {
2577         "title": "Example usage:",
2578         "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2579         "type": "json"
2580       }
2581     ],
2582     "name": "download",
2583     "group": "Chat_Interactions",
2584     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2585     "version": "0.0.0",
2586     "filename": "server/api/chatInteraction/index.js",
2587     "groupTitle": "Chat_Interactions"
2588   },
2589   {
2590     "type": "get",
2591     "url": "/api/chat/interactions/{id}/messages",
2592     "title": "Gets interaction messages",
2593     "examples": [
2594       {
2595         "title": "Example usage:",
2596         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2597         "type": "json"
2598       }
2599     ],
2600     "name": "getMessages",
2601     "group": "Chat_Interactions",
2602     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2603     "version": "0.0.0",
2604     "filename": "server/api/chatInteraction/index.js",
2605     "groupTitle": "Chat_Interactions"
2606   },
2607   {
2608     "type": "get",
2609     "url": "/api/chat/interactions/{id}/my_messages",
2610     "title": "Gets interaction messages",
2611     "examples": [
2612       {
2613         "title": "Example usage:",
2614         "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2615         "type": "json"
2616       }
2617     ],
2618     "name": "getMyMessages",
2619     "group": "Chat_Interactions",
2620     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2621     "version": "0.0.0",
2622     "filename": "server/api/chatInteraction/index.js",
2623     "groupTitle": "Chat_Interactions"
2624   },
2625   {
2626     "type": "put",
2627     "url": "/api/chat/interactions/{id}",
2628     "title": "Update an existing Interaction",
2629     "examples": [
2630       {
2631         "title": "Example usage:",
2632         "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",
2633         "type": "json"
2634       }
2635     ],
2636     "name": "updateInteractions",
2637     "group": "Chat_Interactions",
2638     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2639     "version": "0.0.0",
2640     "filename": "server/api/chatInteraction/index.js",
2641     "groupTitle": "Chat_Interactions"
2642   },
2643   {
2644     "type": "post",
2645     "url": "/api/chat/internal/messages",
2646     "title": "Creates a new Message",
2647     "examples": [
2648       {
2649         "title": "Example usage:",
2650         "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",
2651         "type": "json"
2652       }
2653     ],
2654     "name": "CreateMessages",
2655     "group": "Chat_Internal_Messages",
2656     "parameter": {
2657       "fields": {
2658         "Body": [
2659           {
2660             "group": "Body",
2661             "type": "Text",
2662             "optional": false,
2663             "field": "body",
2664             "description": ""
2665           },
2666           {
2667             "group": "Body",
2668             "type": "Boolean",
2669             "optional": true,
2670             "field": "read",
2671             "description": ""
2672           },
2673           {
2674             "group": "Body",
2675             "type": "Integer",
2676             "optional": true,
2677             "field": "ChatInternalMessageId",
2678             "description": ""
2679           }
2680         ]
2681       }
2682     },
2683     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2684     "version": "0.0.0",
2685     "filename": "server/api/chatInternalMessage/index.js",
2686     "groupTitle": "Chat_Internal_Messages"
2687   },
2688   {
2689     "type": "delete",
2690     "url": "/api/chat/internal/messages/{id}",
2691     "title": "Deletes a Message",
2692     "examples": [
2693       {
2694         "title": "Example usage:",
2695         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2696         "type": "json"
2697       }
2698     ],
2699     "name": "DeleteMessages",
2700     "group": "Chat_Internal_Messages",
2701     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2702     "version": "0.0.0",
2703     "filename": "server/api/chatInternalMessage/index.js",
2704     "groupTitle": "Chat_Internal_Messages"
2705   },
2706   {
2707     "type": "get",
2708     "url": "/api/chat/internal/messages/describe",
2709     "title": "Gets table info about Messages",
2710     "examples": [
2711       {
2712         "title": "Example usage:",
2713         "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2714         "type": "json"
2715       }
2716     ],
2717     "name": "DescribeMessages",
2718     "group": "Chat_Internal_Messages",
2719     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2720     "version": "0.0.0",
2721     "filename": "server/api/chatInternalMessage/index.js",
2722     "groupTitle": "Chat_Internal_Messages"
2723   },
2724   {
2725     "type": "get",
2726     "url": "/api/chat/internal/messages",
2727     "title": "Gets a list of Messages",
2728     "examples": [
2729       {
2730         "title": "Example usage:",
2731         "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2732         "type": "json"
2733       }
2734     ],
2735     "name": "GetMessages",
2736     "group": "Chat_Internal_Messages",
2737     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2738     "version": "0.0.0",
2739     "filename": "server/api/chatInternalMessage/index.js",
2740     "groupTitle": "Chat_Internal_Messages"
2741   },
2742   {
2743     "type": "get",
2744     "url": "/api/chat/internal/messages/{id}",
2745     "title": "Gets a single Message",
2746     "examples": [
2747       {
2748         "title": "Example usage:",
2749         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2750         "type": "json"
2751       }
2752     ],
2753     "name": "ShowMessages",
2754     "group": "Chat_Internal_Messages",
2755     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2756     "version": "0.0.0",
2757     "filename": "server/api/chatInternalMessage/index.js",
2758     "groupTitle": "Chat_Internal_Messages"
2759   },
2760   {
2761     "type": "put",
2762     "url": "/api/chat/internal/messages/{id}",
2763     "title": "Update an existing Message",
2764     "examples": [
2765       {
2766         "title": "Example usage:",
2767         "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",
2768         "type": "json"
2769       }
2770     ],
2771     "name": "updateMessages",
2772     "group": "Chat_Internal_Messages",
2773     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2774     "version": "0.0.0",
2775     "filename": "server/api/chatInternalMessage/index.js",
2776     "groupTitle": "Chat_Internal_Messages"
2777   },
2778   {
2779     "type": "post",
2780     "url": "/api/chat/messages",
2781     "title": "Creates a new Message",
2782     "examples": [
2783       {
2784         "title": "Example usage:",
2785         "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2786         "type": "json"
2787       }
2788     ],
2789     "name": "CreateMessages",
2790     "group": "Chat_Messages",
2791     "parameter": {
2792       "fields": {
2793         "Body": [
2794           {
2795             "group": "Body",
2796             "type": "Text",
2797             "optional": false,
2798             "field": "body",
2799             "description": ""
2800           },
2801           {
2802             "group": "Body",
2803             "type": "Boolean",
2804             "optional": true,
2805             "field": "read",
2806             "description": ""
2807           },
2808           {
2809             "group": "Body",
2810             "type": "Boolean",
2811             "optional": true,
2812             "field": "secret",
2813             "description": ""
2814           },
2815           {
2816             "group": "Body",
2817             "type": "String",
2818             "allowedValues": [
2819               "\"in\"",
2820               "\"out\""
2821             ],
2822             "optional": false,
2823             "field": "direction",
2824             "description": ""
2825           },
2826           {
2827             "group": "Body",
2828             "type": "String",
2829             "optional": true,
2830             "field": "readAt",
2831             "description": ""
2832           }
2833         ]
2834       }
2835     },
2836     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2837     "version": "0.0.0",
2838     "filename": "server/api/chatMessage/index.js",
2839     "groupTitle": "Chat_Messages"
2840   },
2841   {
2842     "type": "delete",
2843     "url": "/api/chat/messages/{id}",
2844     "title": "Deletes a Message",
2845     "examples": [
2846       {
2847         "title": "Example usage:",
2848         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2849         "type": "json"
2850       }
2851     ],
2852     "name": "DeleteMessages",
2853     "group": "Chat_Messages",
2854     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2855     "version": "0.0.0",
2856     "filename": "server/api/chatMessage/index.js",
2857     "groupTitle": "Chat_Messages"
2858   },
2859   {
2860     "type": "get",
2861     "url": "/api/chat/messages/describe",
2862     "title": "Gets table info about Messages",
2863     "examples": [
2864       {
2865         "title": "Example usage:",
2866         "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2867         "type": "json"
2868       }
2869     ],
2870     "name": "DescribeMessages",
2871     "group": "Chat_Messages",
2872     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2873     "version": "0.0.0",
2874     "filename": "server/api/chatMessage/index.js",
2875     "groupTitle": "Chat_Messages"
2876   },
2877   {
2878     "type": "get",
2879     "url": "/api/chat/messages",
2880     "title": "Gets a list of Messages",
2881     "examples": [
2882       {
2883         "title": "Example usage:",
2884         "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2885         "type": "json"
2886       }
2887     ],
2888     "name": "GetMessages",
2889     "group": "Chat_Messages",
2890     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2891     "version": "0.0.0",
2892     "filename": "server/api/chatMessage/index.js",
2893     "groupTitle": "Chat_Messages"
2894   },
2895   {
2896     "type": "get",
2897     "url": "/api/chat/messages/{id}",
2898     "title": "Gets a single Message",
2899     "examples": [
2900       {
2901         "title": "Example usage:",
2902         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2903         "type": "json"
2904       }
2905     ],
2906     "name": "ShowMessages",
2907     "group": "Chat_Messages",
2908     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2909     "version": "0.0.0",
2910     "filename": "server/api/chatMessage/index.js",
2911     "groupTitle": "Chat_Messages"
2912   },
2913   {
2914     "type": "put",
2915     "url": "/api/chat/messages/{id}",
2916     "title": "Update an existing Message",
2917     "examples": [
2918       {
2919         "title": "Example usage:",
2920         "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",
2921         "type": "json"
2922       }
2923     ],
2924     "name": "updateMessages",
2925     "group": "Chat_Messages",
2926     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2927     "version": "0.0.0",
2928     "filename": "server/api/chatMessage/index.js",
2929     "groupTitle": "Chat_Messages"
2930   },
2931   {
2932     "type": "post",
2933     "url": "/api/chat/offline_messages",
2934     "title": "Creates a new OfflineMessage",
2935     "examples": [
2936       {
2937         "title": "Example usage:",
2938         "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",
2939         "type": "json"
2940       }
2941     ],
2942     "name": "CreateOfflineMessages",
2943     "group": "Chat_Offline_Messages",
2944     "parameter": {
2945       "fields": {
2946         "Body": [
2947           {
2948             "group": "Body",
2949             "type": "Text",
2950             "optional": false,
2951             "field": "body",
2952             "description": ""
2953           }
2954         ]
2955       }
2956     },
2957     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2958     "version": "0.0.0",
2959     "filename": "server/api/chatOfflineMessage/index.js",
2960     "groupTitle": "Chat_Offline_Messages"
2961   },
2962   {
2963     "type": "delete",
2964     "url": "/api/chat/offline_messages/{id}",
2965     "title": "Deletes a OfflineMessage",
2966     "examples": [
2967       {
2968         "title": "Example usage:",
2969         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
2970         "type": "json"
2971       }
2972     ],
2973     "name": "DeleteOfflineMessages",
2974     "group": "Chat_Offline_Messages",
2975     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2976     "version": "0.0.0",
2977     "filename": "server/api/chatOfflineMessage/index.js",
2978     "groupTitle": "Chat_Offline_Messages"
2979   },
2980   {
2981     "type": "get",
2982     "url": "/api/chat/offline_messages/describe",
2983     "title": "Gets table info about OfflineMessages",
2984     "examples": [
2985       {
2986         "title": "Example usage:",
2987         "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
2988         "type": "json"
2989       }
2990     ],
2991     "name": "DescribeOfflineMessages",
2992     "group": "Chat_Offline_Messages",
2993     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2994     "version": "0.0.0",
2995     "filename": "server/api/chatOfflineMessage/index.js",
2996     "groupTitle": "Chat_Offline_Messages"
2997   },
2998   {
2999     "type": "get",
3000     "url": "/api/chat/offline_messages",
3001     "title": "Gets a list of OfflineMessages",
3002     "examples": [
3003       {
3004         "title": "Example usage:",
3005         "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
3006         "type": "json"
3007       }
3008     ],
3009     "name": "GetOfflineMessages",
3010     "group": "Chat_Offline_Messages",
3011     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3012     "version": "0.0.0",
3013     "filename": "server/api/chatOfflineMessage/index.js",
3014     "groupTitle": "Chat_Offline_Messages"
3015   },
3016   {
3017     "type": "get",
3018     "url": "/api/chat/offline_messages/{id}",
3019     "title": "Gets a single OfflineMessage",
3020     "examples": [
3021       {
3022         "title": "Example usage:",
3023         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
3024         "type": "json"
3025       }
3026     ],
3027     "name": "ShowOfflineMessages",
3028     "group": "Chat_Offline_Messages",
3029     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3030     "version": "0.0.0",
3031     "filename": "server/api/chatOfflineMessage/index.js",
3032     "groupTitle": "Chat_Offline_Messages"
3033   },
3034   {
3035     "type": "put",
3036     "url": "/api/chat/offline_messages/{id}",
3037     "title": "Update an existing OfflineMessage",
3038     "examples": [
3039       {
3040         "title": "Example usage:",
3041         "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",
3042         "type": "json"
3043       }
3044     ],
3045     "name": "updateOfflineMessages",
3046     "group": "Chat_Offline_Messages",
3047     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3048     "version": "0.0.0",
3049     "filename": "server/api/chatOfflineMessage/index.js",
3050     "groupTitle": "Chat_Offline_Messages"
3051   },
3052   {
3053     "type": "post",
3054     "url": "/api/chat/proactive_actions",
3055     "title": "Creates a new Proactive Action",
3056     "examples": [
3057       {
3058         "title": "Example usage:",
3059         "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",
3060         "type": "json"
3061       }
3062     ],
3063     "name": "CreateProactive_Actions",
3064     "group": "Chat_Proactive_Actions",
3065     "parameter": {
3066       "fields": {
3067         "Body": [
3068           {
3069             "group": "Body",
3070             "type": "String",
3071             "optional": false,
3072             "field": "name",
3073             "description": ""
3074           },
3075           {
3076             "group": "Body",
3077             "type": "String",
3078             "allowedValues": [
3079               "\"mouseOver\"",
3080               "\"timeout\""
3081             ],
3082             "optional": true,
3083             "field": "type",
3084             "description": ""
3085           },
3086           {
3087             "group": "Body",
3088             "type": "String",
3089             "optional": true,
3090             "field": "selector",
3091             "description": ""
3092           },
3093           {
3094             "group": "Body",
3095             "type": "Integer",
3096             "optional": true,
3097             "field": "timeout",
3098             "description": ""
3099           }
3100         ]
3101       }
3102     },
3103     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3104     "version": "0.0.0",
3105     "filename": "server/api/chatProactiveAction/index.js",
3106     "groupTitle": "Chat_Proactive_Actions"
3107   },
3108   {
3109     "type": "delete",
3110     "url": "/api/chat/proactive_actions/{id}",
3111     "title": "Deletes a Proactive Action",
3112     "examples": [
3113       {
3114         "title": "Example usage:",
3115         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3116         "type": "json"
3117       }
3118     ],
3119     "name": "DeleteProactive_Actions",
3120     "group": "Chat_Proactive_Actions",
3121     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3122     "version": "0.0.0",
3123     "filename": "server/api/chatProactiveAction/index.js",
3124     "groupTitle": "Chat_Proactive_Actions"
3125   },
3126   {
3127     "type": "get",
3128     "url": "/api/chat/proactive_actions/{id}",
3129     "title": "Gets a single Proactive Action",
3130     "examples": [
3131       {
3132         "title": "Example usage:",
3133         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3134         "type": "json"
3135       }
3136     ],
3137     "name": "ShowProactive_Actions",
3138     "group": "Chat_Proactive_Actions",
3139     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3140     "version": "0.0.0",
3141     "filename": "server/api/chatProactiveAction/index.js",
3142     "groupTitle": "Chat_Proactive_Actions"
3143   },
3144   {
3145     "type": "put",
3146     "url": "/api/chat/proactive_actions/{id}",
3147     "title": "Update an existing Proactive Action",
3148     "examples": [
3149       {
3150         "title": "Example usage:",
3151         "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",
3152         "type": "json"
3153       }
3154     ],
3155     "name": "updateProactive_Actions",
3156     "group": "Chat_Proactive_Actions",
3157     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3158     "version": "0.0.0",
3159     "filename": "server/api/chatProactiveAction/index.js",
3160     "groupTitle": "Chat_Proactive_Actions"
3161   },
3162   {
3163     "type": "post",
3164     "url": "/api/chat/reports/queue",
3165     "title": "Creates a new Chat Queue Report",
3166     "examples": [
3167       {
3168         "title": "Example usage:",
3169         "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",
3170         "type": "json"
3171       }
3172     ],
3173     "name": "CreateChat_Queue_Reports",
3174     "group": "Chat_Queue_Reports",
3175     "parameter": {
3176       "fields": {
3177         "Body": [
3178           {
3179             "group": "Body",
3180             "type": "String",
3181             "optional": false,
3182             "field": "uniqueid",
3183             "description": ""
3184           },
3185           {
3186             "group": "Body",
3187             "type": "String",
3188             "optional": true,
3189             "field": "from",
3190             "description": ""
3191           },
3192           {
3193             "group": "Body",
3194             "type": "String",
3195             "optional": true,
3196             "field": "joinAt",
3197             "description": ""
3198           },
3199           {
3200             "group": "Body",
3201             "type": "String",
3202             "optional": true,
3203             "field": "leaveAt",
3204             "description": ""
3205           },
3206           {
3207             "group": "Body",
3208             "type": "String",
3209             "optional": true,
3210             "field": "acceptAt",
3211             "description": ""
3212           },
3213           {
3214             "group": "Body",
3215             "type": "String",
3216             "optional": true,
3217             "field": "exitAt",
3218             "description": ""
3219           },
3220           {
3221             "group": "Body",
3222             "type": "String",
3223             "optional": true,
3224             "field": "reason",
3225             "description": ""
3226           }
3227         ]
3228       }
3229     },
3230     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3231     "version": "0.0.0",
3232     "filename": "server/api/chatQueueReport/index.js",
3233     "groupTitle": "Chat_Queue_Reports"
3234   },
3235   {
3236     "type": "delete",
3237     "url": "/api/chat/reports/queue/{id}",
3238     "title": "Deletes a Chat Queue Report",
3239     "examples": [
3240       {
3241         "title": "Example usage:",
3242         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3243         "type": "json"
3244       }
3245     ],
3246     "name": "DeleteChat_Queue_Reports",
3247     "group": "Chat_Queue_Reports",
3248     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3249     "version": "0.0.0",
3250     "filename": "server/api/chatQueueReport/index.js",
3251     "groupTitle": "Chat_Queue_Reports"
3252   },
3253   {
3254     "type": "get",
3255     "url": "/api/chat/reports/queue/describe",
3256     "title": "Gets table info about Chat Queue Reports",
3257     "examples": [
3258       {
3259         "title": "Example usage:",
3260         "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3261         "type": "json"
3262       }
3263     ],
3264     "name": "DescribeChat_Queue_Reports",
3265     "group": "Chat_Queue_Reports",
3266     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3267     "version": "0.0.0",
3268     "filename": "server/api/chatQueueReport/index.js",
3269     "groupTitle": "Chat_Queue_Reports"
3270   },
3271   {
3272     "type": "get",
3273     "url": "/api/chat/reports/queue",
3274     "title": "Gets a list of Chat Queue Reports",
3275     "examples": [
3276       {
3277         "title": "Example usage:",
3278         "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3279         "type": "json"
3280       }
3281     ],
3282     "name": "GetChat_Queue_Reports",
3283     "group": "Chat_Queue_Reports",
3284     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3285     "version": "0.0.0",
3286     "filename": "server/api/chatQueueReport/index.js",
3287     "groupTitle": "Chat_Queue_Reports"
3288   },
3289   {
3290     "type": "get",
3291     "url": "/api/chat/reports/queue/{id}",
3292     "title": "Gets a single Chat Queue Report",
3293     "examples": [
3294       {
3295         "title": "Example usage:",
3296         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3297         "type": "json"
3298       }
3299     ],
3300     "name": "ShowChat_Queue_Reports",
3301     "group": "Chat_Queue_Reports",
3302     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3303     "version": "0.0.0",
3304     "filename": "server/api/chatQueueReport/index.js",
3305     "groupTitle": "Chat_Queue_Reports"
3306   },
3307   {
3308     "type": "put",
3309     "url": "/api/chat/reports/queue/{id}",
3310     "title": "Update an existing Chat Queue Report",
3311     "examples": [
3312       {
3313         "title": "Example usage:",
3314         "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",
3315         "type": "json"
3316       }
3317     ],
3318     "name": "updateChat_Queue_Reports",
3319     "group": "Chat_Queue_Reports",
3320     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3321     "version": "0.0.0",
3322     "filename": "server/api/chatQueueReport/index.js",
3323     "groupTitle": "Chat_Queue_Reports"
3324   },
3325   {
3326     "type": "post",
3327     "url": "/api/chat/queues/{id}/users",
3328     "title": "Add agents to a queue",
3329     "examples": [
3330       {
3331         "title": "Example usage:",
3332         "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",
3333         "type": "json"
3334       }
3335     ],
3336     "name": "AddAgents",
3337     "group": "Chat_Queues",
3338     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3339     "version": "0.0.0",
3340     "filename": "server/api/chatQueue/index.js",
3341     "groupTitle": "Chat_Queues"
3342   },
3343   {
3344     "type": "post",
3345     "url": "/api/chat/queues/{id}/teams",
3346     "title": "Add teams to a queue",
3347     "examples": [
3348       {
3349         "title": "Example usage:",
3350         "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",
3351         "type": "json"
3352       }
3353     ],
3354     "name": "AddTeams",
3355     "group": "Chat_Queues",
3356     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3357     "version": "0.0.0",
3358     "filename": "server/api/chatQueue/index.js",
3359     "groupTitle": "Chat_Queues"
3360   },
3361   {
3362     "type": "post",
3363     "url": "/api/chat/queues",
3364     "title": "Creates a new Queue",
3365     "examples": [
3366       {
3367         "title": "Example usage:",
3368         "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3369         "type": "json"
3370       }
3371     ],
3372     "name": "CreateQueues",
3373     "group": "Chat_Queues",
3374     "parameter": {
3375       "fields": {
3376         "Body": [
3377           {
3378             "group": "Body",
3379             "type": "String",
3380             "optional": false,
3381             "field": "name",
3382             "description": ""
3383           },
3384           {
3385             "group": "Body",
3386             "type": "String",
3387             "optional": true,
3388             "field": "description",
3389             "description": ""
3390           },
3391           {
3392             "group": "Body",
3393             "type": "Integer",
3394             "optional": true,
3395             "field": "timeout",
3396             "description": ""
3397           },
3398           {
3399             "group": "Body",
3400             "type": "String",
3401             "allowedValues": [
3402               "\"rrmemory\"",
3403               "\"beepall\"",
3404               "\"roundrobin\""
3405             ],
3406             "optional": true,
3407             "field": "strategy",
3408             "description": ""
3409           }
3410         ]
3411       }
3412     },
3413     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3414     "version": "0.0.0",
3415     "filename": "server/api/chatQueue/index.js",
3416     "groupTitle": "Chat_Queues"
3417   },
3418   {
3419     "type": "delete",
3420     "url": "/api/chat/queues/{id}",
3421     "title": "Deletes a Queue",
3422     "examples": [
3423       {
3424         "title": "Example usage:",
3425         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3426         "type": "json"
3427       }
3428     ],
3429     "name": "DeleteQueues",
3430     "group": "Chat_Queues",
3431     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3432     "version": "0.0.0",
3433     "filename": "server/api/chatQueue/index.js",
3434     "groupTitle": "Chat_Queues"
3435   },
3436   {
3437     "type": "get",
3438     "url": "/api/chat/queues/describe",
3439     "title": "Gets table info about Queues",
3440     "examples": [
3441       {
3442         "title": "Example usage:",
3443         "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3444         "type": "json"
3445       }
3446     ],
3447     "name": "DescribeQueues",
3448     "group": "Chat_Queues",
3449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3450     "version": "0.0.0",
3451     "filename": "server/api/chatQueue/index.js",
3452     "groupTitle": "Chat_Queues"
3453   },
3454   {
3455     "type": "get",
3456     "url": "/api/chat/queues/{id}/users",
3457     "title": "Gets queue agents",
3458     "examples": [
3459       {
3460         "title": "Example usage:",
3461         "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3462         "type": "json"
3463       }
3464     ],
3465     "name": "GetAgents",
3466     "group": "Chat_Queues",
3467     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3468     "version": "0.0.0",
3469     "filename": "server/api/chatQueue/index.js",
3470     "groupTitle": "Chat_Queues"
3471   },
3472   {
3473     "type": "get",
3474     "url": "/api/chat/queues/{id}/members",
3475     "title": "GetMembers",
3476     "examples": [
3477       {
3478         "title": "Example usage:",
3479         "content": "curl https://{domain}/api/chat/queues/{id}/members  -v -u {name}:{password}",
3480         "type": "json"
3481       }
3482     ],
3483     "name": "GetMembers",
3484     "group": "Chat_Queues",
3485     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3486     "version": "0.0.0",
3487     "filename": "server/api/chatQueue/index.js",
3488     "groupTitle": "Chat_Queues"
3489   },
3490   {
3491     "type": "get",
3492     "url": "/api/chat/queues",
3493     "title": "Gets a list of Queues",
3494     "examples": [
3495       {
3496         "title": "Example usage:",
3497         "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3498         "type": "json"
3499       }
3500     ],
3501     "name": "GetQueues",
3502     "group": "Chat_Queues",
3503     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3504     "version": "0.0.0",
3505     "filename": "server/api/chatQueue/index.js",
3506     "groupTitle": "Chat_Queues"
3507   },
3508   {
3509     "type": "get",
3510     "url": "/api/chat/queues/{id}/teams",
3511     "title": "Gets queues list",
3512     "examples": [
3513       {
3514         "title": "Example usage:",
3515         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3516         "type": "json"
3517       }
3518     ],
3519     "name": "GetTeams",
3520     "group": "Chat_Queues",
3521     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3522     "version": "0.0.0",
3523     "filename": "server/api/chatQueue/index.js",
3524     "groupTitle": "Chat_Queues"
3525   },
3526   {
3527     "type": "delete",
3528     "url": "/api/chat/queues/{id}/users",
3529     "title": "Removes agents from a queue",
3530     "examples": [
3531       {
3532         "title": "Example usage:",
3533         "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3534         "type": "json"
3535       }
3536     ],
3537     "name": "RemoveAgents",
3538     "group": "Chat_Queues",
3539     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3540     "version": "0.0.0",
3541     "filename": "server/api/chatQueue/index.js",
3542     "groupTitle": "Chat_Queues"
3543   },
3544   {
3545     "type": "get",
3546     "url": "/api/chat/queues/{id}",
3547     "title": "Gets a single Queue",
3548     "examples": [
3549       {
3550         "title": "Example usage:",
3551         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3552         "type": "json"
3553       }
3554     ],
3555     "name": "ShowQueues",
3556     "group": "Chat_Queues",
3557     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3558     "version": "0.0.0",
3559     "filename": "server/api/chatQueue/index.js",
3560     "groupTitle": "Chat_Queues"
3561   },
3562   {
3563     "type": "put",
3564     "url": "/api/chat/queues/{id}",
3565     "title": "Update an existing Queue",
3566     "examples": [
3567       {
3568         "title": "Example usage:",
3569         "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",
3570         "type": "json"
3571       }
3572     ],
3573     "name": "updateQueues",
3574     "group": "Chat_Queues",
3575     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3576     "version": "0.0.0",
3577     "filename": "server/api/chatQueue/index.js",
3578     "groupTitle": "Chat_Queues"
3579   },
3580   {
3581     "type": "post",
3582     "url": "/api/chat/reports/transfer",
3583     "title": "Creates a new Chat Transfer Report",
3584     "examples": [
3585       {
3586         "title": "Example usage:",
3587         "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",
3588         "type": "json"
3589       }
3590     ],
3591     "name": "CreateChat_Transfer_Reports",
3592     "group": "Chat_Transfer_Reports",
3593     "parameter": {
3594       "fields": {
3595         "Body": [
3596           {
3597             "group": "Body",
3598             "type": "String",
3599             "optional": false,
3600             "field": "uniqueid",
3601             "description": ""
3602           },
3603           {
3604             "group": "Body",
3605             "type": "String",
3606             "allowedValues": [
3607               "\"account\"",
3608               "\"agent\"",
3609               "\"queue\""
3610             ],
3611             "optional": false,
3612             "field": "type",
3613             "description": ""
3614           },
3615           {
3616             "group": "Body",
3617             "type": "String",
3618             "optional": false,
3619             "field": "transferredAt",
3620             "description": ""
3621           }
3622         ]
3623       }
3624     },
3625     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3626     "version": "0.0.0",
3627     "filename": "server/api/chatTransferReport/index.js",
3628     "groupTitle": "Chat_Transfer_Reports"
3629   },
3630   {
3631     "type": "delete",
3632     "url": "/api/chat/reports/transfer/{id}",
3633     "title": "Deletes a Chat Transfer Report",
3634     "examples": [
3635       {
3636         "title": "Example usage:",
3637         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3638         "type": "json"
3639       }
3640     ],
3641     "name": "DeleteChat_Transfer_Reports",
3642     "group": "Chat_Transfer_Reports",
3643     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3644     "version": "0.0.0",
3645     "filename": "server/api/chatTransferReport/index.js",
3646     "groupTitle": "Chat_Transfer_Reports"
3647   },
3648   {
3649     "type": "get",
3650     "url": "/api/chat/reports/transfer/describe",
3651     "title": "Gets table info about Chat Transfer Reports",
3652     "examples": [
3653       {
3654         "title": "Example usage:",
3655         "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3656         "type": "json"
3657       }
3658     ],
3659     "name": "DescribeChat_Transfer_Reports",
3660     "group": "Chat_Transfer_Reports",
3661     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3662     "version": "0.0.0",
3663     "filename": "server/api/chatTransferReport/index.js",
3664     "groupTitle": "Chat_Transfer_Reports"
3665   },
3666   {
3667     "type": "get",
3668     "url": "/api/chat/reports/transfer",
3669     "title": "Gets a list of Chat Transfer Reports",
3670     "examples": [
3671       {
3672         "title": "Example usage:",
3673         "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3674         "type": "json"
3675       }
3676     ],
3677     "name": "GetChat_Transfer_Reports",
3678     "group": "Chat_Transfer_Reports",
3679     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3680     "version": "0.0.0",
3681     "filename": "server/api/chatTransferReport/index.js",
3682     "groupTitle": "Chat_Transfer_Reports"
3683   },
3684   {
3685     "type": "get",
3686     "url": "/api/chat/reports/transfer/{id}",
3687     "title": "Gets a single Chat Transfer Report",
3688     "examples": [
3689       {
3690         "title": "Example usage:",
3691         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3692         "type": "json"
3693       }
3694     ],
3695     "name": "ShowChat_Transfer_Reports",
3696     "group": "Chat_Transfer_Reports",
3697     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3698     "version": "0.0.0",
3699     "filename": "server/api/chatTransferReport/index.js",
3700     "groupTitle": "Chat_Transfer_Reports"
3701   },
3702   {
3703     "type": "put",
3704     "url": "/api/chat/reports/transfer/{id}",
3705     "title": "Update an existing Chat Transfer Report",
3706     "examples": [
3707       {
3708         "title": "Example usage:",
3709         "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",
3710         "type": "json"
3711       }
3712     ],
3713     "name": "updateChat_Transfer_Reports",
3714     "group": "Chat_Transfer_Reports",
3715     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3716     "version": "0.0.0",
3717     "filename": "server/api/chatTransferReport/index.js",
3718     "groupTitle": "Chat_Transfer_Reports"
3719   },
3720   {
3721     "type": "post",
3722     "url": "/api/chat/websites/{id}/users",
3723     "title": "Add agents to a website",
3724     "examples": [
3725       {
3726         "title": "Example usage:",
3727         "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",
3728         "type": "json"
3729       }
3730     ],
3731     "name": "AddAgents",
3732     "group": "Chat_Websites",
3733     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3734     "version": "0.0.0",
3735     "filename": "server/api/chatWebsite/index.js",
3736     "groupTitle": "Chat_Websites"
3737   },
3738   {
3739     "type": "post",
3740     "url": "/api/chat/websites",
3741     "title": "Creates a new Website",
3742     "examples": [
3743       {
3744         "title": "Example usage:",
3745         "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3746         "type": "json"
3747       }
3748     ],
3749     "name": "CreateWebsites",
3750     "group": "Chat_Websites",
3751     "parameter": {
3752       "fields": {
3753         "Body": [
3754           {
3755             "group": "Body",
3756             "type": "String",
3757             "optional": false,
3758             "field": "name",
3759             "description": ""
3760           },
3761           {
3762             "group": "Body",
3763             "type": "String",
3764             "optional": false,
3765             "field": "address",
3766             "description": ""
3767           },
3768           {
3769             "group": "Body",
3770             "type": "String",
3771             "optional": true,
3772             "field": "description",
3773             "description": ""
3774           },
3775           {
3776             "group": "Body",
3777             "type": "String",
3778             "optional": true,
3779             "field": "mapKey",
3780             "description": ""
3781           },
3782           {
3783             "group": "Body",
3784             "type": "String",
3785             "optional": true,
3786             "field": "mapKeyOffline",
3787             "description": ""
3788           },
3789           {
3790             "group": "Body",
3791             "type": "String",
3792             "optional": false,
3793             "field": "key",
3794             "description": ""
3795           },
3796           {
3797             "group": "Body",
3798             "type": "String",
3799             "optional": true,
3800             "field": "agentAlias",
3801             "description": ""
3802           },
3803           {
3804             "group": "Body",
3805             "type": "String",
3806             "optional": true,
3807             "field": "customerAlias",
3808             "description": ""
3809           },
3810           {
3811             "group": "Body",
3812             "type": "String",
3813             "optional": false,
3814             "field": "color",
3815             "description": ""
3816           },
3817           {
3818             "group": "Body",
3819             "type": "String",
3820             "optional": false,
3821             "field": "color_button",
3822             "description": ""
3823           },
3824           {
3825             "group": "Body",
3826             "type": "String",
3827             "optional": false,
3828             "field": "textColor",
3829             "description": ""
3830           },
3831           {
3832             "group": "Body",
3833             "type": "Integer",
3834             "optional": true,
3835             "field": "fontSize",
3836             "description": ""
3837           },
3838           {
3839             "group": "Body",
3840             "type": "String",
3841             "optional": true,
3842             "field": "remote",
3843             "description": ""
3844           },
3845           {
3846             "group": "Body",
3847             "type": "Boolean",
3848             "optional": true,
3849             "field": "animation",
3850             "description": ""
3851           },
3852           {
3853             "group": "Body",
3854             "type": "String",
3855             "allowedValues": [
3856               "\"rounded\"",
3857               "\"squared\""
3858             ],
3859             "optional": true,
3860             "field": "header_shape",
3861             "description": ""
3862           },
3863           {
3864             "group": "Body",
3865             "type": "String",
3866             "optional": true,
3867             "field": "header_online",
3868             "description": ""
3869           },
3870           {
3871             "group": "Body",
3872             "type": "String",
3873             "optional": true,
3874             "field": "start_chat_button",
3875             "description": ""
3876           },
3877           {
3878             "group": "Body",
3879             "type": "String",
3880             "optional": true,
3881             "field": "offline_chat_button",
3882             "description": ""
3883           },
3884           {
3885             "group": "Body",
3886             "type": "String",
3887             "optional": true,
3888             "field": "header_offline",
3889             "description": ""
3890           },
3891           {
3892             "group": "Body",
3893             "type": "Boolean",
3894             "optional": true,
3895             "field": "download_transcript",
3896             "description": ""
3897           },
3898           {
3899             "group": "Body",
3900             "type": "Integer",
3901             "optional": true,
3902             "field": "timeout",
3903             "description": ""
3904           },
3905           {
3906             "group": "Body",
3907             "type": "String",
3908             "optional": true,
3909             "field": "whiteLabel",
3910             "description": ""
3911           },
3912           {
3913             "group": "Body",
3914             "type": "Boolean",
3915             "optional": true,
3916             "field": "defaultWhiteLabel",
3917             "description": ""
3918           },
3919           {
3920             "group": "Body",
3921             "type": "Text",
3922             "optional": true,
3923             "field": "sitepic",
3924             "description": ""
3925           },
3926           {
3927             "group": "Body",
3928             "type": "String",
3929             "optional": true,
3930             "field": "closingQuestion",
3931             "description": ""
3932           },
3933           {
3934             "group": "Body",
3935             "type": "String",
3936             "optional": true,
3937             "field": "formSubmitSuccessMessage",
3938             "description": ""
3939           },
3940           {
3941             "group": "Body",
3942             "type": "String",
3943             "optional": true,
3944             "field": "formSubmitFailureMessage",
3945             "description": ""
3946           },
3947           {
3948             "group": "Body",
3949             "type": "String",
3950             "optional": true,
3951             "field": "noteTitle",
3952             "description": ""
3953           },
3954           {
3955             "group": "Body",
3956             "type": "String",
3957             "optional": true,
3958             "field": "placeholderMessage",
3959             "description": ""
3960           },
3961           {
3962             "group": "Body",
3963             "type": "String",
3964             "optional": true,
3965             "field": "closingMessage",
3966             "description": ""
3967           },
3968           {
3969             "group": "Body",
3970             "type": "String",
3971             "optional": true,
3972             "field": "closingMessageButton",
3973             "description": ""
3974           },
3975           {
3976             "group": "Body",
3977             "type": "String",
3978             "optional": true,
3979             "field": "skipMessageButton",
3980             "description": ""
3981           },
3982           {
3983             "group": "Body",
3984             "type": "Boolean",
3985             "optional": true,
3986             "field": "conditionAgreement",
3987             "description": ""
3988           },
3989           {
3990             "group": "Body",
3991             "type": "Boolean",
3992             "optional": true,
3993             "field": "enableRating",
3994             "description": ""
3995           },
3996           {
3997             "group": "Body",
3998             "type": "Boolean",
3999             "optional": true,
4000             "field": "enableFeedback",
4001             "description": ""
4002           },
4003           {
4004             "group": "Body",
4005             "type": "Boolean",
4006             "optional": true,
4007             "field": "enableSendButton",
4008             "description": ""
4009           },
4010           {
4011             "group": "Body",
4012             "type": "String",
4013             "optional": true,
4014             "field": "feedbackTitle",
4015             "description": ""
4016           },
4017           {
4018             "group": "Body",
4019             "type": "String",
4020             "allowedValues": [
4021               "\"star\"",
4022               "\"thumb\""
4023             ],
4024             "optional": true,
4025             "field": "ratingType",
4026             "description": ""
4027           },
4028           {
4029             "group": "Body",
4030             "type": "Integer",
4031             "optional": true,
4032             "field": "ratingStarsNumber",
4033             "description": ""
4034           },
4035           {
4036             "group": "Body",
4037             "type": "Text",
4038             "optional": true,
4039             "field": "onlineForm",
4040             "description": ""
4041           },
4042           {
4043             "group": "Body",
4044             "type": "Text",
4045             "optional": true,
4046             "field": "offlineForm",
4047             "description": ""
4048           },
4049           {
4050             "group": "Body",
4051             "type": "String",
4052             "optional": true,
4053             "field": "token",
4054             "description": ""
4055           },
4056           {
4057             "group": "Body",
4058             "type": "Boolean",
4059             "optional": true,
4060             "field": "autoclose",
4061             "description": ""
4062           },
4063           {
4064             "group": "Body",
4065             "type": "Boolean",
4066             "optional": true,
4067             "field": "enableCustomerWriting",
4068             "description": ""
4069           },
4070           {
4071             "group": "Body",
4072             "type": "Boolean",
4073             "optional": true,
4074             "field": "forwardTranscript",
4075             "description": ""
4076           },
4077           {
4078             "group": "Body",
4079             "type": "String",
4080             "optional": true,
4081             "field": "forwardTranscriptMessage",
4082             "description": ""
4083           },
4084           {
4085             "group": "Body",
4086             "type": "Boolean",
4087             "optional": true,
4088             "field": "forwardOffline",
4089             "description": ""
4090           },
4091           {
4092             "group": "Body",
4093             "type": "String",
4094             "optional": true,
4095             "field": "forwardOfflineAddress",
4096             "description": ""
4097           },
4098           {
4099             "group": "Body",
4100             "type": "String",
4101             "optional": true,
4102             "field": "waitingTitle",
4103             "description": ""
4104           },
4105           {
4106             "group": "Body",
4107             "type": "String",
4108             "optional": true,
4109             "field": "waitingMessage",
4110             "description": ""
4111           },
4112           {
4113             "group": "Body",
4114             "type": "String",
4115             "optional": true,
4116             "field": "offlineMessageSubject",
4117             "description": ""
4118           },
4119           {
4120             "group": "Body",
4121             "type": "String",
4122             "optional": true,
4123             "field": "offlineMessageBody",
4124             "description": ""
4125           },
4126           {
4127             "group": "Body",
4128             "type": "Boolean",
4129             "optional": true,
4130             "field": "enableUnmanagedNote",
4131             "description": ""
4132           },
4133           {
4134             "group": "Body",
4135             "type": "String",
4136             "optional": true,
4137             "field": "unmanagedMessage",
4138             "description": ""
4139           },
4140           {
4141             "group": "Body",
4142             "type": "String",
4143             "optional": true,
4144             "field": "skipUnmanaged",
4145             "description": ""
4146           },
4147           {
4148             "group": "Body",
4149             "type": "String",
4150             "optional": true,
4151             "field": "sendUnmanaged",
4152             "description": ""
4153           },
4154           {
4155             "group": "Body",
4156             "type": "Boolean",
4157             "optional": true,
4158             "field": "enableCustomerAttachment",
4159             "description": ""
4160           },
4161           {
4162             "group": "Body",
4163             "type": "Boolean",
4164             "optional": true,
4165             "field": "enableCustomerCheckmarks",
4166             "description": ""
4167           },
4168           {
4169             "group": "Body",
4170             "type": "Text",
4171             "optional": true,
4172             "field": "agentAvatar",
4173             "description": ""
4174           },
4175           {
4176             "group": "Body",
4177             "type": "Boolean",
4178             "optional": true,
4179             "field": "showAgentAvatar",
4180             "description": ""
4181           },
4182           {
4183             "group": "Body",
4184             "type": "String",
4185             "optional": true,
4186             "field": "timezone",
4187             "description": ""
4188           },
4189           {
4190             "group": "Body",
4191             "type": "Text",
4192             "optional": true,
4193             "field": "notificationTemplate",
4194             "description": ""
4195           },
4196           {
4197             "group": "Body",
4198             "type": "Boolean",
4199             "optional": true,
4200             "field": "notificationSound",
4201             "description": ""
4202           },
4203           {
4204             "group": "Body",
4205             "type": "Boolean",
4206             "optional": true,
4207             "field": "notificationShake",
4208             "description": ""
4209           },
4210           {
4211             "group": "Body",
4212             "type": "Boolean",
4213             "optional": true,
4214             "field": "hideWhenOffline",
4215             "description": ""
4216           },
4217           {
4218             "group": "Body",
4219             "type": "String",
4220             "optional": true,
4221             "field": "agentIdentifier",
4222             "description": ""
4223           },
4224           {
4225             "group": "Body",
4226             "type": "Integer",
4227             "optional": true,
4228             "field": "waitForTheAssignedAgent",
4229             "description": ""
4230           },
4231           {
4232             "group": "Body",
4233             "type": "String",
4234             "optional": true,
4235             "field": "alignment",
4236             "description": ""
4237           },
4238           {
4239             "group": "Body",
4240             "type": "Integer",
4241             "optional": true,
4242             "field": "verticalAlignment",
4243             "description": ""
4244           },
4245           {
4246             "group": "Body",
4247             "type": "String",
4248             "optional": true,
4249             "field": "messagesAlignment",
4250             "description": ""
4251           },
4252           {
4253             "group": "Body",
4254             "type": "String",
4255             "optional": true,
4256             "field": "defaultTitle",
4257             "description": ""
4258           },
4259           {
4260             "group": "Body",
4261             "type": "Text",
4262             "optional": true,
4263             "field": "customerAvatar",
4264             "description": ""
4265           },
4266           {
4267             "group": "Body",
4268             "type": "Boolean",
4269             "optional": true,
4270             "field": "showCustomerAvatar",
4271             "description": ""
4272           },
4273           {
4274             "group": "Body",
4275             "type": "Integer",
4276             "optional": true,
4277             "field": "messageFontSize",
4278             "description": ""
4279           },
4280           {
4281             "group": "Body",
4282             "type": "String",
4283             "optional": false,
4284             "field": "backgroundColor",
4285             "description": ""
4286           },
4287           {
4288             "group": "Body",
4289             "type": "Boolean",
4290             "optional": true,
4291             "field": "queueTransfer",
4292             "description": ""
4293           },
4294           {
4295             "group": "Body",
4296             "type": "Integer",
4297             "optional": true,
4298             "field": "queueTransferTimeout",
4299             "description": ""
4300           },
4301           {
4302             "group": "Body",
4303             "type": "Boolean",
4304             "optional": true,
4305             "field": "agentTransfer",
4306             "description": ""
4307           },
4308           {
4309             "group": "Body",
4310             "type": "Integer",
4311             "optional": true,
4312             "field": "agentTransferTimeout",
4313             "description": ""
4314           },
4315           {
4316             "group": "Body",
4317             "type": "String",
4318             "optional": true,
4319             "field": "systemAlias",
4320             "description": ""
4321           },
4322           {
4323             "group": "Body",
4324             "type": "Text",
4325             "optional": true,
4326             "field": "systemAvatar",
4327             "description": ""
4328           },
4329           {
4330             "group": "Body",
4331             "type": "Integer",
4332             "optional": true,
4333             "field": "mandatoryDispositionPauseId",
4334             "description": "<p>Status to put when mandatory disposition is enabled</p>"
4335           },
4336           {
4337             "group": "Body",
4338             "type": "Boolean",
4339             "optional": true,
4340             "field": "mandatoryDisposition",
4341             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4342           },
4343           {
4344             "group": "Body",
4345             "type": "Boolean",
4346             "optional": true,
4347             "field": "vidaooEscalation",
4348             "description": ""
4349           },
4350           {
4351             "group": "Body",
4352             "type": "String",
4353             "optional": true,
4354             "field": "vidaooApiKey",
4355             "description": ""
4356           }
4357         ]
4358       }
4359     },
4360     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4361     "version": "0.0.0",
4362     "filename": "server/api/chatWebsite/index.js",
4363     "groupTitle": "Chat_Websites"
4364   },
4365   {
4366     "type": "delete",
4367     "url": "/api/chat/websites/{id}",
4368     "title": "Deletes a Website",
4369     "examples": [
4370       {
4371         "title": "Example usage:",
4372         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4373         "type": "json"
4374       }
4375     ],
4376     "name": "DeleteWebsites",
4377     "group": "Chat_Websites",
4378     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4379     "version": "0.0.0",
4380     "filename": "server/api/chatWebsite/index.js",
4381     "groupTitle": "Chat_Websites"
4382   },
4383   {
4384     "type": "get",
4385     "url": "/api/chat/websites/describe",
4386     "title": "Gets table info about Websites",
4387     "examples": [
4388       {
4389         "title": "Example usage:",
4390         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4391         "type": "json"
4392       }
4393     ],
4394     "name": "DescribeWebsites",
4395     "group": "Chat_Websites",
4396     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4397     "version": "0.0.0",
4398     "filename": "server/api/chatWebsite/index.js",
4399     "groupTitle": "Chat_Websites"
4400   },
4401   {
4402     "type": "get",
4403     "url": "/api/chat/websites/{id}/users",
4404     "title": "Gets agents from website",
4405     "examples": [
4406       {
4407         "title": "Example usage:",
4408         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4409         "type": "json"
4410       }
4411     ],
4412     "name": "GetAgents",
4413     "group": "Chat_Websites",
4414     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4415     "version": "0.0.0",
4416     "filename": "server/api/chatWebsite/index.js",
4417     "groupTitle": "Chat_Websites"
4418   },
4419   {
4420     "type": "get",
4421     "url": "/api/chat/websites",
4422     "title": "Gets a list of Websites",
4423     "examples": [
4424       {
4425         "title": "Example usage:",
4426         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4427         "type": "json"
4428       }
4429     ],
4430     "name": "GetWebsites",
4431     "group": "Chat_Websites",
4432     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4433     "version": "0.0.0",
4434     "filename": "server/api/chatWebsite/index.js",
4435     "groupTitle": "Chat_Websites"
4436   },
4437   {
4438     "type": "delete",
4439     "url": "/api/chat/websites/{id}/users",
4440     "title": "Removes agents from a website",
4441     "examples": [
4442       {
4443         "title": "Example usage:",
4444         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4445         "type": "json"
4446       }
4447     ],
4448     "name": "RemoveAgents",
4449     "group": "Chat_Websites",
4450     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4451     "version": "0.0.0",
4452     "filename": "server/api/chatWebsite/index.js",
4453     "groupTitle": "Chat_Websites"
4454   },
4455   {
4456     "type": "delete",
4457     "url": "/api/chat/websites/{id}/canned_answers",
4458     "title": "Removes canned answers from account",
4459     "examples": [
4460       {
4461         "title": "Example usage:",
4462         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4463         "type": "json"
4464       }
4465     ],
4466     "name": "RemoveAnswers",
4467     "group": "Chat_Websites",
4468     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4469     "version": "0.0.0",
4470     "filename": "server/api/chatWebsite/index.js",
4471     "groupTitle": "Chat_Websites"
4472   },
4473   {
4474     "type": "delete",
4475     "url": "/api/chat/websites/{id}/dispositions",
4476     "title": "Removes canned answers from account",
4477     "examples": [
4478       {
4479         "title": "Example usage:",
4480         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4481         "type": "json"
4482       }
4483     ],
4484     "name": "RemoveDispositions",
4485     "group": "Chat_Websites",
4486     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4487     "version": "0.0.0",
4488     "filename": "server/api/chatWebsite/index.js",
4489     "groupTitle": "Chat_Websites"
4490   },
4491   {
4492     "type": "get",
4493     "url": "/api/chat/websites/{id}",
4494     "title": "Gets a single Website",
4495     "examples": [
4496       {
4497         "title": "Example usage:",
4498         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4499         "type": "json"
4500       }
4501     ],
4502     "name": "ShowWebsites",
4503     "group": "Chat_Websites",
4504     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4505     "version": "0.0.0",
4506     "filename": "server/api/chatWebsite/index.js",
4507     "groupTitle": "Chat_Websites"
4508   },
4509   {
4510     "type": "put",
4511     "url": "/api/chat/messages/{id}/accept",
4512     "title": "Accepts message",
4513     "examples": [
4514       {
4515         "title": "Example usage:",
4516         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4517         "type": "json"
4518       }
4519     ],
4520     "name": "acceptMessage",
4521     "group": "Chat_Websites",
4522     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4523     "version": "0.0.0",
4524     "filename": "server/api/chatMessage/index.js",
4525     "groupTitle": "Chat_Websites"
4526   },
4527   {
4528     "type": "post",
4529     "url": "/api/chat/websites/{id}/canned_answers",
4530     "title": "Creates new canned answer",
4531     "examples": [
4532       {
4533         "title": "Example usage:",
4534         "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",
4535         "type": "json"
4536       }
4537     ],
4538     "name": "addAnswer",
4539     "group": "Chat_Websites",
4540     "parameter": {
4541       "fields": {
4542         "Body": [
4543           {
4544             "group": "Body",
4545             "type": "String",
4546             "optional": false,
4547             "field": "key",
4548             "description": ""
4549           },
4550           {
4551             "group": "Body",
4552             "type": "Text",
4553             "optional": false,
4554             "field": "value",
4555             "description": ""
4556           },
4557           {
4558             "group": "Body",
4559             "type": "String",
4560             "optional": true,
4561             "field": "description",
4562             "description": ""
4563           },
4564           {
4565             "group": "Body",
4566             "type": "Virtual",
4567             "optional": true,
4568             "field": "name",
4569             "description": ""
4570           }
4571         ]
4572       }
4573     },
4574     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4575     "version": "0.0.0",
4576     "filename": "server/api/chatWebsite/index.js",
4577     "groupTitle": "Chat_Websites"
4578   },
4579   {
4580     "type": "post",
4581     "url": "/api/chat/websites/{id}/applications",
4582     "title": "Creates new applications",
4583     "examples": [
4584       {
4585         "title": "Example usage:",
4586         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4587         "type": "json"
4588       }
4589     ],
4590     "name": "addApplications",
4591     "group": "Chat_Websites",
4592     "parameter": {
4593       "fields": {
4594         "Body": [
4595           {
4596             "group": "Body",
4597             "type": "Integer",
4598             "optional": false,
4599             "field": "priority",
4600             "description": ""
4601           },
4602           {
4603             "group": "Body",
4604             "type": "String",
4605             "optional": false,
4606             "field": "app",
4607             "description": ""
4608           },
4609           {
4610             "group": "Body",
4611             "type": "Text",
4612             "optional": true,
4613             "field": "appdata",
4614             "description": ""
4615           },
4616           {
4617             "group": "Body",
4618             "type": "String",
4619             "optional": true,
4620             "field": "description",
4621             "description": ""
4622           },
4623           {
4624             "group": "Body",
4625             "type": "String",
4626             "optional": true,
4627             "field": "interval",
4628             "description": ""
4629           }
4630         ]
4631       }
4632     },
4633     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4634     "version": "0.0.0",
4635     "filename": "server/api/chatWebsite/index.js",
4636     "groupTitle": "Chat_Websites"
4637   },
4638   {
4639     "type": "post",
4640     "url": "/api/chat/websites/{id}/avatar",
4641     "title": "Add avatar",
4642     "examples": [
4643       {
4644         "title": "Example usage:",
4645         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4646         "type": "json"
4647       }
4648     ],
4649     "name": "addAvatar",
4650     "group": "Chat_Websites",
4651     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4652     "version": "0.0.0",
4653     "filename": "server/api/chatWebsite/index.js",
4654     "groupTitle": "Chat_Websites"
4655   },
4656   {
4657     "type": "post",
4658     "url": "/api/chat/websites/{id}/customer_avatar",
4659     "title": "Add customer avatar",
4660     "examples": [
4661       {
4662         "title": "Example usage:",
4663         "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",
4664         "type": "json"
4665       }
4666     ],
4667     "name": "addCustomerAvatar",
4668     "group": "Chat_Websites",
4669     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4670     "version": "0.0.0",
4671     "filename": "server/api/chatWebsite/index.js",
4672     "groupTitle": "Chat_Websites"
4673   },
4674   {
4675     "type": "post",
4676     "url": "/api/chat/websites/{id}/dispositions",
4677     "title": "Creates new disposition",
4678     "examples": [
4679       {
4680         "title": "Example usage:",
4681         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4682         "type": "json"
4683       }
4684     ],
4685     "name": "addDisposition",
4686     "group": "Chat_Websites",
4687     "parameter": {
4688       "fields": {
4689         "Body": [
4690           {
4691             "group": "Body",
4692             "type": "String",
4693             "optional": false,
4694             "field": "name",
4695             "description": ""
4696           },
4697           {
4698             "group": "Body",
4699             "type": "String",
4700             "allowedValues": [
4701               "\"first\"",
4702               "\"second\"",
4703               "\"third\""
4704             ],
4705             "optional": false,
4706             "field": "level",
4707             "description": ""
4708           },
4709           {
4710             "group": "Body",
4711             "type": "String",
4712             "optional": true,
4713             "field": "description",
4714             "description": ""
4715           }
4716         ]
4717       }
4718     },
4719     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4720     "version": "0.0.0",
4721     "filename": "server/api/chatWebsite/index.js",
4722     "groupTitle": "Chat_Websites"
4723   },
4724   {
4725     "type": "post",
4726     "url": "/api/chat/accounts/{id}/interactions",
4727     "title": "Creates new interactions",
4728     "examples": [
4729       {
4730         "title": "Example usage:",
4731         "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",
4732         "type": "json"
4733       }
4734     ],
4735     "name": "addInteraction",
4736     "group": "Chat_Websites",
4737     "parameter": {
4738       "fields": {
4739         "Body": [
4740           {
4741             "group": "Body",
4742             "type": "Boolean",
4743             "optional": true,
4744             "field": "closed",
4745             "description": ""
4746           },
4747           {
4748             "group": "Body",
4749             "type": "Integer",
4750             "optional": true,
4751             "field": "ratingValue",
4752             "description": ""
4753           },
4754           {
4755             "group": "Body",
4756             "type": "String",
4757             "allowedValues": [
4758               "\"star\"",
4759               "\"thumb\""
4760             ],
4761             "optional": true,
4762             "field": "ratingType",
4763             "description": ""
4764           },
4765           {
4766             "group": "Body",
4767             "type": "Text",
4768             "optional": true,
4769             "field": "ratingMessage",
4770             "description": ""
4771           },
4772           {
4773             "group": "Body",
4774             "type": "Text",
4775             "optional": true,
4776             "field": "pathTranscript",
4777             "description": ""
4778           },
4779           {
4780             "group": "Body",
4781             "type": "String",
4782             "optional": true,
4783             "field": "mailTranscript",
4784             "description": ""
4785           },
4786           {
4787             "group": "Body",
4788             "type": "String",
4789             "optional": true,
4790             "field": "closedAt",
4791             "description": ""
4792           },
4793           {
4794             "group": "Body",
4795             "type": "String",
4796             "optional": true,
4797             "field": "disposition",
4798             "description": ""
4799           },
4800           {
4801             "group": "Body",
4802             "type": "String",
4803             "optional": true,
4804             "field": "secondDisposition",
4805             "description": ""
4806           },
4807           {
4808             "group": "Body",
4809             "type": "String",
4810             "optional": true,
4811             "field": "thirdDisposition",
4812             "description": ""
4813           },
4814           {
4815             "group": "Body",
4816             "type": "String",
4817             "optional": true,
4818             "field": "note",
4819             "description": ""
4820           },
4821           {
4822             "group": "Body",
4823             "type": "String",
4824             "optional": true,
4825             "field": "browserName",
4826             "description": ""
4827           },
4828           {
4829             "group": "Body",
4830             "type": "String",
4831             "optional": true,
4832             "field": "browserVersion",
4833             "description": ""
4834           },
4835           {
4836             "group": "Body",
4837             "type": "String",
4838             "optional": true,
4839             "field": "osName",
4840             "description": ""
4841           },
4842           {
4843             "group": "Body",
4844             "type": "String",
4845             "optional": true,
4846             "field": "osVersion",
4847             "description": ""
4848           },
4849           {
4850             "group": "Body",
4851             "type": "String",
4852             "optional": true,
4853             "field": "deviceModel",
4854             "description": ""
4855           },
4856           {
4857             "group": "Body",
4858             "type": "String",
4859             "optional": true,
4860             "field": "deviceVendor",
4861             "description": ""
4862           },
4863           {
4864             "group": "Body",
4865             "type": "String",
4866             "optional": true,
4867             "field": "deviceType",
4868             "description": ""
4869           },
4870           {
4871             "group": "Body",
4872             "type": "Text",
4873             "optional": true,
4874             "field": "referer",
4875             "description": ""
4876           },
4877           {
4878             "group": "Body",
4879             "type": "String",
4880             "optional": true,
4881             "field": "customerIp",
4882             "description": ""
4883           },
4884           {
4885             "group": "Body",
4886             "type": "Text",
4887             "optional": true,
4888             "field": "formData",
4889             "description": ""
4890           },
4891           {
4892             "group": "Body",
4893             "type": "String",
4894             "optional": true,
4895             "field": "read1stAt",
4896             "description": ""
4897           },
4898           {
4899             "group": "Body",
4900             "type": "String",
4901             "optional": true,
4902             "field": "lastMsgAt",
4903             "description": ""
4904           },
4905           {
4906             "group": "Body",
4907             "type": "String",
4908             "allowedValues": [
4909               "\"in\"",
4910               "\"out\""
4911             ],
4912             "optional": false,
4913             "field": "lastMsgDirection",
4914             "description": ""
4915           },
4916           {
4917             "group": "Body",
4918             "type": "String",
4919             "optional": true,
4920             "field": "closeReason",
4921             "description": ""
4922           },
4923           {
4924             "group": "Body",
4925             "type": "String",
4926             "optional": true,
4927             "field": "customerPort",
4928             "description": ""
4929           },
4930           {
4931             "group": "Body",
4932             "type": "Text",
4933             "optional": true,
4934             "field": "vidaooSessionId",
4935             "description": ""
4936           }
4937         ]
4938       }
4939     },
4940     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4941     "version": "0.0.0",
4942     "filename": "server/api/chatWebsite/index.js",
4943     "groupTitle": "Chat_Websites"
4944   },
4945   {
4946     "type": "post",
4947     "url": "/api/chat/websites/{id}/logo",
4948     "title": "Add logo",
4949     "examples": [
4950       {
4951         "title": "Example usage:",
4952         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4953         "type": "json"
4954       }
4955     ],
4956     "name": "addLogo",
4957     "group": "Chat_Websites",
4958     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4959     "version": "0.0.0",
4960     "filename": "server/api/chatWebsite/index.js",
4961     "groupTitle": "Chat_Websites"
4962   },
4963   {
4964     "type": "post",
4965     "url": "/api/chat/websites/{id}/proactive_actions",
4966     "title": "Creates new Proactive Actions",
4967     "examples": [
4968       {
4969         "title": "Example usage:",
4970         "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",
4971         "type": "json"
4972       }
4973     ],
4974     "name": "addProactiveActions",
4975     "group": "Chat_Websites",
4976     "parameter": {
4977       "fields": {
4978         "Body": [
4979           {
4980             "group": "Body",
4981             "type": "String",
4982             "optional": false,
4983             "field": "name",
4984             "description": ""
4985           },
4986           {
4987             "group": "Body",
4988             "type": "String",
4989             "allowedValues": [
4990               "\"mouseOver\"",
4991               "\"timeout\""
4992             ],
4993             "optional": true,
4994             "field": "type",
4995             "description": ""
4996           },
4997           {
4998             "group": "Body",
4999             "type": "String",
5000             "optional": true,
5001             "field": "selector",
5002             "description": ""
5003           },
5004           {
5005             "group": "Body",
5006             "type": "Integer",
5007             "optional": true,
5008             "field": "timeout",
5009             "description": ""
5010           }
5011         ]
5012       }
5013     },
5014     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5015     "version": "0.0.0",
5016     "filename": "server/api/chatWebsite/index.js",
5017     "groupTitle": "Chat_Websites"
5018   },
5019   {
5020     "type": "post",
5021     "url": "/api/chat/websites/{id}/system_avatar",
5022     "title": "Add system avatar",
5023     "examples": [
5024       {
5025         "title": "Example usage:",
5026         "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",
5027         "type": "json"
5028       }
5029     ],
5030     "name": "addSystemAvatar",
5031     "group": "Chat_Websites",
5032     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5033     "version": "0.0.0",
5034     "filename": "server/api/chatWebsite/index.js",
5035     "groupTitle": "Chat_Websites"
5036   },
5037   {
5038     "type": "get",
5039     "url": "/api/chat/websites/{id}/canned_answers",
5040     "title": "Gets account canned answers",
5041     "examples": [
5042       {
5043         "title": "Example usage:",
5044         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
5045         "type": "json"
5046       }
5047     ],
5048     "name": "getAnswers",
5049     "group": "Chat_Websites",
5050     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5051     "version": "0.0.0",
5052     "filename": "server/api/chatWebsite/index.js",
5053     "groupTitle": "Chat_Websites"
5054   },
5055   {
5056     "type": "get",
5057     "url": "/api/chat/websites/{id}/applications",
5058     "title": "Gets Website Applications",
5059     "examples": [
5060       {
5061         "title": "Example usage:",
5062         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
5063         "type": "json"
5064       }
5065     ],
5066     "name": "getApplications",
5067     "group": "Chat_Websites",
5068     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5069     "version": "0.0.0",
5070     "filename": "server/api/chatWebsite/index.js",
5071     "groupTitle": "Chat_Websites"
5072   },
5073   {
5074     "type": "get",
5075     "url": "/api/chat/websites/{id}/avatar",
5076     "title": "Get avatar",
5077     "examples": [
5078       {
5079         "title": "Example usage:",
5080         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
5081         "type": "json"
5082       }
5083     ],
5084     "name": "getAvatar",
5085     "group": "Chat_Websites",
5086     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5087     "version": "0.0.0",
5088     "filename": "server/api/chatWebsite/index.js",
5089     "groupTitle": "Chat_Websites"
5090   },
5091   {
5092     "type": "get",
5093     "url": "/api/chat/websites/{id}/customer_avatar",
5094     "title": "Get Customer Avatar",
5095     "examples": [
5096       {
5097         "title": "Example usage:",
5098         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5099         "type": "json"
5100       }
5101     ],
5102     "name": "getCustomerAvatar",
5103     "group": "Chat_Websites",
5104     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5105     "version": "0.0.0",
5106     "filename": "server/api/chatWebsite/index.js",
5107     "groupTitle": "Chat_Websites"
5108   },
5109   {
5110     "type": "get",
5111     "url": "/api/chat/websites/{id}/dispositions",
5112     "title": "Gets account dispositions",
5113     "examples": [
5114       {
5115         "title": "Example usage:",
5116         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5117         "type": "json"
5118       }
5119     ],
5120     "name": "getDispositions",
5121     "group": "Chat_Websites",
5122     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5123     "version": "0.0.0",
5124     "filename": "server/api/chatWebsite/index.js",
5125     "groupTitle": "Chat_Websites"
5126   },
5127   {
5128     "type": "get",
5129     "url": "/api/chat/websites/{id}/fields",
5130     "title": "Gets Website Fields",
5131     "examples": [
5132       {
5133         "title": "Example usage:",
5134         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5135         "type": "json"
5136       }
5137     ],
5138     "name": "getFields",
5139     "group": "Chat_Websites",
5140     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5141     "version": "0.0.0",
5142     "filename": "server/api/chatWebsite/index.js",
5143     "groupTitle": "Chat_Websites"
5144   },
5145   {
5146     "type": "get",
5147     "url": "/api/chat/websites/{id}/interactions",
5148     "title": "Gets Website Interactions",
5149     "examples": [
5150       {
5151         "title": "Example usage:",
5152         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5153         "type": "json"
5154       }
5155     ],
5156     "name": "getInteraction",
5157     "group": "Chat_Websites",
5158     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5159     "version": "0.0.0",
5160     "filename": "server/api/chatWebsite/index.js",
5161     "groupTitle": "Chat_Websites"
5162   },
5163   {
5164     "type": "get",
5165     "url": "/api/chat/websites/{id}/logo",
5166     "title": "Get logo",
5167     "examples": [
5168       {
5169         "title": "Example usage:",
5170         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5171         "type": "json"
5172       }
5173     ],
5174     "name": "getLogo",
5175     "group": "Chat_Websites",
5176     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5177     "version": "0.0.0",
5178     "filename": "server/api/chatWebsite/index.js",
5179     "groupTitle": "Chat_Websites"
5180   },
5181   {
5182     "type": "get",
5183     "url": "/api/chat/websites/{id}/offline_messages",
5184     "title": "Gets Website Offline Messages",
5185     "examples": [
5186       {
5187         "title": "Example usage:",
5188         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5189         "type": "json"
5190       }
5191     ],
5192     "name": "getOfflineMessages",
5193     "group": "Chat_Websites",
5194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5195     "version": "0.0.0",
5196     "filename": "server/api/chatWebsite/index.js",
5197     "groupTitle": "Chat_Websites"
5198   },
5199   {
5200     "type": "get",
5201     "url": "/api/chat/websites/{id}/proactive_actions",
5202     "title": "Gets Website Proactive Actions",
5203     "examples": [
5204       {
5205         "title": "Example usage:",
5206         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5207         "type": "json"
5208       }
5209     ],
5210     "name": "getProactiveActions",
5211     "group": "Chat_Websites",
5212     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5213     "version": "0.0.0",
5214     "filename": "server/api/chatWebsite/index.js",
5215     "groupTitle": "Chat_Websites"
5216   },
5217   {
5218     "type": "get",
5219     "url": "/api/chat/websites/{id}/snippet",
5220     "title": "Gets Website Snippet",
5221     "examples": [
5222       {
5223         "title": "Example usage:",
5224         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5225         "type": "json"
5226       }
5227     ],
5228     "name": "getSnippet",
5229     "group": "Chat_Websites",
5230     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5231     "version": "0.0.0",
5232     "filename": "server/api/chatWebsite/index.js",
5233     "groupTitle": "Chat_Websites"
5234   },
5235   {
5236     "type": "get",
5237     "url": "/api/chat/websites/{id}/system_avatar",
5238     "title": "Get System Avatar",
5239     "examples": [
5240       {
5241         "title": "Example usage:",
5242         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5243         "type": "json"
5244       }
5245     ],
5246     "name": "getSystemAvatar",
5247     "group": "Chat_Websites",
5248     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5249     "version": "0.0.0",
5250     "filename": "server/api/chatWebsite/index.js",
5251     "groupTitle": "Chat_Websites"
5252   },
5253   {
5254     "type": "post",
5255     "url": "/api/chat/websites/{id}/notify",
5256     "title": "Notify new message",
5257     "examples": [
5258       {
5259         "title": "Example usage:",
5260         "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",
5261         "type": "json"
5262       }
5263     ],
5264     "name": "notify",
5265     "group": "Chat_Websites",
5266     "description": "<p>Motion 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>",
5267     "version": "0.0.0",
5268     "filename": "server/api/chatWebsite/index.js",
5269     "groupTitle": "Chat_Websites"
5270   },
5271   {
5272     "type": "post",
5273     "url": "/api/chat/websites/{id}/offline",
5274     "title": "Offline message",
5275     "examples": [
5276       {
5277         "title": "Example usage:",
5278         "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",
5279         "type": "json"
5280       }
5281     ],
5282     "name": "offline",
5283     "group": "Chat_Websites",
5284     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5285     "version": "0.0.0",
5286     "filename": "server/api/chatWebsite/index.js",
5287     "groupTitle": "Chat_Websites"
5288   },
5289   {
5290     "type": "put",
5291     "url": "/api/chat/messages/{id}/reject",
5292     "title": "Rejects message",
5293     "examples": [
5294       {
5295         "title": "Example usage:",
5296         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5297         "type": "json"
5298       }
5299     ],
5300     "name": "rejectMessage",
5301     "group": "Chat_Websites",
5302     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5303     "version": "0.0.0",
5304     "filename": "server/api/chatMessage/index.js",
5305     "groupTitle": "Chat_Websites"
5306   },
5307   {
5308     "type": "put",
5309     "url": "/api/chat/websites/{id}",
5310     "title": "Update an existing Website",
5311     "examples": [
5312       {
5313         "title": "Example usage:",
5314         "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",
5315         "type": "json"
5316       }
5317     ],
5318     "name": "updateWebsites",
5319     "group": "Chat_Websites",
5320     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5321     "version": "0.0.0",
5322     "filename": "server/api/chatWebsite/index.js",
5323     "groupTitle": "Chat_Websites"
5324   },
5325   {
5326     "type": "post",
5327     "url": "/api/cloudProviders",
5328     "title": "Creates a new CloudProvider",
5329     "examples": [
5330       {
5331         "title": "Example usage:",
5332         "content": "curl https://{domain}/api/cloudProviders -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5333         "type": "json"
5334       }
5335     ],
5336     "name": "CreateCloudProviders",
5337     "group": "CloudProviders",
5338     "parameter": {
5339       "fields": {
5340         "Body": [
5341           {
5342             "group": "Body",
5343             "type": "String",
5344             "optional": false,
5345             "field": "name",
5346             "description": ""
5347           },
5348           {
5349             "group": "Body",
5350             "type": "String",
5351             "allowedValues": [
5352               "\"AmazonAWS\"",
5353               "\"Google\""
5354             ],
5355             "optional": false,
5356             "field": "service",
5357             "description": ""
5358           },
5359           {
5360             "group": "Body",
5361             "type": "String",
5362             "optional": true,
5363             "field": "data1",
5364             "description": ""
5365           },
5366           {
5367             "group": "Body",
5368             "type": "String",
5369             "optional": true,
5370             "field": "data2",
5371             "description": ""
5372           }
5373         ]
5374       }
5375     },
5376     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5377     "version": "0.0.0",
5378     "filename": "server/api/cloudProvider/index.js",
5379     "groupTitle": "CloudProviders"
5380   },
5381   {
5382     "type": "delete",
5383     "url": "/api/cloudProviders/{id}",
5384     "title": "Deletes a CloudProvider",
5385     "examples": [
5386       {
5387         "title": "Example usage:",
5388         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password} -X DELETE",
5389         "type": "json"
5390       }
5391     ],
5392     "name": "DeleteCloudProviders",
5393     "group": "CloudProviders",
5394     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5395     "version": "0.0.0",
5396     "filename": "server/api/cloudProvider/index.js",
5397     "groupTitle": "CloudProviders"
5398   },
5399   {
5400     "type": "get",
5401     "url": "/api/cloudProviders",
5402     "title": "Gets a list of CloudProviders",
5403     "examples": [
5404       {
5405         "title": "Example usage:",
5406         "content": "curl https://{domain}/api/cloudProviders -v -u {name}:{password}",
5407         "type": "json"
5408       }
5409     ],
5410     "name": "GetCloudProviders",
5411     "group": "CloudProviders",
5412     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5413     "version": "0.0.0",
5414     "filename": "server/api/cloudProvider/index.js",
5415     "groupTitle": "CloudProviders"
5416   },
5417   {
5418     "type": "get",
5419     "url": "/api/cloudProviders/{id}",
5420     "title": "Gets a single CloudProvider",
5421     "examples": [
5422       {
5423         "title": "Example usage:",
5424         "content": "curl https://{domain}/api/cloudProviders/{id} -v -u {name}:{password}",
5425         "type": "json"
5426       }
5427     ],
5428     "name": "ShowCloudProviders",
5429     "group": "CloudProviders",
5430     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5431     "version": "0.0.0",
5432     "filename": "server/api/cloudProvider/index.js",
5433     "groupTitle": "CloudProviders"
5434   },
5435   {
5436     "type": "put",
5437     "url": "/api/cloudProviders/{id}",
5438     "title": "Update an existing CloudProvider",
5439     "examples": [
5440       {
5441         "title": "Example usage:",
5442         "content": "curl https://{domain}/api/cloudProviders/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
5443         "type": "json"
5444       }
5445     ],
5446     "name": "updateCloudProviders",
5447     "group": "CloudProviders",
5448     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5449     "version": "0.0.0",
5450     "filename": "server/api/cloudProvider/index.js",
5451     "groupTitle": "CloudProviders"
5452   },
5453   {
5454     "type": "post",
5455     "url": "/api/cm/companies",
5456     "title": "Creates a new Company",
5457     "examples": [
5458       {
5459         "title": "Example usage:",
5460         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5461         "type": "json"
5462       }
5463     ],
5464     "name": "CreateCompanies",
5465     "group": "Cm_Companies",
5466     "parameter": {
5467       "fields": {
5468         "Body": [
5469           {
5470             "group": "Body",
5471             "type": "String",
5472             "optional": false,
5473             "field": "name",
5474             "description": ""
5475           },
5476           {
5477             "group": "Body",
5478             "type": "String",
5479             "optional": true,
5480             "field": "vat",
5481             "description": ""
5482           },
5483           {
5484             "group": "Body",
5485             "type": "String",
5486             "optional": true,
5487             "field": "companyId",
5488             "description": ""
5489           },
5490           {
5491             "group": "Body",
5492             "type": "String",
5493             "optional": true,
5494             "field": "website",
5495             "description": ""
5496           },
5497           {
5498             "group": "Body",
5499             "type": "String",
5500             "optional": true,
5501             "field": "phone",
5502             "description": ""
5503           },
5504           {
5505             "group": "Body",
5506             "type": "String",
5507             "optional": true,
5508             "field": "fax",
5509             "description": ""
5510           },
5511           {
5512             "group": "Body",
5513             "type": "String",
5514             "optional": true,
5515             "field": "type",
5516             "description": ""
5517           },
5518           {
5519             "group": "Body",
5520             "type": "String",
5521             "optional": true,
5522             "field": "street",
5523             "description": ""
5524           },
5525           {
5526             "group": "Body",
5527             "type": "String",
5528             "optional": true,
5529             "field": "postalCode",
5530             "description": ""
5531           },
5532           {
5533             "group": "Body",
5534             "type": "String",
5535             "optional": true,
5536             "field": "city",
5537             "description": ""
5538           },
5539           {
5540             "group": "Body",
5541             "type": "String",
5542             "optional": true,
5543             "field": "country",
5544             "description": ""
5545           },
5546           {
5547             "group": "Body",
5548             "type": "String",
5549             "optional": true,
5550             "field": "email",
5551             "description": ""
5552           },
5553           {
5554             "group": "Body",
5555             "type": "String",
5556             "optional": true,
5557             "field": "emailDomain",
5558             "description": ""
5559           },
5560           {
5561             "group": "Body",
5562             "type": "String",
5563             "optional": true,
5564             "field": "sStreet",
5565             "description": ""
5566           },
5567           {
5568             "group": "Body",
5569             "type": "String",
5570             "optional": true,
5571             "field": "sPostalCode",
5572             "description": ""
5573           },
5574           {
5575             "group": "Body",
5576             "type": "String",
5577             "optional": true,
5578             "field": "sCity",
5579             "description": ""
5580           },
5581           {
5582             "group": "Body",
5583             "type": "String",
5584             "optional": true,
5585             "field": "sCountry",
5586             "description": ""
5587           },
5588           {
5589             "group": "Body",
5590             "type": "String",
5591             "optional": true,
5592             "field": "description",
5593             "description": ""
5594           }
5595         ]
5596       }
5597     },
5598     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5599     "version": "0.0.0",
5600     "filename": "server/api/cmCompany/index.js",
5601     "groupTitle": "Cm_Companies"
5602   },
5603   {
5604     "type": "delete",
5605     "url": "/api/cm/companies/{id}",
5606     "title": "Deletes a Company",
5607     "examples": [
5608       {
5609         "title": "Example usage:",
5610         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5611         "type": "json"
5612       }
5613     ],
5614     "name": "DeleteCompanies",
5615     "group": "Cm_Companies",
5616     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5617     "version": "0.0.0",
5618     "filename": "server/api/cmCompany/index.js",
5619     "groupTitle": "Cm_Companies"
5620   },
5621   {
5622     "type": "get",
5623     "url": "/api/cm/companies/describe",
5624     "title": "Gets table info about Companies",
5625     "examples": [
5626       {
5627         "title": "Example usage:",
5628         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5629         "type": "json"
5630       }
5631     ],
5632     "name": "DescribeCompanies",
5633     "group": "Cm_Companies",
5634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5635     "version": "0.0.0",
5636     "filename": "server/api/cmCompany/index.js",
5637     "groupTitle": "Cm_Companies"
5638   },
5639   {
5640     "type": "get",
5641     "url": "/api/cm/companies",
5642     "title": "Gets a list of Companies",
5643     "examples": [
5644       {
5645         "title": "Example usage:",
5646         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5647         "type": "json"
5648       }
5649     ],
5650     "name": "GetCompanies",
5651     "group": "Cm_Companies",
5652     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5653     "version": "0.0.0",
5654     "filename": "server/api/cmCompany/index.js",
5655     "groupTitle": "Cm_Companies"
5656   },
5657   {
5658     "type": "get",
5659     "url": "/api/cm/companies/{id}",
5660     "title": "Gets a single Company",
5661     "examples": [
5662       {
5663         "title": "Example usage:",
5664         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5665         "type": "json"
5666       }
5667     ],
5668     "name": "ShowCompanies",
5669     "group": "Cm_Companies",
5670     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5671     "version": "0.0.0",
5672     "filename": "server/api/cmCompany/index.js",
5673     "groupTitle": "Cm_Companies"
5674   },
5675   {
5676     "type": "post",
5677     "url": "/api/cm/companies/{id}/contacts",
5678     "title": "Creates new contacts",
5679     "examples": [
5680       {
5681         "title": "Example usage:",
5682         "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",
5683         "type": "json"
5684       }
5685     ],
5686     "name": "addContacts",
5687     "group": "Cm_Companies",
5688     "parameter": {
5689       "fields": {
5690         "Body": [
5691           {
5692             "group": "Body",
5693             "type": "String",
5694             "optional": false,
5695             "field": "firstName",
5696             "description": ""
5697           },
5698           {
5699             "group": "Body",
5700             "type": "String",
5701             "optional": true,
5702             "field": "lastName",
5703             "description": ""
5704           },
5705           {
5706             "group": "Body",
5707             "type": "String",
5708             "optional": true,
5709             "field": "street",
5710             "description": ""
5711           },
5712           {
5713             "group": "Body",
5714             "type": "String",
5715             "optional": true,
5716             "field": "postalCode",
5717             "description": ""
5718           },
5719           {
5720             "group": "Body",
5721             "type": "String",
5722             "optional": true,
5723             "field": "city",
5724             "description": ""
5725           },
5726           {
5727             "group": "Body",
5728             "type": "String",
5729             "optional": true,
5730             "field": "country",
5731             "description": ""
5732           },
5733           {
5734             "group": "Body",
5735             "type": "String",
5736             "optional": true,
5737             "field": "dateOfBirth",
5738             "description": ""
5739           },
5740           {
5741             "group": "Body",
5742             "type": "Text",
5743             "optional": true,
5744             "field": "description",
5745             "description": ""
5746           },
5747           {
5748             "group": "Body",
5749             "type": "String",
5750             "optional": true,
5751             "field": "phone",
5752             "description": ""
5753           },
5754           {
5755             "group": "Body",
5756             "type": "String",
5757             "optional": true,
5758             "field": "mobile",
5759             "description": ""
5760           },
5761           {
5762             "group": "Body",
5763             "type": "String",
5764             "optional": true,
5765             "field": "fax",
5766             "description": ""
5767           },
5768           {
5769             "group": "Body",
5770             "type": "String",
5771             "optional": true,
5772             "field": "email",
5773             "description": ""
5774           },
5775           {
5776             "group": "Body",
5777             "type": "String",
5778             "optional": true,
5779             "field": "url",
5780             "description": ""
5781           },
5782           {
5783             "group": "Body",
5784             "type": "String",
5785             "optional": true,
5786             "field": "facebook",
5787             "description": ""
5788           },
5789           {
5790             "group": "Body",
5791             "type": "String",
5792             "optional": true,
5793             "field": "fb_data",
5794             "description": ""
5795           },
5796           {
5797             "group": "Body",
5798             "type": "String",
5799             "optional": true,
5800             "field": "twitter",
5801             "description": ""
5802           },
5803           {
5804             "group": "Body",
5805             "type": "String",
5806             "optional": true,
5807             "field": "skype",
5808             "description": ""
5809           },
5810           {
5811             "group": "Body",
5812             "type": "String",
5813             "optional": true,
5814             "field": "teams",
5815             "description": ""
5816           },
5817           {
5818             "group": "Body",
5819             "type": "String",
5820             "optional": true,
5821             "field": "viber",
5822             "description": ""
5823           },
5824           {
5825             "group": "Body",
5826             "type": "String",
5827             "optional": true,
5828             "field": "line",
5829             "description": ""
5830           },
5831           {
5832             "group": "Body",
5833             "type": "String",
5834             "optional": true,
5835             "field": "wechat",
5836             "description": ""
5837           },
5838           {
5839             "group": "Body",
5840             "type": "String",
5841             "optional": true,
5842             "field": "telegram",
5843             "description": ""
5844           },
5845           {
5846             "group": "Body",
5847             "type": "Integer",
5848             "optional": true,
5849             "field": "UserId",
5850             "description": ""
5851           },
5852           {
5853             "group": "Body",
5854             "type": "Integer",
5855             "optional": true,
5856             "field": "priority",
5857             "description": ""
5858           },
5859           {
5860             "group": "Body",
5861             "type": "String",
5862             "optional": true,
5863             "field": "scheduledat",
5864             "description": ""
5865           }
5866         ]
5867       }
5868     },
5869     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5870     "version": "0.0.0",
5871     "filename": "server/api/cmCompany/index.js",
5872     "groupTitle": "Cm_Companies"
5873   },
5874   {
5875     "type": "get",
5876     "url": "/api/cm/companies/{id}/contacts",
5877     "title": "Gets List Contacts",
5878     "examples": [
5879       {
5880         "title": "Example usage:",
5881         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5882         "type": "json"
5883       }
5884     ],
5885     "name": "getContacts",
5886     "group": "Cm_Companies",
5887     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5888     "version": "0.0.0",
5889     "filename": "server/api/cmCompany/index.js",
5890     "groupTitle": "Cm_Companies"
5891   },
5892   {
5893     "type": "put",
5894     "url": "/api/cm/companies/{id}",
5895     "title": "Update an existing Company",
5896     "examples": [
5897       {
5898         "title": "Example usage:",
5899         "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",
5900         "type": "json"
5901       }
5902     ],
5903     "name": "updateCompanies",
5904     "group": "Cm_Companies",
5905     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5906     "version": "0.0.0",
5907     "filename": "server/api/cmCompany/index.js",
5908     "groupTitle": "Cm_Companies"
5909   },
5910   {
5911     "type": "delete",
5912     "url": "/api/cm/contacts/{id}",
5913     "title": "Deletes a Contact",
5914     "examples": [
5915       {
5916         "title": "Example usage:",
5917         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5918         "type": "json"
5919       }
5920     ],
5921     "name": "DeleteContacts",
5922     "group": "Cm_Contacts",
5923     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5924     "version": "0.0.0",
5925     "filename": "server/api/cmContact/index.js",
5926     "groupTitle": "Cm_Contacts"
5927   },
5928   {
5929     "type": "get",
5930     "url": "/api/cm/contacts/describe",
5931     "title": "Gets table info about Contacts",
5932     "examples": [
5933       {
5934         "title": "Example usage:",
5935         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
5936         "type": "json"
5937       }
5938     ],
5939     "name": "DescribeContacts",
5940     "group": "Cm_Contacts",
5941     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5942     "version": "0.0.0",
5943     "filename": "server/api/cmContact/index.js",
5944     "groupTitle": "Cm_Contacts"
5945   },
5946   {
5947     "type": "get",
5948     "url": "/api/cm/contacts",
5949     "title": "Gets a list of Contacts",
5950     "examples": [
5951       {
5952         "title": "Example usage:",
5953         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
5954         "type": "json"
5955       }
5956     ],
5957     "name": "GetContacts",
5958     "group": "Cm_Contacts",
5959     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5960     "version": "0.0.0",
5961     "filename": "server/api/cmContact/index.js",
5962     "groupTitle": "Cm_Contacts"
5963   },
5964   {
5965     "type": "get",
5966     "url": "/api/cm/contacts/{id}/finals",
5967     "title": "Gets contact hopper finals",
5968     "examples": [
5969       {
5970         "title": "Example usage:",
5971         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
5972         "type": "json"
5973       }
5974     ],
5975     "name": "GetHopperFinals",
5976     "group": "Cm_Contacts",
5977     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5978     "version": "0.0.0",
5979     "filename": "server/api/cmContact/index.js",
5980     "groupTitle": "Cm_Contacts"
5981   },
5982   {
5983     "type": "get",
5984     "url": "/api/cm/contacts/{id}/hopper_histories",
5985     "title": "Gets contact hopper histories",
5986     "examples": [
5987       {
5988         "title": "Example usage:",
5989         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
5990         "type": "json"
5991       }
5992     ],
5993     "name": "GetHopperHistories",
5994     "group": "Cm_Contacts",
5995     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5996     "version": "0.0.0",
5997     "filename": "server/api/cmContact/index.js",
5998     "groupTitle": "Cm_Contacts"
5999   },
6000   {
6001     "type": "get",
6002     "url": "/api/cm/contacts/{id}/hoppers",
6003     "title": "Gets contact hoppers",
6004     "examples": [
6005       {
6006         "title": "Example usage:",
6007         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
6008         "type": "json"
6009       }
6010     ],
6011     "name": "GetHoppers",
6012     "group": "Cm_Contacts",
6013     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6014     "version": "0.0.0",
6015     "filename": "server/api/cmContact/index.js",
6016     "groupTitle": "Cm_Contacts"
6017   },
6018   {
6019     "type": "post",
6020     "url": "/api/cm/contacts/create_many",
6021     "title": "Create Contacts",
6022     "examples": [
6023       {
6024         "title": "Example usage:",
6025         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
6026         "type": "json"
6027       }
6028     ],
6029     "name": "bulkCreate",
6030     "group": "Cm_Contacts",
6031     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6032     "version": "0.0.0",
6033     "filename": "server/api/cmContact/index.js",
6034     "groupTitle": "Cm_Contacts"
6035   },
6036   {
6037     "type": "post",
6038     "url": "/api/cm/contacts",
6039     "title": "Create Contact",
6040     "examples": [
6041       {
6042         "title": "Example usage:",
6043         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
6044         "type": "json"
6045       }
6046     ],
6047     "name": "create",
6048     "group": "Cm_Contacts",
6049     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6050     "version": "0.0.0",
6051     "filename": "server/api/cmContact/index.js",
6052     "groupTitle": "Cm_Contacts"
6053   },
6054   {
6055     "type": "get",
6056     "url": "/api/cm/contacts/{id}/jscripty_sessions",
6057     "title": "Gets contact hopper blacks",
6058     "examples": [
6059       {
6060         "title": "Example usage:",
6061         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
6062         "type": "json"
6063       }
6064     ],
6065     "name": "getJscriptySessions",
6066     "group": "Cm_Contacts",
6067     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6068     "version": "0.0.0",
6069     "filename": "server/api/cmContact/index.js",
6070     "groupTitle": "Cm_Contacts"
6071   },
6072   {
6073     "type": "get",
6074     "url": "/api/cm/contacts/{id}/tags",
6075     "title": "Gets configurations tags",
6076     "examples": [
6077       {
6078         "title": "Example usage:",
6079         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
6080         "type": "json"
6081       }
6082     ],
6083     "name": "getTags",
6084     "group": "Cm_Contacts",
6085     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6086     "version": "0.0.0",
6087     "filename": "server/api/cmContact/index.js",
6088     "groupTitle": "Cm_Contacts"
6089   },
6090   {
6091     "type": "post",
6092     "url": "/api/cm/contacts/merge",
6093     "title": "Merge Contact",
6094     "examples": [
6095       {
6096         "title": "Example usage:",
6097         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6098         "type": "json"
6099       }
6100     ],
6101     "name": "merge",
6102     "group": "Cm_Contacts",
6103     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6104     "version": "0.0.0",
6105     "filename": "server/api/cmContact/index.js",
6106     "groupTitle": "Cm_Contacts"
6107   },
6108   {
6109     "type": "post",
6110     "url": "/api/cm/contacts/{id}/tags",
6111     "title": "Sets new tags",
6112     "examples": [
6113       {
6114         "title": "Example usage:",
6115         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6116         "type": "json"
6117       }
6118     ],
6119     "name": "setTags",
6120     "group": "Cm_Contacts",
6121     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6122     "version": "0.0.0",
6123     "filename": "server/api/cmContact/index.js",
6124     "groupTitle": "Cm_Contacts"
6125   },
6126   {
6127     "type": "get",
6128     "url": "/api/cm/contacts/{id}",
6129     "title": "Gets a single Contact",
6130     "examples": [
6131       {
6132         "title": "Example usage:",
6133         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
6134         "type": "json"
6135       }
6136     ],
6137     "name": "show",
6138     "group": "Cm_Contacts",
6139     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6140     "version": "0.0.0",
6141     "filename": "server/api/cmContact/index.js",
6142     "groupTitle": "Cm_Contacts"
6143   },
6144   {
6145     "type": "put",
6146     "url": "/api/cm/contacts/{id}",
6147     "title": "Update a single Contact",
6148     "examples": [
6149       {
6150         "title": "Example usage:",
6151         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
6152         "type": "json"
6153       }
6154     ],
6155     "name": "update",
6156     "group": "Cm_Contacts",
6157     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6158     "version": "0.0.0",
6159     "filename": "server/api/cmContact/index.js",
6160     "groupTitle": "Cm_Contacts"
6161   },
6162   {
6163     "type": "delete",
6164     "url": "/api/cm/custom_fields/{id}",
6165     "title": "Deletes a Custom Field",
6166     "examples": [
6167       {
6168         "title": "Example usage:",
6169         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
6170         "type": "json"
6171       }
6172     ],
6173     "name": "DeleteCustom_Fields",
6174     "group": "Cm_Custom_Fields",
6175     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6176     "version": "0.0.0",
6177     "filename": "server/api/cmCustomField/index.js",
6178     "groupTitle": "Cm_Custom_Fields"
6179   },
6180   {
6181     "type": "get",
6182     "url": "/api/cm/custom_fields",
6183     "title": "Gets a list of Custom Fields",
6184     "examples": [
6185       {
6186         "title": "Example usage:",
6187         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
6188         "type": "json"
6189       }
6190     ],
6191     "name": "GetCustom_Fields",
6192     "group": "Cm_Custom_Fields",
6193     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6194     "version": "0.0.0",
6195     "filename": "server/api/cmCustomField/index.js",
6196     "groupTitle": "Cm_Custom_Fields"
6197   },
6198   {
6199     "type": "get",
6200     "url": "/api/cm/custom_fields/{id}",
6201     "title": "Gets a single Custom Field",
6202     "examples": [
6203       {
6204         "title": "Example usage:",
6205         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
6206         "type": "json"
6207       }
6208     ],
6209     "name": "ShowCustom_Fields",
6210     "group": "Cm_Custom_Fields",
6211     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6212     "version": "0.0.0",
6213     "filename": "server/api/cmCustomField/index.js",
6214     "groupTitle": "Cm_Custom_Fields"
6215   },
6216   {
6217     "type": "put",
6218     "url": "/api/cm/custom_fields/{id}",
6219     "title": "Update an existing Custom Field",
6220     "examples": [
6221       {
6222         "title": "Example usage:",
6223         "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",
6224         "type": "json"
6225       }
6226     ],
6227     "name": "updateCustom_Fields",
6228     "group": "Cm_Custom_Fields",
6229     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6230     "version": "0.0.0",
6231     "filename": "server/api/cmCustomField/index.js",
6232     "groupTitle": "Cm_Custom_Fields"
6233   },
6234   {
6235     "type": "post",
6236     "url": "/api/cm/hopper",
6237     "title": "Creates a new Hopper",
6238     "examples": [
6239       {
6240         "title": "Example usage:",
6241         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6242         "type": "json"
6243       }
6244     ],
6245     "name": "CreateHopper",
6246     "group": "Cm_Hopper",
6247     "parameter": {
6248       "fields": {
6249         "Body": [
6250           {
6251             "group": "Body",
6252             "type": "String",
6253             "optional": false,
6254             "field": "phone",
6255             "description": ""
6256           },
6257           {
6258             "group": "Body",
6259             "type": "Boolean",
6260             "optional": true,
6261             "field": "active",
6262             "description": ""
6263           },
6264           {
6265             "group": "Body",
6266             "type": "String",
6267             "optional": true,
6268             "field": "scheduledat",
6269             "description": ""
6270           },
6271           {
6272             "group": "Body",
6273             "type": "Integer",
6274             "optional": true,
6275             "field": "countbusyretry",
6276             "description": ""
6277           },
6278           {
6279             "group": "Body",
6280             "type": "Integer",
6281             "optional": true,
6282             "field": "countcongestionretry",
6283             "description": ""
6284           },
6285           {
6286             "group": "Body",
6287             "type": "Integer",
6288             "optional": true,
6289             "field": "countnoanswerretry",
6290             "description": ""
6291           },
6292           {
6293             "group": "Body",
6294             "type": "Boolean",
6295             "optional": true,
6296             "field": "callback",
6297             "description": ""
6298           },
6299           {
6300             "group": "Body",
6301             "type": "String",
6302             "optional": true,
6303             "field": "callbackuniqueid",
6304             "description": ""
6305           },
6306           {
6307             "group": "Body",
6308             "type": "String",
6309             "optional": true,
6310             "field": "callbackat",
6311             "description": ""
6312           },
6313           {
6314             "group": "Body",
6315             "type": "Integer",
6316             "optional": true,
6317             "field": "priority",
6318             "description": ""
6319           },
6320           {
6321             "group": "Body",
6322             "type": "Boolean",
6323             "optional": true,
6324             "field": "recallme",
6325             "description": ""
6326           },
6327           {
6328             "group": "Body",
6329             "type": "Integer",
6330             "optional": true,
6331             "field": "ContactId",
6332             "description": ""
6333           },
6334           {
6335             "group": "Body",
6336             "type": "Integer",
6337             "optional": true,
6338             "field": "ListId",
6339             "description": ""
6340           },
6341           {
6342             "group": "Body",
6343             "type": "Integer",
6344             "optional": true,
6345             "field": "UserId",
6346             "description": ""
6347           },
6348           {
6349             "group": "Body",
6350             "type": "Integer",
6351             "optional": true,
6352             "field": "VoiceQueueId",
6353             "description": ""
6354           },
6355           {
6356             "group": "Body",
6357             "type": "Integer",
6358             "optional": true,
6359             "field": "CampaignId",
6360             "description": ""
6361           },
6362           {
6363             "group": "Body",
6364             "type": "Integer",
6365             "optional": true,
6366             "field": "countnosuchnumberretry",
6367             "description": ""
6368           },
6369           {
6370             "group": "Body",
6371             "type": "Integer",
6372             "optional": true,
6373             "field": "countdropretry",
6374             "description": ""
6375           },
6376           {
6377             "group": "Body",
6378             "type": "Integer",
6379             "optional": true,
6380             "field": "countabandonedretry",
6381             "description": ""
6382           },
6383           {
6384             "group": "Body",
6385             "type": "Integer",
6386             "optional": true,
6387             "field": "countmachineretry",
6388             "description": ""
6389           },
6390           {
6391             "group": "Body",
6392             "type": "Integer",
6393             "optional": true,
6394             "field": "countagentrejectretry",
6395             "description": ""
6396           }
6397         ]
6398       }
6399     },
6400     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6401     "version": "0.0.0",
6402     "filename": "server/api/cmHopper/index.js",
6403     "groupTitle": "Cm_Hopper"
6404   },
6405   {
6406     "type": "get",
6407     "url": "/api/cm/hopper/describe",
6408     "title": "Gets table info about Hopper",
6409     "examples": [
6410       {
6411         "title": "Example usage:",
6412         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6413         "type": "json"
6414       }
6415     ],
6416     "name": "DescribeHopper",
6417     "group": "Cm_Hopper",
6418     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6419     "version": "0.0.0",
6420     "filename": "server/api/cmHopper/index.js",
6421     "groupTitle": "Cm_Hopper"
6422   },
6423   {
6424     "type": "get",
6425     "url": "/api/cm/hopper",
6426     "title": "Gets a list of Hopper",
6427     "examples": [
6428       {
6429         "title": "Example usage:",
6430         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6431         "type": "json"
6432       }
6433     ],
6434     "name": "GetHopper",
6435     "group": "Cm_Hopper",
6436     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6437     "version": "0.0.0",
6438     "filename": "server/api/cmHopper/index.js",
6439     "groupTitle": "Cm_Hopper"
6440   },
6441   {
6442     "type": "get",
6443     "url": "/api/cm/hopper/{id}",
6444     "title": "Gets a single Hopper",
6445     "examples": [
6446       {
6447         "title": "Example usage:",
6448         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6449         "type": "json"
6450       }
6451     ],
6452     "name": "ShowHopper",
6453     "group": "Cm_Hopper",
6454     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6455     "version": "0.0.0",
6456     "filename": "server/api/cmHopper/index.js",
6457     "groupTitle": "Cm_Hopper"
6458   },
6459   {
6460     "type": "delete",
6461     "url": "/api/cm/hopper_black/{id}",
6462     "title": "Deletes a Hopper Black",
6463     "examples": [
6464       {
6465         "title": "Example usage:",
6466         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6467         "type": "json"
6468       }
6469     ],
6470     "name": "DeleteHopper_Black",
6471     "group": "Cm_Hopper_Black",
6472     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6473     "version": "0.0.0",
6474     "filename": "server/api/cmHopperBlack/index.js",
6475     "groupTitle": "Cm_Hopper_Black"
6476   },
6477   {
6478     "type": "get",
6479     "url": "/api/cm/hopper_black/describe",
6480     "title": "Gets table info about Hopper Black",
6481     "examples": [
6482       {
6483         "title": "Example usage:",
6484         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6485         "type": "json"
6486       }
6487     ],
6488     "name": "DescribeHopper_Black",
6489     "group": "Cm_Hopper_Black",
6490     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6491     "version": "0.0.0",
6492     "filename": "server/api/cmHopperBlack/index.js",
6493     "groupTitle": "Cm_Hopper_Black"
6494   },
6495   {
6496     "type": "get",
6497     "url": "/api/cm/hopper_black",
6498     "title": "Gets a list of Hopper Black",
6499     "examples": [
6500       {
6501         "title": "Example usage:",
6502         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6503         "type": "json"
6504       }
6505     ],
6506     "name": "GetHopper_Black",
6507     "group": "Cm_Hopper_Black",
6508     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6509     "version": "0.0.0",
6510     "filename": "server/api/cmHopperBlack/index.js",
6511     "groupTitle": "Cm_Hopper_Black"
6512   },
6513   {
6514     "type": "get",
6515     "url": "/api/cm/hopper_black/{id}",
6516     "title": "Gets a single Hopper Black",
6517     "examples": [
6518       {
6519         "title": "Example usage:",
6520         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6521         "type": "json"
6522       }
6523     ],
6524     "name": "ShowHopper_Black",
6525     "group": "Cm_Hopper_Black",
6526     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6527     "version": "0.0.0",
6528     "filename": "server/api/cmHopperBlack/index.js",
6529     "groupTitle": "Cm_Hopper_Black"
6530   },
6531   {
6532     "type": "put",
6533     "url": "/api/cm/hopper_black/{id}",
6534     "title": "Update an existing Hopper Black",
6535     "examples": [
6536       {
6537         "title": "Example usage:",
6538         "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",
6539         "type": "json"
6540       }
6541     ],
6542     "name": "updateHopper_Black",
6543     "group": "Cm_Hopper_Black",
6544     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6545     "version": "0.0.0",
6546     "filename": "server/api/cmHopperBlack/index.js",
6547     "groupTitle": "Cm_Hopper_Black"
6548   },
6549   {
6550     "type": "post",
6551     "url": "/api/cm/hopper_final/checkContactHopper",
6552     "title": "Check if contact is in hopper",
6553     "examples": [
6554       {
6555         "title": "Example usage:",
6556         "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",
6557         "type": "json"
6558       }
6559     ],
6560     "name": "/checkContactHopper",
6561     "group": "Cm_Hopper_Final",
6562     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6563     "version": "0.0.0",
6564     "filename": "server/api/cmHopperFinal/index.js",
6565     "groupTitle": "Cm_Hopper_Final"
6566   },
6567   {
6568     "type": "get",
6569     "url": "/api/cm/hopper_final/describe",
6570     "title": "Gets table info about HopperFinal",
6571     "examples": [
6572       {
6573         "title": "Example usage:",
6574         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6575         "type": "json"
6576       }
6577     ],
6578     "name": "DescribeHopperFinal",
6579     "group": "Cm_Hopper_Final",
6580     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6581     "version": "0.0.0",
6582     "filename": "server/api/cmHopperFinal/index.js",
6583     "groupTitle": "Cm_Hopper_Final"
6584   },
6585   {
6586     "type": "get",
6587     "url": "/api/cm/hopper_final",
6588     "title": "Gets a list of HopperFinal",
6589     "examples": [
6590       {
6591         "title": "Example usage:",
6592         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6593         "type": "json"
6594       }
6595     ],
6596     "name": "GetHopperFinal",
6597     "group": "Cm_Hopper_Final",
6598     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6599     "version": "0.0.0",
6600     "filename": "server/api/cmHopperFinal/index.js",
6601     "groupTitle": "Cm_Hopper_Final"
6602   },
6603   {
6604     "type": "get",
6605     "url": "/api/cm/hopper_final/{id}",
6606     "title": "Gets a single HopperFinal",
6607     "examples": [
6608       {
6609         "title": "Example usage:",
6610         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6611         "type": "json"
6612       }
6613     ],
6614     "name": "ShowHopperFinal",
6615     "group": "Cm_Hopper_Final",
6616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6617     "version": "0.0.0",
6618     "filename": "server/api/cmHopperFinal/index.js",
6619     "groupTitle": "Cm_Hopper_Final"
6620   },
6621   {
6622     "type": "get",
6623     "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6624     "title": "Return number contacts for attributes",
6625     "examples": [
6626       {
6627         "title": "Example usage:",
6628         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6629         "type": "json"
6630       }
6631     ],
6632     "name": "countContactsIvrCampaignHopperFinal",
6633     "group": "Cm_Hopper_Final",
6634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6635     "version": "0.0.0",
6636     "filename": "server/api/cmHopperFinal/index.js",
6637     "groupTitle": "Cm_Hopper_Final"
6638   },
6639   {
6640     "type": "get",
6641     "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6642     "title": "Return number contacts for attributes",
6643     "examples": [
6644       {
6645         "title": "Example usage:",
6646         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6647         "type": "json"
6648       }
6649     ],
6650     "name": "countContactsQueueCampaignHopperFinal",
6651     "group": "Cm_Hopper_Final",
6652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6653     "version": "0.0.0",
6654     "filename": "server/api/cmHopperFinal/index.js",
6655     "groupTitle": "Cm_Hopper_Final"
6656   },
6657   {
6658     "type": "post",
6659     "url": "/api/cm/hopper_final/campaign/{id}",
6660     "title": "Move contacts in hopper",
6661     "examples": [
6662       {
6663         "title": "Example usage:",
6664         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6665         "type": "json"
6666       }
6667     ],
6668     "name": "moveContactsIvrCampaignHopperFinal",
6669     "group": "Cm_Hopper_Final",
6670     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6671     "version": "0.0.0",
6672     "filename": "server/api/cmHopperFinal/index.js",
6673     "groupTitle": "Cm_Hopper_Final"
6674   },
6675   {
6676     "type": "post",
6677     "url": "/api/cm/hopper_final/voice/queue/{id}",
6678     "title": "Move contacts in hopper",
6679     "examples": [
6680       {
6681         "title": "Example usage:",
6682         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6683         "type": "json"
6684       }
6685     ],
6686     "name": "moveContactsQueueCampaignHopperFinal",
6687     "group": "Cm_Hopper_Final",
6688     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6689     "version": "0.0.0",
6690     "filename": "server/api/cmHopperFinal/index.js",
6691     "groupTitle": "Cm_Hopper_Final"
6692   },
6693   {
6694     "type": "put",
6695     "url": "/api/cm/hopper_final/{id}",
6696     "title": "Update a single hopper final",
6697     "examples": [
6698       {
6699         "title": "Example usage:",
6700         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6701         "type": "json"
6702       }
6703     ],
6704     "name": "update",
6705     "group": "Cm_Hopper_Final",
6706     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6707     "version": "0.0.0",
6708     "filename": "server/api/cmHopperFinal/index.js",
6709     "groupTitle": "Cm_Hopper_Final"
6710   },
6711   {
6712     "type": "post",
6713     "url": "/api/cm/hopper_history",
6714     "title": "Creates a new HopperHistory",
6715     "examples": [
6716       {
6717         "title": "Example usage:",
6718         "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",
6719         "type": "json"
6720       }
6721     ],
6722     "name": "CreateHopperHistory",
6723     "group": "Cm_Hopper_History",
6724     "parameter": {
6725       "fields": {
6726         "Body": [
6727           {
6728             "group": "Body",
6729             "type": "Integer",
6730             "optional": true,
6731             "field": "state",
6732             "description": ""
6733           },
6734           {
6735             "group": "Body",
6736             "type": "String",
6737             "optional": true,
6738             "field": "statedesc",
6739             "description": ""
6740           },
6741           {
6742             "group": "Body",
6743             "type": "String",
6744             "optional": true,
6745             "field": "scheduledat",
6746             "description": ""
6747           },
6748           {
6749             "group": "Body",
6750             "type": "Integer",
6751             "optional": true,
6752             "field": "countbusyretry",
6753             "description": ""
6754           },
6755           {
6756             "group": "Body",
6757             "type": "Integer",
6758             "optional": true,
6759             "field": "countcongestionretry",
6760             "description": ""
6761           },
6762           {
6763             "group": "Body",
6764             "type": "Integer",
6765             "optional": true,
6766             "field": "countnoanswerretry",
6767             "description": ""
6768           },
6769           {
6770             "group": "Body",
6771             "type": "Integer",
6772             "optional": true,
6773             "field": "countglobal",
6774             "description": ""
6775           },
6776           {
6777             "group": "Body",
6778             "type": "String",
6779             "optional": true,
6780             "field": "uniqueid",
6781             "description": ""
6782           },
6783           {
6784             "group": "Body",
6785             "type": "String",
6786             "optional": true,
6787             "field": "originatecalleridnum",
6788             "description": ""
6789           },
6790           {
6791             "group": "Body",
6792             "type": "String",
6793             "optional": true,
6794             "field": "originatecalleridname",
6795             "description": ""
6796           },
6797           {
6798             "group": "Body",
6799             "type": "String",
6800             "optional": true,
6801             "field": "calleridnum",
6802             "description": ""
6803           },
6804           {
6805             "group": "Body",
6806             "type": "String",
6807             "optional": true,
6808             "field": "calleridname",
6809             "description": ""
6810           },
6811           {
6812             "group": "Body",
6813             "type": "String",
6814             "optional": true,
6815             "field": "starttime",
6816             "description": ""
6817           },
6818           {
6819             "group": "Body",
6820             "type": "String",
6821             "optional": true,
6822             "field": "responsetime",
6823             "description": ""
6824           },
6825           {
6826             "group": "Body",
6827             "type": "String",
6828             "optional": true,
6829             "field": "answertime",
6830             "description": ""
6831           },
6832           {
6833             "group": "Body",
6834             "type": "String",
6835             "optional": true,
6836             "field": "droptime",
6837             "description": ""
6838           },
6839           {
6840             "group": "Body",
6841             "type": "String",
6842             "optional": true,
6843             "field": "endtime",
6844             "description": ""
6845           },
6846           {
6847             "group": "Body",
6848             "type": "Integer",
6849             "optional": true,
6850             "field": "ringtime",
6851             "description": ""
6852           },
6853           {
6854             "group": "Body",
6855             "type": "Integer",
6856             "optional": true,
6857             "field": "holdtime",
6858             "description": ""
6859           },
6860           {
6861             "group": "Body",
6862             "type": "Integer",
6863             "optional": true,
6864             "field": "talktime",
6865             "description": ""
6866           },
6867           {
6868             "group": "Body",
6869             "type": "Integer",
6870             "optional": true,
6871             "field": "followuptime",
6872             "description": ""
6873           },
6874           {
6875             "group": "Body",
6876             "type": "String",
6877             "optional": true,
6878             "field": "dropreason",
6879             "description": ""
6880           },
6881           {
6882             "group": "Body",
6883             "type": "String",
6884             "optional": true,
6885             "field": "campaign",
6886             "description": ""
6887           },
6888           {
6889             "group": "Body",
6890             "type": "String",
6891             "optional": true,
6892             "field": "campaigntype",
6893             "description": ""
6894           },
6895           {
6896             "group": "Body",
6897             "type": "String",
6898             "optional": true,
6899             "field": "membername",
6900             "description": ""
6901           },
6902           {
6903             "group": "Body",
6904             "type": "String",
6905             "optional": true,
6906             "field": "reason",
6907             "description": ""
6908           },
6909           {
6910             "group": "Body",
6911             "type": "Boolean",
6912             "optional": true,
6913             "field": "amd",
6914             "description": ""
6915           },
6916           {
6917             "group": "Body",
6918             "type": "Boolean",
6919             "optional": true,
6920             "field": "fax",
6921             "description": ""
6922           },
6923           {
6924             "group": "Body",
6925             "type": "Boolean",
6926             "optional": true,
6927             "field": "callback",
6928             "description": ""
6929           },
6930           {
6931             "group": "Body",
6932             "type": "String",
6933             "optional": true,
6934             "field": "callbackuniqueid",
6935             "description": ""
6936           },
6937           {
6938             "group": "Body",
6939             "type": "String",
6940             "optional": true,
6941             "field": "callbackat",
6942             "description": ""
6943           },
6944           {
6945             "group": "Body",
6946             "type": "Boolean",
6947             "optional": true,
6948             "field": "recallme",
6949             "description": ""
6950           },
6951           {
6952             "group": "Body",
6953             "type": "String",
6954             "optional": true,
6955             "field": "editedat",
6956             "description": ""
6957           },
6958           {
6959             "group": "Body",
6960             "type": "Boolean",
6961             "optional": true,
6962             "field": "edited",
6963             "description": ""
6964           },
6965           {
6966             "group": "Body",
6967             "type": "Integer",
6968             "optional": true,
6969             "field": "countnosuchnumberretry",
6970             "description": ""
6971           },
6972           {
6973             "group": "Body",
6974             "type": "Integer",
6975             "optional": true,
6976             "field": "countdropretry",
6977             "description": ""
6978           },
6979           {
6980             "group": "Body",
6981             "type": "Integer",
6982             "optional": true,
6983             "field": "countabandonedretry",
6984             "description": ""
6985           },
6986           {
6987             "group": "Body",
6988             "type": "Integer",
6989             "optional": true,
6990             "field": "countmachineretry",
6991             "description": ""
6992           },
6993           {
6994             "group": "Body",
6995             "type": "Integer",
6996             "optional": true,
6997             "field": "countagentrejectretry",
6998             "description": ""
6999           }
7000         ]
7001       }
7002     },
7003     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7004     "version": "0.0.0",
7005     "filename": "server/api/cmHopperHistory/index.js",
7006     "groupTitle": "Cm_Hopper_History"
7007   },
7008   {
7009     "type": "get",
7010     "url": "/api/cm/hopper_history/describe",
7011     "title": "Gets table info about HopperHistory",
7012     "examples": [
7013       {
7014         "title": "Example usage:",
7015         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
7016         "type": "json"
7017       }
7018     ],
7019     "name": "DescribeHopperHistory",
7020     "group": "Cm_Hopper_History",
7021     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7022     "version": "0.0.0",
7023     "filename": "server/api/cmHopperHistory/index.js",
7024     "groupTitle": "Cm_Hopper_History"
7025   },
7026   {
7027     "type": "get",
7028     "url": "/api/cm/hopper_history",
7029     "title": "Gets a list of HopperHistory",
7030     "examples": [
7031       {
7032         "title": "Example usage:",
7033         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
7034         "type": "json"
7035       }
7036     ],
7037     "name": "GetHopperHistory",
7038     "group": "Cm_Hopper_History",
7039     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7040     "version": "0.0.0",
7041     "filename": "server/api/cmHopperHistory/index.js",
7042     "groupTitle": "Cm_Hopper_History"
7043   },
7044   {
7045     "type": "get",
7046     "url": "/api/cm/hopper_history/{id}",
7047     "title": "Gets a single HopperHistory",
7048     "examples": [
7049       {
7050         "title": "Example usage:",
7051         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
7052         "type": "json"
7053       }
7054     ],
7055     "name": "ShowHopperHistory",
7056     "group": "Cm_Hopper_History",
7057     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7058     "version": "0.0.0",
7059     "filename": "server/api/cmHopperHistory/index.js",
7060     "groupTitle": "Cm_Hopper_History"
7061   },
7062   {
7063     "type": "put",
7064     "url": "/api/cm/hopper_history/{id}",
7065     "title": "Update a single hopper history",
7066     "examples": [
7067       {
7068         "title": "Example usage:",
7069         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
7070         "type": "json"
7071       }
7072     ],
7073     "name": "update",
7074     "group": "Cm_Hopper_History",
7075     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7076     "version": "0.0.0",
7077     "filename": "server/api/cmHopperHistory/index.js",
7078     "groupTitle": "Cm_Hopper_History"
7079   },
7080   {
7081     "type": "delete",
7082     "url": "/api/cm/hopper/{id}",
7083     "title": "Delete Hopper",
7084     "examples": [
7085       {
7086         "title": "Example usage:",
7087         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
7088         "type": "json"
7089       }
7090     ],
7091     "name": "destroy",
7092     "group": "Cm_Hopper",
7093     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7094     "version": "0.0.0",
7095     "filename": "server/api/cmHopper/index.js",
7096     "groupTitle": "Cm_Hopper"
7097   },
7098   {
7099     "type": "get",
7100     "url": "/api/cm/hopper/opencontacts",
7101     "title": "Gets Open Contacts",
7102     "examples": [
7103       {
7104         "title": "Example usage:",
7105         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
7106         "type": "json"
7107       }
7108     ],
7109     "name": "getOpenContacts",
7110     "group": "Cm_Hopper",
7111     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7112     "version": "0.0.0",
7113     "filename": "server/api/cmHopper/index.js",
7114     "groupTitle": "Cm_Hopper"
7115   },
7116   {
7117     "type": "post",
7118     "url": "/api/cm/hopper/preview",
7119     "title": "Gets Preview Dialer Contacts",
7120     "examples": [
7121       {
7122         "title": "Example usage:",
7123         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
7124         "type": "json"
7125       }
7126     ],
7127     "name": "getPreview",
7128     "group": "Cm_Hopper",
7129     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7130     "version": "0.0.0",
7131     "filename": "server/api/cmHopper/index.js",
7132     "groupTitle": "Cm_Hopper"
7133   },
7134   {
7135     "type": "put",
7136     "url": "/api/cm/hopper/{id}",
7137     "title": "Update an existing Hopper",
7138     "examples": [
7139       {
7140         "title": "Example usage:",
7141         "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",
7142         "type": "json"
7143       }
7144     ],
7145     "name": "updateHopper",
7146     "group": "Cm_Hopper",
7147     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7148     "version": "0.0.0",
7149     "filename": "server/api/cmHopper/index.js",
7150     "groupTitle": "Cm_Hopper"
7151   },
7152   {
7153     "type": "post",
7154     "url": "/api/cm/lists",
7155     "title": "Creates a new List",
7156     "examples": [
7157       {
7158         "title": "Example usage:",
7159         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7160         "type": "json"
7161       }
7162     ],
7163     "name": "CreateLists",
7164     "group": "Cm_Lists",
7165     "parameter": {
7166       "fields": {
7167         "Body": [
7168           {
7169             "group": "Body",
7170             "type": "String",
7171             "optional": false,
7172             "field": "name",
7173             "description": ""
7174           },
7175           {
7176             "group": "Body",
7177             "type": "String",
7178             "optional": true,
7179             "field": "description",
7180             "description": ""
7181           },
7182           {
7183             "group": "Body",
7184             "type": "String",
7185             "optional": true,
7186             "field": "dialPrefix",
7187             "description": ""
7188           }
7189         ]
7190       }
7191     },
7192     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7193     "version": "0.0.0",
7194     "filename": "server/api/cmList/index.js",
7195     "groupTitle": "Cm_Lists"
7196   },
7197   {
7198     "type": "delete",
7199     "url": "/api/cm/lists/{id}",
7200     "title": "Deletes a List",
7201     "examples": [
7202       {
7203         "title": "Example usage:",
7204         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
7205         "type": "json"
7206       }
7207     ],
7208     "name": "DeleteLists",
7209     "group": "Cm_Lists",
7210     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7211     "version": "0.0.0",
7212     "filename": "server/api/cmList/index.js",
7213     "groupTitle": "Cm_Lists"
7214   },
7215   {
7216     "type": "get",
7217     "url": "/api/cm/lists/describe",
7218     "title": "Gets table info about Lists",
7219     "examples": [
7220       {
7221         "title": "Example usage:",
7222         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
7223         "type": "json"
7224       }
7225     ],
7226     "name": "DescribeLists",
7227     "group": "Cm_Lists",
7228     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7229     "version": "0.0.0",
7230     "filename": "server/api/cmList/index.js",
7231     "groupTitle": "Cm_Lists"
7232   },
7233   {
7234     "type": "get",
7235     "url": "/api/cm/lists/{id}/users",
7236     "title": "Gets agents from list",
7237     "examples": [
7238       {
7239         "title": "Example usage:",
7240         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
7241         "type": "json"
7242       }
7243     ],
7244     "name": "GetAgents",
7245     "group": "Cm_Lists",
7246     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7247     "version": "0.0.0",
7248     "filename": "server/api/cmList/index.js",
7249     "groupTitle": "Cm_Lists"
7250   },
7251   {
7252     "type": "get",
7253     "url": "/api/cm/lists",
7254     "title": "Gets a list of Lists",
7255     "examples": [
7256       {
7257         "title": "Example usage:",
7258         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
7259         "type": "json"
7260       }
7261     ],
7262     "name": "GetLists",
7263     "group": "Cm_Lists",
7264     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7265     "version": "0.0.0",
7266     "filename": "server/api/cmList/index.js",
7267     "groupTitle": "Cm_Lists"
7268   },
7269   {
7270     "type": "delete",
7271     "url": "/api/cm/lists/{id}/users",
7272     "title": "Removes agents from a list",
7273     "examples": [
7274       {
7275         "title": "Example usage:",
7276         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7277         "type": "json"
7278       }
7279     ],
7280     "name": "RemoveAgents",
7281     "group": "Cm_Lists",
7282     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7283     "version": "0.0.0",
7284     "filename": "server/api/cmList/index.js",
7285     "groupTitle": "Cm_Lists"
7286   },
7287   {
7288     "type": "delete",
7289     "url": "/api/cm/lists/{id}/dispositions",
7290     "title": "Removes dispositions from account",
7291     "examples": [
7292       {
7293         "title": "Example usage:",
7294         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7295         "type": "json"
7296       }
7297     ],
7298     "name": "RemoveDispositions",
7299     "group": "Cm_Lists",
7300     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7301     "version": "0.0.0",
7302     "filename": "server/api/cmList/index.js",
7303     "groupTitle": "Cm_Lists"
7304   },
7305   {
7306     "type": "get",
7307     "url": "/api/cm/lists/{id}",
7308     "title": "Gets a single List",
7309     "examples": [
7310       {
7311         "title": "Example usage:",
7312         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7313         "type": "json"
7314       }
7315     ],
7316     "name": "ShowLists",
7317     "group": "Cm_Lists",
7318     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7319     "version": "0.0.0",
7320     "filename": "server/api/cmList/index.js",
7321     "groupTitle": "Cm_Lists"
7322   },
7323   {
7324     "type": "post",
7325     "url": "/api/cm/lists/{id}/users",
7326     "title": "Adds agents to a list",
7327     "examples": [
7328       {
7329         "title": "Example usage:",
7330         "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",
7331         "type": "json"
7332       }
7333     ],
7334     "name": "addAgents",
7335     "group": "Cm_Lists",
7336     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7337     "version": "0.0.0",
7338     "filename": "server/api/cmList/index.js",
7339     "groupTitle": "Cm_Lists"
7340   },
7341   {
7342     "type": "post",
7343     "url": "/api/cm/lists/{id}/contacts",
7344     "title": "Creates new contacts",
7345     "examples": [
7346       {
7347         "title": "Example usage:",
7348         "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",
7349         "type": "json"
7350       }
7351     ],
7352     "name": "addContacts",
7353     "group": "Cm_Lists",
7354     "parameter": {
7355       "fields": {
7356         "Body": [
7357           {
7358             "group": "Body",
7359             "type": "String",
7360             "optional": false,
7361             "field": "firstName",
7362             "description": ""
7363           },
7364           {
7365             "group": "Body",
7366             "type": "String",
7367             "optional": true,
7368             "field": "lastName",
7369             "description": ""
7370           },
7371           {
7372             "group": "Body",
7373             "type": "String",
7374             "optional": true,
7375             "field": "street",
7376             "description": ""
7377           },
7378           {
7379             "group": "Body",
7380             "type": "String",
7381             "optional": true,
7382             "field": "postalCode",
7383             "description": ""
7384           },
7385           {
7386             "group": "Body",
7387             "type": "String",
7388             "optional": true,
7389             "field": "city",
7390             "description": ""
7391           },
7392           {
7393             "group": "Body",
7394             "type": "String",
7395             "optional": true,
7396             "field": "country",
7397             "description": ""
7398           },
7399           {
7400             "group": "Body",
7401             "type": "String",
7402             "optional": true,
7403             "field": "dateOfBirth",
7404             "description": ""
7405           },
7406           {
7407             "group": "Body",
7408             "type": "Text",
7409             "optional": true,
7410             "field": "description",
7411             "description": ""
7412           },
7413           {
7414             "group": "Body",
7415             "type": "String",
7416             "optional": true,
7417             "field": "phone",
7418             "description": ""
7419           },
7420           {
7421             "group": "Body",
7422             "type": "String",
7423             "optional": true,
7424             "field": "mobile",
7425             "description": ""
7426           },
7427           {
7428             "group": "Body",
7429             "type": "String",
7430             "optional": true,
7431             "field": "fax",
7432             "description": ""
7433           },
7434           {
7435             "group": "Body",
7436             "type": "String",
7437             "optional": true,
7438             "field": "email",
7439             "description": ""
7440           },
7441           {
7442             "group": "Body",
7443             "type": "String",
7444             "optional": true,
7445             "field": "url",
7446             "description": ""
7447           },
7448           {
7449             "group": "Body",
7450             "type": "String",
7451             "optional": true,
7452             "field": "facebook",
7453             "description": ""
7454           },
7455           {
7456             "group": "Body",
7457             "type": "String",
7458             "optional": true,
7459             "field": "fb_data",
7460             "description": ""
7461           },
7462           {
7463             "group": "Body",
7464             "type": "String",
7465             "optional": true,
7466             "field": "twitter",
7467             "description": ""
7468           },
7469           {
7470             "group": "Body",
7471             "type": "String",
7472             "optional": true,
7473             "field": "skype",
7474             "description": ""
7475           },
7476           {
7477             "group": "Body",
7478             "type": "String",
7479             "optional": true,
7480             "field": "teams",
7481             "description": ""
7482           },
7483           {
7484             "group": "Body",
7485             "type": "String",
7486             "optional": true,
7487             "field": "viber",
7488             "description": ""
7489           },
7490           {
7491             "group": "Body",
7492             "type": "String",
7493             "optional": true,
7494             "field": "line",
7495             "description": ""
7496           },
7497           {
7498             "group": "Body",
7499             "type": "String",
7500             "optional": true,
7501             "field": "wechat",
7502             "description": ""
7503           },
7504           {
7505             "group": "Body",
7506             "type": "String",
7507             "optional": true,
7508             "field": "telegram",
7509             "description": ""
7510           },
7511           {
7512             "group": "Body",
7513             "type": "Integer",
7514             "optional": true,
7515             "field": "UserId",
7516             "description": ""
7517           },
7518           {
7519             "group": "Body",
7520             "type": "Integer",
7521             "optional": true,
7522             "field": "priority",
7523             "description": ""
7524           },
7525           {
7526             "group": "Body",
7527             "type": "String",
7528             "optional": true,
7529             "field": "scheduledat",
7530             "description": ""
7531           }
7532         ]
7533       }
7534     },
7535     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7536     "version": "0.0.0",
7537     "filename": "server/api/cmList/index.js",
7538     "groupTitle": "Cm_Lists"
7539   },
7540   {
7541     "type": "post",
7542     "url": "/api/cm/lists/{id}/fields",
7543     "title": "Creates a new custom field",
7544     "examples": [
7545       {
7546         "title": "Example usage:",
7547         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7548         "type": "json"
7549       }
7550     ],
7551     "name": "addCustomField",
7552     "group": "Cm_Lists",
7553     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7554     "version": "0.0.0",
7555     "filename": "server/api/cmList/index.js",
7556     "groupTitle": "Cm_Lists"
7557   },
7558   {
7559     "type": "post",
7560     "url": "/api/cm/lists/{id}/dispositions",
7561     "title": "Creates new disposition",
7562     "examples": [
7563       {
7564         "title": "Example usage:",
7565         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7566         "type": "json"
7567       }
7568     ],
7569     "name": "addDisposition",
7570     "group": "Cm_Lists",
7571     "parameter": {
7572       "fields": {
7573         "Body": [
7574           {
7575             "group": "Body",
7576             "type": "String",
7577             "optional": false,
7578             "field": "name",
7579             "description": ""
7580           },
7581           {
7582             "group": "Body",
7583             "type": "String",
7584             "allowedValues": [
7585               "\"first\"",
7586               "\"second\"",
7587               "\"third\""
7588             ],
7589             "optional": false,
7590             "field": "level",
7591             "description": ""
7592           },
7593           {
7594             "group": "Body",
7595             "type": "String",
7596             "optional": true,
7597             "field": "description",
7598             "description": ""
7599           }
7600         ]
7601       }
7602     },
7603     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7604     "version": "0.0.0",
7605     "filename": "server/api/cmList/index.js",
7606     "groupTitle": "Cm_Lists"
7607   },
7608   {
7609     "type": "get",
7610     "url": "/api/cm/lists/{id}/contacts",
7611     "title": "Gets List Contacts",
7612     "examples": [
7613       {
7614         "title": "Example usage:",
7615         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7616         "type": "json"
7617       }
7618     ],
7619     "name": "getContacts",
7620     "group": "Cm_Lists",
7621     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7622     "version": "0.0.0",
7623     "filename": "server/api/cmList/index.js",
7624     "groupTitle": "Cm_Lists"
7625   },
7626   {
7627     "type": "get",
7628     "url": "/api/cm/lists/{id}/fields",
7629     "title": "Gets Custom Fields",
7630     "examples": [
7631       {
7632         "title": "Example usage:",
7633         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7634         "type": "json"
7635       }
7636     ],
7637     "name": "getCustomFields",
7638     "group": "Cm_Lists",
7639     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7640     "version": "0.0.0",
7641     "filename": "server/api/cmList/index.js",
7642     "groupTitle": "Cm_Lists"
7643   },
7644   {
7645     "type": "get",
7646     "url": "/api/cm/lists/{id}/dispositions",
7647     "title": "Gets list dispositions",
7648     "examples": [
7649       {
7650         "title": "Example usage:",
7651         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7652         "type": "json"
7653       }
7654     ],
7655     "name": "getDispositions",
7656     "group": "Cm_Lists",
7657     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7658     "version": "0.0.0",
7659     "filename": "server/api/cmList/index.js",
7660     "groupTitle": "Cm_Lists"
7661   },
7662   {
7663     "type": "get",
7664     "url": "/api/cm/lists/{id}/contacts/csv",
7665     "title": "Gets CSV List Contacts",
7666     "examples": [
7667       {
7668         "title": "Example usage:",
7669         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7670         "type": "json"
7671       }
7672     ],
7673     "name": "grunt",
7674     "group": "Cm_Lists",
7675     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7676     "version": "0.0.0",
7677     "filename": "server/api/cmList/index.js",
7678     "groupTitle": "Cm_Lists"
7679   },
7680   {
7681     "type": "put",
7682     "url": "/api/cm/lists/{id}",
7683     "title": "Update an existing List",
7684     "examples": [
7685       {
7686         "title": "Example usage:",
7687         "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",
7688         "type": "json"
7689       }
7690     ],
7691     "name": "updateLists",
7692     "group": "Cm_Lists",
7693     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7694     "version": "0.0.0",
7695     "filename": "server/api/cmList/index.js",
7696     "groupTitle": "Cm_Lists"
7697   },
7698   {
7699     "type": "post",
7700     "url": "/api/cm/contacts/upload/:id",
7701     "title": "Import new contacts by csv",
7702     "examples": [
7703       {
7704         "title": "Example usage:",
7705         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7706         "type": "json"
7707       }
7708     ],
7709     "name": "import",
7710     "group": "Cm_contacts",
7711     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7712     "version": "0.0.0",
7713     "filename": "server/api/cmContact/index.js",
7714     "groupTitle": "Cm_contacts"
7715   },
7716   {
7717     "type": "post",
7718     "url": "/api/cm/contacts/upload",
7719     "title": "Upload csv",
7720     "examples": [
7721       {
7722         "title": "Example usage:",
7723         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7724         "type": "json"
7725       }
7726     ],
7727     "name": "upload",
7728     "group": "Cm_contacts",
7729     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7730     "version": "0.0.0",
7731     "filename": "server/api/cmContact/index.js",
7732     "groupTitle": "Cm_contacts"
7733   },
7734   {
7735     "type": "post",
7736     "url": "/api/cm/contacts/csv",
7737     "title": "Create new contacts by csv",
7738     "examples": [
7739       {
7740         "title": "Example usage:",
7741         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7742         "type": "json"
7743       }
7744     ],
7745     "name": "uploadCsv",
7746     "group": "Cm_contacts",
7747     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7748     "version": "0.0.0",
7749     "filename": "server/api/cmContact/index.js",
7750     "groupTitle": "Cm_contacts"
7751   },
7752   {
7753     "type": "delete",
7754     "url": "/api/conditions/{id}",
7755     "title": "Deletes a Condition",
7756     "examples": [
7757       {
7758         "title": "Example usage:",
7759         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7760         "type": "json"
7761       }
7762     ],
7763     "name": "DeleteConditions",
7764     "group": "Conditions",
7765     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7766     "version": "0.0.0",
7767     "filename": "server/api/condition/index.js",
7768     "groupTitle": "Conditions"
7769   },
7770   {
7771     "type": "put",
7772     "url": "/api/conditions/{id}",
7773     "title": "Update an existing Condition",
7774     "examples": [
7775       {
7776         "title": "Example usage:",
7777         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7778         "type": "json"
7779       }
7780     ],
7781     "name": "updateConditions",
7782     "group": "Conditions",
7783     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7784     "version": "0.0.0",
7785     "filename": "server/api/condition/index.js",
7786     "groupTitle": "Conditions"
7787   },
7788   {
7789     "type": "post",
7790     "url": "/api/cm/custom_field",
7791     "title": "Create a new custom field",
7792     "examples": [
7793       {
7794         "title": "Example usage:",
7795         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7796         "type": "json"
7797       }
7798     ],
7799     "name": "CreateCustomField",
7800     "group": "Custom_Fields",
7801     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7802     "version": "0.0.0",
7803     "filename": "server/api/cmCustomField/index.js",
7804     "groupTitle": "Custom_Fields"
7805   },
7806   {
7807     "type": "post",
7808     "url": "/api/dashboards/items",
7809     "title": "Create dasboard item",
7810     "examples": [
7811       {
7812         "title": "Example usage:",
7813         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7814         "type": "json"
7815       }
7816     ],
7817     "name": "Create",
7818     "group": "Dashboard_Items",
7819     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7820     "version": "0.0.0",
7821     "filename": "server/api/dashboardItem/index.js",
7822     "groupTitle": "Dashboard_Items"
7823   },
7824   {
7825     "type": "delete",
7826     "url": "/api/dashboards/items/{id}",
7827     "title": "Deletes a Dashboard Item",
7828     "examples": [
7829       {
7830         "title": "Example usage:",
7831         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7832         "type": "json"
7833       }
7834     ],
7835     "name": "DeleteDashboard_Items",
7836     "group": "Dashboard_Items",
7837     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7838     "version": "0.0.0",
7839     "filename": "server/api/dashboardItem/index.js",
7840     "groupTitle": "Dashboard_Items"
7841   },
7842   {
7843     "type": "get",
7844     "url": "/api/dashboards/items/{id}",
7845     "title": "Gets a single Dashboard Item",
7846     "examples": [
7847       {
7848         "title": "Example usage:",
7849         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7850         "type": "json"
7851       }
7852     ],
7853     "name": "ShowDashboard_Items",
7854     "group": "Dashboard_Items",
7855     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7856     "version": "0.0.0",
7857     "filename": "server/api/dashboardItem/index.js",
7858     "groupTitle": "Dashboard_Items"
7859   },
7860   {
7861     "type": "put",
7862     "url": "/api/dashboards/items/{id}",
7863     "title": "Update an existing item",
7864     "examples": [
7865       {
7866         "title": "Example usage:",
7867         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7868         "type": "json"
7869       }
7870     ],
7871     "name": "Update",
7872     "group": "Dashboard_Items",
7873     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7874     "version": "0.0.0",
7875     "filename": "server/api/dashboardItem/index.js",
7876     "groupTitle": "Dashboard_Items"
7877   },
7878   {
7879     "type": "post",
7880     "url": "/api/dashboards/clone",
7881     "title": "Clone an existing Dashboard",
7882     "examples": [
7883       {
7884         "title": "Example usage:",
7885         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7886         "type": "json"
7887       }
7888     ],
7889     "name": "CloneDashboards",
7890     "group": "Dashboards",
7891     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7892     "version": "0.0.0",
7893     "filename": "server/api/dashboard/index.js",
7894     "groupTitle": "Dashboards"
7895   },
7896   {
7897     "type": "post",
7898     "url": "/api/dashboards",
7899     "title": "Creates a new Dashboard",
7900     "examples": [
7901       {
7902         "title": "Example usage:",
7903         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7904         "type": "json"
7905       }
7906     ],
7907     "name": "CreateDashboards",
7908     "group": "Dashboards",
7909     "parameter": {
7910       "fields": {
7911         "Body": [
7912           {
7913             "group": "Body",
7914             "type": "String",
7915             "optional": false,
7916             "field": "name",
7917             "description": ""
7918           },
7919           {
7920             "group": "Body",
7921             "type": "String",
7922             "optional": true,
7923             "field": "description",
7924             "description": ""
7925           }
7926         ]
7927       }
7928     },
7929     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7930     "version": "0.0.0",
7931     "filename": "server/api/dashboard/index.js",
7932     "groupTitle": "Dashboards"
7933   },
7934   {
7935     "type": "delete",
7936     "url": "/api/dashboards/{id}",
7937     "title": "Deletes a Dashboard",
7938     "examples": [
7939       {
7940         "title": "Example usage:",
7941         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
7942         "type": "json"
7943       }
7944     ],
7945     "name": "DeleteDashboards",
7946     "group": "Dashboards",
7947     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7948     "version": "0.0.0",
7949     "filename": "server/api/dashboard/index.js",
7950     "groupTitle": "Dashboards"
7951   },
7952   {
7953     "type": "get",
7954     "url": "/api/dashboards",
7955     "title": "Gets a list of Dashboards",
7956     "examples": [
7957       {
7958         "title": "Example usage:",
7959         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
7960         "type": "json"
7961       }
7962     ],
7963     "name": "GetDashboards",
7964     "group": "Dashboards",
7965     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7966     "version": "0.0.0",
7967     "filename": "server/api/dashboard/index.js",
7968     "groupTitle": "Dashboards"
7969   },
7970   {
7971     "type": "get",
7972     "url": "/api/dashboards/{id}",
7973     "title": "Gets a single Dashboard",
7974     "examples": [
7975       {
7976         "title": "Example usage:",
7977         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
7978         "type": "json"
7979       }
7980     ],
7981     "name": "ShowDashboards",
7982     "group": "Dashboards",
7983     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7984     "version": "0.0.0",
7985     "filename": "server/api/dashboard/index.js",
7986     "groupTitle": "Dashboards"
7987   },
7988   {
7989     "type": "post",
7990     "url": "/api/dashboards/{id}/items",
7991     "title": "Creates new item",
7992     "examples": [
7993       {
7994         "title": "Example usage:",
7995         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7996         "type": "json"
7997       }
7998     ],
7999     "name": "addItem",
8000     "group": "Dashboards",
8001     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8002     "version": "0.0.0",
8003     "filename": "server/api/dashboard/index.js",
8004     "groupTitle": "Dashboards"
8005   },
8006   {
8007     "type": "get",
8008     "url": "/api/dashboards/{id}/items",
8009     "title": "Gets items",
8010     "examples": [
8011       {
8012         "title": "Example usage:",
8013         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
8014         "type": "json"
8015       }
8016     ],
8017     "name": "getItems",
8018     "group": "Dashboards",
8019     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8020     "version": "0.0.0",
8021     "filename": "server/api/dashboard/index.js",
8022     "groupTitle": "Dashboards"
8023   },
8024   {
8025     "type": "put",
8026     "url": "/api/dashboards/{id}",
8027     "title": "Update an existing Dashboard",
8028     "examples": [
8029       {
8030         "title": "Example usage:",
8031         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8032         "type": "json"
8033       }
8034     ],
8035     "name": "updateDashboards",
8036     "group": "Dashboards",
8037     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8038     "version": "0.0.0",
8039     "filename": "server/api/dashboard/index.js",
8040     "groupTitle": "Dashboards"
8041   },
8042   {
8043     "type": "post",
8044     "url": "/api/integrations/desk/accounts",
8045     "title": "Creates a new Desk Account",
8046     "examples": [
8047       {
8048         "title": "Example usage:",
8049         "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",
8050         "type": "json"
8051       }
8052     ],
8053     "name": "CreateDesk_Accounts",
8054     "group": "Desk_Accounts",
8055     "parameter": {
8056       "fields": {
8057         "Body": [
8058           {
8059             "group": "Body",
8060             "type": "String",
8061             "optional": true,
8062             "field": "name",
8063             "description": ""
8064           },
8065           {
8066             "group": "Body",
8067             "type": "String",
8068             "optional": true,
8069             "field": "description",
8070             "description": ""
8071           },
8072           {
8073             "group": "Body",
8074             "type": "String",
8075             "optional": true,
8076             "field": "username",
8077             "description": ""
8078           },
8079           {
8080             "group": "Body",
8081             "type": "String",
8082             "optional": true,
8083             "field": "remoteUri",
8084             "description": ""
8085           },
8086           {
8087             "group": "Body",
8088             "type": "String",
8089             "allowedValues": [
8090               "\"basic\""
8091             ],
8092             "optional": true,
8093             "field": "authType",
8094             "description": ""
8095           },
8096           {
8097             "group": "Body",
8098             "type": "String",
8099             "optional": true,
8100             "field": "password",
8101             "description": ""
8102           },
8103           {
8104             "group": "Body",
8105             "type": "String",
8106             "optional": true,
8107             "field": "consumerKey",
8108             "description": ""
8109           },
8110           {
8111             "group": "Body",
8112             "type": "String",
8113             "optional": true,
8114             "field": "consumerSecret",
8115             "description": ""
8116           },
8117           {
8118             "group": "Body",
8119             "type": "String",
8120             "optional": true,
8121             "field": "token",
8122             "description": ""
8123           },
8124           {
8125             "group": "Body",
8126             "type": "String",
8127             "optional": true,
8128             "field": "tokenSecret",
8129             "description": ""
8130           },
8131           {
8132             "group": "Body",
8133             "type": "String",
8134             "optional": true,
8135             "field": "serverUrl",
8136             "description": ""
8137           },
8138           {
8139             "group": "Body",
8140             "type": "String",
8141             "allowedValues": [
8142               "\"integrationTab\"",
8143               "\"newTab\""
8144             ],
8145             "optional": true,
8146             "field": "type",
8147             "description": ""
8148           }
8149         ]
8150       }
8151     },
8152     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8153     "version": "0.0.0",
8154     "filename": "server/api/intDeskAccount/index.js",
8155     "groupTitle": "Desk_Accounts"
8156   },
8157   {
8158     "type": "delete",
8159     "url": "/api/integrations/desk/accounts/{id}",
8160     "title": "Deletes a Desk Account",
8161     "examples": [
8162       {
8163         "title": "Example usage:",
8164         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
8165         "type": "json"
8166       }
8167     ],
8168     "name": "DeleteDesk_Accounts",
8169     "group": "Desk_Accounts",
8170     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8171     "version": "0.0.0",
8172     "filename": "server/api/intDeskAccount/index.js",
8173     "groupTitle": "Desk_Accounts"
8174   },
8175   {
8176     "type": "get",
8177     "url": "/api/integrations/desk/accounts",
8178     "title": "Gets a list of Desk Accounts",
8179     "examples": [
8180       {
8181         "title": "Example usage:",
8182         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
8183         "type": "json"
8184       }
8185     ],
8186     "name": "GetDesk_Accounts",
8187     "group": "Desk_Accounts",
8188     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8189     "version": "0.0.0",
8190     "filename": "server/api/intDeskAccount/index.js",
8191     "groupTitle": "Desk_Accounts"
8192   },
8193   {
8194     "type": "get",
8195     "url": "/api/integrations/desk/accounts/{id}",
8196     "title": "Gets a single Desk Account",
8197     "examples": [
8198       {
8199         "title": "Example usage:",
8200         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
8201         "type": "json"
8202       }
8203     ],
8204     "name": "ShowDesk_Accounts",
8205     "group": "Desk_Accounts",
8206     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8207     "version": "0.0.0",
8208     "filename": "server/api/intDeskAccount/index.js",
8209     "groupTitle": "Desk_Accounts"
8210   },
8211   {
8212     "type": "post",
8213     "url": "/api/integrations/desk/accounts/{id}/configurations",
8214     "title": "Creates new configuration",
8215     "examples": [
8216       {
8217         "title": "Example usage:",
8218         "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",
8219         "type": "json"
8220       }
8221     ],
8222     "name": "addConfiguration",
8223     "group": "Desk_Accounts",
8224     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8225     "version": "0.0.0",
8226     "filename": "server/api/intDeskAccount/index.js",
8227     "groupTitle": "Desk_Accounts"
8228   },
8229   {
8230     "type": "get",
8231     "url": "/api/integrations/desk/accounts/{id}/configurations",
8232     "title": "Gets account configurations",
8233     "examples": [
8234       {
8235         "title": "Example usage:",
8236         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8237         "type": "json"
8238       }
8239     ],
8240     "name": "getConfigurations",
8241     "group": "Desk_Accounts",
8242     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8243     "version": "0.0.0",
8244     "filename": "server/api/intDeskAccount/index.js",
8245     "groupTitle": "Desk_Accounts"
8246   },
8247   {
8248     "type": "get",
8249     "url": "/api/integrations/desk/accounts/{id}/fields",
8250     "title": "Gets account fields",
8251     "examples": [
8252       {
8253         "title": "Example usage:",
8254         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
8255         "type": "json"
8256       }
8257     ],
8258     "name": "getFields",
8259     "group": "Desk_Accounts",
8260     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8261     "version": "0.0.0",
8262     "filename": "server/api/intDeskAccount/index.js",
8263     "groupTitle": "Desk_Accounts"
8264   },
8265   {
8266     "type": "put",
8267     "url": "/api/integrations/desk/accounts/{id}",
8268     "title": "Update an existing Desk Account",
8269     "examples": [
8270       {
8271         "title": "Example usage:",
8272         "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",
8273         "type": "json"
8274       }
8275     ],
8276     "name": "updateDesk_Accounts",
8277     "group": "Desk_Accounts",
8278     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8279     "version": "0.0.0",
8280     "filename": "server/api/intDeskAccount/index.js",
8281     "groupTitle": "Desk_Accounts"
8282   },
8283   {
8284     "type": "post",
8285     "url": "/api/integrations/desk/configurations",
8286     "title": "Creates a new Desk Configuration",
8287     "examples": [
8288       {
8289         "title": "Example usage:",
8290         "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",
8291         "type": "json"
8292       }
8293     ],
8294     "name": "CreateDesk_Configurations",
8295     "group": "Desk_Configurations",
8296     "parameter": {
8297       "fields": {
8298         "Body": [
8299           {
8300             "group": "Body",
8301             "type": "String",
8302             "optional": true,
8303             "field": "name",
8304             "description": ""
8305           },
8306           {
8307             "group": "Body",
8308             "type": "String",
8309             "optional": true,
8310             "field": "description",
8311             "description": ""
8312           }
8313         ]
8314       }
8315     },
8316     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8317     "version": "0.0.0",
8318     "filename": "server/api/intDeskConfiguration/index.js",
8319     "groupTitle": "Desk_Configurations"
8320   },
8321   {
8322     "type": "delete",
8323     "url": "/api/integrations/desk/configurations/{id}",
8324     "title": "Deletes a Desk Configuration",
8325     "examples": [
8326       {
8327         "title": "Example usage:",
8328         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8329         "type": "json"
8330       }
8331     ],
8332     "name": "DeleteDesk_Configurations",
8333     "group": "Desk_Configurations",
8334     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8335     "version": "0.0.0",
8336     "filename": "server/api/intDeskConfiguration/index.js",
8337     "groupTitle": "Desk_Configurations"
8338   },
8339   {
8340     "type": "get",
8341     "url": "/api/integrations/desk/configurations",
8342     "title": "Gets a list of Desk Configurations",
8343     "examples": [
8344       {
8345         "title": "Example usage:",
8346         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8347         "type": "json"
8348       }
8349     ],
8350     "name": "GetDesk_Configurations",
8351     "group": "Desk_Configurations",
8352     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8353     "version": "0.0.0",
8354     "filename": "server/api/intDeskConfiguration/index.js",
8355     "groupTitle": "Desk_Configurations"
8356   },
8357   {
8358     "type": "get",
8359     "url": "/api/integrations/desk/configurations/{id}",
8360     "title": "Gets a single Desk Configuration",
8361     "examples": [
8362       {
8363         "title": "Example usage:",
8364         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8365         "type": "json"
8366       }
8367     ],
8368     "name": "ShowDesk_Configurations",
8369     "group": "Desk_Configurations",
8370     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8371     "version": "0.0.0",
8372     "filename": "server/api/intDeskConfiguration/index.js",
8373     "groupTitle": "Desk_Configurations"
8374   },
8375   {
8376     "type": "get",
8377     "url": "/api/integrations/desk/configurations/{id}/descriptions",
8378     "title": "Gets configurations descriptions",
8379     "examples": [
8380       {
8381         "title": "Example usage:",
8382         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8383         "type": "json"
8384       }
8385     ],
8386     "name": "getDescriptions",
8387     "group": "Desk_Configurations",
8388     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8389     "version": "0.0.0",
8390     "filename": "server/api/intDeskConfiguration/index.js",
8391     "groupTitle": "Desk_Configurations"
8392   },
8393   {
8394     "type": "get",
8395     "url": "/api/integrations/desk/configurations/{id}/fields",
8396     "title": "Gets configurations fields",
8397     "examples": [
8398       {
8399         "title": "Example usage:",
8400         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8401         "type": "json"
8402       }
8403     ],
8404     "name": "getFields",
8405     "group": "Desk_Configurations",
8406     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8407     "version": "0.0.0",
8408     "filename": "server/api/intDeskConfiguration/index.js",
8409     "groupTitle": "Desk_Configurations"
8410   },
8411   {
8412     "type": "get",
8413     "url": "/api/integrations/desk/configurations/{id}/subjects",
8414     "title": "Gets configurations subjects",
8415     "examples": [
8416       {
8417         "title": "Example usage:",
8418         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8419         "type": "json"
8420       }
8421     ],
8422     "name": "getSubjects",
8423     "group": "Desk_Configurations",
8424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8425     "version": "0.0.0",
8426     "filename": "server/api/intDeskConfiguration/index.js",
8427     "groupTitle": "Desk_Configurations"
8428   },
8429   {
8430     "type": "get",
8431     "url": "/api/integrations/desk/configurations/{id}/tags",
8432     "title": "Gets configurations tags",
8433     "examples": [
8434       {
8435         "title": "Example usage:",
8436         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8437         "type": "json"
8438       }
8439     ],
8440     "name": "getTags",
8441     "group": "Desk_Configurations",
8442     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8443     "version": "0.0.0",
8444     "filename": "server/api/intDeskConfiguration/index.js",
8445     "groupTitle": "Desk_Configurations"
8446   },
8447   {
8448     "type": "post",
8449     "url": "/api/integrations/desk/configurations/{id}/tags",
8450     "title": "Sets new tags",
8451     "examples": [
8452       {
8453         "title": "Example usage:",
8454         "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",
8455         "type": "json"
8456       }
8457     ],
8458     "name": "setTags",
8459     "group": "Desk_Configurations",
8460     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8461     "version": "0.0.0",
8462     "filename": "server/api/intDeskConfiguration/index.js",
8463     "groupTitle": "Desk_Configurations"
8464   },
8465   {
8466     "type": "put",
8467     "url": "/api/integrations/desk/configurations/{id}",
8468     "title": "Update an existing Desk Configuration",
8469     "examples": [
8470       {
8471         "title": "Example usage:",
8472         "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",
8473         "type": "json"
8474       }
8475     ],
8476     "name": "updateDesk_Configurations",
8477     "group": "Desk_Configurations",
8478     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8479     "version": "0.0.0",
8480     "filename": "server/api/intDeskConfiguration/index.js",
8481     "groupTitle": "Desk_Configurations"
8482   },
8483   {
8484     "type": "post",
8485     "url": "/api/integrations/desk/fields",
8486     "title": "Creates a new Desk Field",
8487     "examples": [
8488       {
8489         "title": "Example usage:",
8490         "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",
8491         "type": "json"
8492       }
8493     ],
8494     "name": "CreateDesk_Fields",
8495     "group": "Desk_Fields",
8496     "parameter": {
8497       "fields": {
8498         "Body": [
8499           {
8500             "group": "Body",
8501             "type": "String",
8502             "allowedValues": [
8503               "\"string\"",
8504               "\"variable\"",
8505               "\"customVariable\"",
8506               "\"keyValue\""
8507             ],
8508             "optional": true,
8509             "field": "type",
8510             "description": ""
8511           },
8512           {
8513             "group": "Body",
8514             "type": "String",
8515             "optional": true,
8516             "field": "content",
8517             "description": ""
8518           },
8519           {
8520             "group": "Body",
8521             "type": "String",
8522             "optional": true,
8523             "field": "key",
8524             "description": ""
8525           },
8526           {
8527             "group": "Body",
8528             "type": "String",
8529             "allowedValues": [
8530               "\"string\"",
8531               "\"variable\"",
8532               "\"customVariable\""
8533             ],
8534             "optional": true,
8535             "field": "keyType",
8536             "description": ""
8537           },
8538           {
8539             "group": "Body",
8540             "type": "String",
8541             "optional": true,
8542             "field": "keyContent",
8543             "description": ""
8544           },
8545           {
8546             "group": "Body",
8547             "type": "String",
8548             "optional": true,
8549             "field": "idField",
8550             "description": ""
8551           },
8552           {
8553             "group": "Body",
8554             "type": "String",
8555             "optional": true,
8556             "field": "nameField",
8557             "description": ""
8558           },
8559           {
8560             "group": "Body",
8561             "type": "Boolean",
8562             "optional": true,
8563             "field": "customField",
8564             "description": ""
8565           },
8566           {
8567             "group": "Body",
8568             "type": "String",
8569             "optional": true,
8570             "field": "variableName",
8571             "description": ""
8572           }
8573         ]
8574       }
8575     },
8576     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8577     "version": "0.0.0",
8578     "filename": "server/api/intDeskField/index.js",
8579     "groupTitle": "Desk_Fields"
8580   },
8581   {
8582     "type": "delete",
8583     "url": "/api/integrations/desk/fields/{id}",
8584     "title": "Deletes a Desk Field",
8585     "examples": [
8586       {
8587         "title": "Example usage:",
8588         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8589         "type": "json"
8590       }
8591     ],
8592     "name": "DeleteDesk_Fields",
8593     "group": "Desk_Fields",
8594     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8595     "version": "0.0.0",
8596     "filename": "server/api/intDeskField/index.js",
8597     "groupTitle": "Desk_Fields"
8598   },
8599   {
8600     "type": "get",
8601     "url": "/api/integrations/desk/fields",
8602     "title": "Gets a list of Desk Fields",
8603     "examples": [
8604       {
8605         "title": "Example usage:",
8606         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8607         "type": "json"
8608       }
8609     ],
8610     "name": "GetDesk_Fields",
8611     "group": "Desk_Fields",
8612     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8613     "version": "0.0.0",
8614     "filename": "server/api/intDeskField/index.js",
8615     "groupTitle": "Desk_Fields"
8616   },
8617   {
8618     "type": "get",
8619     "url": "/api/integrations/desk/fields/{id}",
8620     "title": "Gets a single Desk Field",
8621     "examples": [
8622       {
8623         "title": "Example usage:",
8624         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8625         "type": "json"
8626       }
8627     ],
8628     "name": "ShowDesk_Fields",
8629     "group": "Desk_Fields",
8630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8631     "version": "0.0.0",
8632     "filename": "server/api/intDeskField/index.js",
8633     "groupTitle": "Desk_Fields"
8634   },
8635   {
8636     "type": "put",
8637     "url": "/api/integrations/desk/fields/{id}",
8638     "title": "Update an existing Desk Field",
8639     "examples": [
8640       {
8641         "title": "Example usage:",
8642         "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",
8643         "type": "json"
8644       }
8645     ],
8646     "name": "updateDesk_Fields",
8647     "group": "Desk_Fields",
8648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8649     "version": "0.0.0",
8650     "filename": "server/api/intDeskField/index.js",
8651     "groupTitle": "Desk_Fields"
8652   },
8653   {
8654     "type": "post",
8655     "url": "/api/dispositions",
8656     "title": "Creates a new Disposition",
8657     "examples": [
8658       {
8659         "title": "Example usage:",
8660         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8661         "type": "json"
8662       }
8663     ],
8664     "name": "CreateDispositions",
8665     "group": "Dispositions",
8666     "parameter": {
8667       "fields": {
8668         "Body": [
8669           {
8670             "group": "Body",
8671             "type": "String",
8672             "optional": false,
8673             "field": "name",
8674             "description": ""
8675           },
8676           {
8677             "group": "Body",
8678             "type": "String",
8679             "allowedValues": [
8680               "\"first\"",
8681               "\"second\"",
8682               "\"third\""
8683             ],
8684             "optional": false,
8685             "field": "level",
8686             "description": ""
8687           },
8688           {
8689             "group": "Body",
8690             "type": "String",
8691             "optional": true,
8692             "field": "description",
8693             "description": ""
8694           }
8695         ]
8696       }
8697     },
8698     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8699     "version": "0.0.0",
8700     "filename": "server/api/disposition/index.js",
8701     "groupTitle": "Dispositions"
8702   },
8703   {
8704     "type": "delete",
8705     "url": "/api/dispositions/{id}",
8706     "title": "Deletes a Disposition",
8707     "examples": [
8708       {
8709         "title": "Example usage:",
8710         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8711         "type": "json"
8712       }
8713     ],
8714     "name": "DeleteDispositions",
8715     "group": "Dispositions",
8716     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8717     "version": "0.0.0",
8718     "filename": "server/api/disposition/index.js",
8719     "groupTitle": "Dispositions"
8720   },
8721   {
8722     "type": "get",
8723     "url": "/api/dispositions",
8724     "title": "Gets a list of Dispositions",
8725     "examples": [
8726       {
8727         "title": "Example usage:",
8728         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8729         "type": "json"
8730       }
8731     ],
8732     "name": "GetDispositions",
8733     "group": "Dispositions",
8734     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8735     "version": "0.0.0",
8736     "filename": "server/api/disposition/index.js",
8737     "groupTitle": "Dispositions"
8738   },
8739   {
8740     "type": "get",
8741     "url": "/api/dispositions/{id}",
8742     "title": "Gets a single Disposition",
8743     "examples": [
8744       {
8745         "title": "Example usage:",
8746         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8747         "type": "json"
8748       }
8749     ],
8750     "name": "ShowDispositions",
8751     "group": "Dispositions",
8752     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8753     "version": "0.0.0",
8754     "filename": "server/api/disposition/index.js",
8755     "groupTitle": "Dispositions"
8756   },
8757   {
8758     "type": "put",
8759     "url": "/api/dispositions/{id}",
8760     "title": "Update an existing Disposition",
8761     "examples": [
8762       {
8763         "title": "Example usage:",
8764         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8765         "type": "json"
8766       }
8767     ],
8768     "name": "updateDispositions",
8769     "group": "Dispositions",
8770     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8771     "version": "0.0.0",
8772     "filename": "server/api/disposition/index.js",
8773     "groupTitle": "Dispositions"
8774   },
8775   {
8776     "type": "post",
8777     "url": "/api/integrations/dynamics365/accounts",
8778     "title": "Creates a new Dynamics365 Account",
8779     "examples": [
8780       {
8781         "title": "Example usage:",
8782         "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",
8783         "type": "json"
8784       }
8785     ],
8786     "name": "CreateDynamics365_Accounts",
8787     "group": "Dynamics365_Accounts",
8788     "parameter": {
8789       "fields": {
8790         "Body": [
8791           {
8792             "group": "Body",
8793             "type": "String",
8794             "optional": true,
8795             "field": "name",
8796             "description": ""
8797           },
8798           {
8799             "group": "Body",
8800             "type": "String",
8801             "optional": true,
8802             "field": "username",
8803             "description": ""
8804           },
8805           {
8806             "group": "Body",
8807             "type": "String",
8808             "optional": true,
8809             "field": "password",
8810             "description": ""
8811           },
8812           {
8813             "group": "Body",
8814             "type": "String",
8815             "optional": true,
8816             "field": "remoteUri",
8817             "description": ""
8818           },
8819           {
8820             "group": "Body",
8821             "type": "String",
8822             "optional": true,
8823             "field": "tenantId",
8824             "description": ""
8825           },
8826           {
8827             "group": "Body",
8828             "type": "String",
8829             "optional": true,
8830             "field": "clientId",
8831             "description": ""
8832           },
8833           {
8834             "group": "Body",
8835             "type": "String",
8836             "optional": true,
8837             "field": "clientSecret",
8838             "description": ""
8839           },
8840           {
8841             "group": "Body",
8842             "type": "String",
8843             "optional": true,
8844             "field": "serverUrl",
8845             "description": ""
8846           },
8847           {
8848             "group": "Body",
8849             "type": "String",
8850             "optional": true,
8851             "field": "description",
8852             "description": ""
8853           }
8854         ]
8855       }
8856     },
8857     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8858     "version": "0.0.0",
8859     "filename": "server/api/intDynamics365Account/index.js",
8860     "groupTitle": "Dynamics365_Accounts"
8861   },
8862   {
8863     "type": "delete",
8864     "url": "/api/integrations/dynamics365/accounts/{id}",
8865     "title": "Deletes a Dynamics365 Account",
8866     "examples": [
8867       {
8868         "title": "Example usage:",
8869         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8870         "type": "json"
8871       }
8872     ],
8873     "name": "DeleteDynamics365_Accounts",
8874     "group": "Dynamics365_Accounts",
8875     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8876     "version": "0.0.0",
8877     "filename": "server/api/intDynamics365Account/index.js",
8878     "groupTitle": "Dynamics365_Accounts"
8879   },
8880   {
8881     "type": "get",
8882     "url": "/api/integrations/dynamics365/accounts",
8883     "title": "Gets a list of Dynamics365 Accounts",
8884     "examples": [
8885       {
8886         "title": "Example usage:",
8887         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8888         "type": "json"
8889       }
8890     ],
8891     "name": "GetDynamics365_Accounts",
8892     "group": "Dynamics365_Accounts",
8893     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8894     "version": "0.0.0",
8895     "filename": "server/api/intDynamics365Account/index.js",
8896     "groupTitle": "Dynamics365_Accounts"
8897   },
8898   {
8899     "type": "get",
8900     "url": "/api/integrations/dynamics365/accounts/{id}",
8901     "title": "Gets a single Dynamics365 Account",
8902     "examples": [
8903       {
8904         "title": "Example usage:",
8905         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8906         "type": "json"
8907       }
8908     ],
8909     "name": "ShowDynamics365_Accounts",
8910     "group": "Dynamics365_Accounts",
8911     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8912     "version": "0.0.0",
8913     "filename": "server/api/intDynamics365Account/index.js",
8914     "groupTitle": "Dynamics365_Accounts"
8915   },
8916   {
8917     "type": "post",
8918     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8919     "title": "Creates new configuration",
8920     "examples": [
8921       {
8922         "title": "Example usage:",
8923         "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",
8924         "type": "json"
8925       }
8926     ],
8927     "name": "addConfiguration",
8928     "group": "Dynamics365_Accounts",
8929     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8930     "version": "0.0.0",
8931     "filename": "server/api/intDynamics365Account/index.js",
8932     "groupTitle": "Dynamics365_Accounts"
8933   },
8934   {
8935     "type": "get",
8936     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8937     "title": "Gets account configurations",
8938     "examples": [
8939       {
8940         "title": "Example usage:",
8941         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8942         "type": "json"
8943       }
8944     ],
8945     "name": "getConfigurations",
8946     "group": "Dynamics365_Accounts",
8947     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8948     "version": "0.0.0",
8949     "filename": "server/api/intDynamics365Account/index.js",
8950     "groupTitle": "Dynamics365_Accounts"
8951   },
8952   {
8953     "type": "get",
8954     "url": "/api/integrations/dynamics365/accounts/{id}/fields",
8955     "title": "Gets account fields",
8956     "examples": [
8957       {
8958         "title": "Example usage:",
8959         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
8960         "type": "json"
8961       }
8962     ],
8963     "name": "getFields",
8964     "group": "Dynamics365_Accounts",
8965     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8966     "version": "0.0.0",
8967     "filename": "server/api/intDynamics365Account/index.js",
8968     "groupTitle": "Dynamics365_Accounts"
8969   },
8970   {
8971     "type": "put",
8972     "url": "/api/integrations/dynamics365/accounts/{id}",
8973     "title": "Update an existing Dynamics365 Account",
8974     "examples": [
8975       {
8976         "title": "Example usage:",
8977         "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",
8978         "type": "json"
8979       }
8980     ],
8981     "name": "updateDynamics365_Accounts",
8982     "group": "Dynamics365_Accounts",
8983     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8984     "version": "0.0.0",
8985     "filename": "server/api/intDynamics365Account/index.js",
8986     "groupTitle": "Dynamics365_Accounts"
8987   },
8988   {
8989     "type": "post",
8990     "url": "/api/integrations/dynamics365/configurations",
8991     "title": "Creates a new Dynamics365 Configuration",
8992     "examples": [
8993       {
8994         "title": "Example usage:",
8995         "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",
8996         "type": "json"
8997       }
8998     ],
8999     "name": "CreateDynamics365_Configurations",
9000     "group": "Dynamics365_Configurations",
9001     "parameter": {
9002       "fields": {
9003         "Body": [
9004           {
9005             "group": "Body",
9006             "type": "String",
9007             "optional": true,
9008             "field": "name",
9009             "description": ""
9010           },
9011           {
9012             "group": "Body",
9013             "type": "String",
9014             "optional": true,
9015             "field": "description",
9016             "description": ""
9017           },
9018           {
9019             "group": "Body",
9020             "type": "String",
9021             "allowedValues": [
9022               "\"incident\"",
9023               "\"phonecall\""
9024             ],
9025             "optional": true,
9026             "field": "ticketType",
9027             "description": ""
9028           }
9029         ]
9030       }
9031     },
9032     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9033     "version": "0.0.0",
9034     "filename": "server/api/intDynamics365Configuration/index.js",
9035     "groupTitle": "Dynamics365_Configurations"
9036   },
9037   {
9038     "type": "delete",
9039     "url": "/api/integrations/dynamics365/configurations/{id}",
9040     "title": "Deletes a Dynamics365 Configuration",
9041     "examples": [
9042       {
9043         "title": "Example usage:",
9044         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
9045         "type": "json"
9046       }
9047     ],
9048     "name": "DeleteDynamics365_Configurations",
9049     "group": "Dynamics365_Configurations",
9050     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9051     "version": "0.0.0",
9052     "filename": "server/api/intDynamics365Configuration/index.js",
9053     "groupTitle": "Dynamics365_Configurations"
9054   },
9055   {
9056     "type": "get",
9057     "url": "/api/integrations/dynamics365/configurations",
9058     "title": "Gets a list of Dynamics365 Configurations",
9059     "examples": [
9060       {
9061         "title": "Example usage:",
9062         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
9063         "type": "json"
9064       }
9065     ],
9066     "name": "GetDynamics365_Configurations",
9067     "group": "Dynamics365_Configurations",
9068     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9069     "version": "0.0.0",
9070     "filename": "server/api/intDynamics365Configuration/index.js",
9071     "groupTitle": "Dynamics365_Configurations"
9072   },
9073   {
9074     "type": "get",
9075     "url": "/api/integrations/dynamics365/configurations/{id}",
9076     "title": "Gets a single Dynamics365 Configuration",
9077     "examples": [
9078       {
9079         "title": "Example usage:",
9080         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
9081         "type": "json"
9082       }
9083     ],
9084     "name": "ShowDynamics365_Configurations",
9085     "group": "Dynamics365_Configurations",
9086     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9087     "version": "0.0.0",
9088     "filename": "server/api/intDynamics365Configuration/index.js",
9089     "groupTitle": "Dynamics365_Configurations"
9090   },
9091   {
9092     "type": "get",
9093     "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
9094     "title": "Gets configurations descriptions",
9095     "examples": [
9096       {
9097         "title": "Example usage:",
9098         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
9099         "type": "json"
9100       }
9101     ],
9102     "name": "getDescriptions",
9103     "group": "Dynamics365_Configurations",
9104     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9105     "version": "0.0.0",
9106     "filename": "server/api/intDynamics365Configuration/index.js",
9107     "groupTitle": "Dynamics365_Configurations"
9108   },
9109   {
9110     "type": "get",
9111     "url": "/api/integrations/dynamics365/configurations/{id}/fields",
9112     "title": "Gets configurations fields",
9113     "examples": [
9114       {
9115         "title": "Example usage:",
9116         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
9117         "type": "json"
9118       }
9119     ],
9120     "name": "getFields",
9121     "group": "Dynamics365_Configurations",
9122     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9123     "version": "0.0.0",
9124     "filename": "server/api/intDynamics365Configuration/index.js",
9125     "groupTitle": "Dynamics365_Configurations"
9126   },
9127   {
9128     "type": "get",
9129     "url": "/api/integrations/zoho/configurations/{id}/subjects",
9130     "title": "Gets configurations subjects",
9131     "examples": [
9132       {
9133         "title": "Example usage:",
9134         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
9135         "type": "json"
9136       }
9137     ],
9138     "name": "getSubjects",
9139     "group": "Dynamics365_Configurations",
9140     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9141     "version": "0.0.0",
9142     "filename": "server/api/intDynamics365Configuration/index.js",
9143     "groupTitle": "Dynamics365_Configurations"
9144   },
9145   {
9146     "type": "put",
9147     "url": "/api/integrations/dynamics365/configurations/{id}",
9148     "title": "Update an existing Dynamics365 Configuration",
9149     "examples": [
9150       {
9151         "title": "Example usage:",
9152         "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",
9153         "type": "json"
9154       }
9155     ],
9156     "name": "updateDynamics365_Configurations",
9157     "group": "Dynamics365_Configurations",
9158     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9159     "version": "0.0.0",
9160     "filename": "server/api/intDynamics365Configuration/index.js",
9161     "groupTitle": "Dynamics365_Configurations"
9162   },
9163   {
9164     "type": "post",
9165     "url": "/api/integrations/dynamics365/fields",
9166     "title": "Creates a new Dynamics365 Field",
9167     "examples": [
9168       {
9169         "title": "Example usage:",
9170         "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",
9171         "type": "json"
9172       }
9173     ],
9174     "name": "CreateDynamics365_Fields",
9175     "group": "Dynamics365_Fields",
9176     "parameter": {
9177       "fields": {
9178         "Body": [
9179           {
9180             "group": "Body",
9181             "type": "String",
9182             "allowedValues": [
9183               "\"string\"",
9184               "\"variable\"",
9185               "\"customVariable\"",
9186               "\"keyValue\""
9187             ],
9188             "optional": true,
9189             "field": "type",
9190             "description": ""
9191           },
9192           {
9193             "group": "Body",
9194             "type": "String",
9195             "optional": true,
9196             "field": "content",
9197             "description": ""
9198           },
9199           {
9200             "group": "Body",
9201             "type": "String",
9202             "optional": true,
9203             "field": "key",
9204             "description": ""
9205           },
9206           {
9207             "group": "Body",
9208             "type": "String",
9209             "allowedValues": [
9210               "\"string\"",
9211               "\"variable\"",
9212               "\"customVariable\""
9213             ],
9214             "optional": true,
9215             "field": "keyType",
9216             "description": ""
9217           },
9218           {
9219             "group": "Body",
9220             "type": "String",
9221             "optional": true,
9222             "field": "keyContent",
9223             "description": ""
9224           },
9225           {
9226             "group": "Body",
9227             "type": "String",
9228             "optional": true,
9229             "field": "idField",
9230             "description": ""
9231           },
9232           {
9233             "group": "Body",
9234             "type": "String",
9235             "optional": true,
9236             "field": "nameField",
9237             "description": ""
9238           },
9239           {
9240             "group": "Body",
9241             "type": "Boolean",
9242             "optional": true,
9243             "field": "customField",
9244             "description": ""
9245           },
9246           {
9247             "group": "Body",
9248             "type": "String",
9249             "optional": true,
9250             "field": "variableName",
9251             "description": ""
9252           }
9253         ]
9254       }
9255     },
9256     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9257     "version": "0.0.0",
9258     "filename": "server/api/intDynamics365Field/index.js",
9259     "groupTitle": "Dynamics365_Fields"
9260   },
9261   {
9262     "type": "delete",
9263     "url": "/api/integrations/dynamics365/fields/{id}",
9264     "title": "Deletes a Dynamics365 Field",
9265     "examples": [
9266       {
9267         "title": "Example usage:",
9268         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
9269         "type": "json"
9270       }
9271     ],
9272     "name": "DeleteDynamics365_Fields",
9273     "group": "Dynamics365_Fields",
9274     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9275     "version": "0.0.0",
9276     "filename": "server/api/intDynamics365Field/index.js",
9277     "groupTitle": "Dynamics365_Fields"
9278   },
9279   {
9280     "type": "get",
9281     "url": "/api/integrations/dynamics365/fields",
9282     "title": "Gets a list of Dynamics365 Fields",
9283     "examples": [
9284       {
9285         "title": "Example usage:",
9286         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
9287         "type": "json"
9288       }
9289     ],
9290     "name": "GetDynamics365_Fields",
9291     "group": "Dynamics365_Fields",
9292     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9293     "version": "0.0.0",
9294     "filename": "server/api/intDynamics365Field/index.js",
9295     "groupTitle": "Dynamics365_Fields"
9296   },
9297   {
9298     "type": "get",
9299     "url": "/api/integrations/dynamics365/fields/{id}",
9300     "title": "Gets a single Dynamics365 Field",
9301     "examples": [
9302       {
9303         "title": "Example usage:",
9304         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
9305         "type": "json"
9306       }
9307     ],
9308     "name": "ShowDynamics365_Fields",
9309     "group": "Dynamics365_Fields",
9310     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9311     "version": "0.0.0",
9312     "filename": "server/api/intDynamics365Field/index.js",
9313     "groupTitle": "Dynamics365_Fields"
9314   },
9315   {
9316     "type": "put",
9317     "url": "/api/integrations/dynamics365/fields/{id}",
9318     "title": "Update an existing Dynamics365 Field",
9319     "examples": [
9320       {
9321         "title": "Example usage:",
9322         "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",
9323         "type": "json"
9324       }
9325     ],
9326     "name": "updateDynamics365_Fields",
9327     "group": "Dynamics365_Fields",
9328     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9329     "version": "0.0.0",
9330     "filename": "server/api/intDynamics365Field/index.js",
9331     "groupTitle": "Dynamics365_Fields"
9332   },
9333   {
9334     "type": "post",
9335     "url": "/api/fax/accounts/{id}/users",
9336     "title": "Add agents to a fax account",
9337     "examples": [
9338       {
9339         "title": "Example usage:",
9340         "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",
9341         "type": "json"
9342       }
9343     ],
9344     "name": "AddAgents",
9345     "group": "Fax_Accounts",
9346     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9347     "version": "0.0.0",
9348     "filename": "server/api/faxAccount/index.js",
9349     "groupTitle": "Fax_Accounts"
9350   },
9351   {
9352     "type": "post",
9353     "url": "/api/fax/accounts",
9354     "title": "Creates a new Account",
9355     "examples": [
9356       {
9357         "title": "Example usage:",
9358         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9359         "type": "json"
9360       }
9361     ],
9362     "name": "CreateAccounts",
9363     "group": "Fax_Accounts",
9364     "parameter": {
9365       "fields": {
9366         "Body": [
9367           {
9368             "group": "Body",
9369             "type": "String",
9370             "optional": false,
9371             "field": "name",
9372             "description": ""
9373           },
9374           {
9375             "group": "Body",
9376             "type": "String",
9377             "optional": true,
9378             "field": "description",
9379             "description": ""
9380           },
9381           {
9382             "group": "Body",
9383             "type": "String",
9384             "allowedValues": [
9385               "\"yes\"",
9386               "\"no\""
9387             ],
9388             "optional": true,
9389             "field": "ecm",
9390             "description": ""
9391           },
9392           {
9393             "group": "Body",
9394             "type": "String",
9395             "optional": true,
9396             "field": "headerinfo",
9397             "description": ""
9398           },
9399           {
9400             "group": "Body",
9401             "type": "String",
9402             "optional": true,
9403             "field": "localstationid",
9404             "description": ""
9405           },
9406           {
9407             "group": "Body",
9408             "type": "String",
9409             "allowedValues": [
9410               "\"2400\"",
9411               "\"4800\"",
9412               "\"7200\"",
9413               "\"9600\"",
9414               "\"12000\"",
9415               "\"14400\""
9416             ],
9417             "optional": true,
9418             "field": "minrate",
9419             "description": ""
9420           },
9421           {
9422             "group": "Body",
9423             "type": "String",
9424             "allowedValues": [
9425               "\"2400\"",
9426               "\"4800\"",
9427               "\"7200\"",
9428               "\"9600\"",
9429               "\"12000\"",
9430               "\"14400\""
9431             ],
9432             "optional": true,
9433             "field": "maxrate",
9434             "description": ""
9435           },
9436           {
9437             "group": "Body",
9438             "type": "String",
9439             "optional": true,
9440             "field": "modem",
9441             "description": ""
9442           },
9443           {
9444             "group": "Body",
9445             "type": "String",
9446             "optional": true,
9447             "field": "gateway",
9448             "description": ""
9449           },
9450           {
9451             "group": "Body",
9452             "type": "String",
9453             "optional": true,
9454             "field": "faxdetect",
9455             "description": ""
9456           },
9457           {
9458             "group": "Body",
9459             "type": "Integer",
9460             "optional": true,
9461             "field": "t38timeout",
9462             "description": ""
9463           },
9464           {
9465             "group": "Body",
9466             "type": "String",
9467             "allowedValues": [
9468               "\"SIP\"",
9469               "\"IAX\"",
9470               "\"DADHI\"",
9471               "\"KHOMP\""
9472             ],
9473             "optional": true,
9474             "field": "tech",
9475             "description": ""
9476           },
9477           {
9478             "group": "Body",
9479             "type": "String",
9480             "optional": false,
9481             "field": "key",
9482             "description": ""
9483           },
9484           {
9485             "group": "Body",
9486             "type": "Text",
9487             "optional": true,
9488             "field": "notificationTemplate",
9489             "description": ""
9490           },
9491           {
9492             "group": "Body",
9493             "type": "Boolean",
9494             "optional": true,
9495             "field": "notificationSound",
9496             "description": ""
9497           },
9498           {
9499             "group": "Body",
9500             "type": "Boolean",
9501             "optional": true,
9502             "field": "notificationShake",
9503             "description": ""
9504           },
9505           {
9506             "group": "Body",
9507             "type": "Integer",
9508             "optional": true,
9509             "field": "waitForTheAssignedAgent",
9510             "description": ""
9511           },
9512           {
9513             "group": "Body",
9514             "type": "Boolean",
9515             "optional": true,
9516             "field": "queueTransfer",
9517             "description": ""
9518           },
9519           {
9520             "group": "Body",
9521             "type": "Integer",
9522             "optional": true,
9523             "field": "queueTransferTimeout",
9524             "description": ""
9525           },
9526           {
9527             "group": "Body",
9528             "type": "Boolean",
9529             "optional": true,
9530             "field": "agentTransfer",
9531             "description": ""
9532           },
9533           {
9534             "group": "Body",
9535             "type": "Integer",
9536             "optional": true,
9537             "field": "agentTransferTimeout",
9538             "description": ""
9539           },
9540           {
9541             "group": "Body",
9542             "type": "Integer",
9543             "optional": true,
9544             "field": "mandatoryDispositionPauseId",
9545             "description": "<p>Status to put when mandatory disposition is enabled</p>"
9546           },
9547           {
9548             "group": "Body",
9549             "type": "Boolean",
9550             "optional": true,
9551             "field": "mandatoryDisposition",
9552             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9553           }
9554         ]
9555       }
9556     },
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/faxAccount/index.js",
9560     "groupTitle": "Fax_Accounts"
9561   },
9562   {
9563     "type": "delete",
9564     "url": "/api/fax/accounts/{id}",
9565     "title": "Deletes a Account",
9566     "examples": [
9567       {
9568         "title": "Example usage:",
9569         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9570         "type": "json"
9571       }
9572     ],
9573     "name": "DeleteAccounts",
9574     "group": "Fax_Accounts",
9575     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/faxAccount/index.js",
9578     "groupTitle": "Fax_Accounts"
9579   },
9580   {
9581     "type": "get",
9582     "url": "/api/fax/accounts/describe",
9583     "title": "Gets table info about Accounts",
9584     "examples": [
9585       {
9586         "title": "Example usage:",
9587         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9588         "type": "json"
9589       }
9590     ],
9591     "name": "DescribeAccounts",
9592     "group": "Fax_Accounts",
9593     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9594     "version": "0.0.0",
9595     "filename": "server/api/faxAccount/index.js",
9596     "groupTitle": "Fax_Accounts"
9597   },
9598   {
9599     "type": "get",
9600     "url": "/api/fax/accounts",
9601     "title": "Gets a list of Accounts",
9602     "examples": [
9603       {
9604         "title": "Example usage:",
9605         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9606         "type": "json"
9607       }
9608     ],
9609     "name": "GetAccounts",
9610     "group": "Fax_Accounts",
9611     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9612     "version": "0.0.0",
9613     "filename": "server/api/faxAccount/index.js",
9614     "groupTitle": "Fax_Accounts"
9615   },
9616   {
9617     "type": "get",
9618     "url": "/api/fax/accounts/{id}/users",
9619     "title": "Gets agents from fax account",
9620     "examples": [
9621       {
9622         "title": "Example usage:",
9623         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9624         "type": "json"
9625       }
9626     ],
9627     "name": "GetAgents",
9628     "group": "Fax_Accounts",
9629     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9630     "version": "0.0.0",
9631     "filename": "server/api/faxAccount/index.js",
9632     "groupTitle": "Fax_Accounts"
9633   },
9634   {
9635     "type": "delete",
9636     "url": "/api/fax/accounts/{id}/users",
9637     "title": "Removes agents from a fax account",
9638     "examples": [
9639       {
9640         "title": "Example usage:",
9641         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9642         "type": "json"
9643       }
9644     ],
9645     "name": "RemoveAgents",
9646     "group": "Fax_Accounts",
9647     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9648     "version": "0.0.0",
9649     "filename": "server/api/faxAccount/index.js",
9650     "groupTitle": "Fax_Accounts"
9651   },
9652   {
9653     "type": "delete",
9654     "url": "/api/fax/accounts/{id}/canned_answers",
9655     "title": "Removes canned answers from account",
9656     "examples": [
9657       {
9658         "title": "Example usage:",
9659         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9660         "type": "json"
9661       }
9662     ],
9663     "name": "RemoveAnswers",
9664     "group": "Fax_Accounts",
9665     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9666     "version": "0.0.0",
9667     "filename": "server/api/faxAccount/index.js",
9668     "groupTitle": "Fax_Accounts"
9669   },
9670   {
9671     "type": "delete",
9672     "url": "/api/fax/accounts/{id}/dispositions",
9673     "title": "Removes dispositions from account",
9674     "examples": [
9675       {
9676         "title": "Example usage:",
9677         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9678         "type": "json"
9679       }
9680     ],
9681     "name": "RemoveDispositions",
9682     "group": "Fax_Accounts",
9683     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9684     "version": "0.0.0",
9685     "filename": "server/api/faxAccount/index.js",
9686     "groupTitle": "Fax_Accounts"
9687   },
9688   {
9689     "type": "get",
9690     "url": "/api/fax/accounts/{id}",
9691     "title": "Gets a single Account",
9692     "examples": [
9693       {
9694         "title": "Example usage:",
9695         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9696         "type": "json"
9697       }
9698     ],
9699     "name": "ShowAccounts",
9700     "group": "Fax_Accounts",
9701     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9702     "version": "0.0.0",
9703     "filename": "server/api/faxAccount/index.js",
9704     "groupTitle": "Fax_Accounts"
9705   },
9706   {
9707     "type": "post",
9708     "url": "/api/fax/accounts/{id}/canned_answers",
9709     "title": "Creates new canned answer",
9710     "examples": [
9711       {
9712         "title": "Example usage:",
9713         "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",
9714         "type": "json"
9715       }
9716     ],
9717     "name": "addAnswer",
9718     "group": "Fax_Accounts",
9719     "parameter": {
9720       "fields": {
9721         "Body": [
9722           {
9723             "group": "Body",
9724             "type": "String",
9725             "optional": false,
9726             "field": "key",
9727             "description": ""
9728           },
9729           {
9730             "group": "Body",
9731             "type": "Text",
9732             "optional": false,
9733             "field": "value",
9734             "description": ""
9735           },
9736           {
9737             "group": "Body",
9738             "type": "String",
9739             "optional": true,
9740             "field": "description",
9741             "description": ""
9742           },
9743           {
9744             "group": "Body",
9745             "type": "Virtual",
9746             "optional": true,
9747             "field": "name",
9748             "description": ""
9749           }
9750         ]
9751       }
9752     },
9753     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9754     "version": "0.0.0",
9755     "filename": "server/api/faxAccount/index.js",
9756     "groupTitle": "Fax_Accounts"
9757   },
9758   {
9759     "type": "post",
9760     "url": "/api/fax/accounts/addaccountapplications",
9761     "title": "Creates new account and applications",
9762     "examples": [
9763       {
9764         "title": "Example usage:",
9765         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9766         "type": "json"
9767       }
9768     ],
9769     "name": "addApplications",
9770     "group": "Fax_Accounts",
9771     "parameter": {
9772       "fields": {
9773         "Body": [
9774           {
9775             "group": "Body",
9776             "type": "Integer",
9777             "optional": false,
9778             "field": "priority",
9779             "description": ""
9780           },
9781           {
9782             "group": "Body",
9783             "type": "String",
9784             "optional": false,
9785             "field": "app",
9786             "description": ""
9787           },
9788           {
9789             "group": "Body",
9790             "type": "Text",
9791             "optional": true,
9792             "field": "appdata",
9793             "description": ""
9794           },
9795           {
9796             "group": "Body",
9797             "type": "String",
9798             "optional": true,
9799             "field": "description",
9800             "description": ""
9801           },
9802           {
9803             "group": "Body",
9804             "type": "String",
9805             "optional": true,
9806             "field": "interval",
9807             "description": ""
9808           }
9809         ]
9810       }
9811     },
9812     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9813     "version": "0.0.0",
9814     "filename": "server/api/faxAccount/index.js",
9815     "groupTitle": "Fax_Accounts"
9816   },
9817   {
9818     "type": "post",
9819     "url": "/api/fax/accounts/{id}/applications",
9820     "title": "Creates new applications",
9821     "examples": [
9822       {
9823         "title": "Example usage:",
9824         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9825         "type": "json"
9826       }
9827     ],
9828     "name": "addApplications",
9829     "group": "Fax_Accounts",
9830     "parameter": {
9831       "fields": {
9832         "Body": [
9833           {
9834             "group": "Body",
9835             "type": "Integer",
9836             "optional": false,
9837             "field": "priority",
9838             "description": ""
9839           },
9840           {
9841             "group": "Body",
9842             "type": "String",
9843             "optional": false,
9844             "field": "app",
9845             "description": ""
9846           },
9847           {
9848             "group": "Body",
9849             "type": "Text",
9850             "optional": true,
9851             "field": "appdata",
9852             "description": ""
9853           },
9854           {
9855             "group": "Body",
9856             "type": "String",
9857             "optional": true,
9858             "field": "description",
9859             "description": ""
9860           },
9861           {
9862             "group": "Body",
9863             "type": "String",
9864             "optional": true,
9865             "field": "interval",
9866             "description": ""
9867           }
9868         ]
9869       }
9870     },
9871     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9872     "version": "0.0.0",
9873     "filename": "server/api/faxAccount/index.js",
9874     "groupTitle": "Fax_Accounts"
9875   },
9876   {
9877     "type": "post",
9878     "url": "/api/fax/accounts/{id}/dispositions",
9879     "title": "Creates new disposition",
9880     "examples": [
9881       {
9882         "title": "Example usage:",
9883         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9884         "type": "json"
9885       }
9886     ],
9887     "name": "addDisposition",
9888     "group": "Fax_Accounts",
9889     "parameter": {
9890       "fields": {
9891         "Body": [
9892           {
9893             "group": "Body",
9894             "type": "String",
9895             "optional": false,
9896             "field": "name",
9897             "description": ""
9898           },
9899           {
9900             "group": "Body",
9901             "type": "String",
9902             "allowedValues": [
9903               "\"first\"",
9904               "\"second\"",
9905               "\"third\""
9906             ],
9907             "optional": false,
9908             "field": "level",
9909             "description": ""
9910           },
9911           {
9912             "group": "Body",
9913             "type": "String",
9914             "optional": true,
9915             "field": "description",
9916             "description": ""
9917           }
9918         ]
9919       }
9920     },
9921     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9922     "version": "0.0.0",
9923     "filename": "server/api/faxAccount/index.js",
9924     "groupTitle": "Fax_Accounts"
9925   },
9926   {
9927     "type": "post",
9928     "url": "/api/fax/accounts/{id}/interactions",
9929     "title": "Creates new interactions",
9930     "examples": [
9931       {
9932         "title": "Example usage:",
9933         "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",
9934         "type": "json"
9935       }
9936     ],
9937     "name": "addInteraction",
9938     "group": "Fax_Accounts",
9939     "parameter": {
9940       "fields": {
9941         "Body": [
9942           {
9943             "group": "Body",
9944             "type": "Boolean",
9945             "optional": true,
9946             "field": "closed",
9947             "description": ""
9948           },
9949           {
9950             "group": "Body",
9951             "type": "String",
9952             "optional": true,
9953             "field": "closedAt",
9954             "description": ""
9955           },
9956           {
9957             "group": "Body",
9958             "type": "String",
9959             "optional": true,
9960             "field": "disposition",
9961             "description": ""
9962           },
9963           {
9964             "group": "Body",
9965             "type": "String",
9966             "optional": true,
9967             "field": "secondDisposition",
9968             "description": ""
9969           },
9970           {
9971             "group": "Body",
9972             "type": "String",
9973             "optional": true,
9974             "field": "thirdDisposition",
9975             "description": ""
9976           },
9977           {
9978             "group": "Body",
9979             "type": "String",
9980             "optional": true,
9981             "field": "note",
9982             "description": ""
9983           },
9984           {
9985             "group": "Body",
9986             "type": "String",
9987             "optional": true,
9988             "field": "read1stAt",
9989             "description": ""
9990           },
9991           {
9992             "group": "Body",
9993             "type": "String",
9994             "optional": true,
9995             "field": "fax",
9996             "description": ""
9997           },
9998           {
9999             "group": "Body",
10000             "type": "String",
10001             "allowedValues": [
10002               "\"in\"",
10003               "\"out\""
10004             ],
10005             "optional": false,
10006             "field": "firstMsgDirection",
10007             "description": ""
10008           },
10009           {
10010             "group": "Body",
10011             "type": "String",
10012             "optional": true,
10013             "field": "lastMsgAt",
10014             "description": ""
10015           },
10016           {
10017             "group": "Body",
10018             "type": "String",
10019             "allowedValues": [
10020               "\"in\"",
10021               "\"out\""
10022             ],
10023             "optional": false,
10024             "field": "lastMsgDirection",
10025             "description": ""
10026           }
10027         ]
10028       }
10029     },
10030     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10031     "version": "0.0.0",
10032     "filename": "server/api/faxAccount/index.js",
10033     "groupTitle": "Fax_Accounts"
10034   },
10035   {
10036     "type": "get",
10037     "url": "/api/fax/accounts/{id}/canned_answers",
10038     "title": "Gets account canned answers",
10039     "examples": [
10040       {
10041         "title": "Example usage:",
10042         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
10043         "type": "json"
10044       }
10045     ],
10046     "name": "getAnswers",
10047     "group": "Fax_Accounts",
10048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10049     "version": "0.0.0",
10050     "filename": "server/api/faxAccount/index.js",
10051     "groupTitle": "Fax_Accounts"
10052   },
10053   {
10054     "type": "get",
10055     "url": "/api/fax/accounts/{id}/applications",
10056     "title": "Gets account pplications",
10057     "examples": [
10058       {
10059         "title": "Example usage:",
10060         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
10061         "type": "json"
10062       }
10063     ],
10064     "name": "getApplications",
10065     "group": "Fax_Accounts",
10066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10067     "version": "0.0.0",
10068     "filename": "server/api/faxAccount/index.js",
10069     "groupTitle": "Fax_Accounts"
10070   },
10071   {
10072     "type": "get",
10073     "url": "/api/fax/accounts/{id}/dispositions",
10074     "title": "Gets account dispositions",
10075     "examples": [
10076       {
10077         "title": "Example usage:",
10078         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
10079         "type": "json"
10080       }
10081     ],
10082     "name": "getDispositions",
10083     "group": "Fax_Accounts",
10084     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10085     "version": "0.0.0",
10086     "filename": "server/api/faxAccount/index.js",
10087     "groupTitle": "Fax_Accounts"
10088   },
10089   {
10090     "type": "get",
10091     "url": "/api/fax/accounts/{id}/interactions",
10092     "title": "Gets account interactions",
10093     "examples": [
10094       {
10095         "title": "Example usage:",
10096         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
10097         "type": "json"
10098       }
10099     ],
10100     "name": "getInteraction",
10101     "group": "Fax_Accounts",
10102     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10103     "version": "0.0.0",
10104     "filename": "server/api/faxAccount/index.js",
10105     "groupTitle": "Fax_Accounts"
10106   },
10107   {
10108     "type": "get",
10109     "url": "/api/fax/accounts/{id}/messages",
10110     "title": "Gets account messages",
10111     "examples": [
10112       {
10113         "title": "Example usage:",
10114         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
10115         "type": "json"
10116       }
10117     ],
10118     "name": "getMessages",
10119     "group": "Fax_Accounts",
10120     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10121     "version": "0.0.0",
10122     "filename": "server/api/faxAccount/index.js",
10123     "groupTitle": "Fax_Accounts"
10124   },
10125   {
10126     "type": "post",
10127     "url": "/api/fax/accounts/{id}/send",
10128     "title": "Send new fax",
10129     "examples": [
10130       {
10131         "title": "Example usage:",
10132         "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",
10133         "type": "json"
10134       }
10135     ],
10136     "name": "sendFax",
10137     "group": "Fax_Accounts",
10138     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10139     "version": "0.0.0",
10140     "filename": "server/api/faxAccount/index.js",
10141     "groupTitle": "Fax_Accounts"
10142   },
10143   {
10144     "type": "put",
10145     "url": "/api/fax/accounts/{id}",
10146     "title": "Update an existing Account",
10147     "examples": [
10148       {
10149         "title": "Example usage:",
10150         "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",
10151         "type": "json"
10152       }
10153     ],
10154     "name": "updateAccounts",
10155     "group": "Fax_Accounts",
10156     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10157     "version": "0.0.0",
10158     "filename": "server/api/faxAccount/index.js",
10159     "groupTitle": "Fax_Accounts"
10160   },
10161   {
10162     "type": "post",
10163     "url": "/api/fax/accounts/updateaccountapplications",
10164     "title": "Update account and applications",
10165     "examples": [
10166       {
10167         "title": "Example usage:",
10168         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10169         "type": "json"
10170       }
10171     ],
10172     "name": "updateApplications",
10173     "group": "Fax_Accounts",
10174     "parameter": {
10175       "fields": {
10176         "Body": [
10177           {
10178             "group": "Body",
10179             "type": "Integer",
10180             "optional": false,
10181             "field": "priority",
10182             "description": ""
10183           },
10184           {
10185             "group": "Body",
10186             "type": "String",
10187             "optional": false,
10188             "field": "app",
10189             "description": ""
10190           },
10191           {
10192             "group": "Body",
10193             "type": "Text",
10194             "optional": true,
10195             "field": "appdata",
10196             "description": ""
10197           },
10198           {
10199             "group": "Body",
10200             "type": "String",
10201             "optional": true,
10202             "field": "description",
10203             "description": ""
10204           },
10205           {
10206             "group": "Body",
10207             "type": "String",
10208             "optional": true,
10209             "field": "interval",
10210             "description": ""
10211           }
10212         ]
10213       }
10214     },
10215     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10216     "version": "0.0.0",
10217     "filename": "server/api/faxAccount/index.js",
10218     "groupTitle": "Fax_Accounts"
10219   },
10220   {
10221     "type": "post",
10222     "url": "/api/fax/applications",
10223     "title": "Creates a new Application",
10224     "examples": [
10225       {
10226         "title": "Example usage:",
10227         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10228         "type": "json"
10229       }
10230     ],
10231     "name": "CreateApplications",
10232     "group": "Fax_Applications",
10233     "parameter": {
10234       "fields": {
10235         "Body": [
10236           {
10237             "group": "Body",
10238             "type": "Integer",
10239             "optional": false,
10240             "field": "priority",
10241             "description": ""
10242           },
10243           {
10244             "group": "Body",
10245             "type": "String",
10246             "optional": false,
10247             "field": "app",
10248             "description": ""
10249           },
10250           {
10251             "group": "Body",
10252             "type": "Text",
10253             "optional": true,
10254             "field": "appdata",
10255             "description": ""
10256           },
10257           {
10258             "group": "Body",
10259             "type": "String",
10260             "optional": true,
10261             "field": "description",
10262             "description": ""
10263           },
10264           {
10265             "group": "Body",
10266             "type": "String",
10267             "optional": true,
10268             "field": "interval",
10269             "description": ""
10270           }
10271         ]
10272       }
10273     },
10274     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10275     "version": "0.0.0",
10276     "filename": "server/api/faxApplication/index.js",
10277     "groupTitle": "Fax_Applications"
10278   },
10279   {
10280     "type": "delete",
10281     "url": "/api/fax/applications/{id}",
10282     "title": "Deletes a Application",
10283     "examples": [
10284       {
10285         "title": "Example usage:",
10286         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
10287         "type": "json"
10288       }
10289     ],
10290     "name": "DeleteApplications",
10291     "group": "Fax_Applications",
10292     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10293     "version": "0.0.0",
10294     "filename": "server/api/faxApplication/index.js",
10295     "groupTitle": "Fax_Applications"
10296   },
10297   {
10298     "type": "get",
10299     "url": "/api/fax/applications",
10300     "title": "Gets a list of Applications",
10301     "examples": [
10302       {
10303         "title": "Example usage:",
10304         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
10305         "type": "json"
10306       }
10307     ],
10308     "name": "GetApplications",
10309     "group": "Fax_Applications",
10310     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10311     "version": "0.0.0",
10312     "filename": "server/api/faxApplication/index.js",
10313     "groupTitle": "Fax_Applications"
10314   },
10315   {
10316     "type": "get",
10317     "url": "/api/fax/applications/{id}",
10318     "title": "Gets a single Application",
10319     "examples": [
10320       {
10321         "title": "Example usage:",
10322         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
10323         "type": "json"
10324       }
10325     ],
10326     "name": "ShowApplications",
10327     "group": "Fax_Applications",
10328     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10329     "version": "0.0.0",
10330     "filename": "server/api/faxApplication/index.js",
10331     "groupTitle": "Fax_Applications"
10332   },
10333   {
10334     "type": "put",
10335     "url": "/api/fax/applications/{id}",
10336     "title": "Update an existing Application",
10337     "examples": [
10338       {
10339         "title": "Example usage:",
10340         "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",
10341         "type": "json"
10342       }
10343     ],
10344     "name": "updateApplications",
10345     "group": "Fax_Applications",
10346     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10347     "version": "0.0.0",
10348     "filename": "server/api/faxApplication/index.js",
10349     "groupTitle": "Fax_Applications"
10350   },
10351   {
10352     "type": "post",
10353     "url": "/api/fax/interactions/{id}/tags",
10354     "title": "Add tags to the interaction",
10355     "examples": [
10356       {
10357         "title": "Example usage:",
10358         "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",
10359         "type": "json"
10360       }
10361     ],
10362     "name": "AddTags",
10363     "group": "Fax_Interactions",
10364     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10365     "version": "0.0.0",
10366     "filename": "server/api/faxInteraction/index.js",
10367     "groupTitle": "Fax_Interactions"
10368   },
10369   {
10370     "type": "post",
10371     "url": "/api/fax/interactions",
10372     "title": "Creates a new Interaction",
10373     "examples": [
10374       {
10375         "title": "Example usage:",
10376         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10377         "type": "json"
10378       }
10379     ],
10380     "name": "CreateInteractions",
10381     "group": "Fax_Interactions",
10382     "parameter": {
10383       "fields": {
10384         "Body": [
10385           {
10386             "group": "Body",
10387             "type": "Boolean",
10388             "optional": true,
10389             "field": "closed",
10390             "description": ""
10391           },
10392           {
10393             "group": "Body",
10394             "type": "String",
10395             "optional": true,
10396             "field": "closedAt",
10397             "description": ""
10398           },
10399           {
10400             "group": "Body",
10401             "type": "String",
10402             "optional": true,
10403             "field": "disposition",
10404             "description": ""
10405           },
10406           {
10407             "group": "Body",
10408             "type": "String",
10409             "optional": true,
10410             "field": "secondDisposition",
10411             "description": ""
10412           },
10413           {
10414             "group": "Body",
10415             "type": "String",
10416             "optional": true,
10417             "field": "thirdDisposition",
10418             "description": ""
10419           },
10420           {
10421             "group": "Body",
10422             "type": "String",
10423             "optional": true,
10424             "field": "note",
10425             "description": ""
10426           },
10427           {
10428             "group": "Body",
10429             "type": "String",
10430             "optional": true,
10431             "field": "read1stAt",
10432             "description": ""
10433           },
10434           {
10435             "group": "Body",
10436             "type": "String",
10437             "optional": true,
10438             "field": "fax",
10439             "description": ""
10440           },
10441           {
10442             "group": "Body",
10443             "type": "String",
10444             "allowedValues": [
10445               "\"in\"",
10446               "\"out\""
10447             ],
10448             "optional": false,
10449             "field": "firstMsgDirection",
10450             "description": ""
10451           },
10452           {
10453             "group": "Body",
10454             "type": "String",
10455             "optional": true,
10456             "field": "lastMsgAt",
10457             "description": ""
10458           },
10459           {
10460             "group": "Body",
10461             "type": "String",
10462             "allowedValues": [
10463               "\"in\"",
10464               "\"out\""
10465             ],
10466             "optional": false,
10467             "field": "lastMsgDirection",
10468             "description": ""
10469           }
10470         ]
10471       }
10472     },
10473     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10474     "version": "0.0.0",
10475     "filename": "server/api/faxInteraction/index.js",
10476     "groupTitle": "Fax_Interactions"
10477   },
10478   {
10479     "type": "delete",
10480     "url": "/api/fax/interactions/{id}",
10481     "title": "Deletes a Interaction",
10482     "examples": [
10483       {
10484         "title": "Example usage:",
10485         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10486         "type": "json"
10487       }
10488     ],
10489     "name": "DeleteInteractions",
10490     "group": "Fax_Interactions",
10491     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10492     "version": "0.0.0",
10493     "filename": "server/api/faxInteraction/index.js",
10494     "groupTitle": "Fax_Interactions"
10495   },
10496   {
10497     "type": "get",
10498     "url": "/api/fax/interactions/describe",
10499     "title": "Gets table info about Interactions",
10500     "examples": [
10501       {
10502         "title": "Example usage:",
10503         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10504         "type": "json"
10505       }
10506     ],
10507     "name": "DescribeInteractions",
10508     "group": "Fax_Interactions",
10509     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10510     "version": "0.0.0",
10511     "filename": "server/api/faxInteraction/index.js",
10512     "groupTitle": "Fax_Interactions"
10513   },
10514   {
10515     "type": "get",
10516     "url": "/api/fax/interactions",
10517     "title": "Gets a list of Interactions",
10518     "examples": [
10519       {
10520         "title": "Example usage:",
10521         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10522         "type": "json"
10523       }
10524     ],
10525     "name": "GetInteractions",
10526     "group": "Fax_Interactions",
10527     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10528     "version": "0.0.0",
10529     "filename": "server/api/faxInteraction/index.js",
10530     "groupTitle": "Fax_Interactions"
10531   },
10532   {
10533     "type": "delete",
10534     "url": "/api/fax/interactions/{id}/tags",
10535     "title": "Removes tags from interaction",
10536     "examples": [
10537       {
10538         "title": "Example usage:",
10539         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10540         "type": "json"
10541       }
10542     ],
10543     "name": "RemoveTags",
10544     "group": "Fax_Interactions",
10545     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10546     "version": "0.0.0",
10547     "filename": "server/api/faxInteraction/index.js",
10548     "groupTitle": "Fax_Interactions"
10549   },
10550   {
10551     "type": "get",
10552     "url": "/api/fax/interactions/{id}",
10553     "title": "Gets a single Interaction",
10554     "examples": [
10555       {
10556         "title": "Example usage:",
10557         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10558         "type": "json"
10559       }
10560     ],
10561     "name": "ShowInteractions",
10562     "group": "Fax_Interactions",
10563     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10564     "version": "0.0.0",
10565     "filename": "server/api/faxInteraction/index.js",
10566     "groupTitle": "Fax_Interactions"
10567   },
10568   {
10569     "type": "post",
10570     "url": "/api/fax/interactions/{id}/messages",
10571     "title": "Creates new messages",
10572     "examples": [
10573       {
10574         "title": "Example usage:",
10575         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10576         "type": "json"
10577       }
10578     ],
10579     "name": "addMessage",
10580     "group": "Fax_Interactions",
10581     "parameter": {
10582       "fields": {
10583         "Body": [
10584           {
10585             "group": "Body",
10586             "type": "Text",
10587             "optional": false,
10588             "field": "body",
10589             "description": ""
10590           },
10591           {
10592             "group": "Body",
10593             "type": "Boolean",
10594             "optional": true,
10595             "field": "read",
10596             "description": ""
10597           },
10598           {
10599             "group": "Body",
10600             "type": "String",
10601             "allowedValues": [
10602               "\"in\"",
10603               "\"out\""
10604             ],
10605             "optional": false,
10606             "field": "direction",
10607             "description": ""
10608           },
10609           {
10610             "group": "Body",
10611             "type": "Text",
10612             "optional": true,
10613             "field": "failMessage",
10614             "description": ""
10615           },
10616           {
10617             "group": "Body",
10618             "type": "String",
10619             "optional": true,
10620             "field": "readAt",
10621             "description": ""
10622           }
10623         ]
10624       }
10625     },
10626     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10627     "version": "0.0.0",
10628     "filename": "server/api/faxInteraction/index.js",
10629     "groupTitle": "Fax_Interactions"
10630   },
10631   {
10632     "type": "get",
10633     "url": "/api/fax/interactions/{id}/download",
10634     "title": "Get interactions",
10635     "examples": [
10636       {
10637         "title": "Example usage:",
10638         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10639         "type": "json"
10640       }
10641     ],
10642     "name": "download",
10643     "group": "Fax_Interactions",
10644     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10645     "version": "0.0.0",
10646     "filename": "server/api/faxInteraction/index.js",
10647     "groupTitle": "Fax_Interactions"
10648   },
10649   {
10650     "type": "get",
10651     "url": "/api/fax/interactions/{id}/messages",
10652     "title": "Gets interaction messages",
10653     "examples": [
10654       {
10655         "title": "Example usage:",
10656         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10657         "type": "json"
10658       }
10659     ],
10660     "name": "getMessages",
10661     "group": "Fax_Interactions",
10662     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10663     "version": "0.0.0",
10664     "filename": "server/api/faxInteraction/index.js",
10665     "groupTitle": "Fax_Interactions"
10666   },
10667   {
10668     "type": "put",
10669     "url": "/api/fax/interactions/{id}",
10670     "title": "Update an existing Interaction",
10671     "examples": [
10672       {
10673         "title": "Example usage:",
10674         "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",
10675         "type": "json"
10676       }
10677     ],
10678     "name": "updateInteractions",
10679     "group": "Fax_Interactions",
10680     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10681     "version": "0.0.0",
10682     "filename": "server/api/faxInteraction/index.js",
10683     "groupTitle": "Fax_Interactions"
10684   },
10685   {
10686     "type": "get",
10687     "url": "/api/fax/messages/{id}/download",
10688     "title": "Get message",
10689     "examples": [
10690       {
10691         "title": "Example usage:",
10692         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10693         "type": "json"
10694       }
10695     ],
10696     "name": "download",
10697     "group": "Fax_Message",
10698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10699     "version": "0.0.0",
10700     "filename": "server/api/faxMessage/index.js",
10701     "groupTitle": "Fax_Message"
10702   },
10703   {
10704     "type": "delete",
10705     "url": "/api/fax/messages/{id}",
10706     "title": "Deletes a Message",
10707     "examples": [
10708       {
10709         "title": "Example usage:",
10710         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10711         "type": "json"
10712       }
10713     ],
10714     "name": "DeleteMessages",
10715     "group": "Fax_Messages",
10716     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10717     "version": "0.0.0",
10718     "filename": "server/api/faxMessage/index.js",
10719     "groupTitle": "Fax_Messages"
10720   },
10721   {
10722     "type": "get",
10723     "url": "/api/fax/messages/describe",
10724     "title": "Gets table info about Messages",
10725     "examples": [
10726       {
10727         "title": "Example usage:",
10728         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10729         "type": "json"
10730       }
10731     ],
10732     "name": "DescribeMessages",
10733     "group": "Fax_Messages",
10734     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10735     "version": "0.0.0",
10736     "filename": "server/api/faxMessage/index.js",
10737     "groupTitle": "Fax_Messages"
10738   },
10739   {
10740     "type": "get",
10741     "url": "/api/fax/messages",
10742     "title": "Gets a list of Messages",
10743     "examples": [
10744       {
10745         "title": "Example usage:",
10746         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10747         "type": "json"
10748       }
10749     ],
10750     "name": "GetMessages",
10751     "group": "Fax_Messages",
10752     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10753     "version": "0.0.0",
10754     "filename": "server/api/faxMessage/index.js",
10755     "groupTitle": "Fax_Messages"
10756   },
10757   {
10758     "type": "get",
10759     "url": "/api/fax/messages/{id}",
10760     "title": "Gets a single Message",
10761     "examples": [
10762       {
10763         "title": "Example usage:",
10764         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10765         "type": "json"
10766       }
10767     ],
10768     "name": "ShowMessages",
10769     "group": "Fax_Messages",
10770     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10771     "version": "0.0.0",
10772     "filename": "server/api/faxMessage/index.js",
10773     "groupTitle": "Fax_Messages"
10774   },
10775   {
10776     "type": "put",
10777     "url": "/api/fax/messages/{id}/accept",
10778     "title": "Accepts message",
10779     "examples": [
10780       {
10781         "title": "Example usage:",
10782         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10783         "type": "json"
10784       }
10785     ],
10786     "name": "acceptMessage",
10787     "group": "Fax_Messages",
10788     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10789     "version": "0.0.0",
10790     "filename": "server/api/faxMessage/index.js",
10791     "groupTitle": "Fax_Messages"
10792   },
10793   {
10794     "type": "put",
10795     "url": "/api/fax/messages/{id}/reject",
10796     "title": "Rejects message",
10797     "examples": [
10798       {
10799         "title": "Example usage:",
10800         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10801         "type": "json"
10802       }
10803     ],
10804     "name": "rejectMessage",
10805     "group": "Fax_Messages",
10806     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10807     "version": "0.0.0",
10808     "filename": "server/api/faxMessage/index.js",
10809     "groupTitle": "Fax_Messages"
10810   },
10811   {
10812     "type": "post",
10813     "url": "/api/fax/messages",
10814     "title": "Create message and send Fax",
10815     "examples": [
10816       {
10817         "title": "Example usage:",
10818         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10819         "type": "json"
10820       }
10821     ],
10822     "name": "rejectMessage",
10823     "group": "Fax_Messages",
10824     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10825     "version": "0.0.0",
10826     "filename": "server/api/faxMessage/index.js",
10827     "groupTitle": "Fax_Messages"
10828   },
10829   {
10830     "type": "put",
10831     "url": "/api/fax/messages/{id}",
10832     "title": "Update an existing Message",
10833     "examples": [
10834       {
10835         "title": "Example usage:",
10836         "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",
10837         "type": "json"
10838       }
10839     ],
10840     "name": "updateMessages",
10841     "group": "Fax_Messages",
10842     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10843     "version": "0.0.0",
10844     "filename": "server/api/faxMessage/index.js",
10845     "groupTitle": "Fax_Messages"
10846   },
10847   {
10848     "type": "post",
10849     "url": "/api/fax/reports/queue",
10850     "title": "Creates a new Fax Queue Report",
10851     "examples": [
10852       {
10853         "title": "Example usage:",
10854         "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",
10855         "type": "json"
10856       }
10857     ],
10858     "name": "CreateFax_Queue_Reports",
10859     "group": "Fax_Queue_Reports",
10860     "parameter": {
10861       "fields": {
10862         "Body": [
10863           {
10864             "group": "Body",
10865             "type": "String",
10866             "optional": false,
10867             "field": "uniqueid",
10868             "description": ""
10869           },
10870           {
10871             "group": "Body",
10872             "type": "String",
10873             "optional": true,
10874             "field": "from",
10875             "description": ""
10876           },
10877           {
10878             "group": "Body",
10879             "type": "String",
10880             "optional": true,
10881             "field": "joinAt",
10882             "description": ""
10883           },
10884           {
10885             "group": "Body",
10886             "type": "String",
10887             "optional": true,
10888             "field": "leaveAt",
10889             "description": ""
10890           },
10891           {
10892             "group": "Body",
10893             "type": "String",
10894             "optional": true,
10895             "field": "acceptAt",
10896             "description": ""
10897           },
10898           {
10899             "group": "Body",
10900             "type": "String",
10901             "optional": true,
10902             "field": "exitAt",
10903             "description": ""
10904           },
10905           {
10906             "group": "Body",
10907             "type": "String",
10908             "optional": true,
10909             "field": "reason",
10910             "description": ""
10911           }
10912         ]
10913       }
10914     },
10915     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10916     "version": "0.0.0",
10917     "filename": "server/api/faxQueueReport/index.js",
10918     "groupTitle": "Fax_Queue_Reports"
10919   },
10920   {
10921     "type": "delete",
10922     "url": "/api/fax/reports/queue/{id}",
10923     "title": "Deletes a Fax Queue Report",
10924     "examples": [
10925       {
10926         "title": "Example usage:",
10927         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
10928         "type": "json"
10929       }
10930     ],
10931     "name": "DeleteFax_Queue_Reports",
10932     "group": "Fax_Queue_Reports",
10933     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10934     "version": "0.0.0",
10935     "filename": "server/api/faxQueueReport/index.js",
10936     "groupTitle": "Fax_Queue_Reports"
10937   },
10938   {
10939     "type": "get",
10940     "url": "/api/fax/reports/queue/describe",
10941     "title": "Gets table info about Fax Queue Reports",
10942     "examples": [
10943       {
10944         "title": "Example usage:",
10945         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
10946         "type": "json"
10947       }
10948     ],
10949     "name": "DescribeFax_Queue_Reports",
10950     "group": "Fax_Queue_Reports",
10951     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10952     "version": "0.0.0",
10953     "filename": "server/api/faxQueueReport/index.js",
10954     "groupTitle": "Fax_Queue_Reports"
10955   },
10956   {
10957     "type": "get",
10958     "url": "/api/fax/reports/queue",
10959     "title": "Gets a list of Fax Queue Reports",
10960     "examples": [
10961       {
10962         "title": "Example usage:",
10963         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
10964         "type": "json"
10965       }
10966     ],
10967     "name": "GetFax_Queue_Reports",
10968     "group": "Fax_Queue_Reports",
10969     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10970     "version": "0.0.0",
10971     "filename": "server/api/faxQueueReport/index.js",
10972     "groupTitle": "Fax_Queue_Reports"
10973   },
10974   {
10975     "type": "get",
10976     "url": "/api/fax/reports/queue/{id}",
10977     "title": "Gets a single Fax Queue Report",
10978     "examples": [
10979       {
10980         "title": "Example usage:",
10981         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
10982         "type": "json"
10983       }
10984     ],
10985     "name": "ShowFax_Queue_Reports",
10986     "group": "Fax_Queue_Reports",
10987     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10988     "version": "0.0.0",
10989     "filename": "server/api/faxQueueReport/index.js",
10990     "groupTitle": "Fax_Queue_Reports"
10991   },
10992   {
10993     "type": "put",
10994     "url": "/api/fax/reports/queue/{id}",
10995     "title": "Update an existing Fax Queue Report",
10996     "examples": [
10997       {
10998         "title": "Example usage:",
10999         "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",
11000         "type": "json"
11001       }
11002     ],
11003     "name": "updateFax_Queue_Reports",
11004     "group": "Fax_Queue_Reports",
11005     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11006     "version": "0.0.0",
11007     "filename": "server/api/faxQueueReport/index.js",
11008     "groupTitle": "Fax_Queue_Reports"
11009   },
11010   {
11011     "type": "post",
11012     "url": "/api/fax/queues/{id}/users",
11013     "title": "Add agents to a queue",
11014     "examples": [
11015       {
11016         "title": "Example usage:",
11017         "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",
11018         "type": "json"
11019       }
11020     ],
11021     "name": "AddAgents",
11022     "group": "Fax_Queues",
11023     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11024     "version": "0.0.0",
11025     "filename": "server/api/faxQueue/index.js",
11026     "groupTitle": "Fax_Queues"
11027   },
11028   {
11029     "type": "post",
11030     "url": "/api/fax/queues/{id}/teams",
11031     "title": "Add teams to a queue",
11032     "examples": [
11033       {
11034         "title": "Example usage:",
11035         "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",
11036         "type": "json"
11037       }
11038     ],
11039     "name": "AddTeams",
11040     "group": "Fax_Queues",
11041     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11042     "version": "0.0.0",
11043     "filename": "server/api/faxQueue/index.js",
11044     "groupTitle": "Fax_Queues"
11045   },
11046   {
11047     "type": "post",
11048     "url": "/api/fax/queues",
11049     "title": "Creates a new Queue",
11050     "examples": [
11051       {
11052         "title": "Example usage:",
11053         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
11054         "type": "json"
11055       }
11056     ],
11057     "name": "CreateQueues",
11058     "group": "Fax_Queues",
11059     "parameter": {
11060       "fields": {
11061         "Body": [
11062           {
11063             "group": "Body",
11064             "type": "String",
11065             "optional": false,
11066             "field": "name",
11067             "description": ""
11068           },
11069           {
11070             "group": "Body",
11071             "type": "String",
11072             "optional": true,
11073             "field": "description",
11074             "description": ""
11075           },
11076           {
11077             "group": "Body",
11078             "type": "Integer",
11079             "optional": false,
11080             "field": "timeout",
11081             "description": ""
11082           },
11083           {
11084             "group": "Body",
11085             "type": "String",
11086             "allowedValues": [
11087               "\"rrmemory\"",
11088               "\"beepall\"",
11089               "\"roundrobin\""
11090             ],
11091             "optional": false,
11092             "field": "strategy",
11093             "description": ""
11094           },
11095           {
11096             "group": "Body",
11097             "type": "Integer",
11098             "optional": true,
11099             "field": "lastAgent",
11100             "description": ""
11101           }
11102         ]
11103       }
11104     },
11105     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11106     "version": "0.0.0",
11107     "filename": "server/api/faxQueue/index.js",
11108     "groupTitle": "Fax_Queues"
11109   },
11110   {
11111     "type": "delete",
11112     "url": "/api/fax/queues/{id}",
11113     "title": "Deletes a Queue",
11114     "examples": [
11115       {
11116         "title": "Example usage:",
11117         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
11118         "type": "json"
11119       }
11120     ],
11121     "name": "DeleteQueues",
11122     "group": "Fax_Queues",
11123     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11124     "version": "0.0.0",
11125     "filename": "server/api/faxQueue/index.js",
11126     "groupTitle": "Fax_Queues"
11127   },
11128   {
11129     "type": "get",
11130     "url": "/api/fax/queues/describe",
11131     "title": "Gets table info about Queues",
11132     "examples": [
11133       {
11134         "title": "Example usage:",
11135         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
11136         "type": "json"
11137       }
11138     ],
11139     "name": "DescribeQueues",
11140     "group": "Fax_Queues",
11141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11142     "version": "0.0.0",
11143     "filename": "server/api/faxQueue/index.js",
11144     "groupTitle": "Fax_Queues"
11145   },
11146   {
11147     "type": "get",
11148     "url": "/api/fax/queues/{id}/users",
11149     "title": "Gets queue agents",
11150     "examples": [
11151       {
11152         "title": "Example usage:",
11153         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
11154         "type": "json"
11155       }
11156     ],
11157     "name": "GetAgents",
11158     "group": "Fax_Queues",
11159     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11160     "version": "0.0.0",
11161     "filename": "server/api/faxQueue/index.js",
11162     "groupTitle": "Fax_Queues"
11163   },
11164   {
11165     "type": "get",
11166     "url": "/api/fax/queues/{id}/members",
11167     "title": "GetMembers",
11168     "examples": [
11169       {
11170         "title": "Example usage:",
11171         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
11172         "type": "json"
11173       }
11174     ],
11175     "name": "GetMembers",
11176     "group": "Fax_Queues",
11177     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11178     "version": "0.0.0",
11179     "filename": "server/api/faxQueue/index.js",
11180     "groupTitle": "Fax_Queues"
11181   },
11182   {
11183     "type": "get",
11184     "url": "/api/fax/queues",
11185     "title": "Gets a list of Queues",
11186     "examples": [
11187       {
11188         "title": "Example usage:",
11189         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
11190         "type": "json"
11191       }
11192     ],
11193     "name": "GetQueues",
11194     "group": "Fax_Queues",
11195     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11196     "version": "0.0.0",
11197     "filename": "server/api/faxQueue/index.js",
11198     "groupTitle": "Fax_Queues"
11199   },
11200   {
11201     "type": "get",
11202     "url": "/api/fax/queues/{id}/teams",
11203     "title": "Gets queues list",
11204     "examples": [
11205       {
11206         "title": "Example usage:",
11207         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
11208         "type": "json"
11209       }
11210     ],
11211     "name": "GetTeams",
11212     "group": "Fax_Queues",
11213     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11214     "version": "0.0.0",
11215     "filename": "server/api/faxQueue/index.js",
11216     "groupTitle": "Fax_Queues"
11217   },
11218   {
11219     "type": "delete",
11220     "url": "/api/fax/queues/{id}/users",
11221     "title": "Removes agents from a queue",
11222     "examples": [
11223       {
11224         "title": "Example usage:",
11225         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
11226         "type": "json"
11227       }
11228     ],
11229     "name": "RemoveAgents",
11230     "group": "Fax_Queues",
11231     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11232     "version": "0.0.0",
11233     "filename": "server/api/faxQueue/index.js",
11234     "groupTitle": "Fax_Queues"
11235   },
11236   {
11237     "type": "get",
11238     "url": "/api/fax/queues/{id}",
11239     "title": "Gets a single Queue",
11240     "examples": [
11241       {
11242         "title": "Example usage:",
11243         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
11244         "type": "json"
11245       }
11246     ],
11247     "name": "ShowQueues",
11248     "group": "Fax_Queues",
11249     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11250     "version": "0.0.0",
11251     "filename": "server/api/faxQueue/index.js",
11252     "groupTitle": "Fax_Queues"
11253   },
11254   {
11255     "type": "put",
11256     "url": "/api/fax/queues/{id}",
11257     "title": "Update an existing Queue",
11258     "examples": [
11259       {
11260         "title": "Example usage:",
11261         "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",
11262         "type": "json"
11263       }
11264     ],
11265     "name": "updateQueues",
11266     "group": "Fax_Queues",
11267     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11268     "version": "0.0.0",
11269     "filename": "server/api/faxQueue/index.js",
11270     "groupTitle": "Fax_Queues"
11271   },
11272   {
11273     "type": "post",
11274     "url": "/api/fax/reports/transfer",
11275     "title": "Creates a new Fax Transfer Report",
11276     "examples": [
11277       {
11278         "title": "Example usage:",
11279         "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",
11280         "type": "json"
11281       }
11282     ],
11283     "name": "CreateFax_Transfer_Reports",
11284     "group": "Fax_Transfer_Reports",
11285     "parameter": {
11286       "fields": {
11287         "Body": [
11288           {
11289             "group": "Body",
11290             "type": "String",
11291             "optional": false,
11292             "field": "uniqueid",
11293             "description": ""
11294           },
11295           {
11296             "group": "Body",
11297             "type": "String",
11298             "allowedValues": [
11299               "\"account\"",
11300               "\"agent\"",
11301               "\"queue\""
11302             ],
11303             "optional": false,
11304             "field": "type",
11305             "description": ""
11306           },
11307           {
11308             "group": "Body",
11309             "type": "String",
11310             "optional": false,
11311             "field": "transferredAt",
11312             "description": ""
11313           }
11314         ]
11315       }
11316     },
11317     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11318     "version": "0.0.0",
11319     "filename": "server/api/faxTransferReport/index.js",
11320     "groupTitle": "Fax_Transfer_Reports"
11321   },
11322   {
11323     "type": "delete",
11324     "url": "/api/fax/reports/transfer/{id}",
11325     "title": "Deletes a Fax Transfer Report",
11326     "examples": [
11327       {
11328         "title": "Example usage:",
11329         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
11330         "type": "json"
11331       }
11332     ],
11333     "name": "DeleteFax_Transfer_Reports",
11334     "group": "Fax_Transfer_Reports",
11335     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11336     "version": "0.0.0",
11337     "filename": "server/api/faxTransferReport/index.js",
11338     "groupTitle": "Fax_Transfer_Reports"
11339   },
11340   {
11341     "type": "get",
11342     "url": "/api/fax/reports/transfer/describe",
11343     "title": "Gets table info about Fax Transfer Reports",
11344     "examples": [
11345       {
11346         "title": "Example usage:",
11347         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
11348         "type": "json"
11349       }
11350     ],
11351     "name": "DescribeFax_Transfer_Reports",
11352     "group": "Fax_Transfer_Reports",
11353     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11354     "version": "0.0.0",
11355     "filename": "server/api/faxTransferReport/index.js",
11356     "groupTitle": "Fax_Transfer_Reports"
11357   },
11358   {
11359     "type": "get",
11360     "url": "/api/fax/reports/transfer",
11361     "title": "Gets a list of Fax Transfer Reports",
11362     "examples": [
11363       {
11364         "title": "Example usage:",
11365         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
11366         "type": "json"
11367       }
11368     ],
11369     "name": "GetFax_Transfer_Reports",
11370     "group": "Fax_Transfer_Reports",
11371     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11372     "version": "0.0.0",
11373     "filename": "server/api/faxTransferReport/index.js",
11374     "groupTitle": "Fax_Transfer_Reports"
11375   },
11376   {
11377     "type": "get",
11378     "url": "/api/fax/reports/transfer/{id}",
11379     "title": "Gets a single Fax Transfer Report",
11380     "examples": [
11381       {
11382         "title": "Example usage:",
11383         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11384         "type": "json"
11385       }
11386     ],
11387     "name": "ShowFax_Transfer_Reports",
11388     "group": "Fax_Transfer_Reports",
11389     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11390     "version": "0.0.0",
11391     "filename": "server/api/faxTransferReport/index.js",
11392     "groupTitle": "Fax_Transfer_Reports"
11393   },
11394   {
11395     "type": "put",
11396     "url": "/api/fax/reports/transfer/{id}",
11397     "title": "Update an existing Fax Transfer Report",
11398     "examples": [
11399       {
11400         "title": "Example usage:",
11401         "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",
11402         "type": "json"
11403       }
11404     ],
11405     "name": "updateFax_Transfer_Reports",
11406     "group": "Fax_Transfer_Reports",
11407     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11408     "version": "0.0.0",
11409     "filename": "server/api/faxTransferReport/index.js",
11410     "groupTitle": "Fax_Transfer_Reports"
11411   },
11412   {
11413     "type": "post",
11414     "url": "/api/integrations/freshdesk/accounts",
11415     "title": "Creates a new Freshdesk Account",
11416     "examples": [
11417       {
11418         "title": "Example usage:",
11419         "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",
11420         "type": "json"
11421       }
11422     ],
11423     "name": "CreateFreshdesk_Accounts",
11424     "group": "Freshdesk_Accounts",
11425     "parameter": {
11426       "fields": {
11427         "Body": [
11428           {
11429             "group": "Body",
11430             "type": "String",
11431             "optional": true,
11432             "field": "name",
11433             "description": ""
11434           },
11435           {
11436             "group": "Body",
11437             "type": "String",
11438             "optional": true,
11439             "field": "description",
11440             "description": ""
11441           },
11442           {
11443             "group": "Body",
11444             "type": "String",
11445             "optional": true,
11446             "field": "username",
11447             "description": ""
11448           },
11449           {
11450             "group": "Body",
11451             "type": "String",
11452             "optional": true,
11453             "field": "apiKey",
11454             "description": ""
11455           },
11456           {
11457             "group": "Body",
11458             "type": "String",
11459             "optional": true,
11460             "field": "remoteUri",
11461             "description": ""
11462           },
11463           {
11464             "group": "Body",
11465             "type": "String",
11466             "optional": true,
11467             "field": "serverUrl",
11468             "description": ""
11469           }
11470         ]
11471       }
11472     },
11473     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11474     "version": "0.0.0",
11475     "filename": "server/api/intFreshdeskAccount/index.js",
11476     "groupTitle": "Freshdesk_Accounts"
11477   },
11478   {
11479     "type": "delete",
11480     "url": "/api/integrations/freshdesk/accounts/{id}",
11481     "title": "Deletes a Freshdesk Account",
11482     "examples": [
11483       {
11484         "title": "Example usage:",
11485         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11486         "type": "json"
11487       }
11488     ],
11489     "name": "DeleteFreshdesk_Accounts",
11490     "group": "Freshdesk_Accounts",
11491     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11492     "version": "0.0.0",
11493     "filename": "server/api/intFreshdeskAccount/index.js",
11494     "groupTitle": "Freshdesk_Accounts"
11495   },
11496   {
11497     "type": "get",
11498     "url": "/api/integrations/freshdesk/accounts",
11499     "title": "Gets a list of Freshdesk Accounts",
11500     "examples": [
11501       {
11502         "title": "Example usage:",
11503         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11504         "type": "json"
11505       }
11506     ],
11507     "name": "GetFreshdesk_Accounts",
11508     "group": "Freshdesk_Accounts",
11509     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11510     "version": "0.0.0",
11511     "filename": "server/api/intFreshdeskAccount/index.js",
11512     "groupTitle": "Freshdesk_Accounts"
11513   },
11514   {
11515     "type": "get",
11516     "url": "/api/integrations/freshdesk/accounts/{id}",
11517     "title": "Gets a single Freshdesk Account",
11518     "examples": [
11519       {
11520         "title": "Example usage:",
11521         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11522         "type": "json"
11523       }
11524     ],
11525     "name": "ShowFreshdesk_Accounts",
11526     "group": "Freshdesk_Accounts",
11527     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11528     "version": "0.0.0",
11529     "filename": "server/api/intFreshdeskAccount/index.js",
11530     "groupTitle": "Freshdesk_Accounts"
11531   },
11532   {
11533     "type": "post",
11534     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11535     "title": "Creates new configuration",
11536     "examples": [
11537       {
11538         "title": "Example usage:",
11539         "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",
11540         "type": "json"
11541       }
11542     ],
11543     "name": "addConfiguration",
11544     "group": "Freshdesk_Accounts",
11545     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11546     "version": "0.0.0",
11547     "filename": "server/api/intFreshdeskAccount/index.js",
11548     "groupTitle": "Freshdesk_Accounts"
11549   },
11550   {
11551     "type": "get",
11552     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11553     "title": "Gets account configurations",
11554     "examples": [
11555       {
11556         "title": "Example usage:",
11557         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11558         "type": "json"
11559       }
11560     ],
11561     "name": "getConfigurations",
11562     "group": "Freshdesk_Accounts",
11563     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11564     "version": "0.0.0",
11565     "filename": "server/api/intFreshdeskAccount/index.js",
11566     "groupTitle": "Freshdesk_Accounts"
11567   },
11568   {
11569     "type": "get",
11570     "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11571     "title": "Gets account fields",
11572     "examples": [
11573       {
11574         "title": "Example usage:",
11575         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11576         "type": "json"
11577       }
11578     ],
11579     "name": "getFields",
11580     "group": "Freshdesk_Accounts",
11581     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11582     "version": "0.0.0",
11583     "filename": "server/api/intFreshdeskAccount/index.js",
11584     "groupTitle": "Freshdesk_Accounts"
11585   },
11586   {
11587     "type": "put",
11588     "url": "/api/integrations/freshdesk/accounts/{id}",
11589     "title": "Update an existing Freshdesk Account",
11590     "examples": [
11591       {
11592         "title": "Example usage:",
11593         "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",
11594         "type": "json"
11595       }
11596     ],
11597     "name": "updateFreshdesk_Accounts",
11598     "group": "Freshdesk_Accounts",
11599     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11600     "version": "0.0.0",
11601     "filename": "server/api/intFreshdeskAccount/index.js",
11602     "groupTitle": "Freshdesk_Accounts"
11603   },
11604   {
11605     "type": "post",
11606     "url": "/api/integrations/freshdesk/configurations",
11607     "title": "Creates a new Freshdesk Configuration",
11608     "examples": [
11609       {
11610         "title": "Example usage:",
11611         "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",
11612         "type": "json"
11613       }
11614     ],
11615     "name": "CreateFreshdesk_Configurations",
11616     "group": "Freshdesk_Configurations",
11617     "parameter": {
11618       "fields": {
11619         "Body": [
11620           {
11621             "group": "Body",
11622             "type": "String",
11623             "optional": true,
11624             "field": "name",
11625             "description": ""
11626           },
11627           {
11628             "group": "Body",
11629             "type": "String",
11630             "optional": true,
11631             "field": "description",
11632             "description": ""
11633           }
11634         ]
11635       }
11636     },
11637     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11638     "version": "0.0.0",
11639     "filename": "server/api/intFreshdeskConfiguration/index.js",
11640     "groupTitle": "Freshdesk_Configurations"
11641   },
11642   {
11643     "type": "delete",
11644     "url": "/api/integrations/freshdesk/configurations/{id}",
11645     "title": "Deletes a Freshdesk Configuration",
11646     "examples": [
11647       {
11648         "title": "Example usage:",
11649         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11650         "type": "json"
11651       }
11652     ],
11653     "name": "DeleteFreshdesk_Configurations",
11654     "group": "Freshdesk_Configurations",
11655     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11656     "version": "0.0.0",
11657     "filename": "server/api/intFreshdeskConfiguration/index.js",
11658     "groupTitle": "Freshdesk_Configurations"
11659   },
11660   {
11661     "type": "get",
11662     "url": "/api/integrations/freshdesk/configurations",
11663     "title": "Gets a list of Freshdesk Configurations",
11664     "examples": [
11665       {
11666         "title": "Example usage:",
11667         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11668         "type": "json"
11669       }
11670     ],
11671     "name": "GetFreshdesk_Configurations",
11672     "group": "Freshdesk_Configurations",
11673     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11674     "version": "0.0.0",
11675     "filename": "server/api/intFreshdeskConfiguration/index.js",
11676     "groupTitle": "Freshdesk_Configurations"
11677   },
11678   {
11679     "type": "get",
11680     "url": "/api/integrations/freshdesk/configurations/{id}",
11681     "title": "Gets a single Freshdesk Configuration",
11682     "examples": [
11683       {
11684         "title": "Example usage:",
11685         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11686         "type": "json"
11687       }
11688     ],
11689     "name": "ShowFreshdesk_Configurations",
11690     "group": "Freshdesk_Configurations",
11691     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11692     "version": "0.0.0",
11693     "filename": "server/api/intFreshdeskConfiguration/index.js",
11694     "groupTitle": "Freshdesk_Configurations"
11695   },
11696   {
11697     "type": "get",
11698     "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11699     "title": "Gets configurations descriptions",
11700     "examples": [
11701       {
11702         "title": "Example usage:",
11703         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11704         "type": "json"
11705       }
11706     ],
11707     "name": "getDescriptions",
11708     "group": "Freshdesk_Configurations",
11709     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11710     "version": "0.0.0",
11711     "filename": "server/api/intFreshdeskConfiguration/index.js",
11712     "groupTitle": "Freshdesk_Configurations"
11713   },
11714   {
11715     "type": "get",
11716     "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11717     "title": "Gets configurations fields",
11718     "examples": [
11719       {
11720         "title": "Example usage:",
11721         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11722         "type": "json"
11723       }
11724     ],
11725     "name": "getFields",
11726     "group": "Freshdesk_Configurations",
11727     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11728     "version": "0.0.0",
11729     "filename": "server/api/intFreshdeskConfiguration/index.js",
11730     "groupTitle": "Freshdesk_Configurations"
11731   },
11732   {
11733     "type": "get",
11734     "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11735     "title": "Gets configurations subjects",
11736     "examples": [
11737       {
11738         "title": "Example usage:",
11739         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11740         "type": "json"
11741       }
11742     ],
11743     "name": "getSubjects",
11744     "group": "Freshdesk_Configurations",
11745     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11746     "version": "0.0.0",
11747     "filename": "server/api/intFreshdeskConfiguration/index.js",
11748     "groupTitle": "Freshdesk_Configurations"
11749   },
11750   {
11751     "type": "get",
11752     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11753     "title": "Gets configurations tags",
11754     "examples": [
11755       {
11756         "title": "Example usage:",
11757         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11758         "type": "json"
11759       }
11760     ],
11761     "name": "getTags",
11762     "group": "Freshdesk_Configurations",
11763     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11764     "version": "0.0.0",
11765     "filename": "server/api/intFreshdeskConfiguration/index.js",
11766     "groupTitle": "Freshdesk_Configurations"
11767   },
11768   {
11769     "type": "post",
11770     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11771     "title": "Sets new tags",
11772     "examples": [
11773       {
11774         "title": "Example usage:",
11775         "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",
11776         "type": "json"
11777       }
11778     ],
11779     "name": "setTags",
11780     "group": "Freshdesk_Configurations",
11781     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11782     "version": "0.0.0",
11783     "filename": "server/api/intFreshdeskConfiguration/index.js",
11784     "groupTitle": "Freshdesk_Configurations"
11785   },
11786   {
11787     "type": "put",
11788     "url": "/api/integrations/freshdesk/configurations/{id}",
11789     "title": "Update an existing Freshdesk Configuration",
11790     "examples": [
11791       {
11792         "title": "Example usage:",
11793         "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",
11794         "type": "json"
11795       }
11796     ],
11797     "name": "updateFreshdesk_Configurations",
11798     "group": "Freshdesk_Configurations",
11799     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11800     "version": "0.0.0",
11801     "filename": "server/api/intFreshdeskConfiguration/index.js",
11802     "groupTitle": "Freshdesk_Configurations"
11803   },
11804   {
11805     "type": "post",
11806     "url": "/api/integrations/freshdesk/fields",
11807     "title": "Creates a new Freshdesk Field",
11808     "examples": [
11809       {
11810         "title": "Example usage:",
11811         "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",
11812         "type": "json"
11813       }
11814     ],
11815     "name": "CreateFreshdesk_Fields",
11816     "group": "Freshdesk_Fields",
11817     "parameter": {
11818       "fields": {
11819         "Body": [
11820           {
11821             "group": "Body",
11822             "type": "String",
11823             "allowedValues": [
11824               "\"string\"",
11825               "\"variable\"",
11826               "\"customVariable\"",
11827               "\"keyValue\""
11828             ],
11829             "optional": true,
11830             "field": "type",
11831             "description": ""
11832           },
11833           {
11834             "group": "Body",
11835             "type": "String",
11836             "optional": true,
11837             "field": "content",
11838             "description": ""
11839           },
11840           {
11841             "group": "Body",
11842             "type": "String",
11843             "optional": true,
11844             "field": "key",
11845             "description": ""
11846           },
11847           {
11848             "group": "Body",
11849             "type": "String",
11850             "allowedValues": [
11851               "\"string\"",
11852               "\"variable\"",
11853               "\"customVariable\""
11854             ],
11855             "optional": true,
11856             "field": "keyType",
11857             "description": ""
11858           },
11859           {
11860             "group": "Body",
11861             "type": "String",
11862             "optional": true,
11863             "field": "keyContent",
11864             "description": ""
11865           },
11866           {
11867             "group": "Body",
11868             "type": "String",
11869             "optional": true,
11870             "field": "idField",
11871             "description": ""
11872           },
11873           {
11874             "group": "Body",
11875             "type": "String",
11876             "optional": true,
11877             "field": "nameField",
11878             "description": ""
11879           },
11880           {
11881             "group": "Body",
11882             "type": "Boolean",
11883             "optional": true,
11884             "field": "customField",
11885             "description": ""
11886           },
11887           {
11888             "group": "Body",
11889             "type": "String",
11890             "optional": true,
11891             "field": "variableName",
11892             "description": ""
11893           }
11894         ]
11895       }
11896     },
11897     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11898     "version": "0.0.0",
11899     "filename": "server/api/intFreshdeskField/index.js",
11900     "groupTitle": "Freshdesk_Fields"
11901   },
11902   {
11903     "type": "delete",
11904     "url": "/api/integrations/freshdesk/fields/{id}",
11905     "title": "Deletes a Freshdesk Field",
11906     "examples": [
11907       {
11908         "title": "Example usage:",
11909         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11910         "type": "json"
11911       }
11912     ],
11913     "name": "DeleteFreshdesk_Fields",
11914     "group": "Freshdesk_Fields",
11915     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11916     "version": "0.0.0",
11917     "filename": "server/api/intFreshdeskField/index.js",
11918     "groupTitle": "Freshdesk_Fields"
11919   },
11920   {
11921     "type": "get",
11922     "url": "/api/integrations/freshdesk/fields",
11923     "title": "Gets a list of Freshdesk Fields",
11924     "examples": [
11925       {
11926         "title": "Example usage:",
11927         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
11928         "type": "json"
11929       }
11930     ],
11931     "name": "GetFreshdesk_Fields",
11932     "group": "Freshdesk_Fields",
11933     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11934     "version": "0.0.0",
11935     "filename": "server/api/intFreshdeskField/index.js",
11936     "groupTitle": "Freshdesk_Fields"
11937   },
11938   {
11939     "type": "get",
11940     "url": "/api/integrations/freshdesk/fields/{id}",
11941     "title": "Gets a single Freshdesk Field",
11942     "examples": [
11943       {
11944         "title": "Example usage:",
11945         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
11946         "type": "json"
11947       }
11948     ],
11949     "name": "ShowFreshdesk_Fields",
11950     "group": "Freshdesk_Fields",
11951     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11952     "version": "0.0.0",
11953     "filename": "server/api/intFreshdeskField/index.js",
11954     "groupTitle": "Freshdesk_Fields"
11955   },
11956   {
11957     "type": "put",
11958     "url": "/api/integrations/freshdesk/fields/{id}",
11959     "title": "Update an existing Freshdesk Field",
11960     "examples": [
11961       {
11962         "title": "Example usage:",
11963         "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",
11964         "type": "json"
11965       }
11966     ],
11967     "name": "updateFreshdesk_Fields",
11968     "group": "Freshdesk_Fields",
11969     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11970     "version": "0.0.0",
11971     "filename": "server/api/intFreshdeskField/index.js",
11972     "groupTitle": "Freshdesk_Fields"
11973   },
11974   {
11975     "type": "post",
11976     "url": "/api/integrations/freshsales/accounts",
11977     "title": "Creates a new Freshsales Account",
11978     "examples": [
11979       {
11980         "title": "Example usage:",
11981         "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",
11982         "type": "json"
11983       }
11984     ],
11985     "name": "CreateFreshsales_Accounts",
11986     "group": "Freshsales_Accounts",
11987     "parameter": {
11988       "fields": {
11989         "Body": [
11990           {
11991             "group": "Body",
11992             "type": "String",
11993             "optional": true,
11994             "field": "name",
11995             "description": ""
11996           },
11997           {
11998             "group": "Body",
11999             "type": "String",
12000             "optional": true,
12001             "field": "description",
12002             "description": ""
12003           },
12004           {
12005             "group": "Body",
12006             "type": "String",
12007             "optional": true,
12008             "field": "username",
12009             "description": ""
12010           },
12011           {
12012             "group": "Body",
12013             "type": "String",
12014             "optional": true,
12015             "field": "apiKey",
12016             "description": ""
12017           },
12018           {
12019             "group": "Body",
12020             "type": "String",
12021             "optional": true,
12022             "field": "remoteUri",
12023             "description": ""
12024           },
12025           {
12026             "group": "Body",
12027             "type": "String",
12028             "optional": true,
12029             "field": "serverUrl",
12030             "description": ""
12031           }
12032         ]
12033       }
12034     },
12035     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12036     "version": "0.0.0",
12037     "filename": "server/api/intFreshsalesAccount/index.js",
12038     "groupTitle": "Freshsales_Accounts"
12039   },
12040   {
12041     "type": "delete",
12042     "url": "/api/integrations/freshsales/accounts/{id}",
12043     "title": "Deletes a Freshsales Account",
12044     "examples": [
12045       {
12046         "title": "Example usage:",
12047         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
12048         "type": "json"
12049       }
12050     ],
12051     "name": "DeleteFreshsales_Accounts",
12052     "group": "Freshsales_Accounts",
12053     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12054     "version": "0.0.0",
12055     "filename": "server/api/intFreshsalesAccount/index.js",
12056     "groupTitle": "Freshsales_Accounts"
12057   },
12058   {
12059     "type": "get",
12060     "url": "/api/integrations/freshsales/accounts",
12061     "title": "Gets a list of Freshsales Accounts",
12062     "examples": [
12063       {
12064         "title": "Example usage:",
12065         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
12066         "type": "json"
12067       }
12068     ],
12069     "name": "GetFreshsales_Accounts",
12070     "group": "Freshsales_Accounts",
12071     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12072     "version": "0.0.0",
12073     "filename": "server/api/intFreshsalesAccount/index.js",
12074     "groupTitle": "Freshsales_Accounts"
12075   },
12076   {
12077     "type": "get",
12078     "url": "/api/integrations/freshsales/accounts/{id}",
12079     "title": "Gets a single Freshsales Account",
12080     "examples": [
12081       {
12082         "title": "Example usage:",
12083         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
12084         "type": "json"
12085       }
12086     ],
12087     "name": "ShowFreshsales_Accounts",
12088     "group": "Freshsales_Accounts",
12089     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12090     "version": "0.0.0",
12091     "filename": "server/api/intFreshsalesAccount/index.js",
12092     "groupTitle": "Freshsales_Accounts"
12093   },
12094   {
12095     "type": "post",
12096     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12097     "title": "Creates new configuration",
12098     "examples": [
12099       {
12100         "title": "Example usage:",
12101         "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",
12102         "type": "json"
12103       }
12104     ],
12105     "name": "addConfiguration",
12106     "group": "Freshsales_Accounts",
12107     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12108     "version": "0.0.0",
12109     "filename": "server/api/intFreshsalesAccount/index.js",
12110     "groupTitle": "Freshsales_Accounts"
12111   },
12112   {
12113     "type": "get",
12114     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
12115     "title": "Gets account configurations",
12116     "examples": [
12117       {
12118         "title": "Example usage:",
12119         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
12120         "type": "json"
12121       }
12122     ],
12123     "name": "getConfigurations",
12124     "group": "Freshsales_Accounts",
12125     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12126     "version": "0.0.0",
12127     "filename": "server/api/intFreshsalesAccount/index.js",
12128     "groupTitle": "Freshsales_Accounts"
12129   },
12130   {
12131     "type": "get",
12132     "url": "/api/integrations/freshsales/accounts/{id}/fields",
12133     "title": "Gets account fields",
12134     "examples": [
12135       {
12136         "title": "Example usage:",
12137         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
12138         "type": "json"
12139       }
12140     ],
12141     "name": "getFields",
12142     "group": "Freshsales_Accounts",
12143     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12144     "version": "0.0.0",
12145     "filename": "server/api/intFreshsalesAccount/index.js",
12146     "groupTitle": "Freshsales_Accounts"
12147   },
12148   {
12149     "type": "put",
12150     "url": "/api/integrations/freshsales/accounts/{id}",
12151     "title": "Update an existing Freshsales Account",
12152     "examples": [
12153       {
12154         "title": "Example usage:",
12155         "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",
12156         "type": "json"
12157       }
12158     ],
12159     "name": "updateFreshsales_Accounts",
12160     "group": "Freshsales_Accounts",
12161     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12162     "version": "0.0.0",
12163     "filename": "server/api/intFreshsalesAccount/index.js",
12164     "groupTitle": "Freshsales_Accounts"
12165   },
12166   {
12167     "type": "post",
12168     "url": "/api/integrations/freshsales/configurations",
12169     "title": "Creates a new Freshsales Configuration",
12170     "examples": [
12171       {
12172         "title": "Example usage:",
12173         "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",
12174         "type": "json"
12175       }
12176     ],
12177     "name": "CreateFreshsales_Configurations",
12178     "group": "Freshsales_Configurations",
12179     "parameter": {
12180       "fields": {
12181         "Body": [
12182           {
12183             "group": "Body",
12184             "type": "String",
12185             "optional": true,
12186             "field": "name",
12187             "description": ""
12188           },
12189           {
12190             "group": "Body",
12191             "type": "String",
12192             "optional": true,
12193             "field": "description",
12194             "description": ""
12195           }
12196         ]
12197       }
12198     },
12199     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12200     "version": "0.0.0",
12201     "filename": "server/api/intFreshsalesConfiguration/index.js",
12202     "groupTitle": "Freshsales_Configurations"
12203   },
12204   {
12205     "type": "delete",
12206     "url": "/api/integrations/freshsales/configurations/{id}",
12207     "title": "Deletes a Freshsales Configuration",
12208     "examples": [
12209       {
12210         "title": "Example usage:",
12211         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
12212         "type": "json"
12213       }
12214     ],
12215     "name": "DeleteFreshsales_Configurations",
12216     "group": "Freshsales_Configurations",
12217     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12218     "version": "0.0.0",
12219     "filename": "server/api/intFreshsalesConfiguration/index.js",
12220     "groupTitle": "Freshsales_Configurations"
12221   },
12222   {
12223     "type": "get",
12224     "url": "/api/integrations/freshsales/configurations",
12225     "title": "Gets a list of Freshsales Configurations",
12226     "examples": [
12227       {
12228         "title": "Example usage:",
12229         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
12230         "type": "json"
12231       }
12232     ],
12233     "name": "GetFreshsales_Configurations",
12234     "group": "Freshsales_Configurations",
12235     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12236     "version": "0.0.0",
12237     "filename": "server/api/intFreshsalesConfiguration/index.js",
12238     "groupTitle": "Freshsales_Configurations"
12239   },
12240   {
12241     "type": "get",
12242     "url": "/api/integrations/freshsales/configurations/{id}",
12243     "title": "Gets a single Freshsales Configuration",
12244     "examples": [
12245       {
12246         "title": "Example usage:",
12247         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
12248         "type": "json"
12249       }
12250     ],
12251     "name": "ShowFreshsales_Configurations",
12252     "group": "Freshsales_Configurations",
12253     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12254     "version": "0.0.0",
12255     "filename": "server/api/intFreshsalesConfiguration/index.js",
12256     "groupTitle": "Freshsales_Configurations"
12257   },
12258   {
12259     "type": "get",
12260     "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
12261     "title": "Gets configurations descriptions",
12262     "examples": [
12263       {
12264         "title": "Example usage:",
12265         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
12266         "type": "json"
12267       }
12268     ],
12269     "name": "getDescriptions",
12270     "group": "Freshsales_Configurations",
12271     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12272     "version": "0.0.0",
12273     "filename": "server/api/intFreshsalesConfiguration/index.js",
12274     "groupTitle": "Freshsales_Configurations"
12275   },
12276   {
12277     "type": "get",
12278     "url": "/api/integrations/freshsales/configurations/{id}/fields",
12279     "title": "Gets configurations fields",
12280     "examples": [
12281       {
12282         "title": "Example usage:",
12283         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
12284         "type": "json"
12285       }
12286     ],
12287     "name": "getFields",
12288     "group": "Freshsales_Configurations",
12289     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12290     "version": "0.0.0",
12291     "filename": "server/api/intFreshsalesConfiguration/index.js",
12292     "groupTitle": "Freshsales_Configurations"
12293   },
12294   {
12295     "type": "get",
12296     "url": "/api/integrations/freshsales/configurations/{id}/subjects",
12297     "title": "Gets configurations subjects",
12298     "examples": [
12299       {
12300         "title": "Example usage:",
12301         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
12302         "type": "json"
12303       }
12304     ],
12305     "name": "getSubjects",
12306     "group": "Freshsales_Configurations",
12307     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12308     "version": "0.0.0",
12309     "filename": "server/api/intFreshsalesConfiguration/index.js",
12310     "groupTitle": "Freshsales_Configurations"
12311   },
12312   {
12313     "type": "put",
12314     "url": "/api/integrations/freshsales/configurations/{id}",
12315     "title": "Update an existing Freshsales Configuration",
12316     "examples": [
12317       {
12318         "title": "Example usage:",
12319         "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",
12320         "type": "json"
12321       }
12322     ],
12323     "name": "updateFreshsales_Configurations",
12324     "group": "Freshsales_Configurations",
12325     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12326     "version": "0.0.0",
12327     "filename": "server/api/intFreshsalesConfiguration/index.js",
12328     "groupTitle": "Freshsales_Configurations"
12329   },
12330   {
12331     "type": "post",
12332     "url": "/api/integrations/freshsales/fields",
12333     "title": "Creates a new Freshsales Field",
12334     "examples": [
12335       {
12336         "title": "Example usage:",
12337         "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",
12338         "type": "json"
12339       }
12340     ],
12341     "name": "CreateFreshsales_Fields",
12342     "group": "Freshsales_Fields",
12343     "parameter": {
12344       "fields": {
12345         "Body": [
12346           {
12347             "group": "Body",
12348             "type": "String",
12349             "allowedValues": [
12350               "\"string\"",
12351               "\"variable\"",
12352               "\"customVariable\"",
12353               "\"keyValue\""
12354             ],
12355             "optional": true,
12356             "field": "type",
12357             "description": ""
12358           },
12359           {
12360             "group": "Body",
12361             "type": "String",
12362             "optional": true,
12363             "field": "content",
12364             "description": ""
12365           },
12366           {
12367             "group": "Body",
12368             "type": "String",
12369             "optional": true,
12370             "field": "key",
12371             "description": ""
12372           },
12373           {
12374             "group": "Body",
12375             "type": "String",
12376             "allowedValues": [
12377               "\"string\"",
12378               "\"variable\"",
12379               "\"customVariable\""
12380             ],
12381             "optional": true,
12382             "field": "keyType",
12383             "description": ""
12384           },
12385           {
12386             "group": "Body",
12387             "type": "String",
12388             "optional": true,
12389             "field": "keyContent",
12390             "description": ""
12391           },
12392           {
12393             "group": "Body",
12394             "type": "String",
12395             "optional": true,
12396             "field": "idField",
12397             "description": ""
12398           },
12399           {
12400             "group": "Body",
12401             "type": "String",
12402             "optional": true,
12403             "field": "nameField",
12404             "description": ""
12405           },
12406           {
12407             "group": "Body",
12408             "type": "Boolean",
12409             "optional": true,
12410             "field": "customField",
12411             "description": ""
12412           },
12413           {
12414             "group": "Body",
12415             "type": "String",
12416             "optional": true,
12417             "field": "variableName",
12418             "description": ""
12419           }
12420         ]
12421       }
12422     },
12423     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12424     "version": "0.0.0",
12425     "filename": "server/api/intFreshsalesField/index.js",
12426     "groupTitle": "Freshsales_Fields"
12427   },
12428   {
12429     "type": "delete",
12430     "url": "/api/integrations/freshsales/fields/{id}",
12431     "title": "Deletes a Freshsales Field",
12432     "examples": [
12433       {
12434         "title": "Example usage:",
12435         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12436         "type": "json"
12437       }
12438     ],
12439     "name": "DeleteFreshsales_Fields",
12440     "group": "Freshsales_Fields",
12441     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12442     "version": "0.0.0",
12443     "filename": "server/api/intFreshsalesField/index.js",
12444     "groupTitle": "Freshsales_Fields"
12445   },
12446   {
12447     "type": "get",
12448     "url": "/api/integrations/freshsales/fields",
12449     "title": "Gets a list of Freshsales Fields",
12450     "examples": [
12451       {
12452         "title": "Example usage:",
12453         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12454         "type": "json"
12455       }
12456     ],
12457     "name": "GetFreshsales_Fields",
12458     "group": "Freshsales_Fields",
12459     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12460     "version": "0.0.0",
12461     "filename": "server/api/intFreshsalesField/index.js",
12462     "groupTitle": "Freshsales_Fields"
12463   },
12464   {
12465     "type": "get",
12466     "url": "/api/integrations/freshsales/fields/{id}",
12467     "title": "Gets a single Freshsales Field",
12468     "examples": [
12469       {
12470         "title": "Example usage:",
12471         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12472         "type": "json"
12473       }
12474     ],
12475     "name": "ShowFreshsales_Fields",
12476     "group": "Freshsales_Fields",
12477     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12478     "version": "0.0.0",
12479     "filename": "server/api/intFreshsalesField/index.js",
12480     "groupTitle": "Freshsales_Fields"
12481   },
12482   {
12483     "type": "put",
12484     "url": "/api/integrations/freshsales/fields/{id}",
12485     "title": "Update an existing Freshsales Field",
12486     "examples": [
12487       {
12488         "title": "Example usage:",
12489         "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",
12490         "type": "json"
12491       }
12492     ],
12493     "name": "updateFreshsales_Fields",
12494     "group": "Freshsales_Fields",
12495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12496     "version": "0.0.0",
12497     "filename": "server/api/intFreshsalesField/index.js",
12498     "groupTitle": "Freshsales_Fields"
12499   },
12500   {
12501     "type": "post",
12502     "url": "/api/campaigns/{id}/blacklists",
12503     "title": "Add blacklists to an IVR campaign",
12504     "examples": [
12505       {
12506         "title": "Example usage:",
12507         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12508         "type": "json"
12509       }
12510     ],
12511     "name": "AddBlackLists",
12512     "group": "IVR_Campaigns",
12513     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12514     "version": "0.0.0",
12515     "filename": "server/api/campaign/index.js",
12516     "groupTitle": "IVR_Campaigns"
12517   },
12518   {
12519     "type": "post",
12520     "url": "/api/campaigns/{id}/lists",
12521     "title": "Add lists to an IVR campaign",
12522     "examples": [
12523       {
12524         "title": "Example usage:",
12525         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12526         "type": "json"
12527       }
12528     ],
12529     "name": "AddLists",
12530     "group": "IVR_Campaigns",
12531     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12532     "version": "0.0.0",
12533     "filename": "server/api/campaign/index.js",
12534     "groupTitle": "IVR_Campaigns"
12535   },
12536   {
12537     "type": "post",
12538     "url": "/api/campaigns/clone",
12539     "title": "Clone an existing IVR Campaign",
12540     "examples": [
12541       {
12542         "title": "Example usage:",
12543         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12544         "type": "json"
12545       }
12546     ],
12547     "name": "CloneIVR_Campaigns",
12548     "group": "IVR_Campaigns",
12549     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12550     "version": "0.0.0",
12551     "filename": "server/api/campaign/index.js",
12552     "groupTitle": "IVR_Campaigns"
12553   },
12554   {
12555     "type": "post",
12556     "url": "/api/campaigns",
12557     "title": "Creates a new IVR Campaign",
12558     "examples": [
12559       {
12560         "title": "Example usage:",
12561         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12562         "type": "json"
12563       }
12564     ],
12565     "name": "CreateIVR_Campaigns",
12566     "group": "IVR_Campaigns",
12567     "parameter": {
12568       "fields": {
12569         "Body": [
12570           {
12571             "group": "Body",
12572             "type": "String",
12573             "optional": false,
12574             "field": "name",
12575             "description": ""
12576           },
12577           {
12578             "group": "Body",
12579             "type": "String",
12580             "allowedValues": [
12581               "\"ivr\""
12582             ],
12583             "optional": false,
12584             "field": "type",
12585             "description": ""
12586           },
12587           {
12588             "group": "Body",
12589             "type": "String",
12590             "optional": true,
12591             "field": "description",
12592             "description": ""
12593           },
12594           {
12595             "group": "Body",
12596             "type": "Boolean",
12597             "optional": true,
12598             "field": "active",
12599             "description": "<p>Active/Disactive Campaign</p>"
12600           },
12601           {
12602             "group": "Body",
12603             "type": "Integer",
12604             "optional": true,
12605             "field": "limitCalls",
12606             "description": "<p>Max 200 calls.</p>"
12607           },
12608           {
12609             "group": "Body",
12610             "type": "String",
12611             "optional": true,
12612             "field": "dialOriginateCallerIdName",
12613             "description": ""
12614           },
12615           {
12616             "group": "Body",
12617             "type": "String",
12618             "optional": true,
12619             "field": "dialOriginateCallerIdNumber",
12620             "description": ""
12621           },
12622           {
12623             "group": "Body",
12624             "type": "Integer",
12625             "optional": true,
12626             "field": "dialOriginateTimeout",
12627             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12628           },
12629           {
12630             "group": "Body",
12631             "type": "Integer",
12632             "optional": true,
12633             "field": "dialCongestionMaxRetry",
12634             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12635           },
12636           {
12637             "group": "Body",
12638             "type": "Integer",
12639             "optional": true,
12640             "field": "dialCongestionRetryFrequency",
12641             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12642           },
12643           {
12644             "group": "Body",
12645             "type": "Integer",
12646             "optional": true,
12647             "field": "dialBusyMaxRetry",
12648             "description": "<p>#Busy Retry (min:1, max:999)</p>"
12649           },
12650           {
12651             "group": "Body",
12652             "type": "Integer",
12653             "optional": true,
12654             "field": "dialBusyRetryFrequency",
12655             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12656           },
12657           {
12658             "group": "Body",
12659             "type": "Integer",
12660             "optional": true,
12661             "field": "dialNoAnswerMaxRetry",
12662             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12663           },
12664           {
12665             "group": "Body",
12666             "type": "Integer",
12667             "optional": true,
12668             "field": "dialNoAnswerRetryFrequency",
12669             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12670           },
12671           {
12672             "group": "Body",
12673             "type": "Integer",
12674             "optional": true,
12675             "field": "dialGlobalMaxRetry",
12676             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12677           },
12678           {
12679             "group": "Body",
12680             "type": "String",
12681             "optional": true,
12682             "field": "dialTimezone",
12683             "description": ""
12684           },
12685           {
12686             "group": "Body",
12687             "type": "String",
12688             "optional": true,
12689             "field": "dialGlobalInterval",
12690             "description": ""
12691           },
12692           {
12693             "group": "Body",
12694             "type": "String",
12695             "allowedValues": [
12696               "\"always\"",
12697               "\"never\"",
12698               "\"onlyIfOpen\""
12699             ],
12700             "optional": true,
12701             "field": "dialCheckDuplicateType",
12702             "description": ""
12703           },
12704           {
12705             "group": "Body",
12706             "type": "Boolean",
12707             "optional": true,
12708             "field": "dialAMDActive",
12709             "description": "<p>Active/Disactive AMD</p>"
12710           },
12711           {
12712             "group": "Body",
12713             "type": "Integer",
12714             "optional": true,
12715             "field": "dialAMDInitialSilence",
12716             "description": "<p>#AMD Initial Silence</p>"
12717           },
12718           {
12719             "group": "Body",
12720             "type": "Integer",
12721             "optional": true,
12722             "field": "dialAMDGreeting",
12723             "description": "<p>#AMD Greeting</p>"
12724           },
12725           {
12726             "group": "Body",
12727             "type": "Integer",
12728             "optional": true,
12729             "field": "dialAMDAfterGreetingSilence",
12730             "description": "<p>#AMD After Greeting Silence</p>"
12731           },
12732           {
12733             "group": "Body",
12734             "type": "Integer",
12735             "optional": true,
12736             "field": "dialAMDTotalAnalysisTime",
12737             "description": "<p>#AMD Total Analysis Time</p>"
12738           },
12739           {
12740             "group": "Body",
12741             "type": "Integer",
12742             "optional": true,
12743             "field": "dialAMDMinWordLength",
12744             "description": "<p>#AMD Min Word Length</p>"
12745           },
12746           {
12747             "group": "Body",
12748             "type": "Integer",
12749             "optional": true,
12750             "field": "dialAMDBetweenWordsSilence",
12751             "description": "<p>#AMD Between Words Silence</p>"
12752           },
12753           {
12754             "group": "Body",
12755             "type": "Integer",
12756             "optional": true,
12757             "field": "dialAMDMaximumNumberOfWords",
12758             "description": "<p>#AMD Maximum Number Of Words</p>"
12759           },
12760           {
12761             "group": "Body",
12762             "type": "Integer",
12763             "optional": true,
12764             "field": "dialAMDSilenceThreshold",
12765             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12766           },
12767           {
12768             "group": "Body",
12769             "type": "Integer",
12770             "optional": true,
12771             "field": "dialAMDMaximumWordLength",
12772             "description": "<p>#AMD Maximum Word Length</p>"
12773           },
12774           {
12775             "group": "Body",
12776             "type": "String",
12777             "allowedValues": [
12778               "\"DESC\"",
12779               "\"ASC\""
12780             ],
12781             "optional": true,
12782             "field": "dialOrderByScheduledAt",
12783             "description": ""
12784           },
12785           {
12786             "group": "Body",
12787             "type": "String",
12788             "optional": true,
12789             "field": "dialPrefix",
12790             "description": ""
12791           },
12792           {
12793             "group": "Body",
12794             "type": "Integer",
12795             "optional": true,
12796             "field": "dialRandomLastDigitCallerIdNumber",
12797             "description": "<p>Random Last Digit (min:1, max:15)</p>"
12798           },
12799           {
12800             "group": "Body",
12801             "type": "Integer",
12802             "optional": true,
12803             "field": "dialCutDigit",
12804             "description": "<p>Cut Digit (min:1, max:15)</p>"
12805           },
12806           {
12807             "group": "Body",
12808             "type": "Integer",
12809             "optional": true,
12810             "field": "dialNoSuchNumberMaxRetry",
12811             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
12812           },
12813           {
12814             "group": "Body",
12815             "type": "Integer",
12816             "optional": true,
12817             "field": "dialNoSuchNumberRetryFrequency",
12818             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
12819           },
12820           {
12821             "group": "Body",
12822             "type": "Integer",
12823             "optional": true,
12824             "field": "dialDropMaxRetry",
12825             "description": "<p>#Drop Retry (min:1, max:999)</p>"
12826           },
12827           {
12828             "group": "Body",
12829             "type": "Integer",
12830             "optional": true,
12831             "field": "dialDropRetryFrequency",
12832             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
12833           },
12834           {
12835             "group": "Body",
12836             "type": "Integer",
12837             "optional": true,
12838             "field": "dialAbandonedMaxRetry",
12839             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
12840           },
12841           {
12842             "group": "Body",
12843             "type": "Integer",
12844             "optional": true,
12845             "field": "dialAbandonedRetryFrequency",
12846             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
12847           },
12848           {
12849             "group": "Body",
12850             "type": "Integer",
12851             "optional": true,
12852             "field": "dialMachineMaxRetry",
12853             "description": "<p>#Machine Retry (min:1, max:999)</p>"
12854           },
12855           {
12856             "group": "Body",
12857             "type": "Integer",
12858             "optional": true,
12859             "field": "dialMachineRetryFrequency",
12860             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
12861           },
12862           {
12863             "group": "Body",
12864             "type": "Integer",
12865             "optional": true,
12866             "field": "dialAgentRejectMaxRetry",
12867             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
12868           },
12869           {
12870             "group": "Body",
12871             "type": "Integer",
12872             "optional": true,
12873             "field": "dialAgentRejectRetryFrequency",
12874             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
12875           }
12876         ]
12877       }
12878     },
12879     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12880     "version": "0.0.0",
12881     "filename": "server/api/campaign/index.js",
12882     "groupTitle": "IVR_Campaigns"
12883   },
12884   {
12885     "type": "delete",
12886     "url": "/api/campaigns/{id}",
12887     "title": "Deletes a IVR Campaign",
12888     "examples": [
12889       {
12890         "title": "Example usage:",
12891         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12892         "type": "json"
12893       }
12894     ],
12895     "name": "DeleteIVR_Campaigns",
12896     "group": "IVR_Campaigns",
12897     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12898     "version": "0.0.0",
12899     "filename": "server/api/campaign/index.js",
12900     "groupTitle": "IVR_Campaigns"
12901   },
12902   {
12903     "type": "get",
12904     "url": "/api/campaigns/{id}/blacklists",
12905     "title": "Get IVR campaign blacklists",
12906     "examples": [
12907       {
12908         "title": "Example usage:",
12909         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12910         "type": "json"
12911       }
12912     ],
12913     "name": "GetBlackLists",
12914     "group": "IVR_Campaigns",
12915     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12916     "version": "0.0.0",
12917     "filename": "server/api/campaign/index.js",
12918     "groupTitle": "IVR_Campaigns"
12919   },
12920   {
12921     "type": "get",
12922     "url": "/api/campaigns/{id}/finals",
12923     "title": "Gets IVR campaign hopper finals",
12924     "examples": [
12925       {
12926         "title": "Example usage:",
12927         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
12928         "type": "json"
12929       }
12930     ],
12931     "name": "GetHopperFinals",
12932     "group": "IVR_Campaigns",
12933     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12934     "version": "0.0.0",
12935     "filename": "server/api/campaign/index.js",
12936     "groupTitle": "IVR_Campaigns"
12937   },
12938   {
12939     "type": "get",
12940     "url": "/api/campaigns/{id}/hopper_histories",
12941     "title": "Gets IVR campaign hopper histories",
12942     "examples": [
12943       {
12944         "title": "Example usage:",
12945         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
12946         "type": "json"
12947       }
12948     ],
12949     "name": "GetHopperHistories",
12950     "group": "IVR_Campaigns",
12951     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12952     "version": "0.0.0",
12953     "filename": "server/api/campaign/index.js",
12954     "groupTitle": "IVR_Campaigns"
12955   },
12956   {
12957     "type": "get",
12958     "url": "/api/campaigns/{id}/hoppers",
12959     "title": "Gets IVR campaign hoppers",
12960     "examples": [
12961       {
12962         "title": "Example usage:",
12963         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
12964         "type": "json"
12965       }
12966     ],
12967     "name": "GetHoppers",
12968     "group": "IVR_Campaigns",
12969     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12970     "version": "0.0.0",
12971     "filename": "server/api/campaign/index.js",
12972     "groupTitle": "IVR_Campaigns"
12973   },
12974   {
12975     "type": "get",
12976     "url": "/api/campaigns",
12977     "title": "Gets a list of IVR Campaigns",
12978     "examples": [
12979       {
12980         "title": "Example usage:",
12981         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
12982         "type": "json"
12983       }
12984     ],
12985     "name": "GetIVR_Campaigns",
12986     "group": "IVR_Campaigns",
12987     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12988     "version": "0.0.0",
12989     "filename": "server/api/campaign/index.js",
12990     "groupTitle": "IVR_Campaigns"
12991   },
12992   {
12993     "type": "get",
12994     "url": "/api/campaigns/{id}/lists",
12995     "title": "Get IVR campaign lists",
12996     "examples": [
12997       {
12998         "title": "Example usage:",
12999         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
13000         "type": "json"
13001       }
13002     ],
13003     "name": "GetLists",
13004     "group": "IVR_Campaigns",
13005     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13006     "version": "0.0.0",
13007     "filename": "server/api/campaign/index.js",
13008     "groupTitle": "IVR_Campaigns"
13009   },
13010   {
13011     "type": "delete",
13012     "url": "/api/campaigns/{id}/blacklists",
13013     "title": "Remove blacklists from an IVR Campaign",
13014     "examples": [
13015       {
13016         "title": "Example usage:",
13017         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13018         "type": "json"
13019       }
13020     ],
13021     "name": "RemoveBlackLists",
13022     "group": "IVR_Campaigns",
13023     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13024     "version": "0.0.0",
13025     "filename": "server/api/campaign/index.js",
13026     "groupTitle": "IVR_Campaigns"
13027   },
13028   {
13029     "type": "delete",
13030     "url": "/api/campaigns/{id}/lists",
13031     "title": "Remove lists from an IVR Campaign",
13032     "examples": [
13033       {
13034         "title": "Example usage:",
13035         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
13036         "type": "json"
13037       }
13038     ],
13039     "name": "RemoveLists",
13040     "group": "IVR_Campaigns",
13041     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13042     "version": "0.0.0",
13043     "filename": "server/api/campaign/index.js",
13044     "groupTitle": "IVR_Campaigns"
13045   },
13046   {
13047     "type": "get",
13048     "url": "/api/campaigns/{id}",
13049     "title": "Gets a single IVR Campaign",
13050     "examples": [
13051       {
13052         "title": "Example usage:",
13053         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
13054         "type": "json"
13055       }
13056     ],
13057     "name": "ShowIVR_Campaigns",
13058     "group": "IVR_Campaigns",
13059     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13060     "version": "0.0.0",
13061     "filename": "server/api/campaign/index.js",
13062     "groupTitle": "IVR_Campaigns"
13063   },
13064   {
13065     "type": "get",
13066     "url": "/api/campaigns/{id}/blacks",
13067     "title": "Gets IVR campaign hopper blacks",
13068     "examples": [
13069       {
13070         "title": "Example usage:",
13071         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
13072         "type": "json"
13073       }
13074     ],
13075     "name": "getHopperBlacks",
13076     "group": "IVR_Campaigns",
13077     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13078     "version": "0.0.0",
13079     "filename": "server/api/campaign/index.js",
13080     "groupTitle": "IVR_Campaigns"
13081   },
13082   {
13083     "type": "put",
13084     "url": "/api/campaigns/{id}",
13085     "title": "Update an existing IVR Campaign",
13086     "examples": [
13087       {
13088         "title": "Example usage:",
13089         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13090         "type": "json"
13091       }
13092     ],
13093     "name": "updateIVR_Campaigns",
13094     "group": "IVR_Campaigns",
13095     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13096     "version": "0.0.0",
13097     "filename": "server/api/campaign/index.js",
13098     "groupTitle": "IVR_Campaigns"
13099   },
13100   {
13101     "type": "post",
13102     "url": "/api/integrations/reports",
13103     "title": "Creates a new Integration Report",
13104     "examples": [
13105       {
13106         "title": "Example usage:",
13107         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13108         "type": "json"
13109       }
13110     ],
13111     "name": "CreateIntegration_Reports",
13112     "group": "Integration_Reports",
13113     "parameter": {
13114       "fields": {
13115         "Body": [
13116           {
13117             "group": "Body",
13118             "type": "String",
13119             "optional": true,
13120             "field": "integration",
13121             "description": ""
13122           },
13123           {
13124             "group": "Body",
13125             "type": "String",
13126             "optional": true,
13127             "field": "eventChannel",
13128             "description": ""
13129           },
13130           {
13131             "group": "Body",
13132             "type": "String",
13133             "optional": true,
13134             "field": "exitStatus",
13135             "description": ""
13136           },
13137           {
13138             "group": "Body",
13139             "type": "String",
13140             "optional": true,
13141             "field": "ticketId",
13142             "description": ""
13143           },
13144           {
13145             "group": "Body",
13146             "type": "Integer",
13147             "optional": true,
13148             "field": "integrationId",
13149             "description": ""
13150           },
13151           {
13152             "group": "Body",
13153             "type": "String",
13154             "optional": true,
13155             "field": "contacts",
13156             "description": ""
13157           },
13158           {
13159             "group": "Body",
13160             "type": "String",
13161             "optional": true,
13162             "field": "uniqueid",
13163             "description": ""
13164           },
13165           {
13166             "group": "Body",
13167             "type": "String",
13168             "optional": true,
13169             "field": "calleridnum",
13170             "description": ""
13171           },
13172           {
13173             "group": "Body",
13174             "type": "String",
13175             "optional": true,
13176             "field": "calleridname",
13177             "description": ""
13178           },
13179           {
13180             "group": "Body",
13181             "type": "String",
13182             "optional": true,
13183             "field": "queue",
13184             "description": ""
13185           },
13186           {
13187             "group": "Body",
13188             "type": "String",
13189             "optional": true,
13190             "field": "interface",
13191             "description": ""
13192           },
13193           {
13194             "group": "Body",
13195             "type": "String",
13196             "optional": true,
13197             "field": "membername",
13198             "description": ""
13199           },
13200           {
13201             "group": "Body",
13202             "type": "String",
13203             "optional": true,
13204             "field": "agentcalledAt",
13205             "description": ""
13206           },
13207           {
13208             "group": "Body",
13209             "type": "String",
13210             "optional": true,
13211             "field": "agentconnectAt",
13212             "description": ""
13213           },
13214           {
13215             "group": "Body",
13216             "type": "Integer",
13217             "optional": true,
13218             "field": "holdtime",
13219             "description": ""
13220           },
13221           {
13222             "group": "Body",
13223             "type": "Boolean",
13224             "optional": true,
13225             "field": "agentcomplete",
13226             "description": ""
13227           },
13228           {
13229             "group": "Body",
13230             "type": "String",
13231             "optional": true,
13232             "field": "agentcompleteAt",
13233             "description": ""
13234           },
13235           {
13236             "group": "Body",
13237             "type": "Integer",
13238             "optional": true,
13239             "field": "talktime",
13240             "description": ""
13241           },
13242           {
13243             "group": "Body",
13244             "type": "Boolean",
13245             "optional": true,
13246             "field": "agentacw",
13247             "description": ""
13248           },
13249           {
13250             "group": "Body",
13251             "type": "Integer",
13252             "optional": true,
13253             "field": "acwtime",
13254             "description": ""
13255           },
13256           {
13257             "group": "Body",
13258             "type": "String",
13259             "optional": true,
13260             "field": "reason",
13261             "description": ""
13262           },
13263           {
13264             "group": "Body",
13265             "type": "Boolean",
13266             "optional": true,
13267             "field": "agentringnoanswer",
13268             "description": ""
13269           },
13270           {
13271             "group": "Body",
13272             "type": "String",
13273             "optional": true,
13274             "field": "agentringnoanswerAt",
13275             "description": ""
13276           },
13277           {
13278             "group": "Body",
13279             "type": "Boolean",
13280             "optional": true,
13281             "field": "agentdump",
13282             "description": ""
13283           },
13284           {
13285             "group": "Body",
13286             "type": "String",
13287             "optional": true,
13288             "field": "agentdumpAt",
13289             "description": ""
13290           },
13291           {
13292             "group": "Body",
13293             "type": "String",
13294             "optional": true,
13295             "field": "lastevent",
13296             "description": ""
13297           },
13298           {
13299             "group": "Body",
13300             "type": "String",
13301             "optional": true,
13302             "field": "channel",
13303             "description": ""
13304           },
13305           {
13306             "group": "Body",
13307             "type": "Integer",
13308             "optional": true,
13309             "field": "channelstate",
13310             "description": ""
13311           },
13312           {
13313             "group": "Body",
13314             "type": "String",
13315             "optional": true,
13316             "field": "channelstatedesc",
13317             "description": ""
13318           },
13319           {
13320             "group": "Body",
13321             "type": "String",
13322             "optional": true,
13323             "field": "connectedlinenum",
13324             "description": ""
13325           },
13326           {
13327             "group": "Body",
13328             "type": "String",
13329             "optional": true,
13330             "field": "connectedlinename",
13331             "description": ""
13332           },
13333           {
13334             "group": "Body",
13335             "type": "String",
13336             "optional": true,
13337             "field": "language",
13338             "description": ""
13339           },
13340           {
13341             "group": "Body",
13342             "type": "String",
13343             "optional": true,
13344             "field": "accountcode",
13345             "description": ""
13346           },
13347           {
13348             "group": "Body",
13349             "type": "String",
13350             "optional": true,
13351             "field": "context",
13352             "description": ""
13353           },
13354           {
13355             "group": "Body",
13356             "type": "String",
13357             "optional": true,
13358             "field": "exten",
13359             "description": ""
13360           },
13361           {
13362             "group": "Body",
13363             "type": "String",
13364             "optional": true,
13365             "field": "priority",
13366             "description": ""
13367           },
13368           {
13369             "group": "Body",
13370             "type": "String",
13371             "optional": true,
13372             "field": "destchannel",
13373             "description": ""
13374           },
13375           {
13376             "group": "Body",
13377             "type": "Integer",
13378             "optional": true,
13379             "field": "destchannelstate",
13380             "description": ""
13381           },
13382           {
13383             "group": "Body",
13384             "type": "String",
13385             "optional": true,
13386             "field": "destchannelstatedesc",
13387             "description": ""
13388           },
13389           {
13390             "group": "Body",
13391             "type": "String",
13392             "optional": true,
13393             "field": "destcalleridnum",
13394             "description": ""
13395           },
13396           {
13397             "group": "Body",
13398             "type": "String",
13399             "optional": true,
13400             "field": "destcalleridname",
13401             "description": ""
13402           },
13403           {
13404             "group": "Body",
13405             "type": "String",
13406             "optional": true,
13407             "field": "destconnectedlinenum",
13408             "description": ""
13409           },
13410           {
13411             "group": "Body",
13412             "type": "String",
13413             "optional": true,
13414             "field": "destconnectedlinename",
13415             "description": ""
13416           },
13417           {
13418             "group": "Body",
13419             "type": "String",
13420             "optional": true,
13421             "field": "destlanguage",
13422             "description": ""
13423           },
13424           {
13425             "group": "Body",
13426             "type": "String",
13427             "optional": true,
13428             "field": "destaccountcode",
13429             "description": ""
13430           },
13431           {
13432             "group": "Body",
13433             "type": "String",
13434             "optional": true,
13435             "field": "destcontext",
13436             "description": ""
13437           },
13438           {
13439             "group": "Body",
13440             "type": "String",
13441             "optional": true,
13442             "field": "destexten",
13443             "description": ""
13444           },
13445           {
13446             "group": "Body",
13447             "type": "String",
13448             "optional": true,
13449             "field": "destpriority",
13450             "description": ""
13451           },
13452           {
13453             "group": "Body",
13454             "type": "String",
13455             "optional": true,
13456             "field": "destuniqueid",
13457             "description": ""
13458           },
13459           {
13460             "group": "Body",
13461             "type": "String",
13462             "optional": true,
13463             "field": "messageId",
13464             "description": ""
13465           },
13466           {
13467             "group": "Body",
13468             "type": "String",
13469             "optional": true,
13470             "field": "inReplyTo",
13471             "description": ""
13472           },
13473           {
13474             "group": "Body",
13475             "type": "String",
13476             "optional": true,
13477             "field": "subject",
13478             "description": ""
13479           },
13480           {
13481             "group": "Body",
13482             "type": "String",
13483             "optional": true,
13484             "field": "from",
13485             "description": ""
13486           },
13487           {
13488             "group": "Body",
13489             "type": "String",
13490             "optional": true,
13491             "field": "to",
13492             "description": ""
13493           },
13494           {
13495             "group": "Body",
13496             "type": "String",
13497             "optional": true,
13498             "field": "cc",
13499             "description": ""
13500           },
13501           {
13502             "group": "Body",
13503             "type": "Text",
13504             "optional": true,
13505             "field": "attachment",
13506             "description": ""
13507           },
13508           {
13509             "group": "Body",
13510             "type": "Text",
13511             "optional": true,
13512             "field": "html",
13513             "description": ""
13514           },
13515           {
13516             "group": "Body",
13517             "type": "Text",
13518             "optional": true,
13519             "field": "text",
13520             "description": ""
13521           },
13522           {
13523             "group": "Body",
13524             "type": "String",
13525             "allowedValues": [
13526               "\"SENT\"",
13527               "\"SENDING\"",
13528               "\"RECEIVED\"",
13529               "\"FAILED\""
13530             ],
13531             "optional": true,
13532             "field": "status",
13533             "description": ""
13534           },
13535           {
13536             "group": "Body",
13537             "type": "String",
13538             "optional": true,
13539             "field": "url",
13540             "description": ""
13541           },
13542           {
13543             "group": "Body",
13544             "type": "String",
13545             "optional": true,
13546             "field": "app",
13547             "description": ""
13548           },
13549           {
13550             "group": "Body",
13551             "type": "String",
13552             "optional": true,
13553             "field": "appdata",
13554             "description": ""
13555           },
13556           {
13557             "group": "Body",
13558             "type": "Integer",
13559             "optional": true,
13560             "field": "projectId",
13561             "description": ""
13562           }
13563         ]
13564       }
13565     },
13566     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13567     "version": "0.0.0",
13568     "filename": "server/api/integrationReport/index.js",
13569     "groupTitle": "Integration_Reports"
13570   },
13571   {
13572     "type": "delete",
13573     "url": "/api/integrations/reports/{id}",
13574     "title": "Deletes a Integration Report",
13575     "examples": [
13576       {
13577         "title": "Example usage:",
13578         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13579         "type": "json"
13580       }
13581     ],
13582     "name": "DeleteIntegration_Reports",
13583     "group": "Integration_Reports",
13584     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13585     "version": "0.0.0",
13586     "filename": "server/api/integrationReport/index.js",
13587     "groupTitle": "Integration_Reports"
13588   },
13589   {
13590     "type": "get",
13591     "url": "/api/integrations/reports/describe",
13592     "title": "Gets table info about Integration Reports",
13593     "examples": [
13594       {
13595         "title": "Example usage:",
13596         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13597         "type": "json"
13598       }
13599     ],
13600     "name": "DescribeIntegration_Reports",
13601     "group": "Integration_Reports",
13602     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13603     "version": "0.0.0",
13604     "filename": "server/api/integrationReport/index.js",
13605     "groupTitle": "Integration_Reports"
13606   },
13607   {
13608     "type": "get",
13609     "url": "/api/integrations/reports",
13610     "title": "Gets a list of Integration Reports",
13611     "examples": [
13612       {
13613         "title": "Example usage:",
13614         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13615         "type": "json"
13616       }
13617     ],
13618     "name": "GetIntegration_Reports",
13619     "group": "Integration_Reports",
13620     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13621     "version": "0.0.0",
13622     "filename": "server/api/integrationReport/index.js",
13623     "groupTitle": "Integration_Reports"
13624   },
13625   {
13626     "type": "get",
13627     "url": "/api/integrations/reports/{id}",
13628     "title": "Gets a single Integration Report",
13629     "examples": [
13630       {
13631         "title": "Example usage:",
13632         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13633         "type": "json"
13634       }
13635     ],
13636     "name": "ShowIntegration_Reports",
13637     "group": "Integration_Reports",
13638     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13639     "version": "0.0.0",
13640     "filename": "server/api/integrationReport/index.js",
13641     "groupTitle": "Integration_Reports"
13642   },
13643   {
13644     "type": "put",
13645     "url": "/api/integrations/reports/{id}",
13646     "title": "Update an existing Integration Report",
13647     "examples": [
13648       {
13649         "title": "Example usage:",
13650         "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",
13651         "type": "json"
13652       }
13653     ],
13654     "name": "updateIntegration_Reports",
13655     "group": "Integration_Reports",
13656     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13657     "version": "0.0.0",
13658     "filename": "server/api/integrationReport/index.js",
13659     "groupTitle": "Integration_Reports"
13660   },
13661   {
13662     "type": "post",
13663     "url": "/api/intervals",
13664     "title": "Creates a new Interval",
13665     "examples": [
13666       {
13667         "title": "Example usage:",
13668         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13669         "type": "json"
13670       }
13671     ],
13672     "name": "CreateIntervals",
13673     "group": "Intervals",
13674     "parameter": {
13675       "fields": {
13676         "Body": [
13677           {
13678             "group": "Body",
13679             "type": "String",
13680             "optional": true,
13681             "field": "name",
13682             "description": ""
13683           },
13684           {
13685             "group": "Body",
13686             "type": "String",
13687             "optional": true,
13688             "field": "description",
13689             "description": ""
13690           },
13691           {
13692             "group": "Body",
13693             "type": "String",
13694             "optional": true,
13695             "field": "interval",
13696             "description": ""
13697           }
13698         ]
13699       }
13700     },
13701     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13702     "version": "0.0.0",
13703     "filename": "server/api/interval/index.js",
13704     "groupTitle": "Intervals"
13705   },
13706   {
13707     "type": "delete",
13708     "url": "/api/intervals/{id}",
13709     "title": "Deletes a Interval",
13710     "examples": [
13711       {
13712         "title": "Example usage:",
13713         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13714         "type": "json"
13715       }
13716     ],
13717     "name": "DeleteIntervals",
13718     "group": "Intervals",
13719     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13720     "version": "0.0.0",
13721     "filename": "server/api/interval/index.js",
13722     "groupTitle": "Intervals"
13723   },
13724   {
13725     "type": "get",
13726     "url": "/api/intervals",
13727     "title": "Gets a list of Intervals",
13728     "examples": [
13729       {
13730         "title": "Example usage:",
13731         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13732         "type": "json"
13733       }
13734     ],
13735     "name": "GetIntervals",
13736     "group": "Intervals",
13737     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13738     "version": "0.0.0",
13739     "filename": "server/api/interval/index.js",
13740     "groupTitle": "Intervals"
13741   },
13742   {
13743     "type": "get",
13744     "url": "/api/intervals/{id}",
13745     "title": "Gets a single Interval",
13746     "examples": [
13747       {
13748         "title": "Example usage:",
13749         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13750         "type": "json"
13751       }
13752     ],
13753     "name": "ShowIntervals",
13754     "group": "Intervals",
13755     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13756     "version": "0.0.0",
13757     "filename": "server/api/interval/index.js",
13758     "groupTitle": "Intervals"
13759   },
13760   {
13761     "type": "post",
13762     "url": "/api/intervals/{id}/sub_intervals",
13763     "title": "Creates a new sub interval",
13764     "examples": [
13765       {
13766         "title": "Example usage:",
13767         "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",
13768         "type": "json"
13769       }
13770     ],
13771     "name": "addInterval",
13772     "group": "Intervals",
13773     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13774     "version": "0.0.0",
13775     "filename": "server/api/interval/index.js",
13776     "groupTitle": "Intervals"
13777   },
13778   {
13779     "type": "post",
13780     "url": "/api/intervals/{id}/sub_intervals/create_many",
13781     "title": "Create new sub intervals set",
13782     "examples": [
13783       {
13784         "title": "Example usage:",
13785         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13786         "type": "json"
13787       }
13788     ],
13789     "name": "addIntervals",
13790     "group": "Intervals",
13791     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13792     "version": "0.0.0",
13793     "filename": "server/api/interval/index.js",
13794     "groupTitle": "Intervals"
13795   },
13796   {
13797     "type": "get",
13798     "url": "/api/intervals/{id}/sub_intervals",
13799     "title": "Get sub intervals set",
13800     "examples": [
13801       {
13802         "title": "Example usage:",
13803         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13804         "type": "json"
13805       }
13806     ],
13807     "name": "getIntervals",
13808     "group": "Intervals",
13809     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13810     "version": "0.0.0",
13811     "filename": "server/api/interval/index.js",
13812     "groupTitle": "Intervals"
13813   },
13814   {
13815     "type": "put",
13816     "url": "/api/intervals/{id}",
13817     "title": "Update an existing Interval",
13818     "examples": [
13819       {
13820         "title": "Example usage:",
13821         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13822         "type": "json"
13823       }
13824     ],
13825     "name": "updateIntervals",
13826     "group": "Intervals",
13827     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13828     "version": "0.0.0",
13829     "filename": "server/api/interval/index.js",
13830     "groupTitle": "Intervals"
13831   },
13832   {
13833     "type": "post",
13834     "url": "/api/jira",
13835     "title": "Creates a new issue",
13836     "examples": [
13837       {
13838         "title": "Example usage:",
13839         "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}",
13840         "type": "json"
13841       }
13842     ],
13843     "name": "Creates_Issue",
13844     "group": "Issue",
13845     "parameter": {
13846       "fields": {
13847         "Body": [
13848           {
13849             "group": "Body",
13850             "type": "String",
13851             "allowedValues": [
13852               "\"Bug\""
13853             ],
13854             "optional": true,
13855             "field": "issuetype",
13856             "description": ""
13857           },
13858           {
13859             "group": "Body",
13860             "type": "String",
13861             "optional": false,
13862             "field": "summary",
13863             "description": ""
13864           },
13865           {
13866             "group": "Body",
13867             "type": "String",
13868             "optional": false,
13869             "field": "description",
13870             "description": ""
13871           }
13872         ]
13873       }
13874     },
13875     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13876     "version": "0.0.0",
13877     "filename": "server/api/jira/index.js",
13878     "groupTitle": "Issue"
13879   },
13880   {
13881     "type": "post",
13882     "url": "/api/jscripty/answers/reports",
13883     "title": "Creates a new Report",
13884     "examples": [
13885       {
13886         "title": "Example usage:",
13887         "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",
13888         "type": "json"
13889       }
13890     ],
13891     "name": "CreateReports",
13892     "group": "JscriptyAnswerReport",
13893     "parameter": {
13894       "fields": {
13895         "Body": [
13896           {
13897             "group": "Body",
13898             "type": "String",
13899             "optional": true,
13900             "field": "question",
13901             "description": ""
13902           },
13903           {
13904             "group": "Body",
13905             "type": "Text",
13906             "optional": true,
13907             "field": "answer",
13908             "description": ""
13909           },
13910           {
13911             "group": "Body",
13912             "type": "String",
13913             "optional": true,
13914             "field": "membername",
13915             "description": ""
13916           },
13917           {
13918             "group": "Body",
13919             "type": "String",
13920             "optional": true,
13921             "field": "projectname",
13922             "description": ""
13923           },
13924           {
13925             "group": "Body",
13926             "type": "String",
13927             "optional": true,
13928             "field": "queue",
13929             "description": ""
13930           },
13931           {
13932             "group": "Body",
13933             "type": "String",
13934             "optional": true,
13935             "field": "uniqueid",
13936             "description": ""
13937           },
13938           {
13939             "group": "Body",
13940             "type": "String",
13941             "optional": true,
13942             "field": "calleridname",
13943             "description": ""
13944           },
13945           {
13946             "group": "Body",
13947             "type": "String",
13948             "optional": true,
13949             "field": "calleridnum",
13950             "description": ""
13951           },
13952           {
13953             "group": "Body",
13954             "type": "String",
13955             "optional": true,
13956             "field": "questionId",
13957             "description": ""
13958           }
13959         ]
13960       }
13961     },
13962     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13963     "version": "0.0.0",
13964     "filename": "server/api/jscriptyAnswerReport/index.js",
13965     "groupTitle": "JscriptyAnswerReport"
13966   },
13967   {
13968     "type": "delete",
13969     "url": "/api/jscripty/answers/reports/{id}",
13970     "title": "Deletes a Report",
13971     "examples": [
13972       {
13973         "title": "Example usage:",
13974         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
13975         "type": "json"
13976       }
13977     ],
13978     "name": "DeleteReports",
13979     "group": "JscriptyAnswerReport",
13980     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13981     "version": "0.0.0",
13982     "filename": "server/api/jscriptyAnswerReport/index.js",
13983     "groupTitle": "JscriptyAnswerReport"
13984   },
13985   {
13986     "type": "get",
13987     "url": "/api/jscripty/answers/reports/describe",
13988     "title": "Gets table info about Reports",
13989     "examples": [
13990       {
13991         "title": "Example usage:",
13992         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
13993         "type": "json"
13994       }
13995     ],
13996     "name": "DescribeReports",
13997     "group": "JscriptyAnswerReport",
13998     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13999     "version": "0.0.0",
14000     "filename": "server/api/jscriptyAnswerReport/index.js",
14001     "groupTitle": "JscriptyAnswerReport"
14002   },
14003   {
14004     "type": "get",
14005     "url": "/api/jscripty/answers/reports",
14006     "title": "Gets a list of Reports",
14007     "examples": [
14008       {
14009         "title": "Example usage:",
14010         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
14011         "type": "json"
14012       }
14013     ],
14014     "name": "GetReports",
14015     "group": "JscriptyAnswerReport",
14016     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14017     "version": "0.0.0",
14018     "filename": "server/api/jscriptyAnswerReport/index.js",
14019     "groupTitle": "JscriptyAnswerReport"
14020   },
14021   {
14022     "type": "get",
14023     "url": "/api/jscripty/answers/reports/{id}",
14024     "title": "Gets a single Report",
14025     "examples": [
14026       {
14027         "title": "Example usage:",
14028         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
14029         "type": "json"
14030       }
14031     ],
14032     "name": "ShowReports",
14033     "group": "JscriptyAnswerReport",
14034     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14035     "version": "0.0.0",
14036     "filename": "server/api/jscriptyAnswerReport/index.js",
14037     "groupTitle": "JscriptyAnswerReport"
14038   },
14039   {
14040     "type": "put",
14041     "url": "/api/jscripty/answers/reports/{id}",
14042     "title": "Update an existing Report",
14043     "examples": [
14044       {
14045         "title": "Example usage:",
14046         "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",
14047         "type": "json"
14048       }
14049     ],
14050     "name": "updateReports",
14051     "group": "JscriptyAnswerReport",
14052     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14053     "version": "0.0.0",
14054     "filename": "server/api/jscriptyAnswerReport/index.js",
14055     "groupTitle": "JscriptyAnswerReport"
14056   },
14057   {
14058     "type": "post",
14059     "url": "/api/jscripty/questions/reports",
14060     "title": "Creates a new Report",
14061     "examples": [
14062       {
14063         "title": "Example usage:",
14064         "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",
14065         "type": "json"
14066       }
14067     ],
14068     "name": "CreateReports",
14069     "group": "JscriptyQuestionReport",
14070     "parameter": {
14071       "fields": {
14072         "Body": [
14073           {
14074             "group": "Body",
14075             "type": "String",
14076             "optional": true,
14077             "field": "question",
14078             "description": ""
14079           },
14080           {
14081             "group": "Body",
14082             "type": "Text",
14083             "optional": true,
14084             "field": "answer",
14085             "description": ""
14086           },
14087           {
14088             "group": "Body",
14089             "type": "String",
14090             "optional": true,
14091             "field": "membername",
14092             "description": ""
14093           },
14094           {
14095             "group": "Body",
14096             "type": "String",
14097             "optional": true,
14098             "field": "projectname",
14099             "description": ""
14100           },
14101           {
14102             "group": "Body",
14103             "type": "String",
14104             "optional": true,
14105             "field": "queue",
14106             "description": ""
14107           },
14108           {
14109             "group": "Body",
14110             "type": "String",
14111             "optional": true,
14112             "field": "uniqueid",
14113             "description": ""
14114           },
14115           {
14116             "group": "Body",
14117             "type": "String",
14118             "optional": true,
14119             "field": "calleridname",
14120             "description": ""
14121           },
14122           {
14123             "group": "Body",
14124             "type": "String",
14125             "optional": true,
14126             "field": "calleridnum",
14127             "description": ""
14128           },
14129           {
14130             "group": "Body",
14131             "type": "String",
14132             "optional": true,
14133             "field": "questionId",
14134             "description": ""
14135           }
14136         ]
14137       }
14138     },
14139     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14140     "version": "0.0.0",
14141     "filename": "server/api/jscriptyQuestionReport/index.js",
14142     "groupTitle": "JscriptyQuestionReport"
14143   },
14144   {
14145     "type": "delete",
14146     "url": "/api/jscripty/questions/reports/{id}",
14147     "title": "Deletes a Report",
14148     "examples": [
14149       {
14150         "title": "Example usage:",
14151         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
14152         "type": "json"
14153       }
14154     ],
14155     "name": "DeleteReports",
14156     "group": "JscriptyQuestionReport",
14157     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14158     "version": "0.0.0",
14159     "filename": "server/api/jscriptyQuestionReport/index.js",
14160     "groupTitle": "JscriptyQuestionReport"
14161   },
14162   {
14163     "type": "get",
14164     "url": "/api/jscripty/questions/reports/describe",
14165     "title": "Gets table info about Reports",
14166     "examples": [
14167       {
14168         "title": "Example usage:",
14169         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
14170         "type": "json"
14171       }
14172     ],
14173     "name": "DescribeReports",
14174     "group": "JscriptyQuestionReport",
14175     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14176     "version": "0.0.0",
14177     "filename": "server/api/jscriptyQuestionReport/index.js",
14178     "groupTitle": "JscriptyQuestionReport"
14179   },
14180   {
14181     "type": "get",
14182     "url": "/api/jscripty/questions/reports",
14183     "title": "Gets a list of Reports",
14184     "examples": [
14185       {
14186         "title": "Example usage:",
14187         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
14188         "type": "json"
14189       }
14190     ],
14191     "name": "GetReports",
14192     "group": "JscriptyQuestionReport",
14193     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14194     "version": "0.0.0",
14195     "filename": "server/api/jscriptyQuestionReport/index.js",
14196     "groupTitle": "JscriptyQuestionReport"
14197   },
14198   {
14199     "type": "get",
14200     "url": "/api/jscripty/questions/reports/{id}",
14201     "title": "Gets a single Report",
14202     "examples": [
14203       {
14204         "title": "Example usage:",
14205         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
14206         "type": "json"
14207       }
14208     ],
14209     "name": "ShowReports",
14210     "group": "JscriptyQuestionReport",
14211     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14212     "version": "0.0.0",
14213     "filename": "server/api/jscriptyQuestionReport/index.js",
14214     "groupTitle": "JscriptyQuestionReport"
14215   },
14216   {
14217     "type": "put",
14218     "url": "/api/jscripty/questions/reports/{id}",
14219     "title": "Update an existing Report",
14220     "examples": [
14221       {
14222         "title": "Example usage:",
14223         "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",
14224         "type": "json"
14225       }
14226     ],
14227     "name": "updateReports",
14228     "group": "JscriptyQuestionReport",
14229     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14230     "version": "0.0.0",
14231     "filename": "server/api/jscriptyQuestionReport/index.js",
14232     "groupTitle": "JscriptyQuestionReport"
14233   },
14234   {
14235     "type": "post",
14236     "url": "/api/jscripty/sessions/reports",
14237     "title": "Creates a new Report",
14238     "examples": [
14239       {
14240         "title": "Example usage:",
14241         "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",
14242         "type": "json"
14243       }
14244     ],
14245     "name": "CreateReports",
14246     "group": "JscriptySessionReport",
14247     "parameter": {
14248       "fields": {
14249         "Body": [
14250           {
14251             "group": "Body",
14252             "type": "String",
14253             "optional": true,
14254             "field": "starttime",
14255             "description": ""
14256           },
14257           {
14258             "group": "Body",
14259             "type": "String",
14260             "optional": true,
14261             "field": "endtime",
14262             "description": ""
14263           },
14264           {
14265             "group": "Body",
14266             "type": "String",
14267             "optional": true,
14268             "field": "membername",
14269             "description": ""
14270           },
14271           {
14272             "group": "Body",
14273             "type": "String",
14274             "optional": true,
14275             "field": "projectname",
14276             "description": ""
14277           },
14278           {
14279             "group": "Body",
14280             "type": "String",
14281             "optional": true,
14282             "field": "queue",
14283             "description": ""
14284           },
14285           {
14286             "group": "Body",
14287             "type": "String",
14288             "optional": true,
14289             "field": "uniqueid",
14290             "description": ""
14291           },
14292           {
14293             "group": "Body",
14294             "type": "String",
14295             "optional": true,
14296             "field": "calleridname",
14297             "description": ""
14298           },
14299           {
14300             "group": "Body",
14301             "type": "String",
14302             "optional": true,
14303             "field": "calleridnum",
14304             "description": ""
14305           },
14306           {
14307             "group": "Body",
14308             "type": "Boolean",
14309             "optional": true,
14310             "field": "completed",
14311             "description": ""
14312           }
14313         ]
14314       }
14315     },
14316     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14317     "version": "0.0.0",
14318     "filename": "server/api/jscriptySessionReport/index.js",
14319     "groupTitle": "JscriptySessionReport"
14320   },
14321   {
14322     "type": "delete",
14323     "url": "/api/jscripty/sessions/reports/{id}",
14324     "title": "Deletes a Report",
14325     "examples": [
14326       {
14327         "title": "Example usage:",
14328         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
14329         "type": "json"
14330       }
14331     ],
14332     "name": "DeleteReports",
14333     "group": "JscriptySessionReport",
14334     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14335     "version": "0.0.0",
14336     "filename": "server/api/jscriptySessionReport/index.js",
14337     "groupTitle": "JscriptySessionReport"
14338   },
14339   {
14340     "type": "get",
14341     "url": "/api/jscripty/sessions/reports/describe",
14342     "title": "Gets table info about Reports",
14343     "examples": [
14344       {
14345         "title": "Example usage:",
14346         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
14347         "type": "json"
14348       }
14349     ],
14350     "name": "DescribeReports",
14351     "group": "JscriptySessionReport",
14352     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14353     "version": "0.0.0",
14354     "filename": "server/api/jscriptySessionReport/index.js",
14355     "groupTitle": "JscriptySessionReport"
14356   },
14357   {
14358     "type": "get",
14359     "url": "/api/jscripty/sessions/reports",
14360     "title": "Gets a list of Reports",
14361     "examples": [
14362       {
14363         "title": "Example usage:",
14364         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
14365         "type": "json"
14366       }
14367     ],
14368     "name": "GetReports",
14369     "group": "JscriptySessionReport",
14370     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14371     "version": "0.0.0",
14372     "filename": "server/api/jscriptySessionReport/index.js",
14373     "groupTitle": "JscriptySessionReport"
14374   },
14375   {
14376     "type": "get",
14377     "url": "/api/jscripty/sessions/reports/{id}",
14378     "title": "Gets a single Report",
14379     "examples": [
14380       {
14381         "title": "Example usage:",
14382         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
14383         "type": "json"
14384       }
14385     ],
14386     "name": "ShowReports",
14387     "group": "JscriptySessionReport",
14388     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14389     "version": "0.0.0",
14390     "filename": "server/api/jscriptySessionReport/index.js",
14391     "groupTitle": "JscriptySessionReport"
14392   },
14393   {
14394     "type": "get",
14395     "url": "/api/jscripty/sessions/reports/{id}/questions",
14396     "title": "Gets Jscripty Session questions",
14397     "examples": [
14398       {
14399         "title": "Example usage:",
14400         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
14401         "type": "json"
14402       }
14403     ],
14404     "name": "getQuestions",
14405     "group": "JscriptySessionReport",
14406     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14407     "version": "0.0.0",
14408     "filename": "server/api/jscriptySessionReport/index.js",
14409     "groupTitle": "JscriptySessionReport"
14410   },
14411   {
14412     "type": "put",
14413     "url": "/api/jscripty/sessions/reports/{id}",
14414     "title": "Update an existing Report",
14415     "examples": [
14416       {
14417         "title": "Example usage:",
14418         "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",
14419         "type": "json"
14420       }
14421     ],
14422     "name": "updateReports",
14423     "group": "JscriptySessionReport",
14424     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14425     "version": "0.0.0",
14426     "filename": "server/api/jscriptySessionReport/index.js",
14427     "groupTitle": "JscriptySessionReport"
14428   },
14429   {
14430     "type": "post",
14431     "url": "/api/jscripty/projects/clone",
14432     "title": "Clone an existing Project",
14433     "examples": [
14434       {
14435         "title": "Example usage:",
14436         "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",
14437         "type": "json"
14438       }
14439     ],
14440     "name": "CloneProjects",
14441     "group": "Jscripty_Projects",
14442     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14443     "version": "0.0.0",
14444     "filename": "server/api/jscriptyProject/index.js",
14445     "groupTitle": "Jscripty_Projects"
14446   },
14447   {
14448     "type": "post",
14449     "url": "/api/jscripty/projects",
14450     "title": "Creates a new Project",
14451     "examples": [
14452       {
14453         "title": "Example usage:",
14454         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14455         "type": "json"
14456       }
14457     ],
14458     "name": "CreateProjects",
14459     "group": "Jscripty_Projects",
14460     "parameter": {
14461       "fields": {
14462         "Body": [
14463           {
14464             "group": "Body",
14465             "type": "String",
14466             "optional": true,
14467             "field": "name",
14468             "description": ""
14469           },
14470           {
14471             "group": "Body",
14472             "type": "String",
14473             "optional": true,
14474             "field": "description",
14475             "description": ""
14476           },
14477           {
14478             "group": "Body",
14479             "type": "Text",
14480             "optional": true,
14481             "field": "formData",
14482             "description": ""
14483           },
14484           {
14485             "group": "Body",
14486             "type": "Boolean",
14487             "optional": true,
14488             "field": "enableUncompleteSave",
14489             "description": ""
14490           },
14491           {
14492             "group": "Body",
14493             "type": "Boolean",
14494             "optional": true,
14495             "field": "sendUnpauseOnSubmit",
14496             "description": ""
14497           }
14498         ]
14499       }
14500     },
14501     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14502     "version": "0.0.0",
14503     "filename": "server/api/jscriptyProject/index.js",
14504     "groupTitle": "Jscripty_Projects"
14505   },
14506   {
14507     "type": "delete",
14508     "url": "/api/jscripty/projects/{id}",
14509     "title": "Deletes a Project",
14510     "examples": [
14511       {
14512         "title": "Example usage:",
14513         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14514         "type": "json"
14515       }
14516     ],
14517     "name": "DeleteProjects",
14518     "group": "Jscripty_Projects",
14519     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14520     "version": "0.0.0",
14521     "filename": "server/api/jscriptyProject/index.js",
14522     "groupTitle": "Jscripty_Projects"
14523   },
14524   {
14525     "type": "get",
14526     "url": "/api/jscripty/projects",
14527     "title": "Gets a list of Projects",
14528     "examples": [
14529       {
14530         "title": "Example usage:",
14531         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14532         "type": "json"
14533       }
14534     ],
14535     "name": "GetProjects",
14536     "group": "Jscripty_Projects",
14537     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14538     "version": "0.0.0",
14539     "filename": "server/api/jscriptyProject/index.js",
14540     "groupTitle": "Jscripty_Projects"
14541   },
14542   {
14543     "type": "get",
14544     "url": "/api/jscripty/projects/{id}",
14545     "title": "Gets a single Project",
14546     "examples": [
14547       {
14548         "title": "Example usage:",
14549         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14550         "type": "json"
14551       }
14552     ],
14553     "name": "ShowProjects",
14554     "group": "Jscripty_Projects",
14555     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14556     "version": "0.0.0",
14557     "filename": "server/api/jscriptyProject/index.js",
14558     "groupTitle": "Jscripty_Projects"
14559   },
14560   {
14561     "type": "get",
14562     "url": "/api/jscripty/projects/{id}/answers",
14563     "title": "Gets jscripty project answers",
14564     "examples": [
14565       {
14566         "title": "Example usage:",
14567         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
14568         "type": "json"
14569       }
14570     ],
14571     "name": "getAnswers",
14572     "group": "Jscripty_Projects",
14573     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14574     "version": "0.0.0",
14575     "filename": "server/api/jscriptyProject/index.js",
14576     "groupTitle": "Jscripty_Projects"
14577   },
14578   {
14579     "type": "get",
14580     "url": "/api/jscripty/projects/{id}/sessions",
14581     "title": "Gets jscripty project sessions",
14582     "examples": [
14583       {
14584         "title": "Example usage:",
14585         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
14586         "type": "json"
14587       }
14588     ],
14589     "name": "getSessions",
14590     "group": "Jscripty_Projects",
14591     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14592     "version": "0.0.0",
14593     "filename": "server/api/jscriptyProject/index.js",
14594     "groupTitle": "Jscripty_Projects"
14595   },
14596   {
14597     "type": "get",
14598     "url": "/api/jscripty/projects/{id}/summary",
14599     "title": "Gets jscripty project summary",
14600     "examples": [
14601       {
14602         "title": "Example usage:",
14603         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
14604         "type": "json"
14605       }
14606     ],
14607     "name": "getSummary",
14608     "group": "Jscripty_Projects",
14609     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14610     "version": "0.0.0",
14611     "filename": "server/api/jscriptyProject/index.js",
14612     "groupTitle": "Jscripty_Projects"
14613   },
14614   {
14615     "type": "put",
14616     "url": "/api/jscripty/projects/{id}",
14617     "title": "Update an existing Project",
14618     "examples": [
14619       {
14620         "title": "Example usage:",
14621         "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",
14622         "type": "json"
14623       }
14624     ],
14625     "name": "updateProjects",
14626     "group": "Jscripty_Projects",
14627     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14628     "version": "0.0.0",
14629     "filename": "server/api/jscriptyProject/index.js",
14630     "groupTitle": "Jscripty_Projects"
14631   },
14632   {
14633     "type": "get",
14634     "url": "/api/license",
14635     "title": "Gets License Info",
14636     "examples": [
14637       {
14638         "title": "Example usage:",
14639         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14640         "type": "json"
14641       }
14642     ],
14643     "name": "index",
14644     "group": "License",
14645     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14646     "version": "0.0.0",
14647     "filename": "server/api/license/index.js",
14648     "groupTitle": "License"
14649   },
14650   {
14651     "type": "put",
14652     "url": "/api/license/{id}",
14653     "title": "Update License Info",
14654     "examples": [
14655       {
14656         "title": "Example usage:",
14657         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14658         "type": "json"
14659       }
14660     ],
14661     "name": "update",
14662     "group": "License",
14663     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14664     "version": "0.0.0",
14665     "filename": "server/api/license/index.js",
14666     "groupTitle": "License"
14667   },
14668   {
14669     "type": "post",
14670     "url": "/api/mail/accounts/{id}/users",
14671     "title": "Add agents to a mail account",
14672     "examples": [
14673       {
14674         "title": "Example usage:",
14675         "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",
14676         "type": "json"
14677       }
14678     ],
14679     "name": "AddAgents",
14680     "group": "Mail_Accounts",
14681     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14682     "version": "0.0.0",
14683     "filename": "server/api/mailAccount/index.js",
14684     "groupTitle": "Mail_Accounts"
14685   },
14686   {
14687     "type": "post",
14688     "url": "/api/mail/accounts/{id}/in_servers",
14689     "title": "Creates a new IMAP server",
14690     "examples": [
14691       {
14692         "title": "Example usage:",
14693         "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",
14694         "type": "json"
14695       }
14696     ],
14697     "name": "AddImap",
14698     "group": "Mail_Accounts",
14699     "parameter": {
14700       "fields": {
14701         "Body": [
14702           {
14703             "group": "Body",
14704             "type": "String",
14705             "optional": true,
14706             "field": "description",
14707             "description": ""
14708           },
14709           {
14710             "group": "Body",
14711             "type": "String",
14712             "optional": true,
14713             "field": "host",
14714             "description": ""
14715           },
14716           {
14717             "group": "Body",
14718             "type": "Boolean",
14719             "optional": true,
14720             "field": "authentication",
14721             "description": ""
14722           },
14723           {
14724             "group": "Body",
14725             "type": "String",
14726             "optional": true,
14727             "field": "user",
14728             "description": ""
14729           },
14730           {
14731             "group": "Body",
14732             "type": "String",
14733             "optional": true,
14734             "field": "password",
14735             "description": ""
14736           },
14737           {
14738             "group": "Body",
14739             "type": "Integer",
14740             "optional": true,
14741             "field": "port",
14742             "description": ""
14743           },
14744           {
14745             "group": "Body",
14746             "type": "Boolean",
14747             "optional": true,
14748             "field": "tls",
14749             "description": ""
14750           },
14751           {
14752             "group": "Body",
14753             "type": "String",
14754             "optional": true,
14755             "field": "mailbox",
14756             "description": ""
14757           },
14758           {
14759             "group": "Body",
14760             "type": "Integer",
14761             "optional": true,
14762             "field": "connTimeout",
14763             "description": ""
14764           },
14765           {
14766             "group": "Body",
14767             "type": "Integer",
14768             "optional": true,
14769             "field": "authTimeout",
14770             "description": ""
14771           },
14772           {
14773             "group": "Body",
14774             "type": "String",
14775             "optional": true,
14776             "field": "service",
14777             "description": ""
14778           }
14779         ]
14780       }
14781     },
14782     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14783     "version": "0.0.0",
14784     "filename": "server/api/mailAccount/index.js",
14785     "groupTitle": "Mail_Accounts"
14786   },
14787   {
14788     "type": "post",
14789     "url": "/api/mail/accounts/{id}/out_servers",
14790     "title": "Creates a new SMTP server",
14791     "examples": [
14792       {
14793         "title": "Example usage:",
14794         "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",
14795         "type": "json"
14796       }
14797     ],
14798     "name": "AddSmtp",
14799     "group": "Mail_Accounts",
14800     "parameter": {
14801       "fields": {
14802         "Body": [
14803           {
14804             "group": "Body",
14805             "type": "String",
14806             "optional": true,
14807             "field": "description",
14808             "description": ""
14809           },
14810           {
14811             "group": "Body",
14812             "type": "String",
14813             "optional": true,
14814             "field": "host",
14815             "description": ""
14816           },
14817           {
14818             "group": "Body",
14819             "type": "String",
14820             "optional": true,
14821             "field": "user",
14822             "description": ""
14823           },
14824           {
14825             "group": "Body",
14826             "type": "String",
14827             "optional": true,
14828             "field": "pass",
14829             "description": ""
14830           },
14831           {
14832             "group": "Body",
14833             "type": "Integer",
14834             "optional": true,
14835             "field": "port",
14836             "description": ""
14837           },
14838           {
14839             "group": "Body",
14840             "type": "Boolean",
14841             "optional": true,
14842             "field": "secure",
14843             "description": ""
14844           },
14845           {
14846             "group": "Body",
14847             "type": "String",
14848             "optional": true,
14849             "field": "service",
14850             "description": ""
14851           },
14852           {
14853             "group": "Body",
14854             "type": "Boolean",
14855             "optional": true,
14856             "field": "authentication",
14857             "description": ""
14858           }
14859         ]
14860       }
14861     },
14862     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14863     "version": "0.0.0",
14864     "filename": "server/api/mailAccount/index.js",
14865     "groupTitle": "Mail_Accounts"
14866   },
14867   {
14868     "type": "delete",
14869     "url": "/api/mail/accounts/{id}",
14870     "title": "Deletes a mail account",
14871     "examples": [
14872       {
14873         "title": "Example usage:",
14874         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14875         "type": "json"
14876       }
14877     ],
14878     "name": "DeleteMailAccounts",
14879     "group": "Mail_Accounts",
14880     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14881     "version": "0.0.0",
14882     "filename": "server/api/mailAccount/index.js",
14883     "groupTitle": "Mail_Accounts"
14884   },
14885   {
14886     "type": "get",
14887     "url": "/api/mail/accounts/describe",
14888     "title": "Gets table info about Accounts",
14889     "examples": [
14890       {
14891         "title": "Example usage:",
14892         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14893         "type": "json"
14894       }
14895     ],
14896     "name": "DescribeAccounts",
14897     "group": "Mail_Accounts",
14898     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14899     "version": "0.0.0",
14900     "filename": "server/api/mailAccount/index.js",
14901     "groupTitle": "Mail_Accounts"
14902   },
14903   {
14904     "type": "get",
14905     "url": "/api/mail/accounts",
14906     "title": "Gets a list of Accounts",
14907     "examples": [
14908       {
14909         "title": "Example usage:",
14910         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14911         "type": "json"
14912       }
14913     ],
14914     "name": "GetAccounts",
14915     "group": "Mail_Accounts",
14916     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14917     "version": "0.0.0",
14918     "filename": "server/api/mailAccount/index.js",
14919     "groupTitle": "Mail_Accounts"
14920   },
14921   {
14922     "type": "get",
14923     "url": "/api/mail/accounts/{id}/users",
14924     "title": "Gets agents from mail account",
14925     "examples": [
14926       {
14927         "title": "Example usage:",
14928         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
14929         "type": "json"
14930       }
14931     ],
14932     "name": "GetAgents",
14933     "group": "Mail_Accounts",
14934     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14935     "version": "0.0.0",
14936     "filename": "server/api/mailAccount/index.js",
14937     "groupTitle": "Mail_Accounts"
14938   },
14939   {
14940     "type": "get",
14941     "url": "/api/mail/accounts/{id}/in_servers",
14942     "title": "Gets account IMAP server",
14943     "examples": [
14944       {
14945         "title": "Example usage:",
14946         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
14947         "type": "json"
14948       }
14949     ],
14950     "name": "GetImap",
14951     "group": "Mail_Accounts",
14952     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14953     "version": "0.0.0",
14954     "filename": "server/api/mailAccount/index.js",
14955     "groupTitle": "Mail_Accounts"
14956   },
14957   {
14958     "type": "get",
14959     "url": "/api/mail/accounts/{id}/out_servers",
14960     "title": "Gets account SMTP server",
14961     "examples": [
14962       {
14963         "title": "Example usage:",
14964         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
14965         "type": "json"
14966       }
14967     ],
14968     "name": "GetSmtp",
14969     "group": "Mail_Accounts",
14970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14971     "version": "0.0.0",
14972     "filename": "server/api/mailAccount/index.js",
14973     "groupTitle": "Mail_Accounts"
14974   },
14975   {
14976     "type": "delete",
14977     "url": "/api/mail/accounts/{id}/users",
14978     "title": "Removes agents from a mail account",
14979     "examples": [
14980       {
14981         "title": "Example usage:",
14982         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14983         "type": "json"
14984       }
14985     ],
14986     "name": "RemoveAgents",
14987     "group": "Mail_Accounts",
14988     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14989     "version": "0.0.0",
14990     "filename": "server/api/mailAccount/index.js",
14991     "groupTitle": "Mail_Accounts"
14992   },
14993   {
14994     "type": "delete",
14995     "url": "/api/mail/accounts/{id}/canned_answers",
14996     "title": "Removes canned answers from account",
14997     "examples": [
14998       {
14999         "title": "Example usage:",
15000         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15001         "type": "json"
15002       }
15003     ],
15004     "name": "RemoveAnswers",
15005     "group": "Mail_Accounts",
15006     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15007     "version": "0.0.0",
15008     "filename": "server/api/mailAccount/index.js",
15009     "groupTitle": "Mail_Accounts"
15010   },
15011   {
15012     "type": "delete",
15013     "url": "/api/mail/accounts/{id}/dispositions",
15014     "title": "Removes dispositions from account",
15015     "examples": [
15016       {
15017         "title": "Example usage:",
15018         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15019         "type": "json"
15020       }
15021     ],
15022     "name": "RemoveDispositions",
15023     "group": "Mail_Accounts",
15024     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15025     "version": "0.0.0",
15026     "filename": "server/api/mailAccount/index.js",
15027     "groupTitle": "Mail_Accounts"
15028   },
15029   {
15030     "type": "delete",
15031     "url": "/api/mail/accounts/{id}/in_servers",
15032     "title": "Removes IMAP server from an account",
15033     "examples": [
15034       {
15035         "title": "Example usage:",
15036         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
15037         "type": "json"
15038       }
15039     ],
15040     "name": "RemoveImmap",
15041     "group": "Mail_Accounts",
15042     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15043     "version": "0.0.0",
15044     "filename": "server/api/mailAccount/index.js",
15045     "groupTitle": "Mail_Accounts"
15046   },
15047   {
15048     "type": "delete",
15049     "url": "/api/mail/accounts/{id}/out_servers",
15050     "title": "Removes SMTP server from an account",
15051     "examples": [
15052       {
15053         "title": "Example usage:",
15054         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
15055         "type": "json"
15056       }
15057     ],
15058     "name": "RemoveSmtp",
15059     "group": "Mail_Accounts",
15060     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15061     "version": "0.0.0",
15062     "filename": "server/api/mailAccount/index.js",
15063     "groupTitle": "Mail_Accounts"
15064   },
15065   {
15066     "type": "get",
15067     "url": "/api/mail/accounts/{id}",
15068     "title": "Gets a single Account",
15069     "examples": [
15070       {
15071         "title": "Example usage:",
15072         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
15073         "type": "json"
15074       }
15075     ],
15076     "name": "ShowAccounts",
15077     "group": "Mail_Accounts",
15078     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15079     "version": "0.0.0",
15080     "filename": "server/api/mailAccount/index.js",
15081     "groupTitle": "Mail_Accounts"
15082   },
15083   {
15084     "type": "post",
15085     "url": "/api/mail/accounts/{id}/canned_answers",
15086     "title": "Creates new canned answer",
15087     "examples": [
15088       {
15089         "title": "Example usage:",
15090         "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",
15091         "type": "json"
15092       }
15093     ],
15094     "name": "addAnswer",
15095     "group": "Mail_Accounts",
15096     "parameter": {
15097       "fields": {
15098         "Body": [
15099           {
15100             "group": "Body",
15101             "type": "String",
15102             "optional": false,
15103             "field": "key",
15104             "description": ""
15105           },
15106           {
15107             "group": "Body",
15108             "type": "Text",
15109             "optional": false,
15110             "field": "value",
15111             "description": ""
15112           },
15113           {
15114             "group": "Body",
15115             "type": "String",
15116             "optional": true,
15117             "field": "description",
15118             "description": ""
15119           },
15120           {
15121             "group": "Body",
15122             "type": "Virtual",
15123             "optional": true,
15124             "field": "name",
15125             "description": ""
15126           }
15127         ]
15128       }
15129     },
15130     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15131     "version": "0.0.0",
15132     "filename": "server/api/mailAccount/index.js",
15133     "groupTitle": "Mail_Accounts"
15134   },
15135   {
15136     "type": "post",
15137     "url": "/api/mail/accounts/{id}/applications",
15138     "title": "Creates new applications",
15139     "examples": [
15140       {
15141         "title": "Example usage:",
15142         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15143         "type": "json"
15144       }
15145     ],
15146     "name": "addApplications",
15147     "group": "Mail_Accounts",
15148     "parameter": {
15149       "fields": {
15150         "Body": [
15151           {
15152             "group": "Body",
15153             "type": "Integer",
15154             "optional": false,
15155             "field": "priority",
15156             "description": ""
15157           },
15158           {
15159             "group": "Body",
15160             "type": "String",
15161             "optional": false,
15162             "field": "app",
15163             "description": ""
15164           },
15165           {
15166             "group": "Body",
15167             "type": "Text",
15168             "optional": true,
15169             "field": "appdata",
15170             "description": ""
15171           },
15172           {
15173             "group": "Body",
15174             "type": "String",
15175             "optional": true,
15176             "field": "description",
15177             "description": ""
15178           },
15179           {
15180             "group": "Body",
15181             "type": "String",
15182             "optional": true,
15183             "field": "interval",
15184             "description": ""
15185           }
15186         ]
15187       }
15188     },
15189     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15190     "version": "0.0.0",
15191     "filename": "server/api/mailAccount/index.js",
15192     "groupTitle": "Mail_Accounts"
15193   },
15194   {
15195     "type": "post",
15196     "url": "/api/mail/accounts/{id}/dispositions",
15197     "title": "Creates new disposition",
15198     "examples": [
15199       {
15200         "title": "Example usage:",
15201         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15202         "type": "json"
15203       }
15204     ],
15205     "name": "addDisposition",
15206     "group": "Mail_Accounts",
15207     "parameter": {
15208       "fields": {
15209         "Body": [
15210           {
15211             "group": "Body",
15212             "type": "String",
15213             "optional": false,
15214             "field": "name",
15215             "description": ""
15216           },
15217           {
15218             "group": "Body",
15219             "type": "String",
15220             "allowedValues": [
15221               "\"first\"",
15222               "\"second\"",
15223               "\"third\""
15224             ],
15225             "optional": false,
15226             "field": "level",
15227             "description": ""
15228           },
15229           {
15230             "group": "Body",
15231             "type": "String",
15232             "optional": true,
15233             "field": "description",
15234             "description": ""
15235           }
15236         ]
15237       }
15238     },
15239     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15240     "version": "0.0.0",
15241     "filename": "server/api/mailAccount/index.js",
15242     "groupTitle": "Mail_Accounts"
15243   },
15244   {
15245     "type": "post",
15246     "url": "/api/mail/accounts/{id}/interactions",
15247     "title": "Creates new interactions",
15248     "examples": [
15249       {
15250         "title": "Example usage:",
15251         "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",
15252         "type": "json"
15253       }
15254     ],
15255     "name": "addInteraction",
15256     "group": "Mail_Accounts",
15257     "parameter": {
15258       "fields": {
15259         "Body": [
15260           {
15261             "group": "Body",
15262             "type": "Boolean",
15263             "optional": true,
15264             "field": "closed",
15265             "description": ""
15266           },
15267           {
15268             "group": "Body",
15269             "type": "String",
15270             "optional": true,
15271             "field": "closedAt",
15272             "description": ""
15273           },
15274           {
15275             "group": "Body",
15276             "type": "String",
15277             "optional": true,
15278             "field": "disposition",
15279             "description": ""
15280           },
15281           {
15282             "group": "Body",
15283             "type": "String",
15284             "optional": true,
15285             "field": "secondDisposition",
15286             "description": ""
15287           },
15288           {
15289             "group": "Body",
15290             "type": "String",
15291             "optional": true,
15292             "field": "thirdDisposition",
15293             "description": ""
15294           },
15295           {
15296             "group": "Body",
15297             "type": "String",
15298             "optional": true,
15299             "field": "note",
15300             "description": ""
15301           },
15302           {
15303             "group": "Body",
15304             "type": "String",
15305             "optional": true,
15306             "field": "inReplyTo",
15307             "description": ""
15308           },
15309           {
15310             "group": "Body",
15311             "type": "String",
15312             "optional": true,
15313             "field": "to",
15314             "description": ""
15315           },
15316           {
15317             "group": "Body",
15318             "type": "Text",
15319             "optional": true,
15320             "field": "cc",
15321             "description": ""
15322           },
15323           {
15324             "group": "Body",
15325             "type": "Text",
15326             "optional": true,
15327             "field": "subject",
15328             "description": ""
15329           },
15330           {
15331             "group": "Body",
15332             "type": "Boolean",
15333             "optional": true,
15334             "field": "attach",
15335             "description": ""
15336           },
15337           {
15338             "group": "Body",
15339             "type": "String",
15340             "optional": true,
15341             "field": "read1stAt",
15342             "description": ""
15343           },
15344           {
15345             "group": "Body",
15346             "type": "String",
15347             "optional": true,
15348             "field": "substatus",
15349             "description": ""
15350           },
15351           {
15352             "group": "Body",
15353             "type": "String",
15354             "optional": true,
15355             "field": "substatusAt",
15356             "description": ""
15357           },
15358           {
15359             "group": "Body",
15360             "type": "String",
15361             "allowedValues": [
15362               "\"in\"",
15363               "\"out\""
15364             ],
15365             "optional": false,
15366             "field": "firstMsgDirection",
15367             "description": ""
15368           },
15369           {
15370             "group": "Body",
15371             "type": "String",
15372             "optional": true,
15373             "field": "lastMsgAt",
15374             "description": ""
15375           },
15376           {
15377             "group": "Body",
15378             "type": "String",
15379             "allowedValues": [
15380               "\"in\"",
15381               "\"out\""
15382             ],
15383             "optional": false,
15384             "field": "lastMsgDirection",
15385             "description": ""
15386           },
15387           {
15388             "group": "Body",
15389             "type": "Text",
15390             "optional": true,
15391             "field": "lastMsgBody",
15392             "description": ""
15393           },
15394           {
15395             "group": "Body",
15396             "type": "Text",
15397             "optional": true,
15398             "field": "lastMsgText",
15399             "description": ""
15400           }
15401         ]
15402       }
15403     },
15404     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15405     "version": "0.0.0",
15406     "filename": "server/api/mailAccount/index.js",
15407     "groupTitle": "Mail_Accounts"
15408   },
15409   {
15410     "type": "post",
15411     "url": "/api/mail/accounts",
15412     "title": "Create a mail account",
15413     "examples": [
15414       {
15415         "title": "Example usage:",
15416         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15417         "type": "json"
15418       }
15419     ],
15420     "name": "create",
15421     "group": "Mail_Accounts",
15422     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15423     "version": "0.0.0",
15424     "filename": "server/api/mailAccount/index.js",
15425     "groupTitle": "Mail_Accounts"
15426   },
15427   {
15428     "type": "get",
15429     "url": "/api/mail/accounts/{id}/canned_answers",
15430     "title": "Gets account canned answers",
15431     "examples": [
15432       {
15433         "title": "Example usage:",
15434         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
15435         "type": "json"
15436       }
15437     ],
15438     "name": "getAnswers",
15439     "group": "Mail_Accounts",
15440     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15441     "version": "0.0.0",
15442     "filename": "server/api/mailAccount/index.js",
15443     "groupTitle": "Mail_Accounts"
15444   },
15445   {
15446     "type": "get",
15447     "url": "/api/mail/accounts/{id}/applications",
15448     "title": "Gets account applications",
15449     "examples": [
15450       {
15451         "title": "Example usage:",
15452         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
15453         "type": "json"
15454       }
15455     ],
15456     "name": "getApplications",
15457     "group": "Mail_Accounts",
15458     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15459     "version": "0.0.0",
15460     "filename": "server/api/mailAccount/index.js",
15461     "groupTitle": "Mail_Accounts"
15462   },
15463   {
15464     "type": "get",
15465     "url": "/api/mail/accounts/{id}/dispositions",
15466     "title": "Gets account dispositions",
15467     "examples": [
15468       {
15469         "title": "Example usage:",
15470         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
15471         "type": "json"
15472       }
15473     ],
15474     "name": "getDispositions",
15475     "group": "Mail_Accounts",
15476     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15477     "version": "0.0.0",
15478     "filename": "server/api/mailAccount/index.js",
15479     "groupTitle": "Mail_Accounts"
15480   },
15481   {
15482     "type": "get",
15483     "url": "/api/mail/accounts/{id}/interactions",
15484     "title": "Gets account interactions",
15485     "examples": [
15486       {
15487         "title": "Example usage:",
15488         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15489         "type": "json"
15490       }
15491     ],
15492     "name": "getInteraction",
15493     "group": "Mail_Accounts",
15494     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15495     "version": "0.0.0",
15496     "filename": "server/api/mailAccount/index.js",
15497     "groupTitle": "Mail_Accounts"
15498   },
15499   {
15500     "type": "get",
15501     "url": "/api/mail/accounts/{id}/messages",
15502     "title": "Gets account messages",
15503     "examples": [
15504       {
15505         "title": "Example usage:",
15506         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15507         "type": "json"
15508       }
15509     ],
15510     "name": "getMessages",
15511     "group": "Mail_Accounts",
15512     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15513     "version": "0.0.0",
15514     "filename": "server/api/mailAccount/index.js",
15515     "groupTitle": "Mail_Accounts"
15516   },
15517   {
15518     "type": "post",
15519     "url": "/api/mail/accounts/{id}/send",
15520     "title": "Send new mail",
15521     "examples": [
15522       {
15523         "title": "Example usage:",
15524         "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",
15525         "type": "json"
15526       }
15527     ],
15528     "name": "sendMail",
15529     "group": "Mail_Accounts",
15530     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15531     "version": "0.0.0",
15532     "filename": "server/api/mailAccount/index.js",
15533     "groupTitle": "Mail_Accounts"
15534   },
15535   {
15536     "type": "put",
15537     "url": "/api/mail/accounts/{id}",
15538     "title": "Update an existing Account",
15539     "examples": [
15540       {
15541         "title": "Example usage:",
15542         "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",
15543         "type": "json"
15544       }
15545     ],
15546     "name": "updateAccounts",
15547     "group": "Mail_Accounts",
15548     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15549     "version": "0.0.0",
15550     "filename": "server/api/mailAccount/index.js",
15551     "groupTitle": "Mail_Accounts"
15552   },
15553   {
15554     "type": "get",
15555     "url": "/api/mail/accounts/{id}/verify",
15556     "title": "Verify mail account",
15557     "examples": [
15558       {
15559         "title": "Example usage:",
15560         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15561         "type": "json"
15562       }
15563     ],
15564     "name": "verifySmtp",
15565     "group": "Mail_Accounts",
15566     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15567     "version": "0.0.0",
15568     "filename": "server/api/mailAccount/index.js",
15569     "groupTitle": "Mail_Accounts"
15570   },
15571   {
15572     "type": "delete",
15573     "url": "/api/mail/applications/{id}",
15574     "title": "Deletes a Application",
15575     "examples": [
15576       {
15577         "title": "Example usage:",
15578         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15579         "type": "json"
15580       }
15581     ],
15582     "name": "DeleteApplications",
15583     "group": "Mail_Applications",
15584     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15585     "version": "0.0.0",
15586     "filename": "server/api/mailApplication/index.js",
15587     "groupTitle": "Mail_Applications"
15588   },
15589   {
15590     "type": "get",
15591     "url": "/api/mail/applications/{id}",
15592     "title": "Gets a single Application",
15593     "examples": [
15594       {
15595         "title": "Example usage:",
15596         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15597         "type": "json"
15598       }
15599     ],
15600     "name": "ShowApplications",
15601     "group": "Mail_Applications",
15602     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15603     "version": "0.0.0",
15604     "filename": "server/api/mailApplication/index.js",
15605     "groupTitle": "Mail_Applications"
15606   },
15607   {
15608     "type": "put",
15609     "url": "/api/mail/applications/{id}",
15610     "title": "Update an existing Application",
15611     "examples": [
15612       {
15613         "title": "Example usage:",
15614         "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",
15615         "type": "json"
15616       }
15617     ],
15618     "name": "updateApplications",
15619     "group": "Mail_Applications",
15620     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15621     "version": "0.0.0",
15622     "filename": "server/api/mailApplication/index.js",
15623     "groupTitle": "Mail_Applications"
15624   },
15625   {
15626     "type": "post",
15627     "url": "/api/mail/interactions/{id}/tags",
15628     "title": "Add tags to the interaction",
15629     "examples": [
15630       {
15631         "title": "Example usage:",
15632         "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",
15633         "type": "json"
15634       }
15635     ],
15636     "name": "AddTags",
15637     "group": "Mail_Interactions",
15638     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15639     "version": "0.0.0",
15640     "filename": "server/api/mailInteraction/index.js",
15641     "groupTitle": "Mail_Interactions"
15642   },
15643   {
15644     "type": "post",
15645     "url": "/api/mail/interactions",
15646     "title": "Creates a new Interaction",
15647     "examples": [
15648       {
15649         "title": "Example usage:",
15650         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15651         "type": "json"
15652       }
15653     ],
15654     "name": "CreateInteractions",
15655     "group": "Mail_Interactions",
15656     "parameter": {
15657       "fields": {
15658         "Body": [
15659           {
15660             "group": "Body",
15661             "type": "Boolean",
15662             "optional": true,
15663             "field": "closed",
15664             "description": ""
15665           },
15666           {
15667             "group": "Body",
15668             "type": "String",
15669             "optional": true,
15670             "field": "closedAt",
15671             "description": ""
15672           },
15673           {
15674             "group": "Body",
15675             "type": "String",
15676             "optional": true,
15677             "field": "disposition",
15678             "description": ""
15679           },
15680           {
15681             "group": "Body",
15682             "type": "String",
15683             "optional": true,
15684             "field": "secondDisposition",
15685             "description": ""
15686           },
15687           {
15688             "group": "Body",
15689             "type": "String",
15690             "optional": true,
15691             "field": "thirdDisposition",
15692             "description": ""
15693           },
15694           {
15695             "group": "Body",
15696             "type": "String",
15697             "optional": true,
15698             "field": "note",
15699             "description": ""
15700           },
15701           {
15702             "group": "Body",
15703             "type": "String",
15704             "optional": true,
15705             "field": "inReplyTo",
15706             "description": ""
15707           },
15708           {
15709             "group": "Body",
15710             "type": "String",
15711             "optional": true,
15712             "field": "to",
15713             "description": ""
15714           },
15715           {
15716             "group": "Body",
15717             "type": "Text",
15718             "optional": true,
15719             "field": "cc",
15720             "description": ""
15721           },
15722           {
15723             "group": "Body",
15724             "type": "Text",
15725             "optional": true,
15726             "field": "subject",
15727             "description": ""
15728           },
15729           {
15730             "group": "Body",
15731             "type": "Boolean",
15732             "optional": true,
15733             "field": "attach",
15734             "description": ""
15735           },
15736           {
15737             "group": "Body",
15738             "type": "String",
15739             "optional": true,
15740             "field": "read1stAt",
15741             "description": ""
15742           },
15743           {
15744             "group": "Body",
15745             "type": "String",
15746             "optional": true,
15747             "field": "substatus",
15748             "description": ""
15749           },
15750           {
15751             "group": "Body",
15752             "type": "String",
15753             "optional": true,
15754             "field": "substatusAt",
15755             "description": ""
15756           },
15757           {
15758             "group": "Body",
15759             "type": "String",
15760             "allowedValues": [
15761               "\"in\"",
15762               "\"out\""
15763             ],
15764             "optional": false,
15765             "field": "firstMsgDirection",
15766             "description": ""
15767           },
15768           {
15769             "group": "Body",
15770             "type": "String",
15771             "optional": true,
15772             "field": "lastMsgAt",
15773             "description": ""
15774           },
15775           {
15776             "group": "Body",
15777             "type": "String",
15778             "allowedValues": [
15779               "\"in\"",
15780               "\"out\""
15781             ],
15782             "optional": false,
15783             "field": "lastMsgDirection",
15784             "description": ""
15785           },
15786           {
15787             "group": "Body",
15788             "type": "Text",
15789             "optional": true,
15790             "field": "lastMsgBody",
15791             "description": ""
15792           },
15793           {
15794             "group": "Body",
15795             "type": "Text",
15796             "optional": true,
15797             "field": "lastMsgText",
15798             "description": ""
15799           }
15800         ]
15801       }
15802     },
15803     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15804     "version": "0.0.0",
15805     "filename": "server/api/mailInteraction/index.js",
15806     "groupTitle": "Mail_Interactions"
15807   },
15808   {
15809     "type": "delete",
15810     "url": "/api/mail/interactions/{id}",
15811     "title": "Deletes a Interaction",
15812     "examples": [
15813       {
15814         "title": "Example usage:",
15815         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15816         "type": "json"
15817       }
15818     ],
15819     "name": "DeleteInteractions",
15820     "group": "Mail_Interactions",
15821     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15822     "version": "0.0.0",
15823     "filename": "server/api/mailInteraction/index.js",
15824     "groupTitle": "Mail_Interactions"
15825   },
15826   {
15827     "type": "get",
15828     "url": "/api/mail/interactions/describe",
15829     "title": "Gets table info about Interactions",
15830     "examples": [
15831       {
15832         "title": "Example usage:",
15833         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15834         "type": "json"
15835       }
15836     ],
15837     "name": "DescribeInteractions",
15838     "group": "Mail_Interactions",
15839     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15840     "version": "0.0.0",
15841     "filename": "server/api/mailInteraction/index.js",
15842     "groupTitle": "Mail_Interactions"
15843   },
15844   {
15845     "type": "get",
15846     "url": "/api/mail/interactions",
15847     "title": "Gets a list of Interactions",
15848     "examples": [
15849       {
15850         "title": "Example usage:",
15851         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15852         "type": "json"
15853       }
15854     ],
15855     "name": "GetInteractions",
15856     "group": "Mail_Interactions",
15857     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15858     "version": "0.0.0",
15859     "filename": "server/api/mailInteraction/index.js",
15860     "groupTitle": "Mail_Interactions"
15861   },
15862   {
15863     "type": "delete",
15864     "url": "/api/mail/interactions/{id}/tags",
15865     "title": "Removes tags from interaction",
15866     "examples": [
15867       {
15868         "title": "Example usage:",
15869         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15870         "type": "json"
15871       }
15872     ],
15873     "name": "RemoveTags",
15874     "group": "Mail_Interactions",
15875     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15876     "version": "0.0.0",
15877     "filename": "server/api/mailInteraction/index.js",
15878     "groupTitle": "Mail_Interactions"
15879   },
15880   {
15881     "type": "get",
15882     "url": "/api/mail/interactions/{id}",
15883     "title": "Gets a single Interaction",
15884     "examples": [
15885       {
15886         "title": "Example usage:",
15887         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15888         "type": "json"
15889       }
15890     ],
15891     "name": "ShowInteractions",
15892     "group": "Mail_Interactions",
15893     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15894     "version": "0.0.0",
15895     "filename": "server/api/mailInteraction/index.js",
15896     "groupTitle": "Mail_Interactions"
15897   },
15898   {
15899     "type": "post",
15900     "url": "/api/mail/interactions/{id}/messages",
15901     "title": "Creates new message",
15902     "examples": [
15903       {
15904         "title": "Example usage:",
15905         "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",
15906         "type": "json"
15907       }
15908     ],
15909     "name": "addMessage",
15910     "group": "Mail_Interactions",
15911     "parameter": {
15912       "fields": {
15913         "Body": [
15914           {
15915             "group": "Body",
15916             "type": "Text",
15917             "optional": false,
15918             "field": "body",
15919             "description": ""
15920           },
15921           {
15922             "group": "Body",
15923             "type": "Text",
15924             "optional": true,
15925             "field": "plainBody",
15926             "description": ""
15927           },
15928           {
15929             "group": "Body",
15930             "type": "Boolean",
15931             "optional": true,
15932             "field": "read",
15933             "description": ""
15934           },
15935           {
15936             "group": "Body",
15937             "type": "String",
15938             "allowedValues": [
15939               "\"in\"",
15940               "\"out\""
15941             ],
15942             "optional": false,
15943             "field": "direction",
15944             "description": ""
15945           },
15946           {
15947             "group": "Body",
15948             "type": "String",
15949             "optional": true,
15950             "field": "messageId",
15951             "description": ""
15952           },
15953           {
15954             "group": "Body",
15955             "type": "String",
15956             "optional": true,
15957             "field": "from",
15958             "description": ""
15959           },
15960           {
15961             "group": "Body",
15962             "type": "Text",
15963             "optional": true,
15964             "field": "to",
15965             "description": ""
15966           },
15967           {
15968             "group": "Body",
15969             "type": "Text",
15970             "optional": true,
15971             "field": "cc",
15972             "description": ""
15973           },
15974           {
15975             "group": "Body",
15976             "type": "Text",
15977             "optional": true,
15978             "field": "bcc",
15979             "description": ""
15980           },
15981           {
15982             "group": "Body",
15983             "type": "Text",
15984             "optional": true,
15985             "field": "subject",
15986             "description": ""
15987           },
15988           {
15989             "group": "Body",
15990             "type": "String",
15991             "optional": true,
15992             "field": "sentAt",
15993             "description": ""
15994           },
15995           {
15996             "group": "Body",
15997             "type": "Integer",
15998             "optional": true,
15999             "field": "attach",
16000             "description": ""
16001           },
16002           {
16003             "group": "Body",
16004             "type": "Boolean",
16005             "optional": true,
16006             "field": "secret",
16007             "description": ""
16008           },
16009           {
16010             "group": "Body",
16011             "type": "String",
16012             "optional": true,
16013             "field": "readAt",
16014             "description": ""
16015           },
16016           {
16017             "group": "Body",
16018             "type": "Text",
16019             "optional": true,
16020             "field": "originTo",
16021             "description": ""
16022           },
16023           {
16024             "group": "Body",
16025             "type": "Text",
16026             "optional": true,
16027             "field": "originCc",
16028             "description": ""
16029           }
16030         ]
16031       }
16032     },
16033     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16034     "version": "0.0.0",
16035     "filename": "server/api/mailInteraction/index.js",
16036     "groupTitle": "Mail_Interactions"
16037   },
16038   {
16039     "type": "get",
16040     "url": "/api/mail/interactions/{id}/download",
16041     "title": "Gets interaction",
16042     "examples": [
16043       {
16044         "title": "Example usage:",
16045         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
16046         "type": "json"
16047       }
16048     ],
16049     "name": "download",
16050     "group": "Mail_Interactions",
16051     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16052     "version": "0.0.0",
16053     "filename": "server/api/mailInteraction/index.js",
16054     "groupTitle": "Mail_Interactions"
16055   },
16056   {
16057     "type": "get",
16058     "url": "/api/mail/interactions/{id}/messages",
16059     "title": "Gets interaction messages",
16060     "examples": [
16061       {
16062         "title": "Example usage:",
16063         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
16064         "type": "json"
16065       }
16066     ],
16067     "name": "getMessages",
16068     "group": "Mail_Interactions",
16069     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16070     "version": "0.0.0",
16071     "filename": "server/api/mailInteraction/index.js",
16072     "groupTitle": "Mail_Interactions"
16073   },
16074   {
16075     "type": "put",
16076     "url": "/api/mail/interactions/{id}",
16077     "title": "Update an existing Interaction",
16078     "examples": [
16079       {
16080         "title": "Example usage:",
16081         "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",
16082         "type": "json"
16083       }
16084     ],
16085     "name": "updateInteractions",
16086     "group": "Mail_Interactions",
16087     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16088     "version": "0.0.0",
16089     "filename": "server/api/mailInteraction/index.js",
16090     "groupTitle": "Mail_Interactions"
16091   },
16092   {
16093     "type": "delete",
16094     "url": "/api/mail/messages/{id}",
16095     "title": "Deletes a Message",
16096     "examples": [
16097       {
16098         "title": "Example usage:",
16099         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
16100         "type": "json"
16101       }
16102     ],
16103     "name": "DeleteMessages",
16104     "group": "Mail_Messages",
16105     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16106     "version": "0.0.0",
16107     "filename": "server/api/mailMessage/index.js",
16108     "groupTitle": "Mail_Messages"
16109   },
16110   {
16111     "type": "get",
16112     "url": "/api/mail/messages/describe",
16113     "title": "Gets table info about Messages",
16114     "examples": [
16115       {
16116         "title": "Example usage:",
16117         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
16118         "type": "json"
16119       }
16120     ],
16121     "name": "DescribeMessages",
16122     "group": "Mail_Messages",
16123     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16124     "version": "0.0.0",
16125     "filename": "server/api/mailMessage/index.js",
16126     "groupTitle": "Mail_Messages"
16127   },
16128   {
16129     "type": "get",
16130     "url": "/api/mail/messages",
16131     "title": "Gets a list of Messages",
16132     "examples": [
16133       {
16134         "title": "Example usage:",
16135         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
16136         "type": "json"
16137       }
16138     ],
16139     "name": "GetMessages",
16140     "group": "Mail_Messages",
16141     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16142     "version": "0.0.0",
16143     "filename": "server/api/mailMessage/index.js",
16144     "groupTitle": "Mail_Messages"
16145   },
16146   {
16147     "type": "get",
16148     "url": "/api/mail/messages/{id}",
16149     "title": "Gets a single Message",
16150     "examples": [
16151       {
16152         "title": "Example usage:",
16153         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
16154         "type": "json"
16155       }
16156     ],
16157     "name": "ShowMessages",
16158     "group": "Mail_Messages",
16159     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16160     "version": "0.0.0",
16161     "filename": "server/api/mailMessage/index.js",
16162     "groupTitle": "Mail_Messages"
16163   },
16164   {
16165     "type": "put",
16166     "url": "/api/mail/messages/{id}/accept",
16167     "title": "Accepts message",
16168     "examples": [
16169       {
16170         "title": "Example usage:",
16171         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16172         "type": "json"
16173       }
16174     ],
16175     "name": "acceptMessage",
16176     "group": "Mail_Messages",
16177     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16178     "version": "0.0.0",
16179     "filename": "server/api/mailMessage/index.js",
16180     "groupTitle": "Mail_Messages"
16181   },
16182   {
16183     "type": "post",
16184     "url": "/api/mail/messages",
16185     "title": "Create a message",
16186     "examples": [
16187       {
16188         "title": "Example usage:",
16189         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16190         "type": "json"
16191       }
16192     ],
16193     "name": "createMessage",
16194     "group": "Mail_Messages",
16195     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16196     "version": "0.0.0",
16197     "filename": "server/api/mailMessage/index.js",
16198     "groupTitle": "Mail_Messages"
16199   },
16200   {
16201     "type": "get",
16202     "url": "/api/mail/messages/{id}/download",
16203     "title": "Gets message",
16204     "examples": [
16205       {
16206         "title": "Example usage:",
16207         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
16208         "type": "json"
16209       }
16210     ],
16211     "name": "download",
16212     "group": "Mail_Messages",
16213     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16214     "version": "0.0.0",
16215     "filename": "server/api/mailMessage/index.js",
16216     "groupTitle": "Mail_Messages"
16217   },
16218   {
16219     "type": "put",
16220     "url": "/api/mail/messages/{id}/reject",
16221     "title": "Rejects message",
16222     "examples": [
16223       {
16224         "title": "Example usage:",
16225         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
16226         "type": "json"
16227       }
16228     ],
16229     "name": "rejectMessage",
16230     "group": "Mail_Messages",
16231     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16232     "version": "0.0.0",
16233     "filename": "server/api/mailMessage/index.js",
16234     "groupTitle": "Mail_Messages"
16235   },
16236   {
16237     "type": "put",
16238     "url": "/api/mail/messages/{id}",
16239     "title": "Update an existing Message",
16240     "examples": [
16241       {
16242         "title": "Example usage:",
16243         "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",
16244         "type": "json"
16245       }
16246     ],
16247     "name": "updateMessages",
16248     "group": "Mail_Messages",
16249     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16250     "version": "0.0.0",
16251     "filename": "server/api/mailMessage/index.js",
16252     "groupTitle": "Mail_Messages"
16253   },
16254   {
16255     "type": "post",
16256     "url": "/api/mail/reports/queue",
16257     "title": "Creates a new Mail Queue Report",
16258     "examples": [
16259       {
16260         "title": "Example usage:",
16261         "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",
16262         "type": "json"
16263       }
16264     ],
16265     "name": "CreateMail_Queue_Reports",
16266     "group": "Mail_Queue_Reports",
16267     "parameter": {
16268       "fields": {
16269         "Body": [
16270           {
16271             "group": "Body",
16272             "type": "String",
16273             "optional": false,
16274             "field": "uniqueid",
16275             "description": ""
16276           },
16277           {
16278             "group": "Body",
16279             "type": "String",
16280             "optional": true,
16281             "field": "from",
16282             "description": ""
16283           },
16284           {
16285             "group": "Body",
16286             "type": "String",
16287             "optional": true,
16288             "field": "joinAt",
16289             "description": ""
16290           },
16291           {
16292             "group": "Body",
16293             "type": "String",
16294             "optional": true,
16295             "field": "leaveAt",
16296             "description": ""
16297           },
16298           {
16299             "group": "Body",
16300             "type": "String",
16301             "optional": true,
16302             "field": "acceptAt",
16303             "description": ""
16304           },
16305           {
16306             "group": "Body",
16307             "type": "String",
16308             "optional": true,
16309             "field": "exitAt",
16310             "description": ""
16311           },
16312           {
16313             "group": "Body",
16314             "type": "String",
16315             "optional": true,
16316             "field": "reason",
16317             "description": ""
16318           }
16319         ]
16320       }
16321     },
16322     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16323     "version": "0.0.0",
16324     "filename": "server/api/mailQueueReport/index.js",
16325     "groupTitle": "Mail_Queue_Reports"
16326   },
16327   {
16328     "type": "delete",
16329     "url": "/api/mail/reports/queue/{id}",
16330     "title": "Deletes a Mail Queue Report",
16331     "examples": [
16332       {
16333         "title": "Example usage:",
16334         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
16335         "type": "json"
16336       }
16337     ],
16338     "name": "DeleteMail_Queue_Reports",
16339     "group": "Mail_Queue_Reports",
16340     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16341     "version": "0.0.0",
16342     "filename": "server/api/mailQueueReport/index.js",
16343     "groupTitle": "Mail_Queue_Reports"
16344   },
16345   {
16346     "type": "get",
16347     "url": "/api/mail/reports/queue/describe",
16348     "title": "Gets table info about Mail Queue Reports",
16349     "examples": [
16350       {
16351         "title": "Example usage:",
16352         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
16353         "type": "json"
16354       }
16355     ],
16356     "name": "DescribeMail_Queue_Reports",
16357     "group": "Mail_Queue_Reports",
16358     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16359     "version": "0.0.0",
16360     "filename": "server/api/mailQueueReport/index.js",
16361     "groupTitle": "Mail_Queue_Reports"
16362   },
16363   {
16364     "type": "get",
16365     "url": "/api/mail/reports/queue",
16366     "title": "Gets a list of Mail Queue Reports",
16367     "examples": [
16368       {
16369         "title": "Example usage:",
16370         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
16371         "type": "json"
16372       }
16373     ],
16374     "name": "GetMail_Queue_Reports",
16375     "group": "Mail_Queue_Reports",
16376     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16377     "version": "0.0.0",
16378     "filename": "server/api/mailQueueReport/index.js",
16379     "groupTitle": "Mail_Queue_Reports"
16380   },
16381   {
16382     "type": "get",
16383     "url": "/api/mail/reports/queue/{id}",
16384     "title": "Gets a single Mail Queue Report",
16385     "examples": [
16386       {
16387         "title": "Example usage:",
16388         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
16389         "type": "json"
16390       }
16391     ],
16392     "name": "ShowMail_Queue_Reports",
16393     "group": "Mail_Queue_Reports",
16394     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16395     "version": "0.0.0",
16396     "filename": "server/api/mailQueueReport/index.js",
16397     "groupTitle": "Mail_Queue_Reports"
16398   },
16399   {
16400     "type": "put",
16401     "url": "/api/mail/reports/queue/{id}",
16402     "title": "Update an existing Mail Queue Report",
16403     "examples": [
16404       {
16405         "title": "Example usage:",
16406         "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",
16407         "type": "json"
16408       }
16409     ],
16410     "name": "updateMail_Queue_Reports",
16411     "group": "Mail_Queue_Reports",
16412     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16413     "version": "0.0.0",
16414     "filename": "server/api/mailQueueReport/index.js",
16415     "groupTitle": "Mail_Queue_Reports"
16416   },
16417   {
16418     "type": "post",
16419     "url": "/api/mail/queues/{id}/users",
16420     "title": "Add agents to a queue",
16421     "examples": [
16422       {
16423         "title": "Example usage:",
16424         "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",
16425         "type": "json"
16426       }
16427     ],
16428     "name": "AddAgents",
16429     "group": "Mail_Queues",
16430     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16431     "version": "0.0.0",
16432     "filename": "server/api/mailQueue/index.js",
16433     "groupTitle": "Mail_Queues"
16434   },
16435   {
16436     "type": "post",
16437     "url": "/api/mail/queues/{id}/teams",
16438     "title": "Add teams to a queue",
16439     "examples": [
16440       {
16441         "title": "Example usage:",
16442         "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",
16443         "type": "json"
16444       }
16445     ],
16446     "name": "AddTeams",
16447     "group": "Mail_Queues",
16448     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16449     "version": "0.0.0",
16450     "filename": "server/api/mailQueue/index.js",
16451     "groupTitle": "Mail_Queues"
16452   },
16453   {
16454     "type": "post",
16455     "url": "/api/mail/queues",
16456     "title": "Creates a new Queue",
16457     "examples": [
16458       {
16459         "title": "Example usage:",
16460         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16461         "type": "json"
16462       }
16463     ],
16464     "name": "CreateQueues",
16465     "group": "Mail_Queues",
16466     "parameter": {
16467       "fields": {
16468         "Body": [
16469           {
16470             "group": "Body",
16471             "type": "String",
16472             "optional": true,
16473             "field": "name",
16474             "description": ""
16475           },
16476           {
16477             "group": "Body",
16478             "type": "String",
16479             "optional": true,
16480             "field": "description",
16481             "description": ""
16482           },
16483           {
16484             "group": "Body",
16485             "type": "Integer",
16486             "optional": true,
16487             "field": "timeout",
16488             "description": ""
16489           },
16490           {
16491             "group": "Body",
16492             "type": "String",
16493             "allowedValues": [
16494               "\"rrmemory\"",
16495               "\"beepall\"",
16496               "\"roundrobin\""
16497             ],
16498             "optional": true,
16499             "field": "strategy",
16500             "description": ""
16501           }
16502         ]
16503       }
16504     },
16505     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16506     "version": "0.0.0",
16507     "filename": "server/api/mailQueue/index.js",
16508     "groupTitle": "Mail_Queues"
16509   },
16510   {
16511     "type": "delete",
16512     "url": "/api/mail/queues/{id}",
16513     "title": "Deletes a Queue",
16514     "examples": [
16515       {
16516         "title": "Example usage:",
16517         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16518         "type": "json"
16519       }
16520     ],
16521     "name": "DeleteQueues",
16522     "group": "Mail_Queues",
16523     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16524     "version": "0.0.0",
16525     "filename": "server/api/mailQueue/index.js",
16526     "groupTitle": "Mail_Queues"
16527   },
16528   {
16529     "type": "get",
16530     "url": "/api/mail/queues/describe",
16531     "title": "Gets table info about Queues",
16532     "examples": [
16533       {
16534         "title": "Example usage:",
16535         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16536         "type": "json"
16537       }
16538     ],
16539     "name": "DescribeQueues",
16540     "group": "Mail_Queues",
16541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16542     "version": "0.0.0",
16543     "filename": "server/api/mailQueue/index.js",
16544     "groupTitle": "Mail_Queues"
16545   },
16546   {
16547     "type": "get",
16548     "url": "/api/mail/queues/{id}/users",
16549     "title": "Gets queue agents",
16550     "examples": [
16551       {
16552         "title": "Example usage:",
16553         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16554         "type": "json"
16555       }
16556     ],
16557     "name": "GetAgents",
16558     "group": "Mail_Queues",
16559     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16560     "version": "0.0.0",
16561     "filename": "server/api/mailQueue/index.js",
16562     "groupTitle": "Mail_Queues"
16563   },
16564   {
16565     "type": "get",
16566     "url": "/api/mail/queues/{id}/members",
16567     "title": "GetMembers",
16568     "examples": [
16569       {
16570         "title": "Example usage:",
16571         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
16572         "type": "json"
16573       }
16574     ],
16575     "name": "GetMembers",
16576     "group": "Mail_Queues",
16577     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16578     "version": "0.0.0",
16579     "filename": "server/api/mailQueue/index.js",
16580     "groupTitle": "Mail_Queues"
16581   },
16582   {
16583     "type": "get",
16584     "url": "/api/mail/queues",
16585     "title": "Gets a list of Queues",
16586     "examples": [
16587       {
16588         "title": "Example usage:",
16589         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16590         "type": "json"
16591       }
16592     ],
16593     "name": "GetQueues",
16594     "group": "Mail_Queues",
16595     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16596     "version": "0.0.0",
16597     "filename": "server/api/mailQueue/index.js",
16598     "groupTitle": "Mail_Queues"
16599   },
16600   {
16601     "type": "get",
16602     "url": "/api/mail/queues/{id}/teams",
16603     "title": "Gets queues list",
16604     "examples": [
16605       {
16606         "title": "Example usage:",
16607         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16608         "type": "json"
16609       }
16610     ],
16611     "name": "GetTeams",
16612     "group": "Mail_Queues",
16613     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16614     "version": "0.0.0",
16615     "filename": "server/api/mailQueue/index.js",
16616     "groupTitle": "Mail_Queues"
16617   },
16618   {
16619     "type": "delete",
16620     "url": "/api/mail/queues/{id}/users",
16621     "title": "Removes agents from a queue",
16622     "examples": [
16623       {
16624         "title": "Example usage:",
16625         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16626         "type": "json"
16627       }
16628     ],
16629     "name": "RemoveAgents",
16630     "group": "Mail_Queues",
16631     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16632     "version": "0.0.0",
16633     "filename": "server/api/mailQueue/index.js",
16634     "groupTitle": "Mail_Queues"
16635   },
16636   {
16637     "type": "get",
16638     "url": "/api/mail/queues/{id}",
16639     "title": "Gets a single Queue",
16640     "examples": [
16641       {
16642         "title": "Example usage:",
16643         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16644         "type": "json"
16645       }
16646     ],
16647     "name": "ShowQueues",
16648     "group": "Mail_Queues",
16649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16650     "version": "0.0.0",
16651     "filename": "server/api/mailQueue/index.js",
16652     "groupTitle": "Mail_Queues"
16653   },
16654   {
16655     "type": "put",
16656     "url": "/api/mail/queues/{id}",
16657     "title": "Update an existing Queue",
16658     "examples": [
16659       {
16660         "title": "Example usage:",
16661         "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",
16662         "type": "json"
16663       }
16664     ],
16665     "name": "updateQueues",
16666     "group": "Mail_Queues",
16667     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16668     "version": "0.0.0",
16669     "filename": "server/api/mailQueue/index.js",
16670     "groupTitle": "Mail_Queues"
16671   },
16672   {
16673     "type": "post",
16674     "url": "/api/mail/out_servers",
16675     "title": "Creates a new SMTP",
16676     "examples": [
16677       {
16678         "title": "Example usage:",
16679         "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",
16680         "type": "json"
16681       }
16682     ],
16683     "name": "CreateSMTPs",
16684     "group": "Mail_SMTP",
16685     "parameter": {
16686       "fields": {
16687         "Body": [
16688           {
16689             "group": "Body",
16690             "type": "String",
16691             "optional": true,
16692             "field": "description",
16693             "description": ""
16694           },
16695           {
16696             "group": "Body",
16697             "type": "String",
16698             "optional": true,
16699             "field": "host",
16700             "description": ""
16701           },
16702           {
16703             "group": "Body",
16704             "type": "String",
16705             "optional": true,
16706             "field": "user",
16707             "description": ""
16708           },
16709           {
16710             "group": "Body",
16711             "type": "String",
16712             "optional": true,
16713             "field": "pass",
16714             "description": ""
16715           },
16716           {
16717             "group": "Body",
16718             "type": "Integer",
16719             "optional": true,
16720             "field": "port",
16721             "description": ""
16722           },
16723           {
16724             "group": "Body",
16725             "type": "Boolean",
16726             "optional": true,
16727             "field": "secure",
16728             "description": ""
16729           },
16730           {
16731             "group": "Body",
16732             "type": "String",
16733             "optional": true,
16734             "field": "service",
16735             "description": ""
16736           },
16737           {
16738             "group": "Body",
16739             "type": "Boolean",
16740             "optional": true,
16741             "field": "authentication",
16742             "description": ""
16743           }
16744         ]
16745       }
16746     },
16747     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16748     "version": "0.0.0",
16749     "filename": "server/api/mailServerOut/index.js",
16750     "groupTitle": "Mail_SMTP"
16751   },
16752   {
16753     "type": "delete",
16754     "url": "/api/mail/out_servers/{id}",
16755     "title": "Deletes a SMTP",
16756     "examples": [
16757       {
16758         "title": "Example usage:",
16759         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16760         "type": "json"
16761       }
16762     ],
16763     "name": "DeleteSMTPs",
16764     "group": "Mail_SMTP",
16765     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16766     "version": "0.0.0",
16767     "filename": "server/api/mailServerOut/index.js",
16768     "groupTitle": "Mail_SMTP"
16769   },
16770   {
16771     "type": "get",
16772     "url": "/api/mail/out_servers",
16773     "title": "Gets a list of SMTPs",
16774     "examples": [
16775       {
16776         "title": "Example usage:",
16777         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16778         "type": "json"
16779       }
16780     ],
16781     "name": "GetSMTPs",
16782     "group": "Mail_SMTP",
16783     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16784     "version": "0.0.0",
16785     "filename": "server/api/mailServerOut/index.js",
16786     "groupTitle": "Mail_SMTP"
16787   },
16788   {
16789     "type": "get",
16790     "url": "/api/mail/out_servers/{id}",
16791     "title": "Gets a single SMTP",
16792     "examples": [
16793       {
16794         "title": "Example usage:",
16795         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16796         "type": "json"
16797       }
16798     ],
16799     "name": "ShowSMTPs",
16800     "group": "Mail_SMTP",
16801     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16802     "version": "0.0.0",
16803     "filename": "server/api/mailServerOut/index.js",
16804     "groupTitle": "Mail_SMTP"
16805   },
16806   {
16807     "type": "put",
16808     "url": "/api/mail/out_servers/{id}",
16809     "title": "Update an existing SMTP",
16810     "examples": [
16811       {
16812         "title": "Example usage:",
16813         "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",
16814         "type": "json"
16815       }
16816     ],
16817     "name": "updateSMTPs",
16818     "group": "Mail_SMTP",
16819     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16820     "version": "0.0.0",
16821     "filename": "server/api/mailServerOut/index.js",
16822     "groupTitle": "Mail_SMTP"
16823   },
16824   {
16825     "type": "post",
16826     "url": "/api/mail/substatuses",
16827     "title": "Creates a new Queue",
16828     "examples": [
16829       {
16830         "title": "Example usage:",
16831         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16832         "type": "json"
16833       }
16834     ],
16835     "name": "CreateSubstatuses",
16836     "group": "Mail_Substatuses",
16837     "parameter": {
16838       "fields": {
16839         "Body": [
16840           {
16841             "group": "Body",
16842             "type": "String",
16843             "optional": false,
16844             "field": "name",
16845             "description": ""
16846           },
16847           {
16848             "group": "Body",
16849             "type": "String",
16850             "optional": true,
16851             "field": "description",
16852             "description": ""
16853           }
16854         ]
16855       }
16856     },
16857     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16858     "version": "0.0.0",
16859     "filename": "server/api/mailSubstatus/index.js",
16860     "groupTitle": "Mail_Substatuses"
16861   },
16862   {
16863     "type": "delete",
16864     "url": "/api/mail/substatuses/{id}",
16865     "title": "Deletes a Queue",
16866     "examples": [
16867       {
16868         "title": "Example usage:",
16869         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16870         "type": "json"
16871       }
16872     ],
16873     "name": "DeleteSubstatuses",
16874     "group": "Mail_Substatuses",
16875     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16876     "version": "0.0.0",
16877     "filename": "server/api/mailSubstatus/index.js",
16878     "groupTitle": "Mail_Substatuses"
16879   },
16880   {
16881     "type": "get",
16882     "url": "/api/mail/substatuses/describe",
16883     "title": "Gets table info about Substatuses",
16884     "examples": [
16885       {
16886         "title": "Example usage:",
16887         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16888         "type": "json"
16889       }
16890     ],
16891     "name": "DescribeSubstatuses",
16892     "group": "Mail_Substatuses",
16893     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16894     "version": "0.0.0",
16895     "filename": "server/api/mailSubstatus/index.js",
16896     "groupTitle": "Mail_Substatuses"
16897   },
16898   {
16899     "type": "get",
16900     "url": "/api/mail/substatuses",
16901     "title": "Gets a list of Substatuses",
16902     "examples": [
16903       {
16904         "title": "Example usage:",
16905         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16906         "type": "json"
16907       }
16908     ],
16909     "name": "GetSubstatuses",
16910     "group": "Mail_Substatuses",
16911     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16912     "version": "0.0.0",
16913     "filename": "server/api/mailSubstatus/index.js",
16914     "groupTitle": "Mail_Substatuses"
16915   },
16916   {
16917     "type": "get",
16918     "url": "/api/mail/substatuses/{id}",
16919     "title": "Gets a single Queue",
16920     "examples": [
16921       {
16922         "title": "Example usage:",
16923         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16924         "type": "json"
16925       }
16926     ],
16927     "name": "ShowSubstatuses",
16928     "group": "Mail_Substatuses",
16929     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16930     "version": "0.0.0",
16931     "filename": "server/api/mailSubstatus/index.js",
16932     "groupTitle": "Mail_Substatuses"
16933   },
16934   {
16935     "type": "put",
16936     "url": "/api/mail/substatuses/{id}",
16937     "title": "Update an existing Queue",
16938     "examples": [
16939       {
16940         "title": "Example usage:",
16941         "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",
16942         "type": "json"
16943       }
16944     ],
16945     "name": "updateSubstatuses",
16946     "group": "Mail_Substatuses",
16947     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16948     "version": "0.0.0",
16949     "filename": "server/api/mailSubstatus/index.js",
16950     "groupTitle": "Mail_Substatuses"
16951   },
16952   {
16953     "type": "post",
16954     "url": "/api/mail/reports/transfer",
16955     "title": "Creates a new Mail Transfer Report",
16956     "examples": [
16957       {
16958         "title": "Example usage:",
16959         "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",
16960         "type": "json"
16961       }
16962     ],
16963     "name": "CreateMail_Transfer_Reports",
16964     "group": "Mail_Transfer_Reports",
16965     "parameter": {
16966       "fields": {
16967         "Body": [
16968           {
16969             "group": "Body",
16970             "type": "String",
16971             "optional": false,
16972             "field": "uniqueid",
16973             "description": ""
16974           },
16975           {
16976             "group": "Body",
16977             "type": "String",
16978             "allowedValues": [
16979               "\"account\"",
16980               "\"agent\"",
16981               "\"queue\""
16982             ],
16983             "optional": false,
16984             "field": "type",
16985             "description": ""
16986           },
16987           {
16988             "group": "Body",
16989             "type": "String",
16990             "optional": false,
16991             "field": "transferredAt",
16992             "description": ""
16993           }
16994         ]
16995       }
16996     },
16997     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16998     "version": "0.0.0",
16999     "filename": "server/api/mailTransferReport/index.js",
17000     "groupTitle": "Mail_Transfer_Reports"
17001   },
17002   {
17003     "type": "delete",
17004     "url": "/api/mail/reports/transfer/{id}",
17005     "title": "Deletes a Mail Transfer Report",
17006     "examples": [
17007       {
17008         "title": "Example usage:",
17009         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
17010         "type": "json"
17011       }
17012     ],
17013     "name": "DeleteMail_Transfer_Reports",
17014     "group": "Mail_Transfer_Reports",
17015     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17016     "version": "0.0.0",
17017     "filename": "server/api/mailTransferReport/index.js",
17018     "groupTitle": "Mail_Transfer_Reports"
17019   },
17020   {
17021     "type": "get",
17022     "url": "/api/mail/reports/transfer/describe",
17023     "title": "Gets table info about Mail Transfer Reports",
17024     "examples": [
17025       {
17026         "title": "Example usage:",
17027         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
17028         "type": "json"
17029       }
17030     ],
17031     "name": "DescribeMail_Transfer_Reports",
17032     "group": "Mail_Transfer_Reports",
17033     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17034     "version": "0.0.0",
17035     "filename": "server/api/mailTransferReport/index.js",
17036     "groupTitle": "Mail_Transfer_Reports"
17037   },
17038   {
17039     "type": "get",
17040     "url": "/api/mail/reports/transfer",
17041     "title": "Gets a list of Mail Transfer Reports",
17042     "examples": [
17043       {
17044         "title": "Example usage:",
17045         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
17046         "type": "json"
17047       }
17048     ],
17049     "name": "GetMail_Transfer_Reports",
17050     "group": "Mail_Transfer_Reports",
17051     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17052     "version": "0.0.0",
17053     "filename": "server/api/mailTransferReport/index.js",
17054     "groupTitle": "Mail_Transfer_Reports"
17055   },
17056   {
17057     "type": "get",
17058     "url": "/api/mail/reports/transfer/{id}",
17059     "title": "Gets a single Mail Transfer Report",
17060     "examples": [
17061       {
17062         "title": "Example usage:",
17063         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
17064         "type": "json"
17065       }
17066     ],
17067     "name": "ShowMail_Transfer_Reports",
17068     "group": "Mail_Transfer_Reports",
17069     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17070     "version": "0.0.0",
17071     "filename": "server/api/mailTransferReport/index.js",
17072     "groupTitle": "Mail_Transfer_Reports"
17073   },
17074   {
17075     "type": "put",
17076     "url": "/api/mail/reports/transfer/{id}",
17077     "title": "Update an existing Mail Transfer Report",
17078     "examples": [
17079       {
17080         "title": "Example usage:",
17081         "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",
17082         "type": "json"
17083       }
17084     ],
17085     "name": "updateMail_Transfer_Reports",
17086     "group": "Mail_Transfer_Reports",
17087     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17088     "version": "0.0.0",
17089     "filename": "server/api/mailTransferReport/index.js",
17090     "groupTitle": "Mail_Transfer_Reports"
17091   },
17092   {
17093     "type": "get",
17094     "url": "/api/members/reports/describe",
17095     "title": "Gets table info about Member Reports",
17096     "examples": [
17097       {
17098         "title": "Example usage:",
17099         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
17100         "type": "json"
17101       }
17102     ],
17103     "name": "DescribeMember_Reports",
17104     "group": "Member_Reports",
17105     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17106     "version": "0.0.0",
17107     "filename": "server/api/memberReport/index.js",
17108     "groupTitle": "Member_Reports"
17109   },
17110   {
17111     "type": "get",
17112     "url": "/api/members/reports",
17113     "title": "Gets a list of Member Reports",
17114     "examples": [
17115       {
17116         "title": "Example usage:",
17117         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
17118         "type": "json"
17119       }
17120     ],
17121     "name": "GetMember_Reports",
17122     "group": "Member_Reports",
17123     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17124     "version": "0.0.0",
17125     "filename": "server/api/memberReport/index.js",
17126     "groupTitle": "Member_Reports"
17127   },
17128   {
17129     "type": "get",
17130     "url": "/api/members/reports/{id}",
17131     "title": "Gets a single Member Report",
17132     "examples": [
17133       {
17134         "title": "Example usage:",
17135         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
17136         "type": "json"
17137       }
17138     ],
17139     "name": "ShowMember_Reports",
17140     "group": "Member_Reports",
17141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17142     "version": "0.0.0",
17143     "filename": "server/api/memberReport/index.js",
17144     "groupTitle": "Member_Reports"
17145   },
17146   {
17147     "type": "get",
17148     "url": "/api/migrations",
17149     "title": "Gets a list of Migrations",
17150     "examples": [
17151       {
17152         "title": "Example usage:",
17153         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
17154         "type": "json"
17155       }
17156     ],
17157     "name": "GetMigrations",
17158     "group": "Migrations",
17159     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17160     "version": "0.0.0",
17161     "filename": "server/api/migration/index.js",
17162     "groupTitle": "Migrations"
17163   },
17164   {
17165     "type": "post",
17166     "url": "/api/voice/networks",
17167     "title": "Create a new network",
17168     "examples": [
17169       {
17170         "title": "Example usage:",
17171         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17172         "type": "json"
17173       }
17174     ],
17175     "name": "Create",
17176     "group": "Networks",
17177     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17178     "version": "0.0.0",
17179     "filename": "server/api/network/index.js",
17180     "groupTitle": "Networks"
17181   },
17182   {
17183     "type": "delete",
17184     "url": "/api/voice/networks/{id}",
17185     "title": "Deletes a network",
17186     "examples": [
17187       {
17188         "title": "Example usage:",
17189         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
17190         "type": "json"
17191       }
17192     ],
17193     "name": "Delete",
17194     "group": "Networks",
17195     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17196     "version": "0.0.0",
17197     "filename": "server/api/network/index.js",
17198     "groupTitle": "Networks"
17199   },
17200   {
17201     "type": "get",
17202     "url": "/api/networks",
17203     "title": "Gets a list of Networks",
17204     "examples": [
17205       {
17206         "title": "Example usage:",
17207         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
17208         "type": "json"
17209       }
17210     ],
17211     "name": "GetNetworks",
17212     "group": "Networks",
17213     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17214     "version": "0.0.0",
17215     "filename": "server/api/network/index.js",
17216     "groupTitle": "Networks"
17217   },
17218   {
17219     "type": "get",
17220     "url": "/api/networks/{id}",
17221     "title": "Gets a single Network",
17222     "examples": [
17223       {
17224         "title": "Example usage:",
17225         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
17226         "type": "json"
17227       }
17228     ],
17229     "name": "ShowNetworks",
17230     "group": "Networks",
17231     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17232     "version": "0.0.0",
17233     "filename": "server/api/network/index.js",
17234     "groupTitle": "Networks"
17235   },
17236   {
17237     "type": "put",
17238     "url": "/api/voice/networks/{id}",
17239     "title": "Update an existing network",
17240     "examples": [
17241       {
17242         "title": "Example usage:",
17243         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
17244         "type": "json"
17245       }
17246     ],
17247     "name": "Update",
17248     "group": "Networks",
17249     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17250     "version": "0.0.0",
17251     "filename": "server/api/network/index.js",
17252     "groupTitle": "Networks"
17253   },
17254   {
17255     "type": "post",
17256     "url": "/api/notifications",
17257     "title": "Send notification to user",
17258     "examples": [
17259       {
17260         "title": "Example usage:",
17261         "content": "curl https://{domain}/api/notifications -d '{\"text\": \"Hello!\", \"TemplateId\": 1}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17262         "type": "json"
17263       }
17264     ],
17265     "name": "Send",
17266     "group": "Notifications",
17267     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17268     "version": "0.0.0",
17269     "filename": "server/api/notification/index.js",
17270     "groupTitle": "Notifications"
17271   },
17272   {
17273     "type": "post",
17274     "url": "/api/openchannel/accounts/{id}/users",
17275     "title": "Add agents to a openchannel account",
17276     "examples": [
17277       {
17278         "title": "Example usage:",
17279         "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",
17280         "type": "json"
17281       }
17282     ],
17283     "name": "AddAgents",
17284     "group": "Openchannel_Accounts",
17285     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17286     "version": "0.0.0",
17287     "filename": "server/api/openchannelAccount/index.js",
17288     "groupTitle": "Openchannel_Accounts"
17289   },
17290   {
17291     "type": "post",
17292     "url": "/api/openchannel/accounts",
17293     "title": "Creates a new Account",
17294     "examples": [
17295       {
17296         "title": "Example usage:",
17297         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17298         "type": "json"
17299       }
17300     ],
17301     "name": "CreateAccounts",
17302     "group": "Openchannel_Accounts",
17303     "parameter": {
17304       "fields": {
17305         "Body": [
17306           {
17307             "group": "Body",
17308             "type": "String",
17309             "optional": false,
17310             "field": "name",
17311             "description": ""
17312           },
17313           {
17314             "group": "Body",
17315             "type": "String",
17316             "optional": true,
17317             "field": "description",
17318             "description": ""
17319           },
17320           {
17321             "group": "Body",
17322             "type": "String",
17323             "optional": true,
17324             "field": "token",
17325             "description": ""
17326           },
17327           {
17328             "group": "Body",
17329             "type": "String",
17330             "optional": true,
17331             "field": "replyUri",
17332             "description": ""
17333           },
17334           {
17335             "group": "Body",
17336             "type": "String",
17337             "optional": false,
17338             "field": "key",
17339             "description": ""
17340           },
17341           {
17342             "group": "Body",
17343             "type": "Text",
17344             "optional": true,
17345             "field": "notificationTemplate",
17346             "description": ""
17347           },
17348           {
17349             "group": "Body",
17350             "type": "Boolean",
17351             "optional": true,
17352             "field": "notificationSound",
17353             "description": ""
17354           },
17355           {
17356             "group": "Body",
17357             "type": "Boolean",
17358             "optional": true,
17359             "field": "notificationShake",
17360             "description": ""
17361           },
17362           {
17363             "group": "Body",
17364             "type": "Integer",
17365             "optional": true,
17366             "field": "waitForTheAssignedAgent",
17367             "description": ""
17368           },
17369           {
17370             "group": "Body",
17371             "type": "String",
17372             "optional": true,
17373             "field": "mapKey",
17374             "description": ""
17375           },
17376           {
17377             "group": "Body",
17378             "type": "Boolean",
17379             "optional": true,
17380             "field": "queueTransfer",
17381             "description": ""
17382           },
17383           {
17384             "group": "Body",
17385             "type": "Integer",
17386             "optional": true,
17387             "field": "queueTransferTimeout",
17388             "description": ""
17389           },
17390           {
17391             "group": "Body",
17392             "type": "Boolean",
17393             "optional": true,
17394             "field": "agentTransfer",
17395             "description": ""
17396           },
17397           {
17398             "group": "Body",
17399             "type": "Integer",
17400             "optional": true,
17401             "field": "agentTransferTimeout",
17402             "description": ""
17403           },
17404           {
17405             "group": "Body",
17406             "type": "Integer",
17407             "optional": true,
17408             "field": "mandatoryDispositionPauseId",
17409             "description": "<p>Status to put when mandatory disposition is enabled</p>"
17410           },
17411           {
17412             "group": "Body",
17413             "type": "Boolean",
17414             "optional": true,
17415             "field": "mandatoryDisposition",
17416             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
17417           }
17418         ]
17419       }
17420     },
17421     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17422     "version": "0.0.0",
17423     "filename": "server/api/openchannelAccount/index.js",
17424     "groupTitle": "Openchannel_Accounts"
17425   },
17426   {
17427     "type": "delete",
17428     "url": "/api/openchannel/accounts/{id}",
17429     "title": "Deletes a Account",
17430     "examples": [
17431       {
17432         "title": "Example usage:",
17433         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
17434         "type": "json"
17435       }
17436     ],
17437     "name": "DeleteAccounts",
17438     "group": "Openchannel_Accounts",
17439     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17440     "version": "0.0.0",
17441     "filename": "server/api/openchannelAccount/index.js",
17442     "groupTitle": "Openchannel_Accounts"
17443   },
17444   {
17445     "type": "get",
17446     "url": "/api/openchannel/accounts/describe",
17447     "title": "Gets table info about Accounts",
17448     "examples": [
17449       {
17450         "title": "Example usage:",
17451         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
17452         "type": "json"
17453       }
17454     ],
17455     "name": "DescribeAccounts",
17456     "group": "Openchannel_Accounts",
17457     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17458     "version": "0.0.0",
17459     "filename": "server/api/openchannelAccount/index.js",
17460     "groupTitle": "Openchannel_Accounts"
17461   },
17462   {
17463     "type": "get",
17464     "url": "/api/openchannel/accounts",
17465     "title": "Gets a list of Accounts",
17466     "examples": [
17467       {
17468         "title": "Example usage:",
17469         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
17470         "type": "json"
17471       }
17472     ],
17473     "name": "GetAccounts",
17474     "group": "Openchannel_Accounts",
17475     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17476     "version": "0.0.0",
17477     "filename": "server/api/openchannelAccount/index.js",
17478     "groupTitle": "Openchannel_Accounts"
17479   },
17480   {
17481     "type": "get",
17482     "url": "/api/openchannel/accounts/{id}/users",
17483     "title": "Gets agents from openchannel account",
17484     "examples": [
17485       {
17486         "title": "Example usage:",
17487         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
17488         "type": "json"
17489       }
17490     ],
17491     "name": "GetAgents",
17492     "group": "Openchannel_Accounts",
17493     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17494     "version": "0.0.0",
17495     "filename": "server/api/openchannelAccount/index.js",
17496     "groupTitle": "Openchannel_Accounts"
17497   },
17498   {
17499     "type": "delete",
17500     "url": "/api/openchannel/accounts/{id}/users",
17501     "title": "Removes agents from a openchannel account",
17502     "examples": [
17503       {
17504         "title": "Example usage:",
17505         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17506         "type": "json"
17507       }
17508     ],
17509     "name": "RemoveAgents",
17510     "group": "Openchannel_Accounts",
17511     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17512     "version": "0.0.0",
17513     "filename": "server/api/openchannelAccount/index.js",
17514     "groupTitle": "Openchannel_Accounts"
17515   },
17516   {
17517     "type": "delete",
17518     "url": "/api/openchannel/accounts/{id}/canned_answers",
17519     "title": "Removes canned answers from account",
17520     "examples": [
17521       {
17522         "title": "Example usage:",
17523         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17524         "type": "json"
17525       }
17526     ],
17527     "name": "RemoveAnswers",
17528     "group": "Openchannel_Accounts",
17529     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17530     "version": "0.0.0",
17531     "filename": "server/api/openchannelAccount/index.js",
17532     "groupTitle": "Openchannel_Accounts"
17533   },
17534   {
17535     "type": "delete",
17536     "url": "/api/openchannel/accounts/{id}/dispositions",
17537     "title": "Removes dispositions from account",
17538     "examples": [
17539       {
17540         "title": "Example usage:",
17541         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17542         "type": "json"
17543       }
17544     ],
17545     "name": "RemoveDispositions",
17546     "group": "Openchannel_Accounts",
17547     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17548     "version": "0.0.0",
17549     "filename": "server/api/openchannelAccount/index.js",
17550     "groupTitle": "Openchannel_Accounts"
17551   },
17552   {
17553     "type": "get",
17554     "url": "/api/openchannel/accounts/{id}",
17555     "title": "Gets a single Account",
17556     "examples": [
17557       {
17558         "title": "Example usage:",
17559         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17560         "type": "json"
17561       }
17562     ],
17563     "name": "ShowAccounts",
17564     "group": "Openchannel_Accounts",
17565     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17566     "version": "0.0.0",
17567     "filename": "server/api/openchannelAccount/index.js",
17568     "groupTitle": "Openchannel_Accounts"
17569   },
17570   {
17571     "type": "post",
17572     "url": "/api/openchannel/accounts/{id}/canned_answers",
17573     "title": "Creates new canned answer",
17574     "examples": [
17575       {
17576         "title": "Example usage:",
17577         "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",
17578         "type": "json"
17579       }
17580     ],
17581     "name": "addAnswer",
17582     "group": "Openchannel_Accounts",
17583     "parameter": {
17584       "fields": {
17585         "Body": [
17586           {
17587             "group": "Body",
17588             "type": "String",
17589             "optional": false,
17590             "field": "key",
17591             "description": ""
17592           },
17593           {
17594             "group": "Body",
17595             "type": "Text",
17596             "optional": false,
17597             "field": "value",
17598             "description": ""
17599           },
17600           {
17601             "group": "Body",
17602             "type": "String",
17603             "optional": true,
17604             "field": "description",
17605             "description": ""
17606           },
17607           {
17608             "group": "Body",
17609             "type": "Virtual",
17610             "optional": true,
17611             "field": "name",
17612             "description": ""
17613           }
17614         ]
17615       }
17616     },
17617     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17618     "version": "0.0.0",
17619     "filename": "server/api/openchannelAccount/index.js",
17620     "groupTitle": "Openchannel_Accounts"
17621   },
17622   {
17623     "type": "post",
17624     "url": "/api/openchannel/accounts/{id}/applications",
17625     "title": "Creates new applications",
17626     "examples": [
17627       {
17628         "title": "Example usage:",
17629         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17630         "type": "json"
17631       }
17632     ],
17633     "name": "addApplications",
17634     "group": "Openchannel_Accounts",
17635     "parameter": {
17636       "fields": {
17637         "Body": [
17638           {
17639             "group": "Body",
17640             "type": "Integer",
17641             "optional": false,
17642             "field": "priority",
17643             "description": ""
17644           },
17645           {
17646             "group": "Body",
17647             "type": "String",
17648             "optional": false,
17649             "field": "app",
17650             "description": ""
17651           },
17652           {
17653             "group": "Body",
17654             "type": "Text",
17655             "optional": true,
17656             "field": "appdata",
17657             "description": ""
17658           },
17659           {
17660             "group": "Body",
17661             "type": "String",
17662             "optional": true,
17663             "field": "description",
17664             "description": ""
17665           },
17666           {
17667             "group": "Body",
17668             "type": "String",
17669             "optional": true,
17670             "field": "interval",
17671             "description": ""
17672           }
17673         ]
17674       }
17675     },
17676     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17677     "version": "0.0.0",
17678     "filename": "server/api/openchannelAccount/index.js",
17679     "groupTitle": "Openchannel_Accounts"
17680   },
17681   {
17682     "type": "post",
17683     "url": "/api/openchannel/accounts/{id}/dispositions",
17684     "title": "Creates new disposition",
17685     "examples": [
17686       {
17687         "title": "Example usage:",
17688         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17689         "type": "json"
17690       }
17691     ],
17692     "name": "addDisposition",
17693     "group": "Openchannel_Accounts",
17694     "parameter": {
17695       "fields": {
17696         "Body": [
17697           {
17698             "group": "Body",
17699             "type": "String",
17700             "optional": false,
17701             "field": "name",
17702             "description": ""
17703           },
17704           {
17705             "group": "Body",
17706             "type": "String",
17707             "allowedValues": [
17708               "\"first\"",
17709               "\"second\"",
17710               "\"third\""
17711             ],
17712             "optional": false,
17713             "field": "level",
17714             "description": ""
17715           },
17716           {
17717             "group": "Body",
17718             "type": "String",
17719             "optional": true,
17720             "field": "description",
17721             "description": ""
17722           }
17723         ]
17724       }
17725     },
17726     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17727     "version": "0.0.0",
17728     "filename": "server/api/openchannelAccount/index.js",
17729     "groupTitle": "Openchannel_Accounts"
17730   },
17731   {
17732     "type": "get",
17733     "url": "/api/openchannel/accounts/{id}/canned_answers",
17734     "title": "Gets account canned answers",
17735     "examples": [
17736       {
17737         "title": "Example usage:",
17738         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17739         "type": "json"
17740       }
17741     ],
17742     "name": "getAnswers",
17743     "group": "Openchannel_Accounts",
17744     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17745     "version": "0.0.0",
17746     "filename": "server/api/openchannelAccount/index.js",
17747     "groupTitle": "Openchannel_Accounts"
17748   },
17749   {
17750     "type": "get",
17751     "url": "/api/openchannel/accounts/{id}/applications",
17752     "title": "Gets account applications",
17753     "examples": [
17754       {
17755         "title": "Example usage:",
17756         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17757         "type": "json"
17758       }
17759     ],
17760     "name": "getApplications",
17761     "group": "Openchannel_Accounts",
17762     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17763     "version": "0.0.0",
17764     "filename": "server/api/openchannelAccount/index.js",
17765     "groupTitle": "Openchannel_Accounts"
17766   },
17767   {
17768     "type": "get",
17769     "url": "/api/openchannel/accounts/{id}/dispositions",
17770     "title": "Gets account dispositions",
17771     "examples": [
17772       {
17773         "title": "Example usage:",
17774         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17775         "type": "json"
17776       }
17777     ],
17778     "name": "getDispositions",
17779     "group": "Openchannel_Accounts",
17780     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17781     "version": "0.0.0",
17782     "filename": "server/api/openchannelAccount/index.js",
17783     "groupTitle": "Openchannel_Accounts"
17784   },
17785   {
17786     "type": "get",
17787     "url": "/api/openchannel/accounts/{id}/interactions",
17788     "title": "Gets Openchannel Account Interactions",
17789     "examples": [
17790       {
17791         "title": "Example usage:",
17792         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17793         "type": "json"
17794       }
17795     ],
17796     "name": "getInteractions",
17797     "group": "Openchannel_Accounts",
17798     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17799     "version": "0.0.0",
17800     "filename": "server/api/openchannelAccount/index.js",
17801     "groupTitle": "Openchannel_Accounts"
17802   },
17803   {
17804     "type": "post",
17805     "url": "/api/openchannel/accounts/{id}/notify",
17806     "title": "Notify new message",
17807     "examples": [
17808       {
17809         "title": "Example usage:",
17810         "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",
17811         "type": "json"
17812       }
17813     ],
17814     "name": "notify",
17815     "group": "Openchannel_Accounts",
17816     "description": "<p>Motion 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>",
17817     "version": "0.0.0",
17818     "filename": "server/api/openchannelAccount/index.js",
17819     "groupTitle": "Openchannel_Accounts"
17820   },
17821   {
17822     "type": "post",
17823     "url": "/api/openchannel/accounts/{id}/send",
17824     "title": "Send new openchannel message",
17825     "examples": [
17826       {
17827         "title": "Example usage:",
17828         "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",
17829         "type": "json"
17830       }
17831     ],
17832     "name": "sendOpenchannel",
17833     "group": "Openchannel_Accounts",
17834     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17835     "version": "0.0.0",
17836     "filename": "server/api/openchannelAccount/index.js",
17837     "groupTitle": "Openchannel_Accounts"
17838   },
17839   {
17840     "type": "put",
17841     "url": "/api/openchannel/accounts/{id}",
17842     "title": "Update an existing Account",
17843     "examples": [
17844       {
17845         "title": "Example usage:",
17846         "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",
17847         "type": "json"
17848       }
17849     ],
17850     "name": "updateAccounts",
17851     "group": "Openchannel_Accounts",
17852     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17853     "version": "0.0.0",
17854     "filename": "server/api/openchannelAccount/index.js",
17855     "groupTitle": "Openchannel_Accounts"
17856   },
17857   {
17858     "type": "post",
17859     "url": "/api/openchannel/applications",
17860     "title": "Creates a new Application",
17861     "examples": [
17862       {
17863         "title": "Example usage:",
17864         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17865         "type": "json"
17866       }
17867     ],
17868     "name": "CreateApplications",
17869     "group": "Openchannel_Applications",
17870     "parameter": {
17871       "fields": {
17872         "Body": [
17873           {
17874             "group": "Body",
17875             "type": "Integer",
17876             "optional": false,
17877             "field": "priority",
17878             "description": ""
17879           },
17880           {
17881             "group": "Body",
17882             "type": "String",
17883             "optional": false,
17884             "field": "app",
17885             "description": ""
17886           },
17887           {
17888             "group": "Body",
17889             "type": "Text",
17890             "optional": true,
17891             "field": "appdata",
17892             "description": ""
17893           },
17894           {
17895             "group": "Body",
17896             "type": "String",
17897             "optional": true,
17898             "field": "description",
17899             "description": ""
17900           },
17901           {
17902             "group": "Body",
17903             "type": "String",
17904             "optional": true,
17905             "field": "interval",
17906             "description": ""
17907           }
17908         ]
17909       }
17910     },
17911     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17912     "version": "0.0.0",
17913     "filename": "server/api/openchannelApplication/index.js",
17914     "groupTitle": "Openchannel_Applications"
17915   },
17916   {
17917     "type": "delete",
17918     "url": "/api/openchannel/applications/{id}",
17919     "title": "Deletes a Application",
17920     "examples": [
17921       {
17922         "title": "Example usage:",
17923         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17924         "type": "json"
17925       }
17926     ],
17927     "name": "DeleteApplications",
17928     "group": "Openchannel_Applications",
17929     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17930     "version": "0.0.0",
17931     "filename": "server/api/openchannelApplication/index.js",
17932     "groupTitle": "Openchannel_Applications"
17933   },
17934   {
17935     "type": "get",
17936     "url": "/api/openchannel/applications",
17937     "title": "Gets a list of Applications",
17938     "examples": [
17939       {
17940         "title": "Example usage:",
17941         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17942         "type": "json"
17943       }
17944     ],
17945     "name": "GetApplications",
17946     "group": "Openchannel_Applications",
17947     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17948     "version": "0.0.0",
17949     "filename": "server/api/openchannelApplication/index.js",
17950     "groupTitle": "Openchannel_Applications"
17951   },
17952   {
17953     "type": "get",
17954     "url": "/api/openchannel/applications/{id}",
17955     "title": "Gets a single Application",
17956     "examples": [
17957       {
17958         "title": "Example usage:",
17959         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
17960         "type": "json"
17961       }
17962     ],
17963     "name": "ShowApplications",
17964     "group": "Openchannel_Applications",
17965     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17966     "version": "0.0.0",
17967     "filename": "server/api/openchannelApplication/index.js",
17968     "groupTitle": "Openchannel_Applications"
17969   },
17970   {
17971     "type": "put",
17972     "url": "/api/openchannel/applications/{id}",
17973     "title": "Update an existing Application",
17974     "examples": [
17975       {
17976         "title": "Example usage:",
17977         "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",
17978         "type": "json"
17979       }
17980     ],
17981     "name": "updateApplications",
17982     "group": "Openchannel_Applications",
17983     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17984     "version": "0.0.0",
17985     "filename": "server/api/openchannelApplication/index.js",
17986     "groupTitle": "Openchannel_Applications"
17987   },
17988   {
17989     "type": "post",
17990     "url": "/api/openchannel/interactions/{id}/tags",
17991     "title": "Add tags to the interaction",
17992     "examples": [
17993       {
17994         "title": "Example usage:",
17995         "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",
17996         "type": "json"
17997       }
17998     ],
17999     "name": "AddTags",
18000     "group": "Openchannel_Interactions",
18001     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18002     "version": "0.0.0",
18003     "filename": "server/api/openchannelInteraction/index.js",
18004     "groupTitle": "Openchannel_Interactions"
18005   },
18006   {
18007     "type": "post",
18008     "url": "/api/openchannel/interactions",
18009     "title": "Creates a new Interaction",
18010     "examples": [
18011       {
18012         "title": "Example usage:",
18013         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18014         "type": "json"
18015       }
18016     ],
18017     "name": "CreateInteractions",
18018     "group": "Openchannel_Interactions",
18019     "parameter": {
18020       "fields": {
18021         "Body": [
18022           {
18023             "group": "Body",
18024             "type": "Boolean",
18025             "optional": true,
18026             "field": "closed",
18027             "description": ""
18028           },
18029           {
18030             "group": "Body",
18031             "type": "String",
18032             "optional": true,
18033             "field": "closedAt",
18034             "description": ""
18035           },
18036           {
18037             "group": "Body",
18038             "type": "String",
18039             "optional": true,
18040             "field": "disposition",
18041             "description": ""
18042           },
18043           {
18044             "group": "Body",
18045             "type": "String",
18046             "optional": true,
18047             "field": "secondDisposition",
18048             "description": ""
18049           },
18050           {
18051             "group": "Body",
18052             "type": "String",
18053             "optional": true,
18054             "field": "thirdDisposition",
18055             "description": ""
18056           },
18057           {
18058             "group": "Body",
18059             "type": "String",
18060             "optional": true,
18061             "field": "note",
18062             "description": ""
18063           },
18064           {
18065             "group": "Body",
18066             "type": "String",
18067             "optional": true,
18068             "field": "read1stAt",
18069             "description": ""
18070           },
18071           {
18072             "group": "Body",
18073             "type": "String",
18074             "optional": true,
18075             "field": "threadId",
18076             "description": ""
18077           },
18078           {
18079             "group": "Body",
18080             "type": "String",
18081             "optional": true,
18082             "field": "externalUrl",
18083             "description": ""
18084           },
18085           {
18086             "group": "Body",
18087             "type": "String",
18088             "optional": true,
18089             "field": "lastMsgAt",
18090             "description": ""
18091           },
18092           {
18093             "group": "Body",
18094             "type": "String",
18095             "allowedValues": [
18096               "\"in\"",
18097               "\"out\""
18098             ],
18099             "optional": false,
18100             "field": "lastMsgDirection",
18101             "description": ""
18102           },
18103           {
18104             "group": "Body",
18105             "type": "String",
18106             "optional": true,
18107             "field": "from",
18108             "description": ""
18109           }
18110         ]
18111       }
18112     },
18113     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18114     "version": "0.0.0",
18115     "filename": "server/api/openchannelInteraction/index.js",
18116     "groupTitle": "Openchannel_Interactions"
18117   },
18118   {
18119     "type": "delete",
18120     "url": "/api/openchannel/interactions/{id}",
18121     "title": "Deletes a Interaction",
18122     "examples": [
18123       {
18124         "title": "Example usage:",
18125         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
18126         "type": "json"
18127       }
18128     ],
18129     "name": "DeleteInteractions",
18130     "group": "Openchannel_Interactions",
18131     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18132     "version": "0.0.0",
18133     "filename": "server/api/openchannelInteraction/index.js",
18134     "groupTitle": "Openchannel_Interactions"
18135   },
18136   {
18137     "type": "get",
18138     "url": "/api/openchannel/interactions/describe",
18139     "title": "Gets table info about Interactions",
18140     "examples": [
18141       {
18142         "title": "Example usage:",
18143         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
18144         "type": "json"
18145       }
18146     ],
18147     "name": "DescribeInteractions",
18148     "group": "Openchannel_Interactions",
18149     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18150     "version": "0.0.0",
18151     "filename": "server/api/openchannelInteraction/index.js",
18152     "groupTitle": "Openchannel_Interactions"
18153   },
18154   {
18155     "type": "get",
18156     "url": "/api/openchannel/interactions",
18157     "title": "Gets a list of Interactions",
18158     "examples": [
18159       {
18160         "title": "Example usage:",
18161         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
18162         "type": "json"
18163       }
18164     ],
18165     "name": "GetInteractions",
18166     "group": "Openchannel_Interactions",
18167     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18168     "version": "0.0.0",
18169     "filename": "server/api/openchannelInteraction/index.js",
18170     "groupTitle": "Openchannel_Interactions"
18171   },
18172   {
18173     "type": "delete",
18174     "url": "/api/openchannel/interactions/{id}/tags",
18175     "title": "Removes tags from interaction",
18176     "examples": [
18177       {
18178         "title": "Example usage:",
18179         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18180         "type": "json"
18181       }
18182     ],
18183     "name": "RemoveTags",
18184     "group": "Openchannel_Interactions",
18185     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18186     "version": "0.0.0",
18187     "filename": "server/api/openchannelInteraction/index.js",
18188     "groupTitle": "Openchannel_Interactions"
18189   },
18190   {
18191     "type": "get",
18192     "url": "/api/openchannel/interactions/{id}",
18193     "title": "Gets a single Interaction",
18194     "examples": [
18195       {
18196         "title": "Example usage:",
18197         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
18198         "type": "json"
18199       }
18200     ],
18201     "name": "ShowInteractions",
18202     "group": "Openchannel_Interactions",
18203     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18204     "version": "0.0.0",
18205     "filename": "server/api/openchannelInteraction/index.js",
18206     "groupTitle": "Openchannel_Interactions"
18207   },
18208   {
18209     "type": "post",
18210     "url": "/api/openchannel/interactions/{id}/messages",
18211     "title": "Creates new messages",
18212     "examples": [
18213       {
18214         "title": "Example usage:",
18215         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
18216         "type": "json"
18217       }
18218     ],
18219     "name": "addMessage",
18220     "group": "Openchannel_Interactions",
18221     "parameter": {
18222       "fields": {
18223         "Body": [
18224           {
18225             "group": "Body",
18226             "type": "Text",
18227             "optional": false,
18228             "field": "body",
18229             "description": ""
18230           },
18231           {
18232             "group": "Body",
18233             "type": "Boolean",
18234             "optional": true,
18235             "field": "read",
18236             "description": ""
18237           },
18238           {
18239             "group": "Body",
18240             "type": "Boolean",
18241             "optional": true,
18242             "field": "secret",
18243             "description": ""
18244           },
18245           {
18246             "group": "Body",
18247             "type": "String",
18248             "allowedValues": [
18249               "\"in\"",
18250               "\"out\""
18251             ],
18252             "optional": false,
18253             "field": "direction",
18254             "description": ""
18255           },
18256           {
18257             "group": "Body",
18258             "type": "String",
18259             "optional": true,
18260             "field": "readAt",
18261             "description": ""
18262           }
18263         ]
18264       }
18265     },
18266     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18267     "version": "0.0.0",
18268     "filename": "server/api/openchannelInteraction/index.js",
18269     "groupTitle": "Openchannel_Interactions"
18270   },
18271   {
18272     "type": "get",
18273     "url": "/api/openchannel/interactions/{id}/download",
18274     "title": "Gets interaction",
18275     "examples": [
18276       {
18277         "title": "Example usage:",
18278         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
18279         "type": "json"
18280       }
18281     ],
18282     "name": "download",
18283     "group": "Openchannel_Interactions",
18284     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18285     "version": "0.0.0",
18286     "filename": "server/api/openchannelInteraction/index.js",
18287     "groupTitle": "Openchannel_Interactions"
18288   },
18289   {
18290     "type": "get",
18291     "url": "/api/openchannel/interactions/{id}/messages",
18292     "title": "Gets interaction messages",
18293     "examples": [
18294       {
18295         "title": "Example usage:",
18296         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
18297         "type": "json"
18298       }
18299     ],
18300     "name": "getMessages",
18301     "group": "Openchannel_Interactions",
18302     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18303     "version": "0.0.0",
18304     "filename": "server/api/openchannelInteraction/index.js",
18305     "groupTitle": "Openchannel_Interactions"
18306   },
18307   {
18308     "type": "put",
18309     "url": "/api/openchannel/interactions/{id}",
18310     "title": "Update an existing Interaction",
18311     "examples": [
18312       {
18313         "title": "Example usage:",
18314         "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",
18315         "type": "json"
18316       }
18317     ],
18318     "name": "updateInteractions",
18319     "group": "Openchannel_Interactions",
18320     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18321     "version": "0.0.0",
18322     "filename": "server/api/openchannelInteraction/index.js",
18323     "groupTitle": "Openchannel_Interactions"
18324   },
18325   {
18326     "type": "post",
18327     "url": "/api/openchannel/messages",
18328     "title": "Creates a new Message",
18329     "examples": [
18330       {
18331         "title": "Example usage:",
18332         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18333         "type": "json"
18334       }
18335     ],
18336     "name": "CreateMessages",
18337     "group": "Openchannel_Messages",
18338     "parameter": {
18339       "fields": {
18340         "Body": [
18341           {
18342             "group": "Body",
18343             "type": "Text",
18344             "optional": false,
18345             "field": "body",
18346             "description": ""
18347           },
18348           {
18349             "group": "Body",
18350             "type": "Boolean",
18351             "optional": true,
18352             "field": "read",
18353             "description": ""
18354           },
18355           {
18356             "group": "Body",
18357             "type": "Boolean",
18358             "optional": true,
18359             "field": "secret",
18360             "description": ""
18361           },
18362           {
18363             "group": "Body",
18364             "type": "String",
18365             "allowedValues": [
18366               "\"in\"",
18367               "\"out\""
18368             ],
18369             "optional": false,
18370             "field": "direction",
18371             "description": ""
18372           },
18373           {
18374             "group": "Body",
18375             "type": "String",
18376             "optional": true,
18377             "field": "readAt",
18378             "description": ""
18379           }
18380         ]
18381       }
18382     },
18383     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18384     "version": "0.0.0",
18385     "filename": "server/api/openchannelMessage/index.js",
18386     "groupTitle": "Openchannel_Messages"
18387   },
18388   {
18389     "type": "delete",
18390     "url": "/api/openchannel/messages/{id}",
18391     "title": "Deletes a Message",
18392     "examples": [
18393       {
18394         "title": "Example usage:",
18395         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
18396         "type": "json"
18397       }
18398     ],
18399     "name": "DeleteMessages",
18400     "group": "Openchannel_Messages",
18401     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18402     "version": "0.0.0",
18403     "filename": "server/api/openchannelMessage/index.js",
18404     "groupTitle": "Openchannel_Messages"
18405   },
18406   {
18407     "type": "get",
18408     "url": "/api/openchannel/messages/describe",
18409     "title": "Gets table info about Messages",
18410     "examples": [
18411       {
18412         "title": "Example usage:",
18413         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
18414         "type": "json"
18415       }
18416     ],
18417     "name": "DescribeMessages",
18418     "group": "Openchannel_Messages",
18419     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18420     "version": "0.0.0",
18421     "filename": "server/api/openchannelMessage/index.js",
18422     "groupTitle": "Openchannel_Messages"
18423   },
18424   {
18425     "type": "get",
18426     "url": "/api/openchannel/messages",
18427     "title": "Gets a list of Messages",
18428     "examples": [
18429       {
18430         "title": "Example usage:",
18431         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
18432         "type": "json"
18433       }
18434     ],
18435     "name": "GetMessages",
18436     "group": "Openchannel_Messages",
18437     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18438     "version": "0.0.0",
18439     "filename": "server/api/openchannelMessage/index.js",
18440     "groupTitle": "Openchannel_Messages"
18441   },
18442   {
18443     "type": "get",
18444     "url": "/api/openchannel/messages/{id}",
18445     "title": "Gets a single Message",
18446     "examples": [
18447       {
18448         "title": "Example usage:",
18449         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
18450         "type": "json"
18451       }
18452     ],
18453     "name": "ShowMessages",
18454     "group": "Openchannel_Messages",
18455     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18456     "version": "0.0.0",
18457     "filename": "server/api/openchannelMessage/index.js",
18458     "groupTitle": "Openchannel_Messages"
18459   },
18460   {
18461     "type": "put",
18462     "url": "/api/openchannel/messages/{id}/accept",
18463     "title": "Accepts message",
18464     "examples": [
18465       {
18466         "title": "Example usage:",
18467         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18468         "type": "json"
18469       }
18470     ],
18471     "name": "acceptMessage",
18472     "group": "Openchannel_Messages",
18473     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18474     "version": "0.0.0",
18475     "filename": "server/api/openchannelMessage/index.js",
18476     "groupTitle": "Openchannel_Messages"
18477   },
18478   {
18479     "type": "put",
18480     "url": "/api/openchannel/messages/{id}/reject",
18481     "title": "Rejects message",
18482     "examples": [
18483       {
18484         "title": "Example usage:",
18485         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
18486         "type": "json"
18487       }
18488     ],
18489     "name": "rejectMessage",
18490     "group": "Openchannel_Messages",
18491     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18492     "version": "0.0.0",
18493     "filename": "server/api/openchannelMessage/index.js",
18494     "groupTitle": "Openchannel_Messages"
18495   },
18496   {
18497     "type": "put",
18498     "url": "/api/openchannel/messages/{id}",
18499     "title": "Update an existing Message",
18500     "examples": [
18501       {
18502         "title": "Example usage:",
18503         "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",
18504         "type": "json"
18505       }
18506     ],
18507     "name": "updateMessages",
18508     "group": "Openchannel_Messages",
18509     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18510     "version": "0.0.0",
18511     "filename": "server/api/openchannelMessage/index.js",
18512     "groupTitle": "Openchannel_Messages"
18513   },
18514   {
18515     "type": "post",
18516     "url": "/api/openchannel/reports/queue",
18517     "title": "Creates a new Openchannel Queue Report",
18518     "examples": [
18519       {
18520         "title": "Example usage:",
18521         "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",
18522         "type": "json"
18523       }
18524     ],
18525     "name": "CreateOpenchannel_Queue_Reports",
18526     "group": "Openchannel_Queue_Reports",
18527     "parameter": {
18528       "fields": {
18529         "Body": [
18530           {
18531             "group": "Body",
18532             "type": "String",
18533             "optional": false,
18534             "field": "uniqueid",
18535             "description": ""
18536           },
18537           {
18538             "group": "Body",
18539             "type": "String",
18540             "optional": true,
18541             "field": "from",
18542             "description": ""
18543           },
18544           {
18545             "group": "Body",
18546             "type": "String",
18547             "optional": true,
18548             "field": "joinAt",
18549             "description": ""
18550           },
18551           {
18552             "group": "Body",
18553             "type": "String",
18554             "optional": true,
18555             "field": "leaveAt",
18556             "description": ""
18557           },
18558           {
18559             "group": "Body",
18560             "type": "String",
18561             "optional": true,
18562             "field": "acceptAt",
18563             "description": ""
18564           },
18565           {
18566             "group": "Body",
18567             "type": "String",
18568             "optional": true,
18569             "field": "exitAt",
18570             "description": ""
18571           },
18572           {
18573             "group": "Body",
18574             "type": "String",
18575             "optional": true,
18576             "field": "reason",
18577             "description": ""
18578           }
18579         ]
18580       }
18581     },
18582     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18583     "version": "0.0.0",
18584     "filename": "server/api/openchannelQueueReport/index.js",
18585     "groupTitle": "Openchannel_Queue_Reports"
18586   },
18587   {
18588     "type": "delete",
18589     "url": "/api/openchannel/reports/queue/{id}",
18590     "title": "Deletes a Openchannel Queue Report",
18591     "examples": [
18592       {
18593         "title": "Example usage:",
18594         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18595         "type": "json"
18596       }
18597     ],
18598     "name": "DeleteOpenchannel_Queue_Reports",
18599     "group": "Openchannel_Queue_Reports",
18600     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18601     "version": "0.0.0",
18602     "filename": "server/api/openchannelQueueReport/index.js",
18603     "groupTitle": "Openchannel_Queue_Reports"
18604   },
18605   {
18606     "type": "get",
18607     "url": "/api/openchannel/reports/queue/describe",
18608     "title": "Gets table info about Openchannel Queue Reports",
18609     "examples": [
18610       {
18611         "title": "Example usage:",
18612         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18613         "type": "json"
18614       }
18615     ],
18616     "name": "DescribeOpenchannel_Queue_Reports",
18617     "group": "Openchannel_Queue_Reports",
18618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18619     "version": "0.0.0",
18620     "filename": "server/api/openchannelQueueReport/index.js",
18621     "groupTitle": "Openchannel_Queue_Reports"
18622   },
18623   {
18624     "type": "get",
18625     "url": "/api/openchannel/reports/queue",
18626     "title": "Gets a list of Openchannel Queue Reports",
18627     "examples": [
18628       {
18629         "title": "Example usage:",
18630         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18631         "type": "json"
18632       }
18633     ],
18634     "name": "GetOpenchannel_Queue_Reports",
18635     "group": "Openchannel_Queue_Reports",
18636     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18637     "version": "0.0.0",
18638     "filename": "server/api/openchannelQueueReport/index.js",
18639     "groupTitle": "Openchannel_Queue_Reports"
18640   },
18641   {
18642     "type": "get",
18643     "url": "/api/openchannel/reports/queue/{id}",
18644     "title": "Gets a single Openchannel Queue Report",
18645     "examples": [
18646       {
18647         "title": "Example usage:",
18648         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18649         "type": "json"
18650       }
18651     ],
18652     "name": "ShowOpenchannel_Queue_Reports",
18653     "group": "Openchannel_Queue_Reports",
18654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18655     "version": "0.0.0",
18656     "filename": "server/api/openchannelQueueReport/index.js",
18657     "groupTitle": "Openchannel_Queue_Reports"
18658   },
18659   {
18660     "type": "put",
18661     "url": "/api/openchannel/reports/queue/{id}",
18662     "title": "Update an existing Openchannel Queue Report",
18663     "examples": [
18664       {
18665         "title": "Example usage:",
18666         "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",
18667         "type": "json"
18668       }
18669     ],
18670     "name": "updateOpenchannel_Queue_Reports",
18671     "group": "Openchannel_Queue_Reports",
18672     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18673     "version": "0.0.0",
18674     "filename": "server/api/openchannelQueueReport/index.js",
18675     "groupTitle": "Openchannel_Queue_Reports"
18676   },
18677   {
18678     "type": "post",
18679     "url": "/api/openchannel/queues/{id}/users",
18680     "title": "Add agents to a queue",
18681     "examples": [
18682       {
18683         "title": "Example usage:",
18684         "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",
18685         "type": "json"
18686       }
18687     ],
18688     "name": "AddAgents",
18689     "group": "Openchannel_Queues",
18690     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18691     "version": "0.0.0",
18692     "filename": "server/api/openchannelQueue/index.js",
18693     "groupTitle": "Openchannel_Queues"
18694   },
18695   {
18696     "type": "post",
18697     "url": "/api/openchannel/queues/{id}/teams",
18698     "title": "Add teams to a queue",
18699     "examples": [
18700       {
18701         "title": "Example usage:",
18702         "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",
18703         "type": "json"
18704       }
18705     ],
18706     "name": "AddTeams",
18707     "group": "Openchannel_Queues",
18708     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18709     "version": "0.0.0",
18710     "filename": "server/api/openchannelQueue/index.js",
18711     "groupTitle": "Openchannel_Queues"
18712   },
18713   {
18714     "type": "post",
18715     "url": "/api/openchannel/queues",
18716     "title": "Creates a new Queue",
18717     "examples": [
18718       {
18719         "title": "Example usage:",
18720         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18721         "type": "json"
18722       }
18723     ],
18724     "name": "CreateQueues",
18725     "group": "Openchannel_Queues",
18726     "parameter": {
18727       "fields": {
18728         "Body": [
18729           {
18730             "group": "Body",
18731             "type": "String",
18732             "optional": true,
18733             "field": "name",
18734             "description": ""
18735           },
18736           {
18737             "group": "Body",
18738             "type": "String",
18739             "optional": true,
18740             "field": "description",
18741             "description": ""
18742           },
18743           {
18744             "group": "Body",
18745             "type": "Integer",
18746             "optional": true,
18747             "field": "timeout",
18748             "description": ""
18749           },
18750           {
18751             "group": "Body",
18752             "type": "String",
18753             "allowedValues": [
18754               "\"rrmemory\"",
18755               "\"beepall\"",
18756               "\"roundrobin\""
18757             ],
18758             "optional": true,
18759             "field": "strategy",
18760             "description": ""
18761           }
18762         ]
18763       }
18764     },
18765     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18766     "version": "0.0.0",
18767     "filename": "server/api/openchannelQueue/index.js",
18768     "groupTitle": "Openchannel_Queues"
18769   },
18770   {
18771     "type": "delete",
18772     "url": "/api/openchannel/queues/{id}",
18773     "title": "Deletes a Queue",
18774     "examples": [
18775       {
18776         "title": "Example usage:",
18777         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18778         "type": "json"
18779       }
18780     ],
18781     "name": "DeleteQueues",
18782     "group": "Openchannel_Queues",
18783     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18784     "version": "0.0.0",
18785     "filename": "server/api/openchannelQueue/index.js",
18786     "groupTitle": "Openchannel_Queues"
18787   },
18788   {
18789     "type": "get",
18790     "url": "/api/openchannel/queues/describe",
18791     "title": "Gets table info about Queues",
18792     "examples": [
18793       {
18794         "title": "Example usage:",
18795         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18796         "type": "json"
18797       }
18798     ],
18799     "name": "DescribeQueues",
18800     "group": "Openchannel_Queues",
18801     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18802     "version": "0.0.0",
18803     "filename": "server/api/openchannelQueue/index.js",
18804     "groupTitle": "Openchannel_Queues"
18805   },
18806   {
18807     "type": "get",
18808     "url": "/api/openchannel/queues/{id}/users",
18809     "title": "Gets queue agents",
18810     "examples": [
18811       {
18812         "title": "Example usage:",
18813         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18814         "type": "json"
18815       }
18816     ],
18817     "name": "GetAgents",
18818     "group": "Openchannel_Queues",
18819     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18820     "version": "0.0.0",
18821     "filename": "server/api/openchannelQueue/index.js",
18822     "groupTitle": "Openchannel_Queues"
18823   },
18824   {
18825     "type": "get",
18826     "url": "/api/openchannel/queues/{id}/members",
18827     "title": "GetMembers",
18828     "examples": [
18829       {
18830         "title": "Example usage:",
18831         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
18832         "type": "json"
18833       }
18834     ],
18835     "name": "GetMembers",
18836     "group": "Openchannel_Queues",
18837     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18838     "version": "0.0.0",
18839     "filename": "server/api/openchannelQueue/index.js",
18840     "groupTitle": "Openchannel_Queues"
18841   },
18842   {
18843     "type": "get",
18844     "url": "/api/openchannel/queues",
18845     "title": "Gets a list of Queues",
18846     "examples": [
18847       {
18848         "title": "Example usage:",
18849         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18850         "type": "json"
18851       }
18852     ],
18853     "name": "GetQueues",
18854     "group": "Openchannel_Queues",
18855     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18856     "version": "0.0.0",
18857     "filename": "server/api/openchannelQueue/index.js",
18858     "groupTitle": "Openchannel_Queues"
18859   },
18860   {
18861     "type": "get",
18862     "url": "/api/openchannel/queues/{id}/teams",
18863     "title": "Gets queues list",
18864     "examples": [
18865       {
18866         "title": "Example usage:",
18867         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18868         "type": "json"
18869       }
18870     ],
18871     "name": "GetTeams",
18872     "group": "Openchannel_Queues",
18873     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18874     "version": "0.0.0",
18875     "filename": "server/api/openchannelQueue/index.js",
18876     "groupTitle": "Openchannel_Queues"
18877   },
18878   {
18879     "type": "delete",
18880     "url": "/api/openchannel/queues/{id}/users",
18881     "title": "Removes agents from a queue",
18882     "examples": [
18883       {
18884         "title": "Example usage:",
18885         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18886         "type": "json"
18887       }
18888     ],
18889     "name": "RemoveAgents",
18890     "group": "Openchannel_Queues",
18891     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18892     "version": "0.0.0",
18893     "filename": "server/api/openchannelQueue/index.js",
18894     "groupTitle": "Openchannel_Queues"
18895   },
18896   {
18897     "type": "get",
18898     "url": "/api/openchannel/queues/{id}",
18899     "title": "Gets a single Queue",
18900     "examples": [
18901       {
18902         "title": "Example usage:",
18903         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18904         "type": "json"
18905       }
18906     ],
18907     "name": "ShowQueues",
18908     "group": "Openchannel_Queues",
18909     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18910     "version": "0.0.0",
18911     "filename": "server/api/openchannelQueue/index.js",
18912     "groupTitle": "Openchannel_Queues"
18913   },
18914   {
18915     "type": "put",
18916     "url": "/api/openchannel/queues/{id}",
18917     "title": "Update an existing Queue",
18918     "examples": [
18919       {
18920         "title": "Example usage:",
18921         "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",
18922         "type": "json"
18923       }
18924     ],
18925     "name": "updateQueues",
18926     "group": "Openchannel_Queues",
18927     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18928     "version": "0.0.0",
18929     "filename": "server/api/openchannelQueue/index.js",
18930     "groupTitle": "Openchannel_Queues"
18931   },
18932   {
18933     "type": "post",
18934     "url": "/api/openchannel/reports/transfer",
18935     "title": "Creates a new Openchannel Transfer Report",
18936     "examples": [
18937       {
18938         "title": "Example usage:",
18939         "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",
18940         "type": "json"
18941       }
18942     ],
18943     "name": "CreateOpenchannel_Transfer_Reports",
18944     "group": "Openchannel_Transfer_Reports",
18945     "parameter": {
18946       "fields": {
18947         "Body": [
18948           {
18949             "group": "Body",
18950             "type": "String",
18951             "optional": false,
18952             "field": "uniqueid",
18953             "description": ""
18954           },
18955           {
18956             "group": "Body",
18957             "type": "String",
18958             "allowedValues": [
18959               "\"account\"",
18960               "\"agent\"",
18961               "\"queue\""
18962             ],
18963             "optional": false,
18964             "field": "type",
18965             "description": ""
18966           },
18967           {
18968             "group": "Body",
18969             "type": "String",
18970             "optional": false,
18971             "field": "transferredAt",
18972             "description": ""
18973           }
18974         ]
18975       }
18976     },
18977     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18978     "version": "0.0.0",
18979     "filename": "server/api/openchannelTransferReport/index.js",
18980     "groupTitle": "Openchannel_Transfer_Reports"
18981   },
18982   {
18983     "type": "delete",
18984     "url": "/api/openchannel/reports/transfer/{id}",
18985     "title": "Deletes a Openchannel Transfer Report",
18986     "examples": [
18987       {
18988         "title": "Example usage:",
18989         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
18990         "type": "json"
18991       }
18992     ],
18993     "name": "DeleteOpenchannel_Transfer_Reports",
18994     "group": "Openchannel_Transfer_Reports",
18995     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18996     "version": "0.0.0",
18997     "filename": "server/api/openchannelTransferReport/index.js",
18998     "groupTitle": "Openchannel_Transfer_Reports"
18999   },
19000   {
19001     "type": "get",
19002     "url": "/api/openchannel/reports/transfer/describe",
19003     "title": "Gets table info about Openchannel Transfer Reports",
19004     "examples": [
19005       {
19006         "title": "Example usage:",
19007         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
19008         "type": "json"
19009       }
19010     ],
19011     "name": "DescribeOpenchannel_Transfer_Reports",
19012     "group": "Openchannel_Transfer_Reports",
19013     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19014     "version": "0.0.0",
19015     "filename": "server/api/openchannelTransferReport/index.js",
19016     "groupTitle": "Openchannel_Transfer_Reports"
19017   },
19018   {
19019     "type": "get",
19020     "url": "/api/openchannel/reports/transfer",
19021     "title": "Gets a list of Openchannel Transfer Reports",
19022     "examples": [
19023       {
19024         "title": "Example usage:",
19025         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
19026         "type": "json"
19027       }
19028     ],
19029     "name": "GetOpenchannel_Transfer_Reports",
19030     "group": "Openchannel_Transfer_Reports",
19031     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19032     "version": "0.0.0",
19033     "filename": "server/api/openchannelTransferReport/index.js",
19034     "groupTitle": "Openchannel_Transfer_Reports"
19035   },
19036   {
19037     "type": "get",
19038     "url": "/api/openchannel/reports/transfer/{id}",
19039     "title": "Gets a single Openchannel Transfer Report",
19040     "examples": [
19041       {
19042         "title": "Example usage:",
19043         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
19044         "type": "json"
19045       }
19046     ],
19047     "name": "ShowOpenchannel_Transfer_Reports",
19048     "group": "Openchannel_Transfer_Reports",
19049     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19050     "version": "0.0.0",
19051     "filename": "server/api/openchannelTransferReport/index.js",
19052     "groupTitle": "Openchannel_Transfer_Reports"
19053   },
19054   {
19055     "type": "put",
19056     "url": "/api/openchannel/reports/transfer/{id}",
19057     "title": "Update an existing Openchannel Transfer Report",
19058     "examples": [
19059       {
19060         "title": "Example usage:",
19061         "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",
19062         "type": "json"
19063       }
19064     ],
19065     "name": "updateOpenchannel_Transfer_Reports",
19066     "group": "Openchannel_Transfer_Reports",
19067     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19068     "version": "0.0.0",
19069     "filename": "server/api/openchannelTransferReport/index.js",
19070     "groupTitle": "Openchannel_Transfer_Reports"
19071   },
19072   {
19073     "type": "post",
19074     "url": "/api/pauses",
19075     "title": "Creates a new Pause",
19076     "examples": [
19077       {
19078         "title": "Example usage:",
19079         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
19080         "type": "json"
19081       }
19082     ],
19083     "name": "CreatePauses",
19084     "group": "Pauses",
19085     "parameter": {
19086       "fields": {
19087         "Body": [
19088           {
19089             "group": "Body",
19090             "type": "String",
19091             "optional": false,
19092             "field": "name",
19093             "description": ""
19094           },
19095           {
19096             "group": "Body",
19097             "type": "String",
19098             "optional": true,
19099             "field": "description",
19100             "description": ""
19101           }
19102         ]
19103       }
19104     },
19105     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19106     "version": "0.0.0",
19107     "filename": "server/api/pause/index.js",
19108     "groupTitle": "Pauses"
19109   },
19110   {
19111     "type": "delete",
19112     "url": "/api/pauses/{id}",
19113     "title": "Deletes a Pause",
19114     "examples": [
19115       {
19116         "title": "Example usage:",
19117         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
19118         "type": "json"
19119       }
19120     ],
19121     "name": "DeletePauses",
19122     "group": "Pauses",
19123     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19124     "version": "0.0.0",
19125     "filename": "server/api/pause/index.js",
19126     "groupTitle": "Pauses"
19127   },
19128   {
19129     "type": "get",
19130     "url": "/api/pauses",
19131     "title": "Gets a list of Pauses",
19132     "examples": [
19133       {
19134         "title": "Example usage:",
19135         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
19136         "type": "json"
19137       }
19138     ],
19139     "name": "GetPauses",
19140     "group": "Pauses",
19141     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19142     "version": "0.0.0",
19143     "filename": "server/api/pause/index.js",
19144     "groupTitle": "Pauses"
19145   },
19146   {
19147     "type": "get",
19148     "url": "/api/pauses/{id}",
19149     "title": "Gets a single Pause",
19150     "examples": [
19151       {
19152         "title": "Example usage:",
19153         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
19154         "type": "json"
19155       }
19156     ],
19157     "name": "ShowPauses",
19158     "group": "Pauses",
19159     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19160     "version": "0.0.0",
19161     "filename": "server/api/pause/index.js",
19162     "groupTitle": "Pauses"
19163   },
19164   {
19165     "type": "put",
19166     "url": "/api/pauses/{id}",
19167     "title": "Update an existing Pause",
19168     "examples": [
19169       {
19170         "title": "Example usage:",
19171         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19172         "type": "json"
19173       }
19174     ],
19175     "name": "updatePauses",
19176     "group": "Pauses",
19177     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19178     "version": "0.0.0",
19179     "filename": "server/api/pause/index.js",
19180     "groupTitle": "Pauses"
19181   },
19182   {
19183     "type": "get",
19184     "url": "/api/plugins",
19185     "title": "Gets a list of Plugins",
19186     "examples": [
19187       {
19188         "title": "Example usage:",
19189         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
19190         "type": "json"
19191       }
19192     ],
19193     "name": "GetPlugins",
19194     "group": "Plugins",
19195     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19196     "version": "0.0.0",
19197     "filename": "server/api/plugin/index.js",
19198     "groupTitle": "Plugins"
19199   },
19200   {
19201     "type": "get",
19202     "url": "/api/plugins/{id}",
19203     "title": "Gets a single Plugin",
19204     "examples": [
19205       {
19206         "title": "Example usage:",
19207         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
19208         "type": "json"
19209       }
19210     ],
19211     "name": "ShowPlugins",
19212     "group": "Plugins",
19213     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19214     "version": "0.0.0",
19215     "filename": "server/api/plugin/index.js",
19216     "groupTitle": "Plugins"
19217   },
19218   {
19219     "type": "delete",
19220     "url": "/api/plugins/{id}",
19221     "title": "Delete a plugin",
19222     "examples": [
19223       {
19224         "title": "Example usage:",
19225         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
19226         "type": "json"
19227       }
19228     ],
19229     "name": "destroyPlugin",
19230     "group": "Plugins",
19231     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19232     "version": "0.0.0",
19233     "filename": "server/api/plugin/index.js",
19234     "groupTitle": "Plugins"
19235   },
19236   {
19237     "type": "get",
19238     "url": "/api/plugins/{id}/download",
19239     "title": "Download plugin source code",
19240     "examples": [
19241       {
19242         "title": "Example usage:",
19243         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
19244         "type": "json"
19245       }
19246     ],
19247     "name": "download",
19248     "group": "Plugins",
19249     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19250     "version": "0.0.0",
19251     "filename": "server/api/plugin/index.js",
19252     "groupTitle": "Plugins"
19253   },
19254   {
19255     "type": "put",
19256     "url": "/api/plugins/{id}",
19257     "title": "Update an existing plugin",
19258     "examples": [
19259       {
19260         "title": "Example usage:",
19261         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
19262         "type": "json"
19263       }
19264     ],
19265     "name": "updatePlugin",
19266     "group": "Plugins",
19267     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19268     "version": "0.0.0",
19269     "filename": "server/api/plugin/index.js",
19270     "groupTitle": "Plugins"
19271   },
19272   {
19273     "type": "post",
19274     "url": "/api/plugins",
19275     "title": "Upload new plugin",
19276     "examples": [
19277       {
19278         "title": "Example usage:",
19279         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
19280         "type": "json"
19281       }
19282     ],
19283     "name": "uploadPlugin",
19284     "group": "Plugins",
19285     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19286     "version": "0.0.0",
19287     "filename": "server/api/plugin/index.js",
19288     "groupTitle": "Plugins"
19289   },
19290   {
19291     "type": "post",
19292     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19293     "title": "Redirect a plugin request to the specified path",
19294     "examples": [
19295       {
19296         "title": "Example usage:",
19297         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
19298         "type": "json"
19299       }
19300     ],
19301     "name": "webhookPlugin",
19302     "group": "Plugins",
19303     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19304     "version": "0.0.0",
19305     "filename": "server/api/plugin/index.js",
19306     "groupTitle": "Plugins"
19307   },
19308   {
19309     "type": "get",
19310     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
19311     "title": "Redirect a plugin request to the specified path",
19312     "examples": [
19313       {
19314         "title": "Example usage:",
19315         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
19316         "type": "json"
19317       }
19318     ],
19319     "name": "webhookPlugin",
19320     "group": "Plugins",
19321     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19322     "version": "0.0.0",
19323     "filename": "server/api/plugin/index.js",
19324     "groupTitle": "Plugins"
19325   },
19326   {
19327     "type": "delete",
19328     "url": "/api/pm2/{id}",
19329     "title": "Deletes an existing process",
19330     "examples": [
19331       {
19332         "title": "Example usage:",
19333         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
19334         "type": "json"
19335       }
19336     ],
19337     "name": "DeletePm2Process",
19338     "group": "Pm2",
19339     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19340     "version": "0.0.0",
19341     "filename": "server/api/pm2/index.js",
19342     "groupTitle": "Pm2"
19343   },
19344   {
19345     "type": "get",
19346     "url": "/api/pm2/{id}",
19347     "title": "Gets a single pm2 process",
19348     "examples": [
19349       {
19350         "title": "Example usage:",
19351         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
19352         "type": "json"
19353       }
19354     ],
19355     "name": "GetPm2Process",
19356     "group": "Pm2",
19357     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19358     "version": "0.0.0",
19359     "filename": "server/api/pm2/index.js",
19360     "groupTitle": "Pm2"
19361   },
19362   {
19363     "type": "get",
19364     "url": "/api/pm2",
19365     "title": "Gets pm2 processes",
19366     "examples": [
19367       {
19368         "title": "Example usage:",
19369         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
19370         "type": "json"
19371       }
19372     ],
19373     "name": "GetPm2Processes",
19374     "group": "Pm2",
19375     "description": "<p>Motion returns the pm2 processes list.</p>",
19376     "version": "0.0.0",
19377     "filename": "server/api/pm2/index.js",
19378     "groupTitle": "Pm2"
19379   },
19380   {
19381     "type": "post",
19382     "url": "/api/pm2",
19383     "title": "Start a single pm2 process",
19384     "examples": [
19385       {
19386         "title": "Example usage:",
19387         "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",
19388         "type": "json"
19389       }
19390     ],
19391     "name": "StartPm2Process",
19392     "group": "Pm2",
19393     "parameter": {
19394       "fields": {
19395         "Body": [
19396           {
19397             "group": "Body",
19398             "type": "String",
19399             "optional": false,
19400             "field": "name",
19401             "description": ""
19402           },
19403           {
19404             "group": "Body",
19405             "type": "String",
19406             "optional": false,
19407             "field": "script",
19408             "description": ""
19409           }
19410         ]
19411       }
19412     },
19413     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19414     "version": "0.0.0",
19415     "filename": "server/api/pm2/index.js",
19416     "groupTitle": "Pm2"
19417   },
19418   {
19419     "type": "put",
19420     "url": "/api/pm2/{id}",
19421     "title": "Update an existing process",
19422     "examples": [
19423       {
19424         "title": "Example usage:",
19425         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
19426         "type": "json"
19427       }
19428     ],
19429     "name": "UpdatePm2Process",
19430     "group": "Pm2",
19431     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19432     "version": "0.0.0",
19433     "filename": "server/api/pm2/index.js",
19434     "groupTitle": "Pm2"
19435   },
19436   {
19437     "type": "get",
19438     "url": "/api/rpc/campaigns/",
19439     "title": "Gets a list of campaigns",
19440     "examples": [
19441       {
19442         "title": "Example usage:",
19443         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
19444         "type": "json"
19445       }
19446     ],
19447     "name": "Campaigns",
19448     "group": "RPC_Realtime",
19449     "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>",
19450     "version": "0.0.0",
19451     "filename": "server/api/rpc/index.js",
19452     "groupTitle": "RPC_Realtime"
19453   },
19454   {
19455     "type": "get",
19456     "url": "/api/rpc/fax/accounts",
19457     "title": "Gets a list of FaxAccounts",
19458     "examples": [
19459       {
19460         "title": "Example usage:",
19461         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
19462         "type": "json"
19463       }
19464     ],
19465     "name": "FaxAccounts",
19466     "group": "RPC_Realtime",
19467     "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>",
19468     "version": "0.0.0",
19469     "filename": "server/api/rpc/index.js",
19470     "groupTitle": "RPC_Realtime"
19471   },
19472   {
19473     "type": "put",
19474     "url": "/api/rpc/agents/:id/capacity",
19475     "title": "Sets agent capacity",
19476     "examples": [
19477       {
19478         "title": "Example usage:",
19479         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
19480         "type": "json"
19481       }
19482     ],
19483     "name": "RTAgentCapacity",
19484     "group": "RPC_Realtime",
19485     "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>",
19486     "version": "0.0.0",
19487     "filename": "server/api/rpc/index.js",
19488     "groupTitle": "RPC_Realtime"
19489   },
19490   {
19491     "type": "get",
19492     "url": "/api/rpc/agents",
19493     "title": "Gets a list of RTAgents",
19494     "examples": [
19495       {
19496         "title": "Example usage:",
19497         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
19498         "type": "json"
19499       }
19500     ],
19501     "name": "RTAgents",
19502     "group": "RPC_Realtime",
19503     "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>",
19504     "version": "0.0.0",
19505     "filename": "server/api/rpc/index.js",
19506     "groupTitle": "RPC_Realtime"
19507   },
19508   {
19509     "type": "get",
19510     "url": "/api/rpc/chat/queues",
19511     "title": "Gets a list of RTChatQueues",
19512     "examples": [
19513       {
19514         "title": "Example usage:",
19515         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
19516         "type": "json"
19517       }
19518     ],
19519     "name": "RTChatQueues",
19520     "group": "RPC_Realtime",
19521     "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>",
19522     "version": "0.0.0",
19523     "filename": "server/api/rpc/index.js",
19524     "groupTitle": "RPC_Realtime"
19525   },
19526   {
19527     "type": "get",
19528     "url": "/api/rpc/fax/queues",
19529     "title": "Gets a list of RTFaxQueues",
19530     "examples": [
19531       {
19532         "title": "Example usage:",
19533         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
19534         "type": "json"
19535       }
19536     ],
19537     "name": "RTFaxQueues",
19538     "group": "RPC_Realtime",
19539     "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>",
19540     "version": "0.0.0",
19541     "filename": "server/api/rpc/index.js",
19542     "groupTitle": "RPC_Realtime"
19543   },
19544   {
19545     "type": "get",
19546     "url": "/api/rpc/mail/accounts",
19547     "title": "Gets a list of RTMailAccounts",
19548     "examples": [
19549       {
19550         "title": "Example usage:",
19551         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19552         "type": "json"
19553       }
19554     ],
19555     "name": "RTMailAccounts",
19556     "group": "RPC_Realtime",
19557     "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>",
19558     "version": "0.0.0",
19559     "filename": "server/api/rpc/index.js",
19560     "groupTitle": "RPC_Realtime"
19561   },
19562   {
19563     "type": "get",
19564     "url": "/api/rpc/mail/queues",
19565     "title": "Gets a list of RTMailQueues",
19566     "examples": [
19567       {
19568         "title": "Example usage:",
19569         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19570         "type": "json"
19571       }
19572     ],
19573     "name": "RTMailQueues",
19574     "group": "RPC_Realtime",
19575     "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>",
19576     "version": "0.0.0",
19577     "filename": "server/api/rpc/index.js",
19578     "groupTitle": "RPC_Realtime"
19579   },
19580   {
19581     "type": "get",
19582     "url": "/api/rpc/openchannel/queues",
19583     "title": "Gets a list of RTOpenchannelQueues",
19584     "examples": [
19585       {
19586         "title": "Example usage:",
19587         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19588         "type": "json"
19589       }
19590     ],
19591     "name": "RTOpenchannelQueues",
19592     "group": "RPC_Realtime",
19593     "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>",
19594     "version": "0.0.0",
19595     "filename": "server/api/rpc/index.js",
19596     "groupTitle": "RPC_Realtime"
19597   },
19598   {
19599     "type": "get",
19600     "url": "/api/rpc/outbound/channels",
19601     "title": "Gets a list of RTOutboundChannels",
19602     "examples": [
19603       {
19604         "title": "Example usage:",
19605         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19606         "type": "json"
19607       }
19608     ],
19609     "name": "RTOutboundChannels",
19610     "group": "RPC_Realtime",
19611     "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>",
19612     "version": "0.0.0",
19613     "filename": "server/api/rpc/index.js",
19614     "groupTitle": "RPC_Realtime"
19615   },
19616   {
19617     "type": "get",
19618     "url": "/api/rpc/sms/queues",
19619     "title": "Gets a list of RTSmsQueues",
19620     "examples": [
19621       {
19622         "title": "Example usage:",
19623         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19624         "type": "json"
19625       }
19626     ],
19627     "name": "RTSmsQueues",
19628     "group": "RPC_Realtime",
19629     "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>",
19630     "version": "0.0.0",
19631     "filename": "server/api/rpc/index.js",
19632     "groupTitle": "RPC_Realtime"
19633   },
19634   {
19635     "type": "get",
19636     "url": "/api/rpc/telephones",
19637     "title": "Gets a list of RTTelephones",
19638     "examples": [
19639       {
19640         "title": "Example usage:",
19641         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19642         "type": "json"
19643       }
19644     ],
19645     "name": "RTTelephones",
19646     "group": "RPC_Realtime",
19647     "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>",
19648     "version": "0.0.0",
19649     "filename": "server/api/rpc/index.js",
19650     "groupTitle": "RPC_Realtime"
19651   },
19652   {
19653     "type": "get",
19654     "url": "/api/rpc/trunks",
19655     "title": "Gets a list of RTTrunks",
19656     "examples": [
19657       {
19658         "title": "Example usage:",
19659         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19660         "type": "json"
19661       }
19662     ],
19663     "name": "RTTrunks",
19664     "group": "RPC_Realtime",
19665     "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>",
19666     "version": "0.0.0",
19667     "filename": "server/api/rpc/index.js",
19668     "groupTitle": "RPC_Realtime"
19669   },
19670   {
19671     "type": "get",
19672     "url": "/api/rpc/voice/channels",
19673     "title": "Gets a list of RTVoiceChannelMixMonitor",
19674     "examples": [
19675       {
19676         "title": "Example usage:",
19677         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19678         "type": "json"
19679       }
19680     ],
19681     "name": "RTVoiceChannelMixMonitor",
19682     "group": "RPC_Realtime",
19683     "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>",
19684     "version": "0.0.0",
19685     "filename": "server/api/rpc/index.js",
19686     "groupTitle": "RPC_Realtime"
19687   },
19688   {
19689     "type": "get",
19690     "url": "/api/rpc/voice/channels",
19691     "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19692     "examples": [
19693       {
19694         "title": "Example usage:",
19695         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19696         "type": "json"
19697       }
19698     ],
19699     "name": "RTVoiceChannelStopMixMonitor",
19700     "group": "RPC_Realtime",
19701     "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>",
19702     "version": "0.0.0",
19703     "filename": "server/api/rpc/index.js",
19704     "groupTitle": "RPC_Realtime"
19705   },
19706   {
19707     "type": "get",
19708     "url": "/api/rpc/voice/channels",
19709     "title": "Gets a list of RTVoiceChannels",
19710     "examples": [
19711       {
19712         "title": "Example usage:",
19713         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19714         "type": "json"
19715       }
19716     ],
19717     "name": "RTVoiceChannels",
19718     "group": "RPC_Realtime",
19719     "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>",
19720     "version": "0.0.0",
19721     "filename": "server/api/rpc/index.js",
19722     "groupTitle": "RPC_Realtime"
19723   },
19724   {
19725     "type": "get",
19726     "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19727     "title": "Gets a single RTVoiceQueueChannel",
19728     "examples": [
19729       {
19730         "title": "Example usage:",
19731         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19732         "type": "json"
19733       }
19734     ],
19735     "name": "RTVoiceQueueChannel",
19736     "group": "RPC_Realtime",
19737     "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19738     "version": "0.0.0",
19739     "filename": "server/api/rpc/index.js",
19740     "groupTitle": "RPC_Realtime"
19741   },
19742   {
19743     "type": "get",
19744     "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19745     "title": "Hangup a single RTVoiceQueueChannel",
19746     "examples": [
19747       {
19748         "title": "Example usage:",
19749         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19750         "type": "json"
19751       }
19752     ],
19753     "name": "RTVoiceQueueChannelHangup",
19754     "group": "RPC_Realtime",
19755     "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19756     "version": "0.0.0",
19757     "filename": "server/api/rpc/index.js",
19758     "groupTitle": "RPC_Realtime"
19759   },
19760   {
19761     "type": "get",
19762     "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19763     "title": "Hangup a single RTVoiceQueueChannel",
19764     "examples": [
19765       {
19766         "title": "Example usage:",
19767         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19768         "type": "json"
19769       }
19770     ],
19771     "name": "RTVoiceQueueChannelRedirect",
19772     "group": "RPC_Realtime",
19773     "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>",
19774     "version": "0.0.0",
19775     "filename": "server/api/rpc/index.js",
19776     "groupTitle": "RPC_Realtime"
19777   },
19778   {
19779     "type": "get",
19780     "url": "/api/rpc/voice/queues/preview/{id}",
19781     "title": "Gets a single preview contact",
19782     "examples": [
19783       {
19784         "title": "Example usage:",
19785         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19786         "type": "json"
19787       }
19788     ],
19789     "name": "RTVoiceQueuePreview",
19790     "group": "RPC_Realtime",
19791     "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19792     "version": "0.0.0",
19793     "filename": "server/api/rpc/index.js",
19794     "groupTitle": "RPC_Realtime"
19795   },
19796   {
19797     "type": "get",
19798     "url": "/api/rpc/outbound",
19799     "title": "Gets a list of RTOutbound",
19800     "examples": [
19801       {
19802         "title": "Example usage:",
19803         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19804         "type": "json"
19805       }
19806     ],
19807     "name": "RTVoiceQueues",
19808     "group": "RPC_Realtime",
19809     "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>",
19810     "version": "0.0.0",
19811     "filename": "server/api/rpc/index.js",
19812     "groupTitle": "RPC_Realtime"
19813   },
19814   {
19815     "type": "get",
19816     "url": "/api/rpc/voice/queues",
19817     "title": "Gets a list of RTVoiceQueues",
19818     "examples": [
19819       {
19820         "title": "Example usage:",
19821         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19822         "type": "json"
19823       }
19824     ],
19825     "name": "RTVoiceQueues",
19826     "group": "RPC_Realtime",
19827     "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>",
19828     "version": "0.0.0",
19829     "filename": "server/api/rpc/index.js",
19830     "groupTitle": "RPC_Realtime"
19831   },
19832   {
19833     "type": "get",
19834     "url": "/api/rpc/voice/queues/channels",
19835     "title": "Gets a list of RTVoiceQueuesChannels",
19836     "examples": [
19837       {
19838         "title": "Example usage:",
19839         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19840         "type": "json"
19841       }
19842     ],
19843     "name": "RTVoiceQueuesChannels",
19844     "group": "RPC_Realtime",
19845     "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>",
19846     "version": "0.0.0",
19847     "filename": "server/api/rpc/index.js",
19848     "groupTitle": "RPC_Realtime"
19849   },
19850   {
19851     "type": "get",
19852     "url": "/api/rpc/chat/queues/{id}",
19853     "title": "Gets a single RTChatQueue",
19854     "examples": [
19855       {
19856         "title": "Example usage:",
19857         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19858         "type": "json"
19859       }
19860     ],
19861     "name": "ShowRTChatQueues",
19862     "group": "RPC_Realtime",
19863     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19864     "version": "0.0.0",
19865     "filename": "server/api/rpc/index.js",
19866     "groupTitle": "RPC_Realtime"
19867   },
19868   {
19869     "type": "get",
19870     "url": "/api/rpc/fax/queues/{id}",
19871     "title": "Gets a single RTFaxQueue",
19872     "examples": [
19873       {
19874         "title": "Example usage:",
19875         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19876         "type": "json"
19877       }
19878     ],
19879     "name": "ShowRTFaxQueues",
19880     "group": "RPC_Realtime",
19881     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19882     "version": "0.0.0",
19883     "filename": "server/api/rpc/index.js",
19884     "groupTitle": "RPC_Realtime"
19885   },
19886   {
19887     "type": "get",
19888     "url": "/api/rpc/mail/queues/{id}",
19889     "title": "Gets a single RTMailQueue",
19890     "examples": [
19891       {
19892         "title": "Example usage:",
19893         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19894         "type": "json"
19895       }
19896     ],
19897     "name": "ShowRTMailQueues",
19898     "group": "RPC_Realtime",
19899     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19900     "version": "0.0.0",
19901     "filename": "server/api/rpc/index.js",
19902     "groupTitle": "RPC_Realtime"
19903   },
19904   {
19905     "type": "get",
19906     "url": "/api/rpc/openchannel/queues/{id}",
19907     "title": "Gets a single RTOpenchannelQueue",
19908     "examples": [
19909       {
19910         "title": "Example usage:",
19911         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19912         "type": "json"
19913       }
19914     ],
19915     "name": "ShowRTOpenchannelQueues",
19916     "group": "RPC_Realtime",
19917     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19918     "version": "0.0.0",
19919     "filename": "server/api/rpc/index.js",
19920     "groupTitle": "RPC_Realtime"
19921   },
19922   {
19923     "type": "get",
19924     "url": "/api/rpc/sms/queues/{id}",
19925     "title": "Gets a single RTSmsQueue",
19926     "examples": [
19927       {
19928         "title": "Example usage:",
19929         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
19930         "type": "json"
19931       }
19932     ],
19933     "name": "ShowRTSmsQueues",
19934     "group": "RPC_Realtime",
19935     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19936     "version": "0.0.0",
19937     "filename": "server/api/rpc/index.js",
19938     "groupTitle": "RPC_Realtime"
19939   },
19940   {
19941     "type": "get",
19942     "url": "/api/rpc/voice/queues/{id}",
19943     "title": "Gets a single RTVoiceQueue",
19944     "examples": [
19945       {
19946         "title": "Example usage:",
19947         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
19948         "type": "json"
19949       }
19950     ],
19951     "name": "ShowRTVoiceQueues",
19952     "group": "RPC_Realtime",
19953     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19954     "version": "0.0.0",
19955     "filename": "server/api/rpc/index.js",
19956     "groupTitle": "RPC_Realtime"
19957   },
19958   {
19959     "type": "post",
19960     "url": "/api/rpc/agents/:id/notify",
19961     "title": "Notify message to a specific agent",
19962     "examples": [
19963       {
19964         "title": "Example usage:",
19965         "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",
19966         "type": "json"
19967       }
19968     ],
19969     "name": "agentNotify",
19970     "group": "RPC_Realtime",
19971     "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>",
19972     "version": "0.0.0",
19973     "filename": "server/api/rpc/index.js",
19974     "groupTitle": "RPC_Realtime"
19975   },
19976   {
19977     "type": "post",
19978     "url": "/api/rpc/chat/queues/:id/notify",
19979     "title": "Notify message to a specific queue",
19980     "examples": [
19981       {
19982         "title": "Example usage:",
19983         "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",
19984         "type": "json"
19985       }
19986     ],
19987     "name": "chatQueueNotify",
19988     "group": "RPC_Realtime",
19989     "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>",
19990     "version": "0.0.0",
19991     "filename": "server/api/rpc/index.js",
19992     "groupTitle": "RPC_Realtime"
19993   },
19994   {
19995     "type": "get",
19996     "url": "/api/rpc/chat/queues/waitinginteractions",
19997     "title": "Gets a list of chatQueuesWaitingInteractions",
19998     "examples": [
19999       {
20000         "title": "Example usage:",
20001         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
20002         "type": "json"
20003       }
20004     ],
20005     "name": "chatQueuesWaitingInteractions",
20006     "group": "RPC_Realtime",
20007     "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>",
20008     "version": "0.0.0",
20009     "filename": "server/api/rpc/index.js",
20010     "groupTitle": "RPC_Realtime"
20011   },
20012   {
20013     "type": "post",
20014     "url": "/api/rpc/fax/queues/:id/notify",
20015     "title": "Notify message to a specific queue",
20016     "examples": [
20017       {
20018         "title": "Example usage:",
20019         "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",
20020         "type": "json"
20021       }
20022     ],
20023     "name": "faxQueueNotify",
20024     "group": "RPC_Realtime",
20025     "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>",
20026     "version": "0.0.0",
20027     "filename": "server/api/rpc/index.js",
20028     "groupTitle": "RPC_Realtime"
20029   },
20030   {
20031     "type": "get",
20032     "url": "/api/rpc/fax/queues/waitinginteractions",
20033     "title": "Gets a list of faxQueuesWaitingInteractions",
20034     "examples": [
20035       {
20036         "title": "Example usage:",
20037         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
20038         "type": "json"
20039       }
20040     ],
20041     "name": "faxQueuesWaitingInteractions",
20042     "group": "RPC_Realtime",
20043     "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>",
20044     "version": "0.0.0",
20045     "filename": "server/api/rpc/index.js",
20046     "groupTitle": "RPC_Realtime"
20047   },
20048   {
20049     "type": "post",
20050     "url": "/api/rpc/mail/queues/:id/notify",
20051     "title": "Notify message to a specific queue",
20052     "examples": [
20053       {
20054         "title": "Example usage:",
20055         "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",
20056         "type": "json"
20057       }
20058     ],
20059     "name": "mailQueueNotify",
20060     "group": "RPC_Realtime",
20061     "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>",
20062     "version": "0.0.0",
20063     "filename": "server/api/rpc/index.js",
20064     "groupTitle": "RPC_Realtime"
20065   },
20066   {
20067     "type": "get",
20068     "url": "/api/rpc/mail/queues/waitinginteractions",
20069     "title": "Gets a list of mailQueuesWaitingInteractions",
20070     "examples": [
20071       {
20072         "title": "Example usage:",
20073         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
20074         "type": "json"
20075       }
20076     ],
20077     "name": "mailQueuesWaitingInteractions",
20078     "group": "RPC_Realtime",
20079     "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>",
20080     "version": "0.0.0",
20081     "filename": "server/api/rpc/index.js",
20082     "groupTitle": "RPC_Realtime"
20083   },
20084   {
20085     "type": "post",
20086     "url": "/api/rpc/openchannel/queues/:id/notify",
20087     "title": "Notify message to a specific queue",
20088     "examples": [
20089       {
20090         "title": "Example usage:",
20091         "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",
20092         "type": "json"
20093       }
20094     ],
20095     "name": "openchannelQueueNotify",
20096     "group": "RPC_Realtime",
20097     "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>",
20098     "version": "0.0.0",
20099     "filename": "server/api/rpc/index.js",
20100     "groupTitle": "RPC_Realtime"
20101   },
20102   {
20103     "type": "get",
20104     "url": "/api/rpc/openchannel/queues/:id/waitinginteractions",
20105     "title": "Gets a list of openchannelQueuesIdWaitingInteractions",
20106     "examples": [
20107       {
20108         "title": "Example usage:",
20109         "content": "curl https://{domain}/api/rpc/openchannel/queues/:id/waitinginteractions -v -u {name}:{password}",
20110         "type": "json"
20111       }
20112     ],
20113     "name": "openchannelQueuesIdWaitingInteractions",
20114     "group": "RPC_Realtime",
20115     "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>",
20116     "version": "0.0.0",
20117     "filename": "server/api/rpc/index.js",
20118     "groupTitle": "RPC_Realtime"
20119   },
20120   {
20121     "type": "get",
20122     "url": "/api/rpc/openchannel/queues/waitinginteractions",
20123     "title": "Gets a list of openchannelQueuesWaitingInteractions",
20124     "examples": [
20125       {
20126         "title": "Example usage:",
20127         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
20128         "type": "json"
20129       }
20130     ],
20131     "name": "openchannelQueuesWaitingInteractions",
20132     "group": "RPC_Realtime",
20133     "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>",
20134     "version": "0.0.0",
20135     "filename": "server/api/rpc/index.js",
20136     "groupTitle": "RPC_Realtime"
20137   },
20138   {
20139     "type": "post",
20140     "url": "/api/rpc/sms/queues/:id/notify",
20141     "title": "Notify message to a specific queue",
20142     "examples": [
20143       {
20144         "title": "Example usage:",
20145         "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",
20146         "type": "json"
20147       }
20148     ],
20149     "name": "smsQueueNotify",
20150     "group": "RPC_Realtime",
20151     "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>",
20152     "version": "0.0.0",
20153     "filename": "server/api/rpc/index.js",
20154     "groupTitle": "RPC_Realtime"
20155   },
20156   {
20157     "type": "get",
20158     "url": "/api/rpc/sms/queues/waitinginteractions",
20159     "title": "Gets a list of smsQueuesWaitingInteractions",
20160     "examples": [
20161       {
20162         "title": "Example usage:",
20163         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
20164         "type": "json"
20165       }
20166     ],
20167     "name": "smsQueuesWaitingInteractions",
20168     "group": "RPC_Realtime",
20169     "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>",
20170     "version": "0.0.0",
20171     "filename": "server/api/rpc/index.js",
20172     "groupTitle": "RPC_Realtime"
20173   },
20174   {
20175     "type": "post",
20176     "url": "/api/integrations/salesforce/accounts",
20177     "title": "Creates a new Salesforce Account",
20178     "examples": [
20179       {
20180         "title": "Example usage:",
20181         "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",
20182         "type": "json"
20183       }
20184     ],
20185     "name": "CreateSalesforce_Accounts",
20186     "group": "Salesforce_Accounts",
20187     "parameter": {
20188       "fields": {
20189         "Body": [
20190           {
20191             "group": "Body",
20192             "type": "String",
20193             "optional": true,
20194             "field": "name",
20195             "description": ""
20196           },
20197           {
20198             "group": "Body",
20199             "type": "String",
20200             "optional": true,
20201             "field": "description",
20202             "description": ""
20203           },
20204           {
20205             "group": "Body",
20206             "type": "String",
20207             "optional": true,
20208             "field": "username",
20209             "description": ""
20210           },
20211           {
20212             "group": "Body",
20213             "type": "String",
20214             "optional": true,
20215             "field": "remoteUri",
20216             "description": ""
20217           },
20218           {
20219             "group": "Body",
20220             "type": "String",
20221             "optional": true,
20222             "field": "password",
20223             "description": ""
20224           },
20225           {
20226             "group": "Body",
20227             "type": "String",
20228             "optional": true,
20229             "field": "clientId",
20230             "description": ""
20231           },
20232           {
20233             "group": "Body",
20234             "type": "String",
20235             "optional": true,
20236             "field": "clientSecret",
20237             "description": ""
20238           },
20239           {
20240             "group": "Body",
20241             "type": "String",
20242             "optional": true,
20243             "field": "securityToken",
20244             "description": ""
20245           },
20246           {
20247             "group": "Body",
20248             "type": "String",
20249             "optional": true,
20250             "field": "serverUrl",
20251             "description": ""
20252           },
20253           {
20254             "group": "Body",
20255             "type": "String",
20256             "allowedValues": [
20257               "\"integrationTab\"",
20258               "\"newTab\""
20259             ],
20260             "optional": true,
20261             "field": "type",
20262             "description": ""
20263           }
20264         ]
20265       }
20266     },
20267     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20268     "version": "0.0.0",
20269     "filename": "server/api/intSalesforceAccount/index.js",
20270     "groupTitle": "Salesforce_Accounts"
20271   },
20272   {
20273     "type": "delete",
20274     "url": "/api/integrations/salesforce/accounts/{id}",
20275     "title": "Deletes a Salesforce Account",
20276     "examples": [
20277       {
20278         "title": "Example usage:",
20279         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
20280         "type": "json"
20281       }
20282     ],
20283     "name": "DeleteSalesforce_Accounts",
20284     "group": "Salesforce_Accounts",
20285     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20286     "version": "0.0.0",
20287     "filename": "server/api/intSalesforceAccount/index.js",
20288     "groupTitle": "Salesforce_Accounts"
20289   },
20290   {
20291     "type": "get",
20292     "url": "/api/integrations/salesforce/accounts",
20293     "title": "Gets a list of Salesforce Accounts",
20294     "examples": [
20295       {
20296         "title": "Example usage:",
20297         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
20298         "type": "json"
20299       }
20300     ],
20301     "name": "GetSalesforce_Accounts",
20302     "group": "Salesforce_Accounts",
20303     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20304     "version": "0.0.0",
20305     "filename": "server/api/intSalesforceAccount/index.js",
20306     "groupTitle": "Salesforce_Accounts"
20307   },
20308   {
20309     "type": "get",
20310     "url": "/api/integrations/salesforce/accounts/{id}",
20311     "title": "Gets a single Salesforce Account",
20312     "examples": [
20313       {
20314         "title": "Example usage:",
20315         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
20316         "type": "json"
20317       }
20318     ],
20319     "name": "ShowSalesforce_Accounts",
20320     "group": "Salesforce_Accounts",
20321     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20322     "version": "0.0.0",
20323     "filename": "server/api/intSalesforceAccount/index.js",
20324     "groupTitle": "Salesforce_Accounts"
20325   },
20326   {
20327     "type": "post",
20328     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20329     "title": "Creates new configuration",
20330     "examples": [
20331       {
20332         "title": "Example usage:",
20333         "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",
20334         "type": "json"
20335       }
20336     ],
20337     "name": "addConfiguration",
20338     "group": "Salesforce_Accounts",
20339     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20340     "version": "0.0.0",
20341     "filename": "server/api/intSalesforceAccount/index.js",
20342     "groupTitle": "Salesforce_Accounts"
20343   },
20344   {
20345     "type": "get",
20346     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
20347     "title": "Gets account configurations",
20348     "examples": [
20349       {
20350         "title": "Example usage:",
20351         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20352         "type": "json"
20353       }
20354     ],
20355     "name": "getConfigurations",
20356     "group": "Salesforce_Accounts",
20357     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20358     "version": "0.0.0",
20359     "filename": "server/api/intSalesforceAccount/index.js",
20360     "groupTitle": "Salesforce_Accounts"
20361   },
20362   {
20363     "type": "get",
20364     "url": "/api/integrations/salesforce/accounts/{id}/fields",
20365     "title": "Gets account fields",
20366     "examples": [
20367       {
20368         "title": "Example usage:",
20369         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
20370         "type": "json"
20371       }
20372     ],
20373     "name": "getFields",
20374     "group": "Salesforce_Accounts",
20375     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20376     "version": "0.0.0",
20377     "filename": "server/api/intSalesforceAccount/index.js",
20378     "groupTitle": "Salesforce_Accounts"
20379   },
20380   {
20381     "type": "put",
20382     "url": "/api/integrations/salesforce/accounts/{id}",
20383     "title": "Update an existing Salesforce Account",
20384     "examples": [
20385       {
20386         "title": "Example usage:",
20387         "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",
20388         "type": "json"
20389       }
20390     ],
20391     "name": "updateSalesforce_Accounts",
20392     "group": "Salesforce_Accounts",
20393     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20394     "version": "0.0.0",
20395     "filename": "server/api/intSalesforceAccount/index.js",
20396     "groupTitle": "Salesforce_Accounts"
20397   },
20398   {
20399     "type": "post",
20400     "url": "/api/integrations/salesforce/configurations",
20401     "title": "Creates a new Salesforce Configuration",
20402     "examples": [
20403       {
20404         "title": "Example usage:",
20405         "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",
20406         "type": "json"
20407       }
20408     ],
20409     "name": "CreateSalesforce_Configurations",
20410     "group": "Salesforce_Configurations",
20411     "parameter": {
20412       "fields": {
20413         "Body": [
20414           {
20415             "group": "Body",
20416             "type": "String",
20417             "optional": true,
20418             "field": "name",
20419             "description": ""
20420           },
20421           {
20422             "group": "Body",
20423             "type": "String",
20424             "optional": true,
20425             "field": "description",
20426             "description": ""
20427           },
20428           {
20429             "group": "Body",
20430             "type": "String",
20431             "allowedValues": [
20432               "\"Task\"",
20433               "\"Case\""
20434             ],
20435             "optional": true,
20436             "field": "ticketType",
20437             "description": ""
20438           },
20439           {
20440             "group": "Body",
20441             "type": "String",
20442             "allowedValues": [
20443               "\"contact_lead\"",
20444               "\"contact\"",
20445               "\"lead\""
20446             ],
20447             "optional": true,
20448             "field": "moduleSearch",
20449             "description": ""
20450           },
20451           {
20452             "group": "Body",
20453             "type": "String",
20454             "allowedValues": [
20455               "\"nothing\"",
20456               "\"contact\"",
20457               "\"lead\""
20458             ],
20459             "optional": true,
20460             "field": "moduleCreate",
20461             "description": ""
20462           }
20463         ]
20464       }
20465     },
20466     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20467     "version": "0.0.0",
20468     "filename": "server/api/intSalesforceConfiguration/index.js",
20469     "groupTitle": "Salesforce_Configurations"
20470   },
20471   {
20472     "type": "delete",
20473     "url": "/api/integrations/salesforce/configurations/{id}",
20474     "title": "Deletes a Salesforce Configuration",
20475     "examples": [
20476       {
20477         "title": "Example usage:",
20478         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
20479         "type": "json"
20480       }
20481     ],
20482     "name": "DeleteSalesforce_Configurations",
20483     "group": "Salesforce_Configurations",
20484     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20485     "version": "0.0.0",
20486     "filename": "server/api/intSalesforceConfiguration/index.js",
20487     "groupTitle": "Salesforce_Configurations"
20488   },
20489   {
20490     "type": "get",
20491     "url": "/api/integrations/salesforce/configurations",
20492     "title": "Gets a list of Salesforce Configurations",
20493     "examples": [
20494       {
20495         "title": "Example usage:",
20496         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
20497         "type": "json"
20498       }
20499     ],
20500     "name": "GetSalesforce_Configurations",
20501     "group": "Salesforce_Configurations",
20502     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20503     "version": "0.0.0",
20504     "filename": "server/api/intSalesforceConfiguration/index.js",
20505     "groupTitle": "Salesforce_Configurations"
20506   },
20507   {
20508     "type": "get",
20509     "url": "/api/integrations/salesforce/configurations/{id}",
20510     "title": "Gets a single Salesforce Configuration",
20511     "examples": [
20512       {
20513         "title": "Example usage:",
20514         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
20515         "type": "json"
20516       }
20517     ],
20518     "name": "ShowSalesforce_Configurations",
20519     "group": "Salesforce_Configurations",
20520     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20521     "version": "0.0.0",
20522     "filename": "server/api/intSalesforceConfiguration/index.js",
20523     "groupTitle": "Salesforce_Configurations"
20524   },
20525   {
20526     "type": "get",
20527     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
20528     "title": "Gets configurations descriptions",
20529     "examples": [
20530       {
20531         "title": "Example usage:",
20532         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20533         "type": "json"
20534       }
20535     ],
20536     "name": "getDescriptions",
20537     "group": "Salesforce_Configurations",
20538     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20539     "version": "0.0.0",
20540     "filename": "server/api/intSalesforceConfiguration/index.js",
20541     "groupTitle": "Salesforce_Configurations"
20542   },
20543   {
20544     "type": "get",
20545     "url": "/api/integrations/salesforce/configurations/{id}/fields",
20546     "title": "Gets configurations fields",
20547     "examples": [
20548       {
20549         "title": "Example usage:",
20550         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
20551         "type": "json"
20552       }
20553     ],
20554     "name": "getFields",
20555     "group": "Salesforce_Configurations",
20556     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20557     "version": "0.0.0",
20558     "filename": "server/api/intSalesforceConfiguration/index.js",
20559     "groupTitle": "Salesforce_Configurations"
20560   },
20561   {
20562     "type": "get",
20563     "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20564     "title": "Gets configurations subjects",
20565     "examples": [
20566       {
20567         "title": "Example usage:",
20568         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20569         "type": "json"
20570       }
20571     ],
20572     "name": "getSubjects",
20573     "group": "Salesforce_Configurations",
20574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20575     "version": "0.0.0",
20576     "filename": "server/api/intSalesforceConfiguration/index.js",
20577     "groupTitle": "Salesforce_Configurations"
20578   },
20579   {
20580     "type": "put",
20581     "url": "/api/integrations/salesforce/configurations/{id}",
20582     "title": "Update an existing Salesforce Configuration",
20583     "examples": [
20584       {
20585         "title": "Example usage:",
20586         "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",
20587         "type": "json"
20588       }
20589     ],
20590     "name": "updateSalesforce_Configurations",
20591     "group": "Salesforce_Configurations",
20592     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20593     "version": "0.0.0",
20594     "filename": "server/api/intSalesforceConfiguration/index.js",
20595     "groupTitle": "Salesforce_Configurations"
20596   },
20597   {
20598     "type": "post",
20599     "url": "/api/integrations/salesforce/fields",
20600     "title": "Creates a new Salesforce Field",
20601     "examples": [
20602       {
20603         "title": "Example usage:",
20604         "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",
20605         "type": "json"
20606       }
20607     ],
20608     "name": "CreateSalesforce_Fields",
20609     "group": "Salesforce_Fields",
20610     "parameter": {
20611       "fields": {
20612         "Body": [
20613           {
20614             "group": "Body",
20615             "type": "String",
20616             "allowedValues": [
20617               "\"string\"",
20618               "\"variable\"",
20619               "\"customVariable\"",
20620               "\"keyValue\""
20621             ],
20622             "optional": true,
20623             "field": "type",
20624             "description": ""
20625           },
20626           {
20627             "group": "Body",
20628             "type": "String",
20629             "optional": true,
20630             "field": "content",
20631             "description": ""
20632           },
20633           {
20634             "group": "Body",
20635             "type": "String",
20636             "optional": true,
20637             "field": "key",
20638             "description": ""
20639           },
20640           {
20641             "group": "Body",
20642             "type": "String",
20643             "allowedValues": [
20644               "\"string\"",
20645               "\"variable\"",
20646               "\"customVariable\""
20647             ],
20648             "optional": true,
20649             "field": "keyType",
20650             "description": ""
20651           },
20652           {
20653             "group": "Body",
20654             "type": "String",
20655             "optional": true,
20656             "field": "keyContent",
20657             "description": ""
20658           },
20659           {
20660             "group": "Body",
20661             "type": "String",
20662             "optional": true,
20663             "field": "idField",
20664             "description": ""
20665           },
20666           {
20667             "group": "Body",
20668             "type": "String",
20669             "optional": true,
20670             "field": "variableName",
20671             "description": ""
20672           }
20673         ]
20674       }
20675     },
20676     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20677     "version": "0.0.0",
20678     "filename": "server/api/intSalesforceField/index.js",
20679     "groupTitle": "Salesforce_Fields"
20680   },
20681   {
20682     "type": "delete",
20683     "url": "/api/integrations/salesforce/fields/{id}",
20684     "title": "Deletes a Salesforce Field",
20685     "examples": [
20686       {
20687         "title": "Example usage:",
20688         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20689         "type": "json"
20690       }
20691     ],
20692     "name": "DeleteSalesforce_Fields",
20693     "group": "Salesforce_Fields",
20694     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20695     "version": "0.0.0",
20696     "filename": "server/api/intSalesforceField/index.js",
20697     "groupTitle": "Salesforce_Fields"
20698   },
20699   {
20700     "type": "get",
20701     "url": "/api/integrations/salesforce/fields",
20702     "title": "Gets a list of Salesforce Fields",
20703     "examples": [
20704       {
20705         "title": "Example usage:",
20706         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20707         "type": "json"
20708       }
20709     ],
20710     "name": "GetSalesforce_Fields",
20711     "group": "Salesforce_Fields",
20712     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20713     "version": "0.0.0",
20714     "filename": "server/api/intSalesforceField/index.js",
20715     "groupTitle": "Salesforce_Fields"
20716   },
20717   {
20718     "type": "get",
20719     "url": "/api/integrations/salesforce/fields/{id}",
20720     "title": "Gets a single Salesforce Field",
20721     "examples": [
20722       {
20723         "title": "Example usage:",
20724         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20725         "type": "json"
20726       }
20727     ],
20728     "name": "ShowSalesforce_Fields",
20729     "group": "Salesforce_Fields",
20730     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20731     "version": "0.0.0",
20732     "filename": "server/api/intSalesforceField/index.js",
20733     "groupTitle": "Salesforce_Fields"
20734   },
20735   {
20736     "type": "put",
20737     "url": "/api/integrations/salesforce/fields/{id}",
20738     "title": "Update an existing Salesforce Field",
20739     "examples": [
20740       {
20741         "title": "Example usage:",
20742         "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",
20743         "type": "json"
20744       }
20745     ],
20746     "name": "updateSalesforce_Fields",
20747     "group": "Salesforce_Fields",
20748     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20749     "version": "0.0.0",
20750     "filename": "server/api/intSalesforceField/index.js",
20751     "groupTitle": "Salesforce_Fields"
20752   },
20753   {
20754     "type": "post",
20755     "url": "/api/schedules",
20756     "title": "Creates a new Schedule",
20757     "examples": [
20758       {
20759         "title": "Example usage:",
20760         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20761         "type": "json"
20762       }
20763     ],
20764     "name": "CreateSchedules",
20765     "group": "Schedules",
20766     "parameter": {
20767       "fields": {
20768         "Body": [
20769           {
20770             "group": "Body",
20771             "type": "String",
20772             "optional": false,
20773             "field": "name",
20774             "description": ""
20775           },
20776           {
20777             "group": "Body",
20778             "type": "String",
20779             "optional": true,
20780             "field": "description",
20781             "description": ""
20782           },
20783           {
20784             "group": "Body",
20785             "type": "Boolean",
20786             "optional": false,
20787             "field": "active",
20788             "description": ""
20789           },
20790           {
20791             "group": "Body",
20792             "type": "String",
20793             "optional": false,
20794             "field": "cron",
20795             "description": ""
20796           },
20797           {
20798             "group": "Body",
20799             "type": "String",
20800             "optional": false,
20801             "field": "startAt",
20802             "description": ""
20803           },
20804           {
20805             "group": "Body",
20806             "type": "String",
20807             "optional": false,
20808             "field": "endAt",
20809             "description": ""
20810           },
20811           {
20812             "group": "Body",
20813             "type": "Integer",
20814             "optional": false,
20815             "field": "subtractNumber",
20816             "description": ""
20817           },
20818           {
20819             "group": "Body",
20820             "type": "String",
20821             "allowedValues": [
20822               "\"years\"",
20823               "\"quarters\"",
20824               "\"months\"",
20825               "\"weeks\"",
20826               "\"days\"",
20827               "\"hours\"",
20828               "\"minutes\""
20829             ],
20830             "optional": false,
20831             "field": "subtractUnit",
20832             "description": ""
20833           },
20834           {
20835             "group": "Body",
20836             "type": "String",
20837             "allowedValues": [
20838               "\"csv\"",
20839               "\"pdf\"",
20840               "\"xlsx\""
20841             ],
20842             "optional": false,
20843             "field": "output",
20844             "description": ""
20845           },
20846           {
20847             "group": "Body",
20848             "type": "String",
20849             "allowedValues": [
20850               "\"custom\"",
20851               "\"default\""
20852             ],
20853             "optional": false,
20854             "field": "type",
20855             "description": ""
20856           },
20857           {
20858             "group": "Body",
20859             "type": "Boolean",
20860             "optional": true,
20861             "field": "sendMail",
20862             "description": ""
20863           },
20864           {
20865             "group": "Body",
20866             "type": "String",
20867             "optional": true,
20868             "field": "email",
20869             "description": ""
20870           },
20871           {
20872             "group": "Body",
20873             "type": "Text",
20874             "optional": true,
20875             "field": "cc",
20876             "description": ""
20877           },
20878           {
20879             "group": "Body",
20880             "type": "Text",
20881             "optional": true,
20882             "field": "bcc",
20883             "description": ""
20884           },
20885           {
20886             "group": "Body",
20887             "type": "Boolean",
20888             "optional": true,
20889             "field": "sendIfEmpty",
20890             "description": ""
20891           }
20892         ]
20893       }
20894     },
20895     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20896     "version": "0.0.0",
20897     "filename": "server/api/schedule/index.js",
20898     "groupTitle": "Schedules"
20899   },
20900   {
20901     "type": "delete",
20902     "url": "/api/schedules/{id}",
20903     "title": "Deletes a Schedule",
20904     "examples": [
20905       {
20906         "title": "Example usage:",
20907         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
20908         "type": "json"
20909       }
20910     ],
20911     "name": "DeleteSchedules",
20912     "group": "Schedules",
20913     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20914     "version": "0.0.0",
20915     "filename": "server/api/schedule/index.js",
20916     "groupTitle": "Schedules"
20917   },
20918   {
20919     "type": "get",
20920     "url": "/api/schedules",
20921     "title": "Gets a list of Schedules",
20922     "examples": [
20923       {
20924         "title": "Example usage:",
20925         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
20926         "type": "json"
20927       }
20928     ],
20929     "name": "GetSchedules",
20930     "group": "Schedules",
20931     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20932     "version": "0.0.0",
20933     "filename": "server/api/schedule/index.js",
20934     "groupTitle": "Schedules"
20935   },
20936   {
20937     "type": "get",
20938     "url": "/api/schedules/{id}",
20939     "title": "Gets a single Schedule",
20940     "examples": [
20941       {
20942         "title": "Example usage:",
20943         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
20944         "type": "json"
20945       }
20946     ],
20947     "name": "ShowSchedules",
20948     "group": "Schedules",
20949     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20950     "version": "0.0.0",
20951     "filename": "server/api/schedule/index.js",
20952     "groupTitle": "Schedules"
20953   },
20954   {
20955     "type": "get",
20956     "url": "/api/schedules/{id}/run",
20957     "title": "Run Scheduler",
20958     "examples": [
20959       {
20960         "title": "Example usage:",
20961         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
20962         "type": "json"
20963       }
20964     ],
20965     "name": "run",
20966     "group": "Schedules",
20967     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20968     "version": "0.0.0",
20969     "filename": "server/api/schedule/index.js",
20970     "groupTitle": "Schedules"
20971   },
20972   {
20973     "type": "put",
20974     "url": "/api/schedules/{id}",
20975     "title": "Update an existing Schedule",
20976     "examples": [
20977       {
20978         "title": "Example usage:",
20979         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20980         "type": "json"
20981       }
20982     ],
20983     "name": "updateSchedules",
20984     "group": "Schedules",
20985     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20986     "version": "0.0.0",
20987     "filename": "server/api/schedule/index.js",
20988     "groupTitle": "Schedules"
20989   },
20990   {
20991     "type": "post",
20992     "url": "/api/screen/recordings",
20993     "title": "Creates a new Recording",
20994     "examples": [
20995       {
20996         "title": "Example usage:",
20997         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20998         "type": "json"
20999       }
21000     ],
21001     "name": "CreateRecordings",
21002     "group": "Screen_Recordings",
21003     "parameter": {
21004       "fields": {
21005         "Body": [
21006           {
21007             "group": "Body",
21008             "type": "Virtual",
21009             "optional": true,
21010             "field": "format",
21011             "description": ""
21012           },
21013           {
21014             "group": "Body",
21015             "type": "String",
21016             "optional": true,
21017             "field": "interactionid",
21018             "description": ""
21019           },
21020           {
21021             "group": "Body",
21022             "type": "String",
21023             "optional": true,
21024             "field": "channel",
21025             "description": ""
21026           },
21027           {
21028             "group": "Body",
21029             "type": "String",
21030             "optional": true,
21031             "field": "value",
21032             "description": ""
21033           },
21034           {
21035             "group": "Body",
21036             "type": "Integer",
21037             "optional": true,
21038             "field": "rating",
21039             "description": ""
21040           },
21041           {
21042             "group": "Body",
21043             "type": "Integer",
21044             "optional": true,
21045             "field": "duration",
21046             "description": ""
21047           },
21048           {
21049             "group": "Body",
21050             "type": "String",
21051             "optional": true,
21052             "field": "startedAt",
21053             "description": ""
21054           },
21055           {
21056             "group": "Body",
21057             "type": "String",
21058             "optional": true,
21059             "field": "closedAt",
21060             "description": ""
21061           },
21062           {
21063             "group": "Body",
21064             "type": "String",
21065             "optional": true,
21066             "field": "createdAt",
21067             "description": ""
21068           },
21069           {
21070             "group": "Body",
21071             "type": "String",
21072             "optional": true,
21073             "field": "updatedAt",
21074             "description": ""
21075           }
21076         ]
21077       }
21078     },
21079     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21080     "version": "0.0.0",
21081     "filename": "server/api/screenRecording/index.js",
21082     "groupTitle": "Screen_Recordings"
21083   },
21084   {
21085     "type": "get",
21086     "url": "/api/screen/recordings/describe",
21087     "title": "Gets table info about Recordings",
21088     "examples": [
21089       {
21090         "title": "Example usage:",
21091         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
21092         "type": "json"
21093       }
21094     ],
21095     "name": "DescribeRecordings",
21096     "group": "Screen_Recordings",
21097     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21098     "version": "0.0.0",
21099     "filename": "server/api/screenRecording/index.js",
21100     "groupTitle": "Screen_Recordings"
21101   },
21102   {
21103     "type": "get",
21104     "url": "/api/screen/recordings",
21105     "title": "Gets a list of Recordings",
21106     "examples": [
21107       {
21108         "title": "Example usage:",
21109         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
21110         "type": "json"
21111       }
21112     ],
21113     "name": "GetRecordings",
21114     "group": "Screen_Recordings",
21115     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21116     "version": "0.0.0",
21117     "filename": "server/api/screenRecording/index.js",
21118     "groupTitle": "Screen_Recordings"
21119   },
21120   {
21121     "type": "get",
21122     "url": "/api/screen/recordings/{id}",
21123     "title": "Gets a single Recording",
21124     "examples": [
21125       {
21126         "title": "Example usage:",
21127         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
21128         "type": "json"
21129       }
21130     ],
21131     "name": "ShowRecordings",
21132     "group": "Screen_Recordings",
21133     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21134     "version": "0.0.0",
21135     "filename": "server/api/screenRecording/index.js",
21136     "groupTitle": "Screen_Recordings"
21137   },
21138   {
21139     "type": "delete",
21140     "url": "/api/screen/recordings/{id}",
21141     "title": "Delete screen recording",
21142     "examples": [
21143       {
21144         "title": "Example usage:",
21145         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
21146         "type": "json"
21147       }
21148     ],
21149     "name": "destroy",
21150     "group": "Screen_Recordings",
21151     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21152     "version": "0.0.0",
21153     "filename": "server/api/screenRecording/index.js",
21154     "groupTitle": "Screen_Recordings"
21155   },
21156   {
21157     "type": "get",
21158     "url": "/api/screen/recordings/{id}/download",
21159     "title": "Download Recording",
21160     "examples": [
21161       {
21162         "title": "Example usage:",
21163         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
21164         "type": "json"
21165       }
21166     ],
21167     "name": "download",
21168     "group": "Screen_Recordings",
21169     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21170     "version": "0.0.0",
21171     "filename": "server/api/screenRecording/index.js",
21172     "groupTitle": "Screen_Recordings"
21173   },
21174   {
21175     "type": "put",
21176     "url": "/api/screen/recordings/{id}",
21177     "title": "Update an existing Recording",
21178     "examples": [
21179       {
21180         "title": "Example usage:",
21181         "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",
21182         "type": "json"
21183       }
21184     ],
21185     "name": "updateRecordings",
21186     "group": "Screen_Recordings",
21187     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21188     "version": "0.0.0",
21189     "filename": "server/api/screenRecording/index.js",
21190     "groupTitle": "Screen_Recordings"
21191   },
21192   {
21193     "type": "post",
21194     "url": "/api/integrations/servicenow/accounts",
21195     "title": "Creates a new Servicenow Account",
21196     "examples": [
21197       {
21198         "title": "Example usage:",
21199         "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",
21200         "type": "json"
21201       }
21202     ],
21203     "name": "CreateServicenow_Accounts",
21204     "group": "Servicenow_Accounts",
21205     "parameter": {
21206       "fields": {
21207         "Body": [
21208           {
21209             "group": "Body",
21210             "type": "String",
21211             "optional": true,
21212             "field": "name",
21213             "description": ""
21214           },
21215           {
21216             "group": "Body",
21217             "type": "String",
21218             "optional": true,
21219             "field": "description",
21220             "description": ""
21221           },
21222           {
21223             "group": "Body",
21224             "type": "String",
21225             "optional": true,
21226             "field": "username",
21227             "description": ""
21228           },
21229           {
21230             "group": "Body",
21231             "type": "String",
21232             "optional": true,
21233             "field": "password",
21234             "description": ""
21235           },
21236           {
21237             "group": "Body",
21238             "type": "String",
21239             "optional": true,
21240             "field": "email",
21241             "description": ""
21242           },
21243           {
21244             "group": "Body",
21245             "type": "String",
21246             "optional": true,
21247             "field": "remoteUri",
21248             "description": ""
21249           },
21250           {
21251             "group": "Body",
21252             "type": "String",
21253             "optional": true,
21254             "field": "serverUrl",
21255             "description": ""
21256           }
21257         ]
21258       }
21259     },
21260     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21261     "version": "0.0.0",
21262     "filename": "server/api/intServicenowAccount/index.js",
21263     "groupTitle": "Servicenow_Accounts"
21264   },
21265   {
21266     "type": "delete",
21267     "url": "/api/integrations/servicenow/accounts/{id}",
21268     "title": "Deletes a Servicenow Account",
21269     "examples": [
21270       {
21271         "title": "Example usage:",
21272         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
21273         "type": "json"
21274       }
21275     ],
21276     "name": "DeleteServicenow_Accounts",
21277     "group": "Servicenow_Accounts",
21278     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21279     "version": "0.0.0",
21280     "filename": "server/api/intServicenowAccount/index.js",
21281     "groupTitle": "Servicenow_Accounts"
21282   },
21283   {
21284     "type": "get",
21285     "url": "/api/integrations/servicenow/accounts",
21286     "title": "Gets a list of Servicenow Accounts",
21287     "examples": [
21288       {
21289         "title": "Example usage:",
21290         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
21291         "type": "json"
21292       }
21293     ],
21294     "name": "GetServicenow_Accounts",
21295     "group": "Servicenow_Accounts",
21296     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/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>",
21297     "version": "0.0.0",
21298     "filename": "server/api/intServicenowAccount/index.js",
21299     "groupTitle": "Servicenow_Accounts"
21300   },
21301   {
21302     "type": "get",
21303     "url": "/api/integrations/servicenow/accounts/{id}",
21304     "title": "Gets a single Servicenow Account",
21305     "examples": [
21306       {
21307         "title": "Example usage:",
21308         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
21309         "type": "json"
21310       }
21311     ],
21312     "name": "ShowServicenow_Accounts",
21313     "group": "Servicenow_Accounts",
21314     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21315     "version": "0.0.0",
21316     "filename": "server/api/intServicenowAccount/index.js",
21317     "groupTitle": "Servicenow_Accounts"
21318   },
21319   {
21320     "type": "post",
21321     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21322     "title": "Creates new configuration",
21323     "examples": [
21324       {
21325         "title": "Example usage:",
21326         "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",
21327         "type": "json"
21328       }
21329     ],
21330     "name": "addConfiguration",
21331     "group": "Servicenow_Accounts",
21332     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21333     "version": "0.0.0",
21334     "filename": "server/api/intServicenowAccount/index.js",
21335     "groupTitle": "Servicenow_Accounts"
21336   },
21337   {
21338     "type": "get",
21339     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
21340     "title": "Gets account configurations",
21341     "examples": [
21342       {
21343         "title": "Example usage:",
21344         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
21345         "type": "json"
21346       }
21347     ],
21348     "name": "getConfigurations",
21349     "group": "Servicenow_Accounts",
21350     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21351     "version": "0.0.0",
21352     "filename": "server/api/intServicenowAccount/index.js",
21353     "groupTitle": "Servicenow_Accounts"
21354   },
21355   {
21356     "type": "get",
21357     "url": "/api/integrations/servicenow/accounts/{id}/fields",
21358     "title": "Gets account fields",
21359     "examples": [
21360       {
21361         "title": "Example usage:",
21362         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
21363         "type": "json"
21364       }
21365     ],
21366     "name": "getFields",
21367     "group": "Servicenow_Accounts",
21368     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21369     "version": "0.0.0",
21370     "filename": "server/api/intServicenowAccount/index.js",
21371     "groupTitle": "Servicenow_Accounts"
21372   },
21373   {
21374     "type": "put",
21375     "url": "/api/integrations/servicenow/accounts/{id}",
21376     "title": "Update an existing Servicenow Account",
21377     "examples": [
21378       {
21379         "title": "Example usage:",
21380         "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",
21381         "type": "json"
21382       }
21383     ],
21384     "name": "updateServicenow_Accounts",
21385     "group": "Servicenow_Accounts",
21386     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21387     "version": "0.0.0",
21388     "filename": "server/api/intServicenowAccount/index.js",
21389     "groupTitle": "Servicenow_Accounts"
21390   },
21391   {
21392     "type": "post",
21393     "url": "/api/integrations/servicenow/configurations",
21394     "title": "Creates a new Servicenow Configuration",
21395     "examples": [
21396       {
21397         "title": "Example usage:",
21398         "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",
21399         "type": "json"
21400       }
21401     ],
21402     "name": "CreateServicenow_Configurations",
21403     "group": "Servicenow_Configurations",
21404     "parameter": {
21405       "fields": {
21406         "Body": [
21407           {
21408             "group": "Body",
21409             "type": "String",
21410             "optional": true,
21411             "field": "name",
21412             "description": ""
21413           },
21414           {
21415             "group": "Body",
21416             "type": "String",
21417             "optional": true,
21418             "field": "description",
21419             "description": ""
21420           }
21421         ]
21422       }
21423     },
21424     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21425     "version": "0.0.0",
21426     "filename": "server/api/intServicenowConfiguration/index.js",
21427     "groupTitle": "Servicenow_Configurations"
21428   },
21429   {
21430     "type": "delete",
21431     "url": "/api/integrations/servicenow/configurations/{id}",
21432     "title": "Deletes a Servicenow Configuration",
21433     "examples": [
21434       {
21435         "title": "Example usage:",
21436         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
21437         "type": "json"
21438       }
21439     ],
21440     "name": "DeleteServicenow_Configurations",
21441     "group": "Servicenow_Configurations",
21442     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21443     "version": "0.0.0",
21444     "filename": "server/api/intServicenowConfiguration/index.js",
21445     "groupTitle": "Servicenow_Configurations"
21446   },
21447   {
21448     "type": "get",
21449     "url": "/api/integrations/servicenow/configurations",
21450     "title": "Gets a list of Servicenow Configurations",
21451     "examples": [
21452       {
21453         "title": "Example usage:",
21454         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
21455         "type": "json"
21456       }
21457     ],
21458     "name": "GetServicenow_Configurations",
21459     "group": "Servicenow_Configurations",
21460     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21461     "version": "0.0.0",
21462     "filename": "server/api/intServicenowConfiguration/index.js",
21463     "groupTitle": "Servicenow_Configurations"
21464   },
21465   {
21466     "type": "get",
21467     "url": "/api/integrations/servicenow/configurations/{id}",
21468     "title": "Gets a single Servicenow Configuration",
21469     "examples": [
21470       {
21471         "title": "Example usage:",
21472         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
21473         "type": "json"
21474       }
21475     ],
21476     "name": "ShowServicenow_Configurations",
21477     "group": "Servicenow_Configurations",
21478     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21479     "version": "0.0.0",
21480     "filename": "server/api/intServicenowConfiguration/index.js",
21481     "groupTitle": "Servicenow_Configurations"
21482   },
21483   {
21484     "type": "get",
21485     "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
21486     "title": "Gets configurations descriptions",
21487     "examples": [
21488       {
21489         "title": "Example usage:",
21490         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
21491         "type": "json"
21492       }
21493     ],
21494     "name": "getDescriptions",
21495     "group": "Servicenow_Configurations",
21496     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21497     "version": "0.0.0",
21498     "filename": "server/api/intServicenowConfiguration/index.js",
21499     "groupTitle": "Servicenow_Configurations"
21500   },
21501   {
21502     "type": "get",
21503     "url": "/api/integrations/servicenow/configurations/{id}/fields",
21504     "title": "Gets configurations fields",
21505     "examples": [
21506       {
21507         "title": "Example usage:",
21508         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
21509         "type": "json"
21510       }
21511     ],
21512     "name": "getFields",
21513     "group": "Servicenow_Configurations",
21514     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21515     "version": "0.0.0",
21516     "filename": "server/api/intServicenowConfiguration/index.js",
21517     "groupTitle": "Servicenow_Configurations"
21518   },
21519   {
21520     "type": "get",
21521     "url": "/api/integrations/servicenow/configurations/{id}/subjects",
21522     "title": "Gets configurations subjects",
21523     "examples": [
21524       {
21525         "title": "Example usage:",
21526         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
21527         "type": "json"
21528       }
21529     ],
21530     "name": "getSubjects",
21531     "group": "Servicenow_Configurations",
21532     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21533     "version": "0.0.0",
21534     "filename": "server/api/intServicenowConfiguration/index.js",
21535     "groupTitle": "Servicenow_Configurations"
21536   },
21537   {
21538     "type": "put",
21539     "url": "/api/integrations/servicenow/configurations/{id}",
21540     "title": "Update an existing Servicenow Configuration",
21541     "examples": [
21542       {
21543         "title": "Example usage:",
21544         "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",
21545         "type": "json"
21546       }
21547     ],
21548     "name": "updateServicenow_Configurations",
21549     "group": "Servicenow_Configurations",
21550     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21551     "version": "0.0.0",
21552     "filename": "server/api/intServicenowConfiguration/index.js",
21553     "groupTitle": "Servicenow_Configurations"
21554   },
21555   {
21556     "type": "post",
21557     "url": "/api/integrations/servicenow/fields",
21558     "title": "Creates a new Servicenow Field",
21559     "examples": [
21560       {
21561         "title": "Example usage:",
21562         "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",
21563         "type": "json"
21564       }
21565     ],
21566     "name": "CreateServicenow_Fields",
21567     "group": "Servicenow_Fields",
21568     "parameter": {
21569       "fields": {
21570         "Body": [
21571           {
21572             "group": "Body",
21573             "type": "String",
21574             "allowedValues": [
21575               "\"string\"",
21576               "\"variable\"",
21577               "\"customVariable\"",
21578               "\"keyValue\""
21579             ],
21580             "optional": true,
21581             "field": "type",
21582             "description": ""
21583           },
21584           {
21585             "group": "Body",
21586             "type": "String",
21587             "optional": true,
21588             "field": "content",
21589             "description": ""
21590           },
21591           {
21592             "group": "Body",
21593             "type": "String",
21594             "optional": true,
21595             "field": "key",
21596             "description": ""
21597           },
21598           {
21599             "group": "Body",
21600             "type": "String",
21601             "allowedValues": [
21602               "\"string\"",
21603               "\"variable\"",
21604               "\"customVariable\""
21605             ],
21606             "optional": true,
21607             "field": "keyType",
21608             "description": ""
21609           },
21610           {
21611             "group": "Body",
21612             "type": "String",
21613             "optional": true,
21614             "field": "keyContent",
21615             "description": ""
21616           },
21617           {
21618             "group": "Body",
21619             "type": "String",
21620             "optional": true,
21621             "field": "idField",
21622             "description": ""
21623           },
21624           {
21625             "group": "Body",
21626             "type": "String",
21627             "optional": true,
21628             "field": "nameField",
21629             "description": ""
21630           },
21631           {
21632             "group": "Body",
21633             "type": "Boolean",
21634             "optional": true,
21635             "field": "customField",
21636             "description": ""
21637           },
21638           {
21639             "group": "Body",
21640             "type": "String",
21641             "optional": true,
21642             "field": "variableName",
21643             "description": ""
21644           }
21645         ]
21646       }
21647     },
21648     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21649     "version": "0.0.0",
21650     "filename": "server/api/intServicenowField/index.js",
21651     "groupTitle": "Servicenow_Fields"
21652   },
21653   {
21654     "type": "delete",
21655     "url": "/api/integrations/servicenow/fields/{id}",
21656     "title": "Deletes a Servicenow Field",
21657     "examples": [
21658       {
21659         "title": "Example usage:",
21660         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21661         "type": "json"
21662       }
21663     ],
21664     "name": "DeleteServicenow_Fields",
21665     "group": "Servicenow_Fields",
21666     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21667     "version": "0.0.0",
21668     "filename": "server/api/intServicenowField/index.js",
21669     "groupTitle": "Servicenow_Fields"
21670   },
21671   {
21672     "type": "get",
21673     "url": "/api/integrations/servicenow/fields",
21674     "title": "Gets a list of Servicenow Fields",
21675     "examples": [
21676       {
21677         "title": "Example usage:",
21678         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21679         "type": "json"
21680       }
21681     ],
21682     "name": "GetServicenow_Fields",
21683     "group": "Servicenow_Fields",
21684     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21685     "version": "0.0.0",
21686     "filename": "server/api/intServicenowField/index.js",
21687     "groupTitle": "Servicenow_Fields"
21688   },
21689   {
21690     "type": "get",
21691     "url": "/api/integrations/servicenow/fields/{id}",
21692     "title": "Gets a single Servicenow Field",
21693     "examples": [
21694       {
21695         "title": "Example usage:",
21696         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21697         "type": "json"
21698       }
21699     ],
21700     "name": "ShowServicenow_Fields",
21701     "group": "Servicenow_Fields",
21702     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21703     "version": "0.0.0",
21704     "filename": "server/api/intServicenowField/index.js",
21705     "groupTitle": "Servicenow_Fields"
21706   },
21707   {
21708     "type": "put",
21709     "url": "/api/integrations/servicenow/fields/{id}",
21710     "title": "Update an existing Servicenow Field",
21711     "examples": [
21712       {
21713         "title": "Example usage:",
21714         "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",
21715         "type": "json"
21716       }
21717     ],
21718     "name": "updateServicenow_Fields",
21719     "group": "Servicenow_Fields",
21720     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21721     "version": "0.0.0",
21722     "filename": "server/api/intServicenowField/index.js",
21723     "groupTitle": "Servicenow_Fields"
21724   },
21725   {
21726     "type": "get",
21727     "url": "/api/settings",
21728     "title": "Gets a list of Settings",
21729     "examples": [
21730       {
21731         "title": "Example usage:",
21732         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21733         "type": "json"
21734       }
21735     ],
21736     "name": "GetSettings",
21737     "group": "Settings",
21738     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21739     "version": "0.0.0",
21740     "filename": "server/api/setting/index.js",
21741     "groupTitle": "Settings"
21742   },
21743   {
21744     "type": "get",
21745     "url": "/api/settings/{id}",
21746     "title": "Gets a single Setting",
21747     "examples": [
21748       {
21749         "title": "Example usage:",
21750         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21751         "type": "json"
21752       }
21753     ],
21754     "name": "ShowSettings",
21755     "group": "Settings",
21756     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21757     "version": "0.0.0",
21758     "filename": "server/api/setting/index.js",
21759     "groupTitle": "Settings"
21760   },
21761   {
21762     "type": "post",
21763     "url": "/api/settings/{id}/favicon",
21764     "title": "Add Favicon",
21765     "examples": [
21766       {
21767         "title": "Example usage:",
21768         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21769         "type": "json"
21770       }
21771     ],
21772     "name": "addFavicon",
21773     "group": "Settings",
21774     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21775     "version": "0.0.0",
21776     "filename": "server/api/setting/index.js",
21777     "groupTitle": "Settings"
21778   },
21779   {
21780     "type": "post",
21781     "url": "/api/settings/{id}/logo",
21782     "title": "Add logo",
21783     "examples": [
21784       {
21785         "title": "Example usage:",
21786         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21787         "type": "json"
21788       }
21789     ],
21790     "name": "addLogo",
21791     "group": "Settings",
21792     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21793     "version": "0.0.0",
21794     "filename": "server/api/setting/index.js",
21795     "groupTitle": "Settings"
21796   },
21797   {
21798     "type": "post",
21799     "url": "/api/settings/{id}/logo_login",
21800     "title": "Add logo login",
21801     "examples": [
21802       {
21803         "title": "Example usage:",
21804         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21805         "type": "json"
21806       }
21807     ],
21808     "name": "addLogoLogin",
21809     "group": "Settings",
21810     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21811     "version": "0.0.0",
21812     "filename": "server/api/setting/index.js",
21813     "groupTitle": "Settings"
21814   },
21815   {
21816     "type": "post",
21817     "url": "/api/settings/{id}/preferred",
21818     "title": "Add Preferred",
21819     "examples": [
21820       {
21821         "title": "Example usage:",
21822         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21823         "type": "json"
21824       }
21825     ],
21826     "name": "addPreferred",
21827     "group": "Settings",
21828     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21829     "version": "0.0.0",
21830     "filename": "server/api/setting/index.js",
21831     "groupTitle": "Settings"
21832   },
21833   {
21834     "type": "get",
21835     "url": "/api/settings/{id}/favicon",
21836     "title": "Get Favicon",
21837     "examples": [
21838       {
21839         "title": "Example usage:",
21840         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21841         "type": "json"
21842       }
21843     ],
21844     "name": "getFavicon",
21845     "group": "Settings",
21846     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21847     "version": "0.0.0",
21848     "filename": "server/api/setting/index.js",
21849     "groupTitle": "Settings"
21850   },
21851   {
21852     "type": "get",
21853     "url": "/api/settings/{id}/gdpr",
21854     "title": "Get gdpr settings",
21855     "examples": [
21856       {
21857         "title": "Example usage:",
21858         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
21859         "type": "json"
21860       }
21861     ],
21862     "name": "getGdpr",
21863     "group": "Settings",
21864     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21865     "version": "0.0.0",
21866     "filename": "server/api/setting/index.js",
21867     "groupTitle": "Settings"
21868   },
21869   {
21870     "type": "get",
21871     "url": "/api/settings/{id}/logo",
21872     "title": "Get logo",
21873     "examples": [
21874       {
21875         "title": "Example usage:",
21876         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
21877         "type": "json"
21878       }
21879     ],
21880     "name": "getLogo",
21881     "group": "Settings",
21882     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21883     "version": "0.0.0",
21884     "filename": "server/api/setting/index.js",
21885     "groupTitle": "Settings"
21886   },
21887   {
21888     "type": "get",
21889     "url": "/api/settings/{id}/logo_login",
21890     "title": "Get logo login",
21891     "examples": [
21892       {
21893         "title": "Example usage:",
21894         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
21895         "type": "json"
21896       }
21897     ],
21898     "name": "getLogoLogin",
21899     "group": "Settings",
21900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21901     "version": "0.0.0",
21902     "filename": "server/api/setting/index.js",
21903     "groupTitle": "Settings"
21904   },
21905   {
21906     "type": "get",
21907     "url": "/api/settings/{id}/preferred",
21908     "title": "Get Preferred",
21909     "examples": [
21910       {
21911         "title": "Example usage:",
21912         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
21913         "type": "json"
21914       }
21915     ],
21916     "name": "getPreferred",
21917     "group": "Settings",
21918     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21919     "version": "0.0.0",
21920     "filename": "server/api/setting/index.js",
21921     "groupTitle": "Settings"
21922   },
21923   {
21924     "type": "put",
21925     "url": "/api/settings/{id}",
21926     "title": "Update an existing Setting",
21927     "examples": [
21928       {
21929         "title": "Example usage:",
21930         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21931         "type": "json"
21932       }
21933     ],
21934     "name": "updateSettings",
21935     "group": "Settings",
21936     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21937     "version": "0.0.0",
21938     "filename": "server/api/setting/index.js",
21939     "groupTitle": "Settings"
21940   },
21941   {
21942     "type": "post",
21943     "url": "/api/sms/accounts/{id}/users",
21944     "title": "Add agents to a sms account",
21945     "examples": [
21946       {
21947         "title": "Example usage:",
21948         "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",
21949         "type": "json"
21950       }
21951     ],
21952     "name": "AddAgents",
21953     "group": "Sms_Accounts",
21954     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21955     "version": "0.0.0",
21956     "filename": "server/api/smsAccount/index.js",
21957     "groupTitle": "Sms_Accounts"
21958   },
21959   {
21960     "type": "post",
21961     "url": "/api/sms/accounts",
21962     "title": "Creates a new Account",
21963     "examples": [
21964       {
21965         "title": "Example usage:",
21966         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21967         "type": "json"
21968       }
21969     ],
21970     "name": "CreateAccounts",
21971     "group": "Sms_Accounts",
21972     "parameter": {
21973       "fields": {
21974         "Body": [
21975           {
21976             "group": "Body",
21977             "type": "String",
21978             "optional": false,
21979             "field": "name",
21980             "description": ""
21981           },
21982           {
21983             "group": "Body",
21984             "type": "String",
21985             "optional": false,
21986             "field": "key",
21987             "description": ""
21988           },
21989           {
21990             "group": "Body",
21991             "type": "String",
21992             "optional": false,
21993             "field": "remote",
21994             "description": ""
21995           },
21996           {
21997             "group": "Body",
21998             "type": "String",
21999             "optional": true,
22000             "field": "token",
22001             "description": ""
22002           },
22003           {
22004             "group": "Body",
22005             "type": "String",
22006             "optional": true,
22007             "field": "phone",
22008             "description": ""
22009           },
22010           {
22011             "group": "Body",
22012             "type": "String",
22013             "allowedValues": [
22014               "\"twilio\"",
22015               "\"skebby\"",
22016               "\"connectel\"",
22017               "\"clicksend\"",
22018               "\"plivo\"",
22019               "\"clickatell\"",
22020               "\"csc\"",
22021               "\"infobip\"",
22022               "\"intelepeer\""
22023             ],
22024             "optional": true,
22025             "field": "type",
22026             "description": ""
22027           },
22028           {
22029             "group": "Body",
22030             "type": "String",
22031             "optional": true,
22032             "field": "accountSid",
22033             "description": ""
22034           },
22035           {
22036             "group": "Body",
22037             "type": "String",
22038             "optional": true,
22039             "field": "authId",
22040             "description": ""
22041           },
22042           {
22043             "group": "Body",
22044             "type": "String",
22045             "optional": true,
22046             "field": "authToken",
22047             "description": ""
22048           },
22049           {
22050             "group": "Body",
22051             "type": "String",
22052             "allowedValues": [
22053               "\"SI\"",
22054               "\"TI\"",
22055               "\"GP\""
22056             ],
22057             "optional": true,
22058             "field": "smsMethod",
22059             "description": ""
22060           },
22061           {
22062             "group": "Body",
22063             "type": "String",
22064             "optional": true,
22065             "field": "username",
22066             "description": ""
22067           },
22068           {
22069             "group": "Body",
22070             "type": "String",
22071             "optional": true,
22072             "field": "password",
22073             "description": ""
22074           },
22075           {
22076             "group": "Body",
22077             "type": "String",
22078             "optional": true,
22079             "field": "apiKey",
22080             "description": ""
22081           },
22082           {
22083             "group": "Body",
22084             "type": "String",
22085             "optional": true,
22086             "field": "senderString",
22087             "description": ""
22088           },
22089           {
22090             "group": "Body",
22091             "type": "Boolean",
22092             "optional": true,
22093             "field": "deliveryReport",
22094             "description": ""
22095           },
22096           {
22097             "group": "Body",
22098             "type": "String",
22099             "optional": true,
22100             "field": "description",
22101             "description": ""
22102           },
22103           {
22104             "group": "Body",
22105             "type": "Text",
22106             "optional": true,
22107             "field": "notificationTemplate",
22108             "description": ""
22109           },
22110           {
22111             "group": "Body",
22112             "type": "Boolean",
22113             "optional": true,
22114             "field": "notificationSound",
22115             "description": ""
22116           },
22117           {
22118             "group": "Body",
22119             "type": "Boolean",
22120             "optional": true,
22121             "field": "notificationShake",
22122             "description": ""
22123           },
22124           {
22125             "group": "Body",
22126             "type": "Integer",
22127             "optional": true,
22128             "field": "waitForTheAssignedAgent",
22129             "description": ""
22130           },
22131           {
22132             "group": "Body",
22133             "type": "Boolean",
22134             "optional": true,
22135             "field": "queueTransfer",
22136             "description": ""
22137           },
22138           {
22139             "group": "Body",
22140             "type": "Integer",
22141             "optional": true,
22142             "field": "queueTransferTimeout",
22143             "description": ""
22144           },
22145           {
22146             "group": "Body",
22147             "type": "Boolean",
22148             "optional": true,
22149             "field": "agentTransfer",
22150             "description": ""
22151           },
22152           {
22153             "group": "Body",
22154             "type": "Integer",
22155             "optional": true,
22156             "field": "agentTransferTimeout",
22157             "description": ""
22158           },
22159           {
22160             "group": "Body",
22161             "type": "String",
22162             "optional": true,
22163             "field": "baseUrl",
22164             "description": ""
22165           },
22166           {
22167             "group": "Body",
22168             "type": "Integer",
22169             "optional": true,
22170             "field": "mandatoryDispositionPauseId",
22171             "description": "<p>Status to put when mandatory disposition is enabled</p>"
22172           },
22173           {
22174             "group": "Body",
22175             "type": "Boolean",
22176             "optional": true,
22177             "field": "mandatoryDisposition",
22178             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
22179           }
22180         ]
22181       }
22182     },
22183     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22184     "version": "0.0.0",
22185     "filename": "server/api/smsAccount/index.js",
22186     "groupTitle": "Sms_Accounts"
22187   },
22188   {
22189     "type": "delete",
22190     "url": "/api/sms/accounts/{id}",
22191     "title": "Deletes a Account",
22192     "examples": [
22193       {
22194         "title": "Example usage:",
22195         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
22196         "type": "json"
22197       }
22198     ],
22199     "name": "DeleteAccounts",
22200     "group": "Sms_Accounts",
22201     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22202     "version": "0.0.0",
22203     "filename": "server/api/smsAccount/index.js",
22204     "groupTitle": "Sms_Accounts"
22205   },
22206   {
22207     "type": "get",
22208     "url": "/api/sms/accounts/describe",
22209     "title": "Gets table info about Accounts",
22210     "examples": [
22211       {
22212         "title": "Example usage:",
22213         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
22214         "type": "json"
22215       }
22216     ],
22217     "name": "DescribeAccounts",
22218     "group": "Sms_Accounts",
22219     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22220     "version": "0.0.0",
22221     "filename": "server/api/smsAccount/index.js",
22222     "groupTitle": "Sms_Accounts"
22223   },
22224   {
22225     "type": "get",
22226     "url": "/api/sms/accounts",
22227     "title": "Gets a list of Accounts",
22228     "examples": [
22229       {
22230         "title": "Example usage:",
22231         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
22232         "type": "json"
22233       }
22234     ],
22235     "name": "GetAccounts",
22236     "group": "Sms_Accounts",
22237     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22238     "version": "0.0.0",
22239     "filename": "server/api/smsAccount/index.js",
22240     "groupTitle": "Sms_Accounts"
22241   },
22242   {
22243     "type": "get",
22244     "url": "/api/sms/accounts/{id}/users",
22245     "title": "Gets agents from sms account",
22246     "examples": [
22247       {
22248         "title": "Example usage:",
22249         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
22250         "type": "json"
22251       }
22252     ],
22253     "name": "GetAgents",
22254     "group": "Sms_Accounts",
22255     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22256     "version": "0.0.0",
22257     "filename": "server/api/smsAccount/index.js",
22258     "groupTitle": "Sms_Accounts"
22259   },
22260   {
22261     "type": "delete",
22262     "url": "/api/sms/accounts/{id}/users",
22263     "title": "Removes agents from a sms account",
22264     "examples": [
22265       {
22266         "title": "Example usage:",
22267         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22268         "type": "json"
22269       }
22270     ],
22271     "name": "RemoveAgents",
22272     "group": "Sms_Accounts",
22273     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22274     "version": "0.0.0",
22275     "filename": "server/api/smsAccount/index.js",
22276     "groupTitle": "Sms_Accounts"
22277   },
22278   {
22279     "type": "delete",
22280     "url": "/api/sms/accounts/{id}/canned_answers",
22281     "title": "Removes canned answers from account",
22282     "examples": [
22283       {
22284         "title": "Example usage:",
22285         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22286         "type": "json"
22287       }
22288     ],
22289     "name": "RemoveAnswers",
22290     "group": "Sms_Accounts",
22291     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22292     "version": "0.0.0",
22293     "filename": "server/api/smsAccount/index.js",
22294     "groupTitle": "Sms_Accounts"
22295   },
22296   {
22297     "type": "delete",
22298     "url": "/api/sms/accounts/{id}/dispositions",
22299     "title": "Removes dispositions from account",
22300     "examples": [
22301       {
22302         "title": "Example usage:",
22303         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22304         "type": "json"
22305       }
22306     ],
22307     "name": "RemoveDispositions",
22308     "group": "Sms_Accounts",
22309     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22310     "version": "0.0.0",
22311     "filename": "server/api/smsAccount/index.js",
22312     "groupTitle": "Sms_Accounts"
22313   },
22314   {
22315     "type": "get",
22316     "url": "/api/sms/accounts/{id}",
22317     "title": "Gets a single Account",
22318     "examples": [
22319       {
22320         "title": "Example usage:",
22321         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
22322         "type": "json"
22323       }
22324     ],
22325     "name": "ShowAccounts",
22326     "group": "Sms_Accounts",
22327     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22328     "version": "0.0.0",
22329     "filename": "server/api/smsAccount/index.js",
22330     "groupTitle": "Sms_Accounts"
22331   },
22332   {
22333     "type": "put",
22334     "url": "/api/sms/messages/{id}/accept",
22335     "title": "Accepts message",
22336     "examples": [
22337       {
22338         "title": "Example usage:",
22339         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22340         "type": "json"
22341       }
22342     ],
22343     "name": "acceptMessage",
22344     "group": "Sms_Accounts",
22345     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22346     "version": "0.0.0",
22347     "filename": "server/api/smsMessage/index.js",
22348     "groupTitle": "Sms_Accounts"
22349   },
22350   {
22351     "type": "post",
22352     "url": "/api/sms/accounts/{id}/canned_answers",
22353     "title": "Creates new canned answer",
22354     "examples": [
22355       {
22356         "title": "Example usage:",
22357         "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",
22358         "type": "json"
22359       }
22360     ],
22361     "name": "addAnswer",
22362     "group": "Sms_Accounts",
22363     "parameter": {
22364       "fields": {
22365         "Body": [
22366           {
22367             "group": "Body",
22368             "type": "String",
22369             "optional": false,
22370             "field": "key",
22371             "description": ""
22372           },
22373           {
22374             "group": "Body",
22375             "type": "Text",
22376             "optional": false,
22377             "field": "value",
22378             "description": ""
22379           },
22380           {
22381             "group": "Body",
22382             "type": "String",
22383             "optional": true,
22384             "field": "description",
22385             "description": ""
22386           },
22387           {
22388             "group": "Body",
22389             "type": "Virtual",
22390             "optional": true,
22391             "field": "name",
22392             "description": ""
22393           }
22394         ]
22395       }
22396     },
22397     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22398     "version": "0.0.0",
22399     "filename": "server/api/smsAccount/index.js",
22400     "groupTitle": "Sms_Accounts"
22401   },
22402   {
22403     "type": "post",
22404     "url": "/api/sms/accounts/{id}/applications",
22405     "title": "Creates new applications",
22406     "examples": [
22407       {
22408         "title": "Example usage:",
22409         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22410         "type": "json"
22411       }
22412     ],
22413     "name": "addApplications",
22414     "group": "Sms_Accounts",
22415     "parameter": {
22416       "fields": {
22417         "Body": [
22418           {
22419             "group": "Body",
22420             "type": "Integer",
22421             "optional": false,
22422             "field": "priority",
22423             "description": ""
22424           },
22425           {
22426             "group": "Body",
22427             "type": "String",
22428             "optional": false,
22429             "field": "app",
22430             "description": ""
22431           },
22432           {
22433             "group": "Body",
22434             "type": "Text",
22435             "optional": true,
22436             "field": "appdata",
22437             "description": ""
22438           },
22439           {
22440             "group": "Body",
22441             "type": "String",
22442             "optional": true,
22443             "field": "description",
22444             "description": ""
22445           },
22446           {
22447             "group": "Body",
22448             "type": "String",
22449             "optional": true,
22450             "field": "interval",
22451             "description": ""
22452           }
22453         ]
22454       }
22455     },
22456     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22457     "version": "0.0.0",
22458     "filename": "server/api/smsAccount/index.js",
22459     "groupTitle": "Sms_Accounts"
22460   },
22461   {
22462     "type": "post",
22463     "url": "/api/sms/accounts/{id}/dispositions",
22464     "title": "Creates new disposition",
22465     "examples": [
22466       {
22467         "title": "Example usage:",
22468         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22469         "type": "json"
22470       }
22471     ],
22472     "name": "addDisposition",
22473     "group": "Sms_Accounts",
22474     "parameter": {
22475       "fields": {
22476         "Body": [
22477           {
22478             "group": "Body",
22479             "type": "String",
22480             "optional": false,
22481             "field": "name",
22482             "description": ""
22483           },
22484           {
22485             "group": "Body",
22486             "type": "String",
22487             "allowedValues": [
22488               "\"first\"",
22489               "\"second\"",
22490               "\"third\""
22491             ],
22492             "optional": false,
22493             "field": "level",
22494             "description": ""
22495           },
22496           {
22497             "group": "Body",
22498             "type": "String",
22499             "optional": true,
22500             "field": "description",
22501             "description": ""
22502           }
22503         ]
22504       }
22505     },
22506     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22507     "version": "0.0.0",
22508     "filename": "server/api/smsAccount/index.js",
22509     "groupTitle": "Sms_Accounts"
22510   },
22511   {
22512     "type": "get",
22513     "url": "/api/sms/accounts/{id}/canned_answers",
22514     "title": "Gets account canned answers",
22515     "examples": [
22516       {
22517         "title": "Example usage:",
22518         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
22519         "type": "json"
22520       }
22521     ],
22522     "name": "getAnswers",
22523     "group": "Sms_Accounts",
22524     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22525     "version": "0.0.0",
22526     "filename": "server/api/smsAccount/index.js",
22527     "groupTitle": "Sms_Accounts"
22528   },
22529   {
22530     "type": "get",
22531     "url": "/api/sms/accounts/{id}/applications",
22532     "title": "Gets account applications",
22533     "examples": [
22534       {
22535         "title": "Example usage:",
22536         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
22537         "type": "json"
22538       }
22539     ],
22540     "name": "getApplications",
22541     "group": "Sms_Accounts",
22542     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22543     "version": "0.0.0",
22544     "filename": "server/api/smsAccount/index.js",
22545     "groupTitle": "Sms_Accounts"
22546   },
22547   {
22548     "type": "get",
22549     "url": "/api/sms/accounts/{id}/dispositions",
22550     "title": "Gets account dispositions",
22551     "examples": [
22552       {
22553         "title": "Example usage:",
22554         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
22555         "type": "json"
22556       }
22557     ],
22558     "name": "getDispositions",
22559     "group": "Sms_Accounts",
22560     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22561     "version": "0.0.0",
22562     "filename": "server/api/smsAccount/index.js",
22563     "groupTitle": "Sms_Accounts"
22564   },
22565   {
22566     "type": "get",
22567     "url": "/api/sms/accounts/{id}/interactions",
22568     "title": "Gets Sms Account interactions",
22569     "examples": [
22570       {
22571         "title": "Example usage:",
22572         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
22573         "type": "json"
22574       }
22575     ],
22576     "name": "getInteractions",
22577     "group": "Sms_Accounts",
22578     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22579     "version": "0.0.0",
22580     "filename": "server/api/smsAccount/index.js",
22581     "groupTitle": "Sms_Accounts"
22582   },
22583   {
22584     "type": "post",
22585     "url": "/api/sms/accounts/{id}/notify",
22586     "title": "Notify new message",
22587     "examples": [
22588       {
22589         "title": "Example usage:",
22590         "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",
22591         "type": "json"
22592       }
22593     ],
22594     "name": "notify",
22595     "group": "Sms_Accounts",
22596     "description": "<p>Motion 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>",
22597     "version": "0.0.0",
22598     "filename": "server/api/smsAccount/index.js",
22599     "groupTitle": "Sms_Accounts"
22600   },
22601   {
22602     "type": "put",
22603     "url": "/api/sms/messages/{id}/reject",
22604     "title": "Rejects message",
22605     "examples": [
22606       {
22607         "title": "Example usage:",
22608         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22609         "type": "json"
22610       }
22611     ],
22612     "name": "rejectMessage",
22613     "group": "Sms_Accounts",
22614     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22615     "version": "0.0.0",
22616     "filename": "server/api/smsMessage/index.js",
22617     "groupTitle": "Sms_Accounts"
22618   },
22619   {
22620     "type": "post",
22621     "url": "/api/sms/accounts/{id}/send",
22622     "title": "Send new sms message",
22623     "examples": [
22624       {
22625         "title": "Example usage:",
22626         "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",
22627         "type": "json"
22628       }
22629     ],
22630     "name": "sendSms",
22631     "group": "Sms_Accounts",
22632     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22633     "version": "0.0.0",
22634     "filename": "server/api/smsAccount/index.js",
22635     "groupTitle": "Sms_Accounts"
22636   },
22637   {
22638     "type": "post",
22639     "url": "/api/sms/messages/{id}/status",
22640     "title": "Receive message status",
22641     "examples": [
22642       {
22643         "title": "Example usage:",
22644         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22645         "type": "json"
22646       }
22647     ],
22648     "name": "statusMessage",
22649     "group": "Sms_Accounts",
22650     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22651     "version": "0.0.0",
22652     "filename": "server/api/smsMessage/index.js",
22653     "groupTitle": "Sms_Accounts"
22654   },
22655   {
22656     "type": "post",
22657     "url": "/api/sms/accounts/{id}/status",
22658     "title": "Receive message status",
22659     "examples": [
22660       {
22661         "title": "Example usage:",
22662         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22663         "type": "json"
22664       }
22665     ],
22666     "name": "statusMessage",
22667     "group": "Sms_Accounts",
22668     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22669     "version": "0.0.0",
22670     "filename": "server/api/smsAccount/index.js",
22671     "groupTitle": "Sms_Accounts"
22672   },
22673   {
22674     "type": "get",
22675     "url": "/api/sms/accounts/{id}/status",
22676     "title": "Receive message status as get request",
22677     "examples": [
22678       {
22679         "title": "Example usage:",
22680         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22681         "type": "json"
22682       }
22683     ],
22684     "name": "statusMessage",
22685     "group": "Sms_Accounts",
22686     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22687     "version": "0.0.0",
22688     "filename": "server/api/smsAccount/index.js",
22689     "groupTitle": "Sms_Accounts"
22690   },
22691   {
22692     "type": "put",
22693     "url": "/api/sms/accounts/{id}",
22694     "title": "Update an existing Account",
22695     "examples": [
22696       {
22697         "title": "Example usage:",
22698         "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",
22699         "type": "json"
22700       }
22701     ],
22702     "name": "updateAccounts",
22703     "group": "Sms_Accounts",
22704     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22705     "version": "0.0.0",
22706     "filename": "server/api/smsAccount/index.js",
22707     "groupTitle": "Sms_Accounts"
22708   },
22709   {
22710     "type": "post",
22711     "url": "/api/sms/applications",
22712     "title": "Creates a new Application",
22713     "examples": [
22714       {
22715         "title": "Example usage:",
22716         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22717         "type": "json"
22718       }
22719     ],
22720     "name": "CreateApplications",
22721     "group": "Sms_Applications",
22722     "parameter": {
22723       "fields": {
22724         "Body": [
22725           {
22726             "group": "Body",
22727             "type": "Integer",
22728             "optional": false,
22729             "field": "priority",
22730             "description": ""
22731           },
22732           {
22733             "group": "Body",
22734             "type": "String",
22735             "optional": false,
22736             "field": "app",
22737             "description": ""
22738           },
22739           {
22740             "group": "Body",
22741             "type": "Text",
22742             "optional": true,
22743             "field": "appdata",
22744             "description": ""
22745           },
22746           {
22747             "group": "Body",
22748             "type": "String",
22749             "optional": true,
22750             "field": "description",
22751             "description": ""
22752           },
22753           {
22754             "group": "Body",
22755             "type": "String",
22756             "optional": true,
22757             "field": "interval",
22758             "description": ""
22759           }
22760         ]
22761       }
22762     },
22763     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22764     "version": "0.0.0",
22765     "filename": "server/api/smsApplication/index.js",
22766     "groupTitle": "Sms_Applications"
22767   },
22768   {
22769     "type": "delete",
22770     "url": "/api/sms/applications/{id}",
22771     "title": "Deletes a Application",
22772     "examples": [
22773       {
22774         "title": "Example usage:",
22775         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22776         "type": "json"
22777       }
22778     ],
22779     "name": "DeleteApplications",
22780     "group": "Sms_Applications",
22781     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22782     "version": "0.0.0",
22783     "filename": "server/api/smsApplication/index.js",
22784     "groupTitle": "Sms_Applications"
22785   },
22786   {
22787     "type": "get",
22788     "url": "/api/sms/applications",
22789     "title": "Gets a list of Applications",
22790     "examples": [
22791       {
22792         "title": "Example usage:",
22793         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22794         "type": "json"
22795       }
22796     ],
22797     "name": "GetApplications",
22798     "group": "Sms_Applications",
22799     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22800     "version": "0.0.0",
22801     "filename": "server/api/smsApplication/index.js",
22802     "groupTitle": "Sms_Applications"
22803   },
22804   {
22805     "type": "get",
22806     "url": "/api/sms/applications/{id}",
22807     "title": "Gets a single Application",
22808     "examples": [
22809       {
22810         "title": "Example usage:",
22811         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22812         "type": "json"
22813       }
22814     ],
22815     "name": "ShowApplications",
22816     "group": "Sms_Applications",
22817     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22818     "version": "0.0.0",
22819     "filename": "server/api/smsApplication/index.js",
22820     "groupTitle": "Sms_Applications"
22821   },
22822   {
22823     "type": "put",
22824     "url": "/api/sms/applications/{id}",
22825     "title": "Update an existing Application",
22826     "examples": [
22827       {
22828         "title": "Example usage:",
22829         "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",
22830         "type": "json"
22831       }
22832     ],
22833     "name": "updateApplications",
22834     "group": "Sms_Applications",
22835     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22836     "version": "0.0.0",
22837     "filename": "server/api/smsApplication/index.js",
22838     "groupTitle": "Sms_Applications"
22839   },
22840   {
22841     "type": "post",
22842     "url": "/api/sms/interactions/{id}/tags",
22843     "title": "Add tags to the interaction",
22844     "examples": [
22845       {
22846         "title": "Example usage:",
22847         "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",
22848         "type": "json"
22849       }
22850     ],
22851     "name": "AddTags",
22852     "group": "Sms_Interactions",
22853     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22854     "version": "0.0.0",
22855     "filename": "server/api/smsInteraction/index.js",
22856     "groupTitle": "Sms_Interactions"
22857   },
22858   {
22859     "type": "post",
22860     "url": "/api/sms/interactions",
22861     "title": "Creates a new Interaction",
22862     "examples": [
22863       {
22864         "title": "Example usage:",
22865         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22866         "type": "json"
22867       }
22868     ],
22869     "name": "CreateInteractions",
22870     "group": "Sms_Interactions",
22871     "parameter": {
22872       "fields": {
22873         "Body": [
22874           {
22875             "group": "Body",
22876             "type": "Boolean",
22877             "optional": true,
22878             "field": "closed",
22879             "description": ""
22880           },
22881           {
22882             "group": "Body",
22883             "type": "String",
22884             "optional": true,
22885             "field": "closedAt",
22886             "description": ""
22887           },
22888           {
22889             "group": "Body",
22890             "type": "String",
22891             "optional": true,
22892             "field": "disposition",
22893             "description": ""
22894           },
22895           {
22896             "group": "Body",
22897             "type": "String",
22898             "optional": true,
22899             "field": "secondDisposition",
22900             "description": ""
22901           },
22902           {
22903             "group": "Body",
22904             "type": "String",
22905             "optional": true,
22906             "field": "thirdDisposition",
22907             "description": ""
22908           },
22909           {
22910             "group": "Body",
22911             "type": "String",
22912             "optional": true,
22913             "field": "note",
22914             "description": ""
22915           },
22916           {
22917             "group": "Body",
22918             "type": "String",
22919             "optional": true,
22920             "field": "phone",
22921             "description": ""
22922           },
22923           {
22924             "group": "Body",
22925             "type": "String",
22926             "optional": true,
22927             "field": "read1stAt",
22928             "description": ""
22929           },
22930           {
22931             "group": "Body",
22932             "type": "String",
22933             "allowedValues": [
22934               "\"in\"",
22935               "\"out\""
22936             ],
22937             "optional": false,
22938             "field": "firstMsgDirection",
22939             "description": ""
22940           },
22941           {
22942             "group": "Body",
22943             "type": "String",
22944             "optional": true,
22945             "field": "lastMsgAt",
22946             "description": ""
22947           },
22948           {
22949             "group": "Body",
22950             "type": "String",
22951             "allowedValues": [
22952               "\"in\"",
22953               "\"out\""
22954             ],
22955             "optional": false,
22956             "field": "lastMsgDirection",
22957             "description": ""
22958           }
22959         ]
22960       }
22961     },
22962     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22963     "version": "0.0.0",
22964     "filename": "server/api/smsInteraction/index.js",
22965     "groupTitle": "Sms_Interactions"
22966   },
22967   {
22968     "type": "delete",
22969     "url": "/api/sms/interactions/{id}",
22970     "title": "Deletes a Interaction",
22971     "examples": [
22972       {
22973         "title": "Example usage:",
22974         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
22975         "type": "json"
22976       }
22977     ],
22978     "name": "DeleteInteractions",
22979     "group": "Sms_Interactions",
22980     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22981     "version": "0.0.0",
22982     "filename": "server/api/smsInteraction/index.js",
22983     "groupTitle": "Sms_Interactions"
22984   },
22985   {
22986     "type": "get",
22987     "url": "/api/sms/interactions/describe",
22988     "title": "Gets table info about Interactions",
22989     "examples": [
22990       {
22991         "title": "Example usage:",
22992         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
22993         "type": "json"
22994       }
22995     ],
22996     "name": "DescribeInteractions",
22997     "group": "Sms_Interactions",
22998     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22999     "version": "0.0.0",
23000     "filename": "server/api/smsInteraction/index.js",
23001     "groupTitle": "Sms_Interactions"
23002   },
23003   {
23004     "type": "get",
23005     "url": "/api/sms/interactions",
23006     "title": "Gets a list of Interactions",
23007     "examples": [
23008       {
23009         "title": "Example usage:",
23010         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
23011         "type": "json"
23012       }
23013     ],
23014     "name": "GetInteractions",
23015     "group": "Sms_Interactions",
23016     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23017     "version": "0.0.0",
23018     "filename": "server/api/smsInteraction/index.js",
23019     "groupTitle": "Sms_Interactions"
23020   },
23021   {
23022     "type": "delete",
23023     "url": "/api/sms/interactions/{id}/tags",
23024     "title": "Removes tags from interaction",
23025     "examples": [
23026       {
23027         "title": "Example usage:",
23028         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23029         "type": "json"
23030       }
23031     ],
23032     "name": "RemoveTags",
23033     "group": "Sms_Interactions",
23034     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23035     "version": "0.0.0",
23036     "filename": "server/api/smsInteraction/index.js",
23037     "groupTitle": "Sms_Interactions"
23038   },
23039   {
23040     "type": "get",
23041     "url": "/api/sms/interactions/{id}",
23042     "title": "Gets a single Interaction",
23043     "examples": [
23044       {
23045         "title": "Example usage:",
23046         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
23047         "type": "json"
23048       }
23049     ],
23050     "name": "ShowInteractions",
23051     "group": "Sms_Interactions",
23052     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23053     "version": "0.0.0",
23054     "filename": "server/api/smsInteraction/index.js",
23055     "groupTitle": "Sms_Interactions"
23056   },
23057   {
23058     "type": "post",
23059     "url": "/api/sms/interactions/{id}/messages",
23060     "title": "Creates new messages",
23061     "examples": [
23062       {
23063         "title": "Example usage:",
23064         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
23065         "type": "json"
23066       }
23067     ],
23068     "name": "addMessage",
23069     "group": "Sms_Interactions",
23070     "parameter": {
23071       "fields": {
23072         "Body": [
23073           {
23074             "group": "Body",
23075             "type": "Text",
23076             "optional": false,
23077             "field": "body",
23078             "description": ""
23079           },
23080           {
23081             "group": "Body",
23082             "type": "Boolean",
23083             "optional": true,
23084             "field": "read",
23085             "description": ""
23086           },
23087           {
23088             "group": "Body",
23089             "type": "String",
23090             "allowedValues": [
23091               "\"in\"",
23092               "\"out\""
23093             ],
23094             "optional": false,
23095             "field": "direction",
23096             "description": ""
23097           },
23098           {
23099             "group": "Body",
23100             "type": "String",
23101             "optional": true,
23102             "field": "messageId",
23103             "description": ""
23104           },
23105           {
23106             "group": "Body",
23107             "type": "String",
23108             "optional": true,
23109             "field": "phone",
23110             "description": ""
23111           },
23112           {
23113             "group": "Body",
23114             "type": "String",
23115             "optional": true,
23116             "field": "readAt",
23117             "description": ""
23118           },
23119           {
23120             "group": "Body",
23121             "type": "Boolean",
23122             "optional": true,
23123             "field": "secret",
23124             "description": ""
23125           }
23126         ]
23127       }
23128     },
23129     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23130     "version": "0.0.0",
23131     "filename": "server/api/smsInteraction/index.js",
23132     "groupTitle": "Sms_Interactions"
23133   },
23134   {
23135     "type": "get",
23136     "url": "/api/sms/interactions/{id}/download",
23137     "title": "Gets interaction",
23138     "examples": [
23139       {
23140         "title": "Example usage:",
23141         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
23142         "type": "json"
23143       }
23144     ],
23145     "name": "download",
23146     "group": "Sms_Interactions",
23147     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23148     "version": "0.0.0",
23149     "filename": "server/api/smsInteraction/index.js",
23150     "groupTitle": "Sms_Interactions"
23151   },
23152   {
23153     "type": "get",
23154     "url": "/api/sms/interactions/{id}/messages",
23155     "title": "Gets interaction messages",
23156     "examples": [
23157       {
23158         "title": "Example usage:",
23159         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
23160         "type": "json"
23161       }
23162     ],
23163     "name": "getMessages",
23164     "group": "Sms_Interactions",
23165     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23166     "version": "0.0.0",
23167     "filename": "server/api/smsInteraction/index.js",
23168     "groupTitle": "Sms_Interactions"
23169   },
23170   {
23171     "type": "put",
23172     "url": "/api/sms/interactions/{id}",
23173     "title": "Update an existing Interaction",
23174     "examples": [
23175       {
23176         "title": "Example usage:",
23177         "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",
23178         "type": "json"
23179       }
23180     ],
23181     "name": "updateInteractions",
23182     "group": "Sms_Interactions",
23183     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23184     "version": "0.0.0",
23185     "filename": "server/api/smsInteraction/index.js",
23186     "groupTitle": "Sms_Interactions"
23187   },
23188   {
23189     "type": "post",
23190     "url": "/api/sms/messages",
23191     "title": "Creates a new Message",
23192     "examples": [
23193       {
23194         "title": "Example usage:",
23195         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23196         "type": "json"
23197       }
23198     ],
23199     "name": "CreateMessages",
23200     "group": "Sms_Messages",
23201     "parameter": {
23202       "fields": {
23203         "Body": [
23204           {
23205             "group": "Body",
23206             "type": "Text",
23207             "optional": false,
23208             "field": "body",
23209             "description": ""
23210           },
23211           {
23212             "group": "Body",
23213             "type": "Boolean",
23214             "optional": true,
23215             "field": "read",
23216             "description": ""
23217           },
23218           {
23219             "group": "Body",
23220             "type": "String",
23221             "allowedValues": [
23222               "\"in\"",
23223               "\"out\""
23224             ],
23225             "optional": false,
23226             "field": "direction",
23227             "description": ""
23228           },
23229           {
23230             "group": "Body",
23231             "type": "String",
23232             "optional": true,
23233             "field": "messageId",
23234             "description": ""
23235           },
23236           {
23237             "group": "Body",
23238             "type": "String",
23239             "optional": true,
23240             "field": "phone",
23241             "description": ""
23242           },
23243           {
23244             "group": "Body",
23245             "type": "String",
23246             "optional": true,
23247             "field": "readAt",
23248             "description": ""
23249           },
23250           {
23251             "group": "Body",
23252             "type": "Boolean",
23253             "optional": true,
23254             "field": "secret",
23255             "description": ""
23256           }
23257         ]
23258       }
23259     },
23260     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23261     "version": "0.0.0",
23262     "filename": "server/api/smsMessage/index.js",
23263     "groupTitle": "Sms_Messages"
23264   },
23265   {
23266     "type": "delete",
23267     "url": "/api/sms/messages/{id}",
23268     "title": "Deletes a Message",
23269     "examples": [
23270       {
23271         "title": "Example usage:",
23272         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
23273         "type": "json"
23274       }
23275     ],
23276     "name": "DeleteMessages",
23277     "group": "Sms_Messages",
23278     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23279     "version": "0.0.0",
23280     "filename": "server/api/smsMessage/index.js",
23281     "groupTitle": "Sms_Messages"
23282   },
23283   {
23284     "type": "get",
23285     "url": "/api/sms/messages/describe",
23286     "title": "Gets table info about Messages",
23287     "examples": [
23288       {
23289         "title": "Example usage:",
23290         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
23291         "type": "json"
23292       }
23293     ],
23294     "name": "DescribeMessages",
23295     "group": "Sms_Messages",
23296     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23297     "version": "0.0.0",
23298     "filename": "server/api/smsMessage/index.js",
23299     "groupTitle": "Sms_Messages"
23300   },
23301   {
23302     "type": "get",
23303     "url": "/api/sms/messages",
23304     "title": "Gets a list of Messages",
23305     "examples": [
23306       {
23307         "title": "Example usage:",
23308         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
23309         "type": "json"
23310       }
23311     ],
23312     "name": "GetMessages",
23313     "group": "Sms_Messages",
23314     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23315     "version": "0.0.0",
23316     "filename": "server/api/smsMessage/index.js",
23317     "groupTitle": "Sms_Messages"
23318   },
23319   {
23320     "type": "get",
23321     "url": "/api/sms/messages/{id}",
23322     "title": "Gets a single Message",
23323     "examples": [
23324       {
23325         "title": "Example usage:",
23326         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
23327         "type": "json"
23328       }
23329     ],
23330     "name": "ShowMessages",
23331     "group": "Sms_Messages",
23332     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23333     "version": "0.0.0",
23334     "filename": "server/api/smsMessage/index.js",
23335     "groupTitle": "Sms_Messages"
23336   },
23337   {
23338     "type": "put",
23339     "url": "/api/sms/messages/{id}",
23340     "title": "Update an existing Message",
23341     "examples": [
23342       {
23343         "title": "Example usage:",
23344         "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",
23345         "type": "json"
23346       }
23347     ],
23348     "name": "updateMessages",
23349     "group": "Sms_Messages",
23350     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23351     "version": "0.0.0",
23352     "filename": "server/api/smsMessage/index.js",
23353     "groupTitle": "Sms_Messages"
23354   },
23355   {
23356     "type": "post",
23357     "url": "/api/sms/reports/queue",
23358     "title": "Creates a new Sms Queue Report",
23359     "examples": [
23360       {
23361         "title": "Example usage:",
23362         "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",
23363         "type": "json"
23364       }
23365     ],
23366     "name": "CreateSms_Queue_Reports",
23367     "group": "Sms_Queue_Reports",
23368     "parameter": {
23369       "fields": {
23370         "Body": [
23371           {
23372             "group": "Body",
23373             "type": "String",
23374             "optional": false,
23375             "field": "uniqueid",
23376             "description": ""
23377           },
23378           {
23379             "group": "Body",
23380             "type": "String",
23381             "optional": true,
23382             "field": "from",
23383             "description": ""
23384           },
23385           {
23386             "group": "Body",
23387             "type": "String",
23388             "optional": true,
23389             "field": "joinAt",
23390             "description": ""
23391           },
23392           {
23393             "group": "Body",
23394             "type": "String",
23395             "optional": true,
23396             "field": "leaveAt",
23397             "description": ""
23398           },
23399           {
23400             "group": "Body",
23401             "type": "String",
23402             "optional": true,
23403             "field": "acceptAt",
23404             "description": ""
23405           },
23406           {
23407             "group": "Body",
23408             "type": "String",
23409             "optional": true,
23410             "field": "exitAt",
23411             "description": ""
23412           },
23413           {
23414             "group": "Body",
23415             "type": "String",
23416             "optional": true,
23417             "field": "reason",
23418             "description": ""
23419           }
23420         ]
23421       }
23422     },
23423     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23424     "version": "0.0.0",
23425     "filename": "server/api/smsQueueReport/index.js",
23426     "groupTitle": "Sms_Queue_Reports"
23427   },
23428   {
23429     "type": "delete",
23430     "url": "/api/sms/reports/queue/{id}",
23431     "title": "Deletes a Sms Queue Report",
23432     "examples": [
23433       {
23434         "title": "Example usage:",
23435         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
23436         "type": "json"
23437       }
23438     ],
23439     "name": "DeleteSms_Queue_Reports",
23440     "group": "Sms_Queue_Reports",
23441     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23442     "version": "0.0.0",
23443     "filename": "server/api/smsQueueReport/index.js",
23444     "groupTitle": "Sms_Queue_Reports"
23445   },
23446   {
23447     "type": "get",
23448     "url": "/api/sms/reports/queue/describe",
23449     "title": "Gets table info about Sms Queue Reports",
23450     "examples": [
23451       {
23452         "title": "Example usage:",
23453         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
23454         "type": "json"
23455       }
23456     ],
23457     "name": "DescribeSms_Queue_Reports",
23458     "group": "Sms_Queue_Reports",
23459     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23460     "version": "0.0.0",
23461     "filename": "server/api/smsQueueReport/index.js",
23462     "groupTitle": "Sms_Queue_Reports"
23463   },
23464   {
23465     "type": "get",
23466     "url": "/api/sms/reports/queue",
23467     "title": "Gets a list of Sms Queue Reports",
23468     "examples": [
23469       {
23470         "title": "Example usage:",
23471         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
23472         "type": "json"
23473       }
23474     ],
23475     "name": "GetSms_Queue_Reports",
23476     "group": "Sms_Queue_Reports",
23477     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23478     "version": "0.0.0",
23479     "filename": "server/api/smsQueueReport/index.js",
23480     "groupTitle": "Sms_Queue_Reports"
23481   },
23482   {
23483     "type": "get",
23484     "url": "/api/sms/reports/queue/{id}",
23485     "title": "Gets a single Sms Queue Report",
23486     "examples": [
23487       {
23488         "title": "Example usage:",
23489         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
23490         "type": "json"
23491       }
23492     ],
23493     "name": "ShowSms_Queue_Reports",
23494     "group": "Sms_Queue_Reports",
23495     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23496     "version": "0.0.0",
23497     "filename": "server/api/smsQueueReport/index.js",
23498     "groupTitle": "Sms_Queue_Reports"
23499   },
23500   {
23501     "type": "put",
23502     "url": "/api/sms/reports/queue/{id}",
23503     "title": "Update an existing Sms Queue Report",
23504     "examples": [
23505       {
23506         "title": "Example usage:",
23507         "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",
23508         "type": "json"
23509       }
23510     ],
23511     "name": "updateSms_Queue_Reports",
23512     "group": "Sms_Queue_Reports",
23513     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23514     "version": "0.0.0",
23515     "filename": "server/api/smsQueueReport/index.js",
23516     "groupTitle": "Sms_Queue_Reports"
23517   },
23518   {
23519     "type": "post",
23520     "url": "/api/sms/queues/{id}/users",
23521     "title": "Add agents to a queue",
23522     "examples": [
23523       {
23524         "title": "Example usage:",
23525         "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",
23526         "type": "json"
23527       }
23528     ],
23529     "name": "AddAgents",
23530     "group": "Sms_Queues",
23531     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23532     "version": "0.0.0",
23533     "filename": "server/api/smsQueue/index.js",
23534     "groupTitle": "Sms_Queues"
23535   },
23536   {
23537     "type": "post",
23538     "url": "/api/sms/queues/{id}/teams",
23539     "title": "Add teams to a queue",
23540     "examples": [
23541       {
23542         "title": "Example usage:",
23543         "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",
23544         "type": "json"
23545       }
23546     ],
23547     "name": "AddTeams",
23548     "group": "Sms_Queues",
23549     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23550     "version": "0.0.0",
23551     "filename": "server/api/smsQueue/index.js",
23552     "groupTitle": "Sms_Queues"
23553   },
23554   {
23555     "type": "post",
23556     "url": "/api/sms/queues",
23557     "title": "Creates a new Queue",
23558     "examples": [
23559       {
23560         "title": "Example usage:",
23561         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23562         "type": "json"
23563       }
23564     ],
23565     "name": "CreateQueues",
23566     "group": "Sms_Queues",
23567     "parameter": {
23568       "fields": {
23569         "Body": [
23570           {
23571             "group": "Body",
23572             "type": "String",
23573             "optional": true,
23574             "field": "name",
23575             "description": ""
23576           },
23577           {
23578             "group": "Body",
23579             "type": "String",
23580             "optional": true,
23581             "field": "description",
23582             "description": ""
23583           },
23584           {
23585             "group": "Body",
23586             "type": "Integer",
23587             "optional": true,
23588             "field": "timeout",
23589             "description": ""
23590           },
23591           {
23592             "group": "Body",
23593             "type": "String",
23594             "allowedValues": [
23595               "\"rrmemory\"",
23596               "\"beepall\"",
23597               "\"roundrobin\""
23598             ],
23599             "optional": true,
23600             "field": "strategy",
23601             "description": ""
23602           }
23603         ]
23604       }
23605     },
23606     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23607     "version": "0.0.0",
23608     "filename": "server/api/smsQueue/index.js",
23609     "groupTitle": "Sms_Queues"
23610   },
23611   {
23612     "type": "delete",
23613     "url": "/api/sms/queues/{id}",
23614     "title": "Deletes a Queue",
23615     "examples": [
23616       {
23617         "title": "Example usage:",
23618         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23619         "type": "json"
23620       }
23621     ],
23622     "name": "DeleteQueues",
23623     "group": "Sms_Queues",
23624     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23625     "version": "0.0.0",
23626     "filename": "server/api/smsQueue/index.js",
23627     "groupTitle": "Sms_Queues"
23628   },
23629   {
23630     "type": "get",
23631     "url": "/api/sms/queues/describe",
23632     "title": "Gets table info about Queues",
23633     "examples": [
23634       {
23635         "title": "Example usage:",
23636         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23637         "type": "json"
23638       }
23639     ],
23640     "name": "DescribeQueues",
23641     "group": "Sms_Queues",
23642     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23643     "version": "0.0.0",
23644     "filename": "server/api/smsQueue/index.js",
23645     "groupTitle": "Sms_Queues"
23646   },
23647   {
23648     "type": "get",
23649     "url": "/api/sms/queues/{id}/users",
23650     "title": "Gets queue agents",
23651     "examples": [
23652       {
23653         "title": "Example usage:",
23654         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23655         "type": "json"
23656       }
23657     ],
23658     "name": "GetAgents",
23659     "group": "Sms_Queues",
23660     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23661     "version": "0.0.0",
23662     "filename": "server/api/smsQueue/index.js",
23663     "groupTitle": "Sms_Queues"
23664   },
23665   {
23666     "type": "get",
23667     "url": "/api/sms/queues/{id}/members",
23668     "title": "GetMembers",
23669     "examples": [
23670       {
23671         "title": "Example usage:",
23672         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
23673         "type": "json"
23674       }
23675     ],
23676     "name": "GetMembers",
23677     "group": "Sms_Queues",
23678     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23679     "version": "0.0.0",
23680     "filename": "server/api/smsQueue/index.js",
23681     "groupTitle": "Sms_Queues"
23682   },
23683   {
23684     "type": "get",
23685     "url": "/api/sms/queues",
23686     "title": "Gets a list of Queues",
23687     "examples": [
23688       {
23689         "title": "Example usage:",
23690         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23691         "type": "json"
23692       }
23693     ],
23694     "name": "GetQueues",
23695     "group": "Sms_Queues",
23696     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23697     "version": "0.0.0",
23698     "filename": "server/api/smsQueue/index.js",
23699     "groupTitle": "Sms_Queues"
23700   },
23701   {
23702     "type": "get",
23703     "url": "/api/sms/queues/{id}/teams",
23704     "title": "Gets queues list",
23705     "examples": [
23706       {
23707         "title": "Example usage:",
23708         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23709         "type": "json"
23710       }
23711     ],
23712     "name": "GetTeams",
23713     "group": "Sms_Queues",
23714     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23715     "version": "0.0.0",
23716     "filename": "server/api/smsQueue/index.js",
23717     "groupTitle": "Sms_Queues"
23718   },
23719   {
23720     "type": "delete",
23721     "url": "/api/sms/queues/{id}/users",
23722     "title": "Removes agents from a queue",
23723     "examples": [
23724       {
23725         "title": "Example usage:",
23726         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23727         "type": "json"
23728       }
23729     ],
23730     "name": "RemoveAgents",
23731     "group": "Sms_Queues",
23732     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23733     "version": "0.0.0",
23734     "filename": "server/api/smsQueue/index.js",
23735     "groupTitle": "Sms_Queues"
23736   },
23737   {
23738     "type": "get",
23739     "url": "/api/sms/queues/{id}",
23740     "title": "Gets a single Queue",
23741     "examples": [
23742       {
23743         "title": "Example usage:",
23744         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23745         "type": "json"
23746       }
23747     ],
23748     "name": "ShowQueues",
23749     "group": "Sms_Queues",
23750     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23751     "version": "0.0.0",
23752     "filename": "server/api/smsQueue/index.js",
23753     "groupTitle": "Sms_Queues"
23754   },
23755   {
23756     "type": "put",
23757     "url": "/api/sms/queues/{id}",
23758     "title": "Update an existing Queue",
23759     "examples": [
23760       {
23761         "title": "Example usage:",
23762         "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",
23763         "type": "json"
23764       }
23765     ],
23766     "name": "updateQueues",
23767     "group": "Sms_Queues",
23768     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23769     "version": "0.0.0",
23770     "filename": "server/api/smsQueue/index.js",
23771     "groupTitle": "Sms_Queues"
23772   },
23773   {
23774     "type": "post",
23775     "url": "/api/sms/reports/transfer",
23776     "title": "Creates a new Sms Transfer Report",
23777     "examples": [
23778       {
23779         "title": "Example usage:",
23780         "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",
23781         "type": "json"
23782       }
23783     ],
23784     "name": "CreateSms_Transfer_Reports",
23785     "group": "Sms_Transfer_Reports",
23786     "parameter": {
23787       "fields": {
23788         "Body": [
23789           {
23790             "group": "Body",
23791             "type": "String",
23792             "optional": false,
23793             "field": "uniqueid",
23794             "description": ""
23795           },
23796           {
23797             "group": "Body",
23798             "type": "String",
23799             "allowedValues": [
23800               "\"account\"",
23801               "\"agent\"",
23802               "\"queue\""
23803             ],
23804             "optional": false,
23805             "field": "type",
23806             "description": ""
23807           },
23808           {
23809             "group": "Body",
23810             "type": "String",
23811             "optional": false,
23812             "field": "transferredAt",
23813             "description": ""
23814           }
23815         ]
23816       }
23817     },
23818     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23819     "version": "0.0.0",
23820     "filename": "server/api/smsTransferReport/index.js",
23821     "groupTitle": "Sms_Transfer_Reports"
23822   },
23823   {
23824     "type": "delete",
23825     "url": "/api/sms/reports/transfer/{id}",
23826     "title": "Deletes a Sms Transfer Report",
23827     "examples": [
23828       {
23829         "title": "Example usage:",
23830         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
23831         "type": "json"
23832       }
23833     ],
23834     "name": "DeleteSms_Transfer_Reports",
23835     "group": "Sms_Transfer_Reports",
23836     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23837     "version": "0.0.0",
23838     "filename": "server/api/smsTransferReport/index.js",
23839     "groupTitle": "Sms_Transfer_Reports"
23840   },
23841   {
23842     "type": "get",
23843     "url": "/api/sms/reports/transfer/describe",
23844     "title": "Gets table info about Sms Transfer Reports",
23845     "examples": [
23846       {
23847         "title": "Example usage:",
23848         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
23849         "type": "json"
23850       }
23851     ],
23852     "name": "DescribeSms_Transfer_Reports",
23853     "group": "Sms_Transfer_Reports",
23854     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23855     "version": "0.0.0",
23856     "filename": "server/api/smsTransferReport/index.js",
23857     "groupTitle": "Sms_Transfer_Reports"
23858   },
23859   {
23860     "type": "get",
23861     "url": "/api/sms/reports/transfer",
23862     "title": "Gets a list of Sms Transfer Reports",
23863     "examples": [
23864       {
23865         "title": "Example usage:",
23866         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
23867         "type": "json"
23868       }
23869     ],
23870     "name": "GetSms_Transfer_Reports",
23871     "group": "Sms_Transfer_Reports",
23872     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23873     "version": "0.0.0",
23874     "filename": "server/api/smsTransferReport/index.js",
23875     "groupTitle": "Sms_Transfer_Reports"
23876   },
23877   {
23878     "type": "get",
23879     "url": "/api/sms/reports/transfer/{id}",
23880     "title": "Gets a single Sms Transfer Report",
23881     "examples": [
23882       {
23883         "title": "Example usage:",
23884         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
23885         "type": "json"
23886       }
23887     ],
23888     "name": "ShowSms_Transfer_Reports",
23889     "group": "Sms_Transfer_Reports",
23890     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23891     "version": "0.0.0",
23892     "filename": "server/api/smsTransferReport/index.js",
23893     "groupTitle": "Sms_Transfer_Reports"
23894   },
23895   {
23896     "type": "put",
23897     "url": "/api/sms/reports/transfer/{id}",
23898     "title": "Update an existing Sms Transfer Report",
23899     "examples": [
23900       {
23901         "title": "Example usage:",
23902         "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",
23903         "type": "json"
23904       }
23905     ],
23906     "name": "updateSms_Transfer_Reports",
23907     "group": "Sms_Transfer_Reports",
23908     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23909     "version": "0.0.0",
23910     "filename": "server/api/smsTransferReport/index.js",
23911     "groupTitle": "Sms_Transfer_Reports"
23912   },
23913   {
23914     "type": "get",
23915     "url": "/api/sounds",
23916     "title": "Gets a list of Sounds",
23917     "examples": [
23918       {
23919         "title": "Example usage:",
23920         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
23921         "type": "json"
23922       }
23923     ],
23924     "name": "GetSounds",
23925     "group": "Sounds",
23926     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23927     "version": "0.0.0",
23928     "filename": "server/api/sound/index.js",
23929     "groupTitle": "Sounds"
23930   },
23931   {
23932     "type": "get",
23933     "url": "/api/sounds/{id}",
23934     "title": "Gets a single Sound",
23935     "examples": [
23936       {
23937         "title": "Example usage:",
23938         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
23939         "type": "json"
23940       }
23941     ],
23942     "name": "ShowSounds",
23943     "group": "Sounds",
23944     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23945     "version": "0.0.0",
23946     "filename": "server/api/sound/index.js",
23947     "groupTitle": "Sounds"
23948   },
23949   {
23950     "type": "post",
23951     "url": "/api/sounds",
23952     "title": "Create a new sound",
23953     "examples": [
23954       {
23955         "title": "Example usage:",
23956         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
23957         "type": "json"
23958       }
23959     ],
23960     "name": "addSound",
23961     "group": "Sounds",
23962     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23963     "version": "0.0.0",
23964     "filename": "server/api/sound/index.js",
23965     "groupTitle": "Sounds"
23966   },
23967   {
23968     "type": "delete",
23969     "url": "/api/sounds/{id}",
23970     "title": "Deletes a sound",
23971     "examples": [
23972       {
23973         "title": "Example usage:",
23974         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
23975         "type": "json"
23976       }
23977     ],
23978     "name": "destroySound",
23979     "group": "Sounds",
23980     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23981     "version": "0.0.0",
23982     "filename": "server/api/sound/index.js",
23983     "groupTitle": "Sounds"
23984   },
23985   {
23986     "type": "get",
23987     "url": "/api/sounds/{id}/download",
23988     "title": "Download Sound",
23989     "examples": [
23990       {
23991         "title": "Example usage:",
23992         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
23993         "type": "json"
23994       }
23995     ],
23996     "name": "download",
23997     "group": "Sounds",
23998     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23999     "version": "0.0.0",
24000     "filename": "server/api/sound/index.js",
24001     "groupTitle": "Sounds"
24002   },
24003   {
24004     "type": "put",
24005     "url": "/api/sounds",
24006     "title": "Update an existing new sound",
24007     "examples": [
24008       {
24009         "title": "Example usage:",
24010         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
24011         "type": "json"
24012       }
24013     ],
24014     "name": "updateSound",
24015     "group": "Sounds",
24016     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24017     "version": "0.0.0",
24018     "filename": "server/api/sound/index.js",
24019     "groupTitle": "Sounds"
24020   },
24021   {
24022     "type": "post",
24023     "url": "/api/square/details/reports",
24024     "title": "Creates a new Square Detail Report",
24025     "examples": [
24026       {
24027         "title": "Example usage:",
24028         "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",
24029         "type": "json"
24030       }
24031     ],
24032     "name": "CreateSquare_Detail_Reports",
24033     "group": "Square_Details_Reports",
24034     "parameter": {
24035       "fields": {
24036         "Body": [
24037           {
24038             "group": "Body",
24039             "type": "String",
24040             "optional": true,
24041             "field": "uniqueid",
24042             "description": ""
24043           },
24044           {
24045             "group": "Body",
24046             "type": "String",
24047             "optional": true,
24048             "field": "node",
24049             "description": ""
24050           },
24051           {
24052             "group": "Body",
24053             "type": "String",
24054             "optional": true,
24055             "field": "application",
24056             "description": ""
24057           },
24058           {
24059             "group": "Body",
24060             "type": "Text",
24061             "optional": true,
24062             "field": "data",
24063             "description": ""
24064           },
24065           {
24066             "group": "Body",
24067             "type": "String",
24068             "optional": true,
24069             "field": "project_name",
24070             "description": ""
24071           },
24072           {
24073             "group": "Body",
24074             "type": "String",
24075             "optional": true,
24076             "field": "callerid",
24077             "description": ""
24078           }
24079         ]
24080       }
24081     },
24082     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24083     "version": "0.0.0",
24084     "filename": "server/api/squareReportDetail/index.js",
24085     "groupTitle": "Square_Details_Reports"
24086   },
24087   {
24088     "type": "delete",
24089     "url": "/api/square/details/reports/{id}",
24090     "title": "Deletes a Square Detail Report",
24091     "examples": [
24092       {
24093         "title": "Example usage:",
24094         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
24095         "type": "json"
24096       }
24097     ],
24098     "name": "DeleteSquare_Detail_Reports",
24099     "group": "Square_Details_Reports",
24100     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24101     "version": "0.0.0",
24102     "filename": "server/api/squareReportDetail/index.js",
24103     "groupTitle": "Square_Details_Reports"
24104   },
24105   {
24106     "type": "get",
24107     "url": "/api/square/details/reports/describe",
24108     "title": "Gets table info about Square Detail Reports",
24109     "examples": [
24110       {
24111         "title": "Example usage:",
24112         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
24113         "type": "json"
24114       }
24115     ],
24116     "name": "DescribeSquare_Detail_Reports",
24117     "group": "Square_Details_Reports",
24118     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24119     "version": "0.0.0",
24120     "filename": "server/api/squareReportDetail/index.js",
24121     "groupTitle": "Square_Details_Reports"
24122   },
24123   {
24124     "type": "get",
24125     "url": "/api/square/details/reports",
24126     "title": "Gets a list of Square Detail Reports",
24127     "examples": [
24128       {
24129         "title": "Example usage:",
24130         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
24131         "type": "json"
24132       }
24133     ],
24134     "name": "GetSquare_Detail_Reports",
24135     "group": "Square_Details_Reports",
24136     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24137     "version": "0.0.0",
24138     "filename": "server/api/squareReportDetail/index.js",
24139     "groupTitle": "Square_Details_Reports"
24140   },
24141   {
24142     "type": "get",
24143     "url": "/api/square/details/reports/{id}",
24144     "title": "Gets a single Square Detail Report",
24145     "examples": [
24146       {
24147         "title": "Example usage:",
24148         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
24149         "type": "json"
24150       }
24151     ],
24152     "name": "ShowSquare_Detail_Reports",
24153     "group": "Square_Details_Reports",
24154     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24155     "version": "0.0.0",
24156     "filename": "server/api/squareReportDetail/index.js",
24157     "groupTitle": "Square_Details_Reports"
24158   },
24159   {
24160     "type": "put",
24161     "url": "/api/square/details/reports/{id}",
24162     "title": "Update an existing Square Detail Report",
24163     "examples": [
24164       {
24165         "title": "Example usage:",
24166         "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",
24167         "type": "json"
24168       }
24169     ],
24170     "name": "updateSquare_Detail_Reports",
24171     "group": "Square_Details_Reports",
24172     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24173     "version": "0.0.0",
24174     "filename": "server/api/squareReportDetail/index.js",
24175     "groupTitle": "Square_Details_Reports"
24176   },
24177   {
24178     "type": "post",
24179     "url": "/api/square/messages",
24180     "title": "Creates a new Message",
24181     "examples": [
24182       {
24183         "title": "Example usage:",
24184         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24185         "type": "json"
24186       }
24187     ],
24188     "name": "CreateMessages",
24189     "group": "Square_Messages",
24190     "parameter": {
24191       "fields": {
24192         "Body": [
24193           {
24194             "group": "Body",
24195             "type": "String",
24196             "optional": true,
24197             "field": "uniqueid",
24198             "description": ""
24199           },
24200           {
24201             "group": "Body",
24202             "type": "Text",
24203             "optional": false,
24204             "field": "body",
24205             "description": ""
24206           },
24207           {
24208             "group": "Body",
24209             "type": "String",
24210             "allowedValues": [
24211               "\"in\"",
24212               "\"out\""
24213             ],
24214             "optional": false,
24215             "field": "direction",
24216             "description": ""
24217           }
24218         ]
24219       }
24220     },
24221     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24222     "version": "0.0.0",
24223     "filename": "server/api/squareMessage/index.js",
24224     "groupTitle": "Square_Messages"
24225   },
24226   {
24227     "type": "delete",
24228     "url": "/api/square/messages/{id}",
24229     "title": "Deletes a Message",
24230     "examples": [
24231       {
24232         "title": "Example usage:",
24233         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
24234         "type": "json"
24235       }
24236     ],
24237     "name": "DeleteMessages",
24238     "group": "Square_Messages",
24239     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24240     "version": "0.0.0",
24241     "filename": "server/api/squareMessage/index.js",
24242     "groupTitle": "Square_Messages"
24243   },
24244   {
24245     "type": "get",
24246     "url": "/api/square/messages",
24247     "title": "Gets a list of Messages",
24248     "examples": [
24249       {
24250         "title": "Example usage:",
24251         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
24252         "type": "json"
24253       }
24254     ],
24255     "name": "GetMessages",
24256     "group": "Square_Messages",
24257     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24258     "version": "0.0.0",
24259     "filename": "server/api/squareMessage/index.js",
24260     "groupTitle": "Square_Messages"
24261   },
24262   {
24263     "type": "get",
24264     "url": "/api/square/messages/{id}",
24265     "title": "Gets a single Message",
24266     "examples": [
24267       {
24268         "title": "Example usage:",
24269         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
24270         "type": "json"
24271       }
24272     ],
24273     "name": "ShowMessages",
24274     "group": "Square_Messages",
24275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24276     "version": "0.0.0",
24277     "filename": "server/api/squareMessage/index.js",
24278     "groupTitle": "Square_Messages"
24279   },
24280   {
24281     "type": "put",
24282     "url": "/api/square/messages/{id}",
24283     "title": "Update an existing Message",
24284     "examples": [
24285       {
24286         "title": "Example usage:",
24287         "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",
24288         "type": "json"
24289       }
24290     ],
24291     "name": "updateMessages",
24292     "group": "Square_Messages",
24293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24294     "version": "0.0.0",
24295     "filename": "server/api/squareMessage/index.js",
24296     "groupTitle": "Square_Messages"
24297   },
24298   {
24299     "type": "post",
24300     "url": "/api/square/odbc",
24301     "title": "Creates a new ODBC",
24302     "examples": [
24303       {
24304         "title": "Example usage:",
24305         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24306         "type": "json"
24307       }
24308     ],
24309     "name": "CreateODBCs",
24310     "group": "Square_ODBC",
24311     "parameter": {
24312       "fields": {
24313         "Body": [
24314           {
24315             "group": "Body",
24316             "type": "String",
24317             "optional": false,
24318             "field": "name",
24319             "description": ""
24320           },
24321           {
24322             "group": "Body",
24323             "type": "String",
24324             "optional": true,
24325             "field": "dsn",
24326             "description": ""
24327           },
24328           {
24329             "group": "Body",
24330             "type": "String",
24331             "optional": true,
24332             "field": "description",
24333             "description": ""
24334           }
24335         ]
24336       }
24337     },
24338     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24339     "version": "0.0.0",
24340     "filename": "server/api/squareOdbc/index.js",
24341     "groupTitle": "Square_ODBC"
24342   },
24343   {
24344     "type": "delete",
24345     "url": "/api/square/odbc/{id}",
24346     "title": "Deletes a ODBC",
24347     "examples": [
24348       {
24349         "title": "Example usage:",
24350         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
24351         "type": "json"
24352       }
24353     ],
24354     "name": "DeleteODBCs",
24355     "group": "Square_ODBC",
24356     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24357     "version": "0.0.0",
24358     "filename": "server/api/squareOdbc/index.js",
24359     "groupTitle": "Square_ODBC"
24360   },
24361   {
24362     "type": "get",
24363     "url": "/api/square/odbc",
24364     "title": "Gets a list of ODBCs",
24365     "examples": [
24366       {
24367         "title": "Example usage:",
24368         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
24369         "type": "json"
24370       }
24371     ],
24372     "name": "GetODBCs",
24373     "group": "Square_ODBC",
24374     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24375     "version": "0.0.0",
24376     "filename": "server/api/squareOdbc/index.js",
24377     "groupTitle": "Square_ODBC"
24378   },
24379   {
24380     "type": "get",
24381     "url": "/api/square/odbc/{id}",
24382     "title": "Gets a single ODBC",
24383     "examples": [
24384       {
24385         "title": "Example usage:",
24386         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
24387         "type": "json"
24388       }
24389     ],
24390     "name": "ShowODBCs",
24391     "group": "Square_ODBC",
24392     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24393     "version": "0.0.0",
24394     "filename": "server/api/squareOdbc/index.js",
24395     "groupTitle": "Square_ODBC"
24396   },
24397   {
24398     "type": "get",
24399     "url": "/api/square/odbc/{id}/test",
24400     "title": "Test Odbc",
24401     "examples": [
24402       {
24403         "title": "Example usage:",
24404         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
24405         "type": "json"
24406       }
24407     ],
24408     "name": "test",
24409     "group": "Square_ODBC",
24410     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24411     "version": "0.0.0",
24412     "filename": "server/api/squareOdbc/index.js",
24413     "groupTitle": "Square_ODBC"
24414   },
24415   {
24416     "type": "put",
24417     "url": "/api/square/odbc/{id}",
24418     "title": "Update an existing ODBC",
24419     "examples": [
24420       {
24421         "title": "Example usage:",
24422         "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",
24423         "type": "json"
24424       }
24425     ],
24426     "name": "updateODBCs",
24427     "group": "Square_ODBC",
24428     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24429     "version": "0.0.0",
24430     "filename": "server/api/squareOdbc/index.js",
24431     "groupTitle": "Square_ODBC"
24432   },
24433   {
24434     "type": "post",
24435     "url": "/api/square/projects",
24436     "title": "Creates a new Project",
24437     "examples": [
24438       {
24439         "title": "Example usage:",
24440         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24441         "type": "json"
24442       }
24443     ],
24444     "name": "CreateProjects",
24445     "group": "Square_Projects",
24446     "parameter": {
24447       "fields": {
24448         "Body": [
24449           {
24450             "group": "Body",
24451             "type": "String",
24452             "optional": false,
24453             "field": "name",
24454             "description": ""
24455           },
24456           {
24457             "group": "Body",
24458             "type": "String",
24459             "optional": true,
24460             "field": "description",
24461             "description": ""
24462           },
24463           {
24464             "group": "Body",
24465             "type": "Text",
24466             "optional": true,
24467             "field": "notes",
24468             "description": ""
24469           },
24470           {
24471             "group": "Body",
24472             "type": "Blob",
24473             "optional": true,
24474             "field": "preproduction",
24475             "description": ""
24476           },
24477           {
24478             "group": "Body",
24479             "type": "Blob",
24480             "optional": true,
24481             "field": "production",
24482             "description": ""
24483           }
24484         ]
24485       }
24486     },
24487     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24488     "version": "0.0.0",
24489     "filename": "server/api/squareProject/index.js",
24490     "groupTitle": "Square_Projects"
24491   },
24492   {
24493     "type": "delete",
24494     "url": "/api/square/projects/{id}",
24495     "title": "Deletes a Project",
24496     "examples": [
24497       {
24498         "title": "Example usage:",
24499         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
24500         "type": "json"
24501       }
24502     ],
24503     "name": "DeleteProjects",
24504     "group": "Square_Projects",
24505     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24506     "version": "0.0.0",
24507     "filename": "server/api/squareProject/index.js",
24508     "groupTitle": "Square_Projects"
24509   },
24510   {
24511     "type": "get",
24512     "url": "/api/square/projects",
24513     "title": "Gets a list of Projects",
24514     "examples": [
24515       {
24516         "title": "Example usage:",
24517         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
24518         "type": "json"
24519       }
24520     ],
24521     "name": "GetProjects",
24522     "group": "Square_Projects",
24523     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24524     "version": "0.0.0",
24525     "filename": "server/api/squareProject/index.js",
24526     "groupTitle": "Square_Projects"
24527   },
24528   {
24529     "type": "get",
24530     "url": "/api/square/projects/{id}",
24531     "title": "Gets a single Project",
24532     "examples": [
24533       {
24534         "title": "Example usage:",
24535         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
24536         "type": "json"
24537       }
24538     ],
24539     "name": "ShowProjects",
24540     "group": "Square_Projects",
24541     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24542     "version": "0.0.0",
24543     "filename": "server/api/squareProject/index.js",
24544     "groupTitle": "Square_Projects"
24545   },
24546   {
24547     "type": "post",
24548     "url": "/api/square/projects/{id}/users",
24549     "title": "Adds user permissions to a Project",
24550     "examples": [
24551       {
24552         "title": "Example usage:",
24553         "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",
24554         "type": "json"
24555       }
24556     ],
24557     "name": "addUsers",
24558     "group": "Square_Projects",
24559     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24560     "version": "0.0.0",
24561     "filename": "server/api/squareProject/index.js",
24562     "groupTitle": "Square_Projects"
24563   },
24564   {
24565     "type": "get",
24566     "url": "/api/square/projects/{id}/users",
24567     "title": "Gets users permissions from Project",
24568     "examples": [
24569       {
24570         "title": "Example usage:",
24571         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
24572         "type": "json"
24573       }
24574     ],
24575     "name": "getUsers",
24576     "group": "Square_Projects",
24577     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24578     "version": "0.0.0",
24579     "filename": "server/api/squareProject/index.js",
24580     "groupTitle": "Square_Projects"
24581   },
24582   {
24583     "type": "delete",
24584     "url": "/api/square/projects/{id}/users",
24585     "title": "Removes user permissions from a Project",
24586     "examples": [
24587       {
24588         "title": "Example usage:",
24589         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
24590         "type": "json"
24591       }
24592     ],
24593     "name": "removeUsers",
24594     "group": "Square_Projects",
24595     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24596     "version": "0.0.0",
24597     "filename": "server/api/squareProject/index.js",
24598     "groupTitle": "Square_Projects"
24599   },
24600   {
24601     "type": "put",
24602     "url": "/api/square/projects/{id}",
24603     "title": "Update an existing Project",
24604     "examples": [
24605       {
24606         "title": "Example usage:",
24607         "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",
24608         "type": "json"
24609       }
24610     ],
24611     "name": "updateProjects",
24612     "group": "Square_Projects",
24613     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24614     "version": "0.0.0",
24615     "filename": "server/api/squareProject/index.js",
24616     "groupTitle": "Square_Projects"
24617   },
24618   {
24619     "type": "post",
24620     "url": "/api/square/recordings",
24621     "title": "Creates a new Recording",
24622     "examples": [
24623       {
24624         "title": "Example usage:",
24625         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24626         "type": "json"
24627       }
24628     ],
24629     "name": "CreateRecordings",
24630     "group": "Square_Recordings",
24631     "parameter": {
24632       "fields": {
24633         "Body": [
24634           {
24635             "group": "Body",
24636             "type": "String",
24637             "optional": true,
24638             "field": "uniqueid",
24639             "description": ""
24640           },
24641           {
24642             "group": "Body",
24643             "type": "String",
24644             "optional": true,
24645             "field": "callerid",
24646             "description": ""
24647           },
24648           {
24649             "group": "Body",
24650             "type": "String",
24651             "optional": true,
24652             "field": "calleridname",
24653             "description": ""
24654           },
24655           {
24656             "group": "Body",
24657             "type": "String",
24658             "optional": true,
24659             "field": "context",
24660             "description": ""
24661           },
24662           {
24663             "group": "Body",
24664             "type": "String",
24665             "optional": true,
24666             "field": "extension",
24667             "description": ""
24668           },
24669           {
24670             "group": "Body",
24671             "type": "String",
24672             "optional": true,
24673             "field": "priority",
24674             "description": ""
24675           },
24676           {
24677             "group": "Body",
24678             "type": "String",
24679             "optional": true,
24680             "field": "accountcode",
24681             "description": ""
24682           },
24683           {
24684             "group": "Body",
24685             "type": "String",
24686             "optional": true,
24687             "field": "dnid",
24688             "description": ""
24689           },
24690           {
24691             "group": "Body",
24692             "type": "String",
24693             "optional": true,
24694             "field": "projectName",
24695             "description": ""
24696           },
24697           {
24698             "group": "Body",
24699             "type": "String",
24700             "optional": true,
24701             "field": "saveName",
24702             "description": ""
24703           },
24704           {
24705             "group": "Body",
24706             "type": "String",
24707             "optional": true,
24708             "field": "filename",
24709             "description": ""
24710           },
24711           {
24712             "group": "Body",
24713             "type": "String",
24714             "optional": true,
24715             "field": "savePath",
24716             "description": ""
24717           },
24718           {
24719             "group": "Body",
24720             "type": "Virtual",
24721             "optional": true,
24722             "field": "format",
24723             "description": ""
24724           }
24725         ]
24726       }
24727     },
24728     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24729     "version": "0.0.0",
24730     "filename": "server/api/squareRecording/index.js",
24731     "groupTitle": "Square_Recordings"
24732   },
24733   {
24734     "type": "get",
24735     "url": "/api/square/recordings",
24736     "title": "Gets a list of Recordings",
24737     "examples": [
24738       {
24739         "title": "Example usage:",
24740         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24741         "type": "json"
24742       }
24743     ],
24744     "name": "GetRecordings",
24745     "group": "Square_Recordings",
24746     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24747     "version": "0.0.0",
24748     "filename": "server/api/squareRecording/index.js",
24749     "groupTitle": "Square_Recordings"
24750   },
24751   {
24752     "type": "get",
24753     "url": "/api/square/recordings/{id}",
24754     "title": "Gets a single Recording",
24755     "examples": [
24756       {
24757         "title": "Example usage:",
24758         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24759         "type": "json"
24760       }
24761     ],
24762     "name": "ShowRecordings",
24763     "group": "Square_Recordings",
24764     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24765     "version": "0.0.0",
24766     "filename": "server/api/squareRecording/index.js",
24767     "groupTitle": "Square_Recordings"
24768   },
24769   {
24770     "type": "delete",
24771     "url": "/api/square/recordings/{id}/delete",
24772     "title": "Delete recording",
24773     "examples": [
24774       {
24775         "title": "Example usage:",
24776         "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
24777         "type": "json"
24778       }
24779     ],
24780     "name": "destroy",
24781     "group": "Square_Recordings",
24782     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24783     "version": "0.0.0",
24784     "filename": "server/api/squareRecording/index.js",
24785     "groupTitle": "Square_Recordings"
24786   },
24787   {
24788     "type": "get",
24789     "url": "/api/square/recordings/{id}/download",
24790     "title": "Download Recording",
24791     "examples": [
24792       {
24793         "title": "Example usage:",
24794         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
24795         "type": "json"
24796       }
24797     ],
24798     "name": "download",
24799     "group": "Square_Recordings",
24800     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24801     "version": "0.0.0",
24802     "filename": "server/api/squareRecording/index.js",
24803     "groupTitle": "Square_Recordings"
24804   },
24805   {
24806     "type": "put",
24807     "url": "/api/square/recordings/{id}",
24808     "title": "Update an existing Recording",
24809     "examples": [
24810       {
24811         "title": "Example usage:",
24812         "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",
24813         "type": "json"
24814       }
24815     ],
24816     "name": "updateRecordings",
24817     "group": "Square_Recordings",
24818     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24819     "version": "0.0.0",
24820     "filename": "server/api/squareRecording/index.js",
24821     "groupTitle": "Square_Recordings"
24822   },
24823   {
24824     "type": "post",
24825     "url": "/api/square/reports",
24826     "title": "Creates a new Square Report",
24827     "examples": [
24828       {
24829         "title": "Example usage:",
24830         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24831         "type": "json"
24832       }
24833     ],
24834     "name": "CreateSquare_Reports",
24835     "group": "Square_Reports",
24836     "parameter": {
24837       "fields": {
24838         "Body": [
24839           {
24840             "group": "Body",
24841             "type": "String",
24842             "optional": true,
24843             "field": "network",
24844             "description": ""
24845           },
24846           {
24847             "group": "Body",
24848             "type": "String",
24849             "optional": true,
24850             "field": "network_script",
24851             "description": ""
24852           },
24853           {
24854             "group": "Body",
24855             "type": "String",
24856             "optional": true,
24857             "field": "request",
24858             "description": ""
24859           },
24860           {
24861             "group": "Body",
24862             "type": "String",
24863             "optional": true,
24864             "field": "channel",
24865             "description": ""
24866           },
24867           {
24868             "group": "Body",
24869             "type": "String",
24870             "optional": true,
24871             "field": "language",
24872             "description": ""
24873           },
24874           {
24875             "group": "Body",
24876             "type": "String",
24877             "optional": true,
24878             "field": "type",
24879             "description": ""
24880           },
24881           {
24882             "group": "Body",
24883             "type": "String",
24884             "optional": true,
24885             "field": "uniqueid",
24886             "description": ""
24887           },
24888           {
24889             "group": "Body",
24890             "type": "String",
24891             "optional": true,
24892             "field": "version",
24893             "description": ""
24894           },
24895           {
24896             "group": "Body",
24897             "type": "String",
24898             "optional": true,
24899             "field": "callerid",
24900             "description": ""
24901           },
24902           {
24903             "group": "Body",
24904             "type": "String",
24905             "optional": true,
24906             "field": "calleridname",
24907             "description": ""
24908           },
24909           {
24910             "group": "Body",
24911             "type": "String",
24912             "optional": true,
24913             "field": "callingpres",
24914             "description": ""
24915           },
24916           {
24917             "group": "Body",
24918             "type": "String",
24919             "optional": true,
24920             "field": "callingani2",
24921             "description": ""
24922           },
24923           {
24924             "group": "Body",
24925             "type": "String",
24926             "optional": true,
24927             "field": "callington",
24928             "description": ""
24929           },
24930           {
24931             "group": "Body",
24932             "type": "String",
24933             "optional": true,
24934             "field": "callingtns",
24935             "description": ""
24936           },
24937           {
24938             "group": "Body",
24939             "type": "String",
24940             "optional": true,
24941             "field": "dnid",
24942             "description": ""
24943           },
24944           {
24945             "group": "Body",
24946             "type": "String",
24947             "optional": true,
24948             "field": "rdnis",
24949             "description": ""
24950           },
24951           {
24952             "group": "Body",
24953             "type": "String",
24954             "optional": true,
24955             "field": "context",
24956             "description": ""
24957           },
24958           {
24959             "group": "Body",
24960             "type": "String",
24961             "optional": true,
24962             "field": "extension",
24963             "description": ""
24964           },
24965           {
24966             "group": "Body",
24967             "type": "String",
24968             "optional": true,
24969             "field": "priority",
24970             "description": ""
24971           },
24972           {
24973             "group": "Body",
24974             "type": "String",
24975             "optional": true,
24976             "field": "enhanced",
24977             "description": ""
24978           },
24979           {
24980             "group": "Body",
24981             "type": "String",
24982             "optional": true,
24983             "field": "accountcode",
24984             "description": ""
24985           },
24986           {
24987             "group": "Body",
24988             "type": "String",
24989             "optional": true,
24990             "field": "threadid",
24991             "description": ""
24992           },
24993           {
24994             "group": "Body",
24995             "type": "String",
24996             "optional": true,
24997             "field": "project_name",
24998             "description": ""
24999           },
25000           {
25001             "group": "Body",
25002             "type": "String",
25003             "optional": true,
25004             "field": "joinAt",
25005             "description": ""
25006           },
25007           {
25008             "group": "Body",
25009             "type": "String",
25010             "optional": true,
25011             "field": "leaveAt",
25012             "description": ""
25013           },
25014           {
25015             "group": "Body",
25016             "type": "Boolean",
25017             "optional": true,
25018             "field": "bot",
25019             "description": ""
25020           }
25021         ]
25022       }
25023     },
25024     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25025     "version": "0.0.0",
25026     "filename": "server/api/squareReport/index.js",
25027     "groupTitle": "Square_Reports"
25028   },
25029   {
25030     "type": "delete",
25031     "url": "/api/square/reports/{id}",
25032     "title": "Deletes a Square Report",
25033     "examples": [
25034       {
25035         "title": "Example usage:",
25036         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
25037         "type": "json"
25038       }
25039     ],
25040     "name": "DeleteSquare_Reports",
25041     "group": "Square_Reports",
25042     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25043     "version": "0.0.0",
25044     "filename": "server/api/squareReport/index.js",
25045     "groupTitle": "Square_Reports"
25046   },
25047   {
25048     "type": "get",
25049     "url": "/api/square/reports/describe",
25050     "title": "Gets table info about Square Reports",
25051     "examples": [
25052       {
25053         "title": "Example usage:",
25054         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
25055         "type": "json"
25056       }
25057     ],
25058     "name": "DescribeSquare_Reports",
25059     "group": "Square_Reports",
25060     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25061     "version": "0.0.0",
25062     "filename": "server/api/squareReport/index.js",
25063     "groupTitle": "Square_Reports"
25064   },
25065   {
25066     "type": "get",
25067     "url": "/api/square/reports",
25068     "title": "Gets a list of Square Reports",
25069     "examples": [
25070       {
25071         "title": "Example usage:",
25072         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
25073         "type": "json"
25074       }
25075     ],
25076     "name": "GetSquare_Reports",
25077     "group": "Square_Reports",
25078     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25079     "version": "0.0.0",
25080     "filename": "server/api/squareReport/index.js",
25081     "groupTitle": "Square_Reports"
25082   },
25083   {
25084     "type": "get",
25085     "url": "/api/square/reports/{id}",
25086     "title": "Gets a single Square Report",
25087     "examples": [
25088       {
25089         "title": "Example usage:",
25090         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
25091         "type": "json"
25092       }
25093     ],
25094     "name": "ShowSquare_Reports",
25095     "group": "Square_Reports",
25096     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25097     "version": "0.0.0",
25098     "filename": "server/api/squareReport/index.js",
25099     "groupTitle": "Square_Reports"
25100   },
25101   {
25102     "type": "put",
25103     "url": "/api/square/reports/{id}",
25104     "title": "Update an existing Square Report",
25105     "examples": [
25106       {
25107         "title": "Example usage:",
25108         "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",
25109         "type": "json"
25110       }
25111     ],
25112     "name": "updateSquare_Reports",
25113     "group": "Square_Reports",
25114     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25115     "version": "0.0.0",
25116     "filename": "server/api/squareReport/index.js",
25117     "groupTitle": "Square_Reports"
25118   },
25119   {
25120     "type": "post",
25121     "url": "/api/integrations/sugarcrm/configurations",
25122     "title": "Creates a new SugarCRM Configuration",
25123     "examples": [
25124       {
25125         "title": "Example usage:",
25126         "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",
25127         "type": "json"
25128       }
25129     ],
25130     "name": "CreateSugarCRM_Configurations",
25131     "group": "SugarCRM_Configurations",
25132     "parameter": {
25133       "fields": {
25134         "Body": [
25135           {
25136             "group": "Body",
25137             "type": "String",
25138             "optional": true,
25139             "field": "name",
25140             "description": ""
25141           },
25142           {
25143             "group": "Body",
25144             "type": "String",
25145             "optional": true,
25146             "field": "description",
25147             "description": ""
25148           }
25149         ]
25150       }
25151     },
25152     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25153     "version": "0.0.0",
25154     "filename": "server/api/intSugarcrmConfiguration/index.js",
25155     "groupTitle": "SugarCRM_Configurations"
25156   },
25157   {
25158     "type": "delete",
25159     "url": "/api/integrations/sugarcrm/configurations/{id}",
25160     "title": "Deletes a SugarCRM Configuration",
25161     "examples": [
25162       {
25163         "title": "Example usage:",
25164         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
25165         "type": "json"
25166       }
25167     ],
25168     "name": "DeleteSugarCRM_Configurations",
25169     "group": "SugarCRM_Configurations",
25170     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25171     "version": "0.0.0",
25172     "filename": "server/api/intSugarcrmConfiguration/index.js",
25173     "groupTitle": "SugarCRM_Configurations"
25174   },
25175   {
25176     "type": "get",
25177     "url": "/api/integrations/sugarcrm/configurations",
25178     "title": "Gets a list of SugarCRM Configurations",
25179     "examples": [
25180       {
25181         "title": "Example usage:",
25182         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
25183         "type": "json"
25184       }
25185     ],
25186     "name": "GetSugarCRM_Configurations",
25187     "group": "SugarCRM_Configurations",
25188     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25189     "version": "0.0.0",
25190     "filename": "server/api/intSugarcrmConfiguration/index.js",
25191     "groupTitle": "SugarCRM_Configurations"
25192   },
25193   {
25194     "type": "get",
25195     "url": "/api/integrations/sugarcrm/configurations/{id}",
25196     "title": "Gets a single SugarCRM Configuration",
25197     "examples": [
25198       {
25199         "title": "Example usage:",
25200         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
25201         "type": "json"
25202       }
25203     ],
25204     "name": "ShowSugarCRM_Configurations",
25205     "group": "SugarCRM_Configurations",
25206     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25207     "version": "0.0.0",
25208     "filename": "server/api/intSugarcrmConfiguration/index.js",
25209     "groupTitle": "SugarCRM_Configurations"
25210   },
25211   {
25212     "type": "put",
25213     "url": "/api/integrations/sugarcrm/configurations/{id}",
25214     "title": "Update an existing SugarCRM Configuration",
25215     "examples": [
25216       {
25217         "title": "Example usage:",
25218         "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",
25219         "type": "json"
25220       }
25221     ],
25222     "name": "updateSugarCRM_Configurations",
25223     "group": "SugarCRM_Configurations",
25224     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25225     "version": "0.0.0",
25226     "filename": "server/api/intSugarcrmConfiguration/index.js",
25227     "groupTitle": "SugarCRM_Configurations"
25228   },
25229   {
25230     "type": "post",
25231     "url": "/api/integrations/sugarcrm/accounts",
25232     "title": "Creates a new Sugarcrm Account",
25233     "examples": [
25234       {
25235         "title": "Example usage:",
25236         "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",
25237         "type": "json"
25238       }
25239     ],
25240     "name": "CreateSugarcrm_Accounts",
25241     "group": "Sugarcrm_Accounts",
25242     "parameter": {
25243       "fields": {
25244         "Body": [
25245           {
25246             "group": "Body",
25247             "type": "String",
25248             "optional": true,
25249             "field": "name",
25250             "description": ""
25251           },
25252           {
25253             "group": "Body",
25254             "type": "String",
25255             "optional": true,
25256             "field": "description",
25257             "description": ""
25258           },
25259           {
25260             "group": "Body",
25261             "type": "String",
25262             "optional": true,
25263             "field": "username",
25264             "description": ""
25265           },
25266           {
25267             "group": "Body",
25268             "type": "String",
25269             "optional": true,
25270             "field": "password",
25271             "description": ""
25272           },
25273           {
25274             "group": "Body",
25275             "type": "String",
25276             "optional": true,
25277             "field": "remoteUri",
25278             "description": ""
25279           },
25280           {
25281             "group": "Body",
25282             "type": "String",
25283             "optional": true,
25284             "field": "serverUrl",
25285             "description": ""
25286           }
25287         ]
25288       }
25289     },
25290     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25291     "version": "0.0.0",
25292     "filename": "server/api/intSugarcrmAccount/index.js",
25293     "groupTitle": "Sugarcrm_Accounts"
25294   },
25295   {
25296     "type": "delete",
25297     "url": "/api/integrations/sugarcrm/accounts/{id}",
25298     "title": "Deletes a Sugarcrm Account",
25299     "examples": [
25300       {
25301         "title": "Example usage:",
25302         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
25303         "type": "json"
25304       }
25305     ],
25306     "name": "DeleteSugarcrm_Accounts",
25307     "group": "Sugarcrm_Accounts",
25308     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25309     "version": "0.0.0",
25310     "filename": "server/api/intSugarcrmAccount/index.js",
25311     "groupTitle": "Sugarcrm_Accounts"
25312   },
25313   {
25314     "type": "get",
25315     "url": "/api/integrations/sugarcrm/accounts",
25316     "title": "Gets a list of Sugarcrm Accounts",
25317     "examples": [
25318       {
25319         "title": "Example usage:",
25320         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
25321         "type": "json"
25322       }
25323     ],
25324     "name": "GetSugarcrm_Accounts",
25325     "group": "Sugarcrm_Accounts",
25326     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25327     "version": "0.0.0",
25328     "filename": "server/api/intSugarcrmAccount/index.js",
25329     "groupTitle": "Sugarcrm_Accounts"
25330   },
25331   {
25332     "type": "get",
25333     "url": "/api/integrations/sugarcrm/accounts/{id}",
25334     "title": "Gets a single Sugarcrm Account",
25335     "examples": [
25336       {
25337         "title": "Example usage:",
25338         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
25339         "type": "json"
25340       }
25341     ],
25342     "name": "ShowSugarcrm_Accounts",
25343     "group": "Sugarcrm_Accounts",
25344     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25345     "version": "0.0.0",
25346     "filename": "server/api/intSugarcrmAccount/index.js",
25347     "groupTitle": "Sugarcrm_Accounts"
25348   },
25349   {
25350     "type": "post",
25351     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25352     "title": "Creates new configuration",
25353     "examples": [
25354       {
25355         "title": "Example usage:",
25356         "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",
25357         "type": "json"
25358       }
25359     ],
25360     "name": "addConfiguration",
25361     "group": "Sugarcrm_Accounts",
25362     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25363     "version": "0.0.0",
25364     "filename": "server/api/intSugarcrmAccount/index.js",
25365     "groupTitle": "Sugarcrm_Accounts"
25366   },
25367   {
25368     "type": "get",
25369     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
25370     "title": "Gets account configurations",
25371     "examples": [
25372       {
25373         "title": "Example usage:",
25374         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
25375         "type": "json"
25376       }
25377     ],
25378     "name": "getConfigurations",
25379     "group": "Sugarcrm_Accounts",
25380     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25381     "version": "0.0.0",
25382     "filename": "server/api/intSugarcrmAccount/index.js",
25383     "groupTitle": "Sugarcrm_Accounts"
25384   },
25385   {
25386     "type": "get",
25387     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
25388     "title": "Gets account fields",
25389     "examples": [
25390       {
25391         "title": "Example usage:",
25392         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
25393         "type": "json"
25394       }
25395     ],
25396     "name": "getFields",
25397     "group": "Sugarcrm_Accounts",
25398     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25399     "version": "0.0.0",
25400     "filename": "server/api/intSugarcrmAccount/index.js",
25401     "groupTitle": "Sugarcrm_Accounts"
25402   },
25403   {
25404     "type": "put",
25405     "url": "/api/integrations/sugarcrm/accounts/{id}",
25406     "title": "Update an existing Sugarcrm Account",
25407     "examples": [
25408       {
25409         "title": "Example usage:",
25410         "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",
25411         "type": "json"
25412       }
25413     ],
25414     "name": "updateSugarcrm_Accounts",
25415     "group": "Sugarcrm_Accounts",
25416     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25417     "version": "0.0.0",
25418     "filename": "server/api/intSugarcrmAccount/index.js",
25419     "groupTitle": "Sugarcrm_Accounts"
25420   },
25421   {
25422     "type": "get",
25423     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
25424     "title": "Gets configurations descriptions",
25425     "examples": [
25426       {
25427         "title": "Example usage:",
25428         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
25429         "type": "json"
25430       }
25431     ],
25432     "name": "getDescriptions",
25433     "group": "Sugarcrm_Configurations",
25434     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25435     "version": "0.0.0",
25436     "filename": "server/api/intSugarcrmConfiguration/index.js",
25437     "groupTitle": "Sugarcrm_Configurations"
25438   },
25439   {
25440     "type": "get",
25441     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
25442     "title": "Gets configurations fields",
25443     "examples": [
25444       {
25445         "title": "Example usage:",
25446         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
25447         "type": "json"
25448       }
25449     ],
25450     "name": "getFields",
25451     "group": "Sugarcrm_Configurations",
25452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25453     "version": "0.0.0",
25454     "filename": "server/api/intSugarcrmConfiguration/index.js",
25455     "groupTitle": "Sugarcrm_Configurations"
25456   },
25457   {
25458     "type": "get",
25459     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
25460     "title": "Gets configurations subjects",
25461     "examples": [
25462       {
25463         "title": "Example usage:",
25464         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
25465         "type": "json"
25466       }
25467     ],
25468     "name": "getSubjects",
25469     "group": "Sugarcrm_Configurations",
25470     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25471     "version": "0.0.0",
25472     "filename": "server/api/intSugarcrmConfiguration/index.js",
25473     "groupTitle": "Sugarcrm_Configurations"
25474   },
25475   {
25476     "type": "post",
25477     "url": "/api/integrations/sugarcrm/fields",
25478     "title": "Creates a new Sugarcrm Field",
25479     "examples": [
25480       {
25481         "title": "Example usage:",
25482         "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",
25483         "type": "json"
25484       }
25485     ],
25486     "name": "CreateSugarcrm_Fields",
25487     "group": "Sugarcrm_Fields",
25488     "parameter": {
25489       "fields": {
25490         "Body": [
25491           {
25492             "group": "Body",
25493             "type": "String",
25494             "allowedValues": [
25495               "\"string\"",
25496               "\"variable\"",
25497               "\"customVariable\"",
25498               "\"keyValue\""
25499             ],
25500             "optional": true,
25501             "field": "type",
25502             "description": ""
25503           },
25504           {
25505             "group": "Body",
25506             "type": "String",
25507             "optional": true,
25508             "field": "content",
25509             "description": ""
25510           },
25511           {
25512             "group": "Body",
25513             "type": "String",
25514             "optional": true,
25515             "field": "key",
25516             "description": ""
25517           },
25518           {
25519             "group": "Body",
25520             "type": "String",
25521             "allowedValues": [
25522               "\"string\"",
25523               "\"variable\"",
25524               "\"customVariable\""
25525             ],
25526             "optional": true,
25527             "field": "keyType",
25528             "description": ""
25529           },
25530           {
25531             "group": "Body",
25532             "type": "String",
25533             "optional": true,
25534             "field": "keyContent",
25535             "description": ""
25536           },
25537           {
25538             "group": "Body",
25539             "type": "String",
25540             "optional": true,
25541             "field": "idField",
25542             "description": ""
25543           },
25544           {
25545             "group": "Body",
25546             "type": "String",
25547             "optional": true,
25548             "field": "nameField",
25549             "description": ""
25550           },
25551           {
25552             "group": "Body",
25553             "type": "Boolean",
25554             "optional": true,
25555             "field": "customField",
25556             "description": ""
25557           },
25558           {
25559             "group": "Body",
25560             "type": "String",
25561             "optional": true,
25562             "field": "variableName",
25563             "description": ""
25564           }
25565         ]
25566       }
25567     },
25568     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25569     "version": "0.0.0",
25570     "filename": "server/api/intSugarcrmField/index.js",
25571     "groupTitle": "Sugarcrm_Fields"
25572   },
25573   {
25574     "type": "delete",
25575     "url": "/api/integrations/sugarcrm/fields/{id}",
25576     "title": "Deletes a Sugarcrm Field",
25577     "examples": [
25578       {
25579         "title": "Example usage:",
25580         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
25581         "type": "json"
25582       }
25583     ],
25584     "name": "DeleteSugarcrm_Fields",
25585     "group": "Sugarcrm_Fields",
25586     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25587     "version": "0.0.0",
25588     "filename": "server/api/intSugarcrmField/index.js",
25589     "groupTitle": "Sugarcrm_Fields"
25590   },
25591   {
25592     "type": "get",
25593     "url": "/api/integrations/sugarcrm/fields",
25594     "title": "Gets a list of Sugarcrm Fields",
25595     "examples": [
25596       {
25597         "title": "Example usage:",
25598         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25599         "type": "json"
25600       }
25601     ],
25602     "name": "GetSugarcrm_Fields",
25603     "group": "Sugarcrm_Fields",
25604     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/integrations/sugarcrm/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>",
25605     "version": "0.0.0",
25606     "filename": "server/api/intSugarcrmField/index.js",
25607     "groupTitle": "Sugarcrm_Fields"
25608   },
25609   {
25610     "type": "get",
25611     "url": "/api/integrations/sugarcrm/fields/{id}",
25612     "title": "Gets a single Sugarcrm Field",
25613     "examples": [
25614       {
25615         "title": "Example usage:",
25616         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25617         "type": "json"
25618       }
25619     ],
25620     "name": "ShowSugarcrm_Fields",
25621     "group": "Sugarcrm_Fields",
25622     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25623     "version": "0.0.0",
25624     "filename": "server/api/intSugarcrmField/index.js",
25625     "groupTitle": "Sugarcrm_Fields"
25626   },
25627   {
25628     "type": "put",
25629     "url": "/api/integrations/sugarcrm/fields/{id}",
25630     "title": "Update an existing Sugarcrm Field",
25631     "examples": [
25632       {
25633         "title": "Example usage:",
25634         "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",
25635         "type": "json"
25636       }
25637     ],
25638     "name": "updateSugarcrm_Fields",
25639     "group": "Sugarcrm_Fields",
25640     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25641     "version": "0.0.0",
25642     "filename": "server/api/intSugarcrmField/index.js",
25643     "groupTitle": "Sugarcrm_Fields"
25644   },
25645   {
25646     "type": "get",
25647     "url": "/api/system/process",
25648     "title": "Gets system information",
25649     "examples": [
25650       {
25651         "title": "Example usage:",
25652         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25653         "type": "json"
25654       }
25655     ],
25656     "name": "GetSystemInformation",
25657     "group": "System_Information",
25658     "description": "<p>Motion returns the system information.</p>",
25659     "version": "0.0.0",
25660     "filename": "server/api/system/index.js",
25661     "groupTitle": "System_Information"
25662   },
25663   {
25664     "type": "get",
25665     "url": "/api/system",
25666     "title": "Gets system information",
25667     "examples": [
25668       {
25669         "title": "Example usage:",
25670         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25671         "type": "json"
25672       }
25673     ],
25674     "name": "GetSystemInformation",
25675     "group": "System_Information",
25676     "description": "<p>Motion returns the system information.</p>",
25677     "version": "0.0.0",
25678     "filename": "server/api/system/index.js",
25679     "groupTitle": "System_Information"
25680   },
25681   {
25682     "type": "post",
25683     "url": "/api/tags",
25684     "title": "Creates a new Tag",
25685     "examples": [
25686       {
25687         "title": "Example usage:",
25688         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25689         "type": "json"
25690       }
25691     ],
25692     "name": "CreateTags",
25693     "group": "Tags",
25694     "parameter": {
25695       "fields": {
25696         "Body": [
25697           {
25698             "group": "Body",
25699             "type": "String",
25700             "optional": false,
25701             "field": "name",
25702             "description": ""
25703           },
25704           {
25705             "group": "Body",
25706             "type": "String",
25707             "optional": true,
25708             "field": "color",
25709             "description": ""
25710           },
25711           {
25712             "group": "Body",
25713             "type": "String",
25714             "optional": true,
25715             "field": "description",
25716             "description": ""
25717           }
25718         ]
25719       }
25720     },
25721     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25722     "version": "0.0.0",
25723     "filename": "server/api/tag/index.js",
25724     "groupTitle": "Tags"
25725   },
25726   {
25727     "type": "delete",
25728     "url": "/api/tags/{id}",
25729     "title": "Deletes a Tag",
25730     "examples": [
25731       {
25732         "title": "Example usage:",
25733         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25734         "type": "json"
25735       }
25736     ],
25737     "name": "DeleteTags",
25738     "group": "Tags",
25739     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25740     "version": "0.0.0",
25741     "filename": "server/api/tag/index.js",
25742     "groupTitle": "Tags"
25743   },
25744   {
25745     "type": "get",
25746     "url": "/api/tags",
25747     "title": "Gets a list of Tags",
25748     "examples": [
25749       {
25750         "title": "Example usage:",
25751         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25752         "type": "json"
25753       }
25754     ],
25755     "name": "GetTags",
25756     "group": "Tags",
25757     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25758     "version": "0.0.0",
25759     "filename": "server/api/tag/index.js",
25760     "groupTitle": "Tags"
25761   },
25762   {
25763     "type": "get",
25764     "url": "/api/tags/{id}",
25765     "title": "Gets a single Tag",
25766     "examples": [
25767       {
25768         "title": "Example usage:",
25769         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25770         "type": "json"
25771       }
25772     ],
25773     "name": "ShowTags",
25774     "group": "Tags",
25775     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25776     "version": "0.0.0",
25777     "filename": "server/api/tag/index.js",
25778     "groupTitle": "Tags"
25779   },
25780   {
25781     "type": "put",
25782     "url": "/api/tags/{id}",
25783     "title": "Update an existing Tag",
25784     "examples": [
25785       {
25786         "title": "Example usage:",
25787         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25788         "type": "json"
25789       }
25790     ],
25791     "name": "updateTags",
25792     "group": "Tags",
25793     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25794     "version": "0.0.0",
25795     "filename": "server/api/tag/index.js",
25796     "groupTitle": "Tags"
25797   },
25798   {
25799     "type": "post",
25800     "url": "/api/teams/{id}/queues",
25801     "title": "Add queues to a team",
25802     "examples": [
25803       {
25804         "title": "Example usage:",
25805         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25806         "type": "json"
25807       }
25808     ],
25809     "name": "AddQueues",
25810     "group": "Teams",
25811     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25812     "version": "0.0.0",
25813     "filename": "server/api/team/index.js",
25814     "groupTitle": "Teams"
25815   },
25816   {
25817     "type": "post",
25818     "url": "/api/teams",
25819     "title": "Creates a new Team",
25820     "examples": [
25821       {
25822         "title": "Example usage:",
25823         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25824         "type": "json"
25825       }
25826     ],
25827     "name": "CreateTeams",
25828     "group": "Teams",
25829     "parameter": {
25830       "fields": {
25831         "Body": [
25832           {
25833             "group": "Body",
25834             "type": "String",
25835             "optional": false,
25836             "field": "name",
25837             "description": ""
25838           },
25839           {
25840             "group": "Body",
25841             "type": "String",
25842             "optional": true,
25843             "field": "description",
25844             "description": ""
25845           }
25846         ]
25847       }
25848     },
25849     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25850     "version": "0.0.0",
25851     "filename": "server/api/team/index.js",
25852     "groupTitle": "Teams"
25853   },
25854   {
25855     "type": "delete",
25856     "url": "/api/teams/{id}",
25857     "title": "Deletes a Team",
25858     "examples": [
25859       {
25860         "title": "Example usage:",
25861         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
25862         "type": "json"
25863       }
25864     ],
25865     "name": "DeleteTeams",
25866     "group": "Teams",
25867     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25868     "version": "0.0.0",
25869     "filename": "server/api/team/index.js",
25870     "groupTitle": "Teams"
25871   },
25872   {
25873     "type": "get",
25874     "url": "/api/teams/{id}/users",
25875     "title": "Gets agents from team",
25876     "examples": [
25877       {
25878         "title": "Example usage:",
25879         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
25880         "type": "json"
25881       }
25882     ],
25883     "name": "GetAgents",
25884     "group": "Teams",
25885     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25886     "version": "0.0.0",
25887     "filename": "server/api/team/index.js",
25888     "groupTitle": "Teams"
25889   },
25890   {
25891     "type": "get",
25892     "url": "/api/teams/{id}/queues?channel={channel}",
25893     "title": "Gets Queues list",
25894     "examples": [
25895       {
25896         "title": "Example usage:",
25897         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
25898         "type": "json"
25899       }
25900     ],
25901     "name": "GetQueues",
25902     "group": "Teams",
25903     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25904     "version": "0.0.0",
25905     "filename": "server/api/team/index.js",
25906     "groupTitle": "Teams"
25907   },
25908   {
25909     "type": "get",
25910     "url": "/api/teams",
25911     "title": "Gets a list of Teams",
25912     "examples": [
25913       {
25914         "title": "Example usage:",
25915         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
25916         "type": "json"
25917       }
25918     ],
25919     "name": "GetTeams",
25920     "group": "Teams",
25921     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25922     "version": "0.0.0",
25923     "filename": "server/api/team/index.js",
25924     "groupTitle": "Teams"
25925   },
25926   {
25927     "type": "delete",
25928     "url": "/api/teams/{id}/users",
25929     "title": "Removes agents from a team",
25930     "examples": [
25931       {
25932         "title": "Example usage:",
25933         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25934         "type": "json"
25935       }
25936     ],
25937     "name": "RemoveAgents",
25938     "group": "Teams",
25939     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25940     "version": "0.0.0",
25941     "filename": "server/api/team/index.js",
25942     "groupTitle": "Teams"
25943   },
25944   {
25945     "type": "delete",
25946     "url": "/api/teams/{id}/queues",
25947     "title": "Remove queues to a team",
25948     "examples": [
25949       {
25950         "title": "Example usage:",
25951         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25952         "type": "json"
25953       }
25954     ],
25955     "name": "RemoveQueues",
25956     "group": "Teams",
25957     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25958     "version": "0.0.0",
25959     "filename": "server/api/team/index.js",
25960     "groupTitle": "Teams"
25961   },
25962   {
25963     "type": "delete",
25964     "url": "/api/mail/queues/{id}/teams",
25965     "title": "Remove teams from a queue",
25966     "examples": [
25967       {
25968         "title": "Example usage:",
25969         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25970         "type": "json"
25971       }
25972     ],
25973     "name": "RemoveTeams",
25974     "group": "Teams",
25975     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25976     "version": "0.0.0",
25977     "filename": "server/api/mailQueue/index.js",
25978     "groupTitle": "Teams"
25979   },
25980   {
25981     "type": "delete",
25982     "url": "/api/openchannel/queues/{id}/teams",
25983     "title": "Remove teams from a queue",
25984     "examples": [
25985       {
25986         "title": "Example usage:",
25987         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25988         "type": "json"
25989       }
25990     ],
25991     "name": "RemoveTeams",
25992     "group": "Teams",
25993     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25994     "version": "0.0.0",
25995     "filename": "server/api/openchannelQueue/index.js",
25996     "groupTitle": "Teams"
25997   },
25998   {
25999     "type": "delete",
26000     "url": "/api/voice/queues/{id}/teams",
26001     "title": "Remove teams from a queue",
26002     "examples": [
26003       {
26004         "title": "Example usage:",
26005         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26006         "type": "json"
26007       }
26008     ],
26009     "name": "RemoveTeams",
26010     "group": "Teams",
26011     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26012     "version": "0.0.0",
26013     "filename": "server/api/voiceQueue/index.js",
26014     "groupTitle": "Teams"
26015   },
26016   {
26017     "type": "delete",
26018     "url": "/api/sms/queues/{id}/teams",
26019     "title": "Remove teams from a queue",
26020     "examples": [
26021       {
26022         "title": "Example usage:",
26023         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26024         "type": "json"
26025       }
26026     ],
26027     "name": "RemoveTeams",
26028     "group": "Teams",
26029     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26030     "version": "0.0.0",
26031     "filename": "server/api/smsQueue/index.js",
26032     "groupTitle": "Teams"
26033   },
26034   {
26035     "type": "delete",
26036     "url": "/api/whatsapp/queues/{id}/teams",
26037     "title": "Remove teams from a queue",
26038     "examples": [
26039       {
26040         "title": "Example usage:",
26041         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26042         "type": "json"
26043       }
26044     ],
26045     "name": "RemoveTeams",
26046     "group": "Teams",
26047     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26048     "version": "0.0.0",
26049     "filename": "server/api/whatsappQueue/index.js",
26050     "groupTitle": "Teams"
26051   },
26052   {
26053     "type": "delete",
26054     "url": "/api/chat/queues/{id}/teams",
26055     "title": "Remove teams from a queue",
26056     "examples": [
26057       {
26058         "title": "Example usage:",
26059         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26060         "type": "json"
26061       }
26062     ],
26063     "name": "RemoveTeams",
26064     "group": "Teams",
26065     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26066     "version": "0.0.0",
26067     "filename": "server/api/chatQueue/index.js",
26068     "groupTitle": "Teams"
26069   },
26070   {
26071     "type": "delete",
26072     "url": "/api/fax/queues/{id}/teams",
26073     "title": "Remove teams from a queue",
26074     "examples": [
26075       {
26076         "title": "Example usage:",
26077         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
26078         "type": "json"
26079       }
26080     ],
26081     "name": "RemoveTeams",
26082     "group": "Teams",
26083     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26084     "version": "0.0.0",
26085     "filename": "server/api/faxQueue/index.js",
26086     "groupTitle": "Teams"
26087   },
26088   {
26089     "type": "get",
26090     "url": "/api/teams/{id}",
26091     "title": "Gets a single Team",
26092     "examples": [
26093       {
26094         "title": "Example usage:",
26095         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
26096         "type": "json"
26097       }
26098     ],
26099     "name": "ShowTeams",
26100     "group": "Teams",
26101     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26102     "version": "0.0.0",
26103     "filename": "server/api/team/index.js",
26104     "groupTitle": "Teams"
26105   },
26106   {
26107     "type": "post",
26108     "url": "/api/teams/{id}/users",
26109     "title": "Adds agents to a team",
26110     "examples": [
26111       {
26112         "title": "Example usage:",
26113         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26114         "type": "json"
26115       }
26116     ],
26117     "name": "addAgents",
26118     "group": "Teams",
26119     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26120     "version": "0.0.0",
26121     "filename": "server/api/team/index.js",
26122     "groupTitle": "Teams"
26123   },
26124   {
26125     "type": "put",
26126     "url": "/api/teams/{id}",
26127     "title": "Update an existing Team",
26128     "examples": [
26129       {
26130         "title": "Example usage:",
26131         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26132         "type": "json"
26133       }
26134     ],
26135     "name": "updateTeams",
26136     "group": "Teams",
26137     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26138     "version": "0.0.0",
26139     "filename": "server/api/team/index.js",
26140     "groupTitle": "Teams"
26141   },
26142   {
26143     "type": "post",
26144     "url": "/api/templates",
26145     "title": "Creates a new Template",
26146     "examples": [
26147       {
26148         "title": "Example usage:",
26149         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26150         "type": "json"
26151       }
26152     ],
26153     "name": "CreateTemplates",
26154     "group": "Templates",
26155     "parameter": {
26156       "fields": {
26157         "Body": [
26158           {
26159             "group": "Body",
26160             "type": "String",
26161             "optional": true,
26162             "field": "name",
26163             "description": ""
26164           },
26165           {
26166             "group": "Body",
26167             "type": "String",
26168             "optional": true,
26169             "field": "description",
26170             "description": ""
26171           },
26172           {
26173             "group": "Body",
26174             "type": "Text",
26175             "optional": true,
26176             "field": "html",
26177             "description": ""
26178           }
26179         ]
26180       }
26181     },
26182     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26183     "version": "0.0.0",
26184     "filename": "server/api/template/index.js",
26185     "groupTitle": "Templates"
26186   },
26187   {
26188     "type": "delete",
26189     "url": "/api/templates/{id}",
26190     "title": "Deletes a Template",
26191     "examples": [
26192       {
26193         "title": "Example usage:",
26194         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
26195         "type": "json"
26196       }
26197     ],
26198     "name": "DeleteTemplates",
26199     "group": "Templates",
26200     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26201     "version": "0.0.0",
26202     "filename": "server/api/template/index.js",
26203     "groupTitle": "Templates"
26204   },
26205   {
26206     "type": "get",
26207     "url": "/api/templates",
26208     "title": "Gets a list of Templates",
26209     "examples": [
26210       {
26211         "title": "Example usage:",
26212         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
26213         "type": "json"
26214       }
26215     ],
26216     "name": "GetTemplates",
26217     "group": "Templates",
26218     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26219     "version": "0.0.0",
26220     "filename": "server/api/template/index.js",
26221     "groupTitle": "Templates"
26222   },
26223   {
26224     "type": "get",
26225     "url": "/api/templates/{id}",
26226     "title": "Gets a single Template",
26227     "examples": [
26228       {
26229         "title": "Example usage:",
26230         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
26231         "type": "json"
26232       }
26233     ],
26234     "name": "ShowTemplates",
26235     "group": "Templates",
26236     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26237     "version": "0.0.0",
26238     "filename": "server/api/template/index.js",
26239     "groupTitle": "Templates"
26240   },
26241   {
26242     "type": "put",
26243     "url": "/api/templates/{id}",
26244     "title": "Update an existing Template",
26245     "examples": [
26246       {
26247         "title": "Example usage:",
26248         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26249         "type": "json"
26250       }
26251     ],
26252     "name": "updateTemplates",
26253     "group": "Templates",
26254     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26255     "version": "0.0.0",
26256     "filename": "server/api/template/index.js",
26257     "groupTitle": "Templates"
26258   },
26259   {
26260     "type": "post",
26261     "url": "/api/triggers",
26262     "title": "Creates a new Trigger",
26263     "examples": [
26264       {
26265         "title": "Example usage:",
26266         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26267         "type": "json"
26268       }
26269     ],
26270     "name": "CreateTriggers",
26271     "group": "Triggers",
26272     "parameter": {
26273       "fields": {
26274         "Body": [
26275           {
26276             "group": "Body",
26277             "type": "String",
26278             "optional": true,
26279             "field": "name",
26280             "description": ""
26281           },
26282           {
26283             "group": "Body",
26284             "type": "String",
26285             "optional": true,
26286             "field": "channel",
26287             "description": ""
26288           },
26289           {
26290             "group": "Body",
26291             "type": "String",
26292             "optional": true,
26293             "field": "description",
26294             "description": ""
26295           },
26296           {
26297             "group": "Body",
26298             "type": "Boolean",
26299             "optional": true,
26300             "field": "status",
26301             "description": ""
26302           }
26303         ]
26304       }
26305     },
26306     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26307     "version": "0.0.0",
26308     "filename": "server/api/trigger/index.js",
26309     "groupTitle": "Triggers"
26310   },
26311   {
26312     "type": "delete",
26313     "url": "/api/triggers/{id}",
26314     "title": "Deletes a Trigger",
26315     "examples": [
26316       {
26317         "title": "Example usage:",
26318         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
26319         "type": "json"
26320       }
26321     ],
26322     "name": "DeleteTriggers",
26323     "group": "Triggers",
26324     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26325     "version": "0.0.0",
26326     "filename": "server/api/trigger/index.js",
26327     "groupTitle": "Triggers"
26328   },
26329   {
26330     "type": "get",
26331     "url": "/api/triggers",
26332     "title": "Gets a list of Triggers",
26333     "examples": [
26334       {
26335         "title": "Example usage:",
26336         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
26337         "type": "json"
26338       }
26339     ],
26340     "name": "GetTriggers",
26341     "group": "Triggers",
26342     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26343     "version": "0.0.0",
26344     "filename": "server/api/trigger/index.js",
26345     "groupTitle": "Triggers"
26346   },
26347   {
26348     "type": "get",
26349     "url": "/api/triggers/{id}",
26350     "title": "Gets a single Trigger",
26351     "examples": [
26352       {
26353         "title": "Example usage:",
26354         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
26355         "type": "json"
26356       }
26357     ],
26358     "name": "ShowTriggers",
26359     "group": "Triggers",
26360     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26361     "version": "0.0.0",
26362     "filename": "server/api/trigger/index.js",
26363     "groupTitle": "Triggers"
26364   },
26365   {
26366     "type": "post",
26367     "url": "/api/triggers/{id}/actions",
26368     "title": "Creates new actions",
26369     "examples": [
26370       {
26371         "title": "Example usage:",
26372         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
26373         "type": "json"
26374       }
26375     ],
26376     "name": "addAction",
26377     "group": "Triggers",
26378     "parameter": {
26379       "fields": {
26380         "Body": [
26381           {
26382             "group": "Body",
26383             "type": "Virtual",
26384             "optional": true,
26385             "field": "name",
26386             "description": ""
26387           },
26388           {
26389             "group": "Body",
26390             "type": "String",
26391             "optional": false,
26392             "field": "action",
26393             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
26394           },
26395           {
26396             "group": "Body",
26397             "type": "String",
26398             "optional": true,
26399             "field": "data1",
26400             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
26401           },
26402           {
26403             "group": "Body",
26404             "type": "String",
26405             "optional": true,
26406             "field": "data2",
26407             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
26408           },
26409           {
26410             "group": "Body",
26411             "type": "String",
26412             "optional": true,
26413             "field": "data3",
26414             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
26415           },
26416           {
26417             "group": "Body",
26418             "type": "String",
26419             "optional": true,
26420             "field": "data4",
26421             "description": ""
26422           },
26423           {
26424             "group": "Body",
26425             "type": "String",
26426             "optional": true,
26427             "field": "data5",
26428             "description": ""
26429           },
26430           {
26431             "group": "Body",
26432             "type": "String",
26433             "optional": true,
26434             "field": "data6",
26435             "description": ""
26436           },
26437           {
26438             "group": "Body",
26439             "type": "Text",
26440             "optional": true,
26441             "field": "data7",
26442             "description": ""
26443           }
26444         ]
26445       }
26446     },
26447     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26448     "version": "0.0.0",
26449     "filename": "server/api/trigger/index.js",
26450     "groupTitle": "Triggers"
26451   },
26452   {
26453     "type": "post",
26454     "url": "/api/triggers/{id}/all_conditions",
26455     "title": "Creates a new \"AND\"condition",
26456     "examples": [
26457       {
26458         "title": "Example usage:",
26459         "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",
26460         "type": "json"
26461       }
26462     ],
26463     "name": "addAllCondition",
26464     "group": "Triggers",
26465     "parameter": {
26466       "fields": {
26467         "Body": [
26468           {
26469             "group": "Body",
26470             "type": "Virtual",
26471             "optional": true,
26472             "field": "name",
26473             "description": ""
26474           },
26475           {
26476             "group": "Body",
26477             "type": "String",
26478             "optional": false,
26479             "field": "field",
26480             "description": ""
26481           },
26482           {
26483             "group": "Body",
26484             "type": "String",
26485             "optional": false,
26486             "field": "operator",
26487             "description": ""
26488           },
26489           {
26490             "group": "Body",
26491             "type": "String",
26492             "optional": false,
26493             "field": "value",
26494             "description": ""
26495           }
26496         ]
26497       }
26498     },
26499     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26500     "version": "0.0.0",
26501     "filename": "server/api/trigger/index.js",
26502     "groupTitle": "Triggers"
26503   },
26504   {
26505     "type": "post",
26506     "url": "/api/triggers/{id}/any_conditions",
26507     "title": "Creates a new \"OR\"condition",
26508     "examples": [
26509       {
26510         "title": "Example usage:",
26511         "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",
26512         "type": "json"
26513       }
26514     ],
26515     "name": "addAnyCondition",
26516     "group": "Triggers",
26517     "parameter": {
26518       "fields": {
26519         "Body": [
26520           {
26521             "group": "Body",
26522             "type": "Virtual",
26523             "optional": true,
26524             "field": "name",
26525             "description": ""
26526           },
26527           {
26528             "group": "Body",
26529             "type": "String",
26530             "optional": false,
26531             "field": "field",
26532             "description": ""
26533           },
26534           {
26535             "group": "Body",
26536             "type": "String",
26537             "optional": false,
26538             "field": "operator",
26539             "description": ""
26540           },
26541           {
26542             "group": "Body",
26543             "type": "String",
26544             "optional": false,
26545             "field": "value",
26546             "description": ""
26547           }
26548         ]
26549       }
26550     },
26551     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26552     "version": "0.0.0",
26553     "filename": "server/api/trigger/index.js",
26554     "groupTitle": "Triggers"
26555   },
26556   {
26557     "type": "get",
26558     "url": "/api/triggers/{id}/actions",
26559     "title": "Gets Trigger Actions",
26560     "examples": [
26561       {
26562         "title": "Example usage:",
26563         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
26564         "type": "json"
26565       }
26566     ],
26567     "name": "getActions",
26568     "group": "Triggers",
26569     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26570     "version": "0.0.0",
26571     "filename": "server/api/trigger/index.js",
26572     "groupTitle": "Triggers"
26573   },
26574   {
26575     "type": "get",
26576     "url": "/api/triggers/{id}/all_conditions",
26577     "title": "Gets \"AND\" Trigger Conditions",
26578     "examples": [
26579       {
26580         "title": "Example usage:",
26581         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
26582         "type": "json"
26583       }
26584     ],
26585     "name": "getAllConditions",
26586     "group": "Triggers",
26587     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26588     "version": "0.0.0",
26589     "filename": "server/api/trigger/index.js",
26590     "groupTitle": "Triggers"
26591   },
26592   {
26593     "type": "get",
26594     "url": "/api/triggers/{id}/any_conditions",
26595     "title": "Gets \"OR\" Trigger Conditions",
26596     "examples": [
26597       {
26598         "title": "Example usage:",
26599         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
26600         "type": "json"
26601       }
26602     ],
26603     "name": "getAnyConditions",
26604     "group": "Triggers",
26605     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26606     "version": "0.0.0",
26607     "filename": "server/api/trigger/index.js",
26608     "groupTitle": "Triggers"
26609   },
26610   {
26611     "type": "put",
26612     "url": "/api/triggers/{id}",
26613     "title": "Update an existing Trigger",
26614     "examples": [
26615       {
26616         "title": "Example usage:",
26617         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26618         "type": "json"
26619       }
26620     ],
26621     "name": "updateTriggers",
26622     "group": "Triggers",
26623     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26624     "version": "0.0.0",
26625     "filename": "server/api/trigger/index.js",
26626     "groupTitle": "Triggers"
26627   },
26628   {
26629     "type": "post",
26630     "url": "/api/trunks/clone",
26631     "title": "Clone an existing Trunk",
26632     "examples": [
26633       {
26634         "title": "Example usage:",
26635         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26636         "type": "json"
26637       }
26638     ],
26639     "name": "CloneTrunks",
26640     "group": "Trunks",
26641     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26642     "version": "0.0.0",
26643     "filename": "server/api/trunk/index.js",
26644     "groupTitle": "Trunks"
26645   },
26646   {
26647     "type": "post",
26648     "url": "/api/trunks",
26649     "title": "Create a new trunk",
26650     "examples": [
26651       {
26652         "title": "Example usage:",
26653         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26654         "type": "json"
26655       }
26656     ],
26657     "name": "Create",
26658     "group": "Trunks",
26659     "parameter": {
26660       "fields": {
26661         "Body": [
26662           {
26663             "group": "Body",
26664             "type": "String",
26665             "optional": false,
26666             "field": "name",
26667             "description": ""
26668           },
26669           {
26670             "group": "Body",
26671             "type": "String",
26672             "allowedValues": [
26673               "\"friend\"",
26674               "\"user\"",
26675               "\"peer\""
26676             ],
26677             "optional": false,
26678             "field": "type",
26679             "description": ""
26680           },
26681           {
26682             "group": "Body",
26683             "type": "String",
26684             "optional": false,
26685             "field": "context",
26686             "description": ""
26687           },
26688           {
26689             "group": "Body",
26690             "type": "String",
26691             "allowedValues": [
26692               "\"ALLOWED_NOT_SCREENED\"",
26693               "\"ALLOWED_PASSED_SCREEN\"",
26694               "\"ALLOWED_FAILED_SCREEN\"",
26695               "\"ALLOWED\"",
26696               "\"PROHIB_NOT_SCREENED\"",
26697               "\"PROHIB_PASSED_SCREEN\"",
26698               "\"PROHIB_FAILED_SCREEN\"",
26699               "\"PROHIB\""
26700             ],
26701             "optional": true,
26702             "field": "callingpres",
26703             "description": ""
26704           },
26705           {
26706             "group": "Body",
26707             "type": "String",
26708             "optional": true,
26709             "field": "deny",
26710             "description": ""
26711           },
26712           {
26713             "group": "Body",
26714             "type": "String",
26715             "optional": true,
26716             "field": "permit",
26717             "description": ""
26718           },
26719           {
26720             "group": "Body",
26721             "type": "String",
26722             "optional": true,
26723             "field": "secret",
26724             "description": ""
26725           },
26726           {
26727             "group": "Body",
26728             "type": "String",
26729             "optional": true,
26730             "field": "md5secret",
26731             "description": ""
26732           },
26733           {
26734             "group": "Body",
26735             "type": "String",
26736             "optional": true,
26737             "field": "remotesecret",
26738             "description": ""
26739           },
26740           {
26741             "group": "Body",
26742             "type": "String",
26743             "optional": true,
26744             "field": "transport",
26745             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
26746           },
26747           {
26748             "group": "Body",
26749             "type": "String",
26750             "allowedValues": [
26751               "\"rfc2833\"",
26752               "\"info\"",
26753               "\"shortinfo\"",
26754               "\"inband\"",
26755               "\"auto\""
26756             ],
26757             "optional": true,
26758             "field": "dtmfmode",
26759             "description": ""
26760           },
26761           {
26762             "group": "Body",
26763             "type": "String",
26764             "allowedValues": [
26765               "\"yes\"",
26766               "\"no\"",
26767               "\"nonat\"",
26768               "\"update\"",
26769               "\"outgoing\""
26770             ],
26771             "optional": true,
26772             "field": "directmedia",
26773             "description": ""
26774           },
26775           {
26776             "group": "Body",
26777             "type": "String",
26778             "allowedValues": [
26779               "\"yes\"",
26780               "\"no\""
26781             ],
26782             "optional": true,
26783             "field": "directrtpsetup",
26784             "description": ""
26785           },
26786           {
26787             "group": "Body",
26788             "type": "String",
26789             "optional": true,
26790             "field": "directmediapermit",
26791             "description": ""
26792           },
26793           {
26794             "group": "Body",
26795             "type": "String",
26796             "optional": true,
26797             "field": "directmediadeny",
26798             "description": ""
26799           },
26800           {
26801             "group": "Body",
26802             "type": "String",
26803             "optional": true,
26804             "field": "nat",
26805             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
26806           },
26807           {
26808             "group": "Body",
26809             "type": "String",
26810             "optional": true,
26811             "field": "callgroup",
26812             "description": ""
26813           },
26814           {
26815             "group": "Body",
26816             "type": "String",
26817             "optional": true,
26818             "field": "namedcallgroup",
26819             "description": ""
26820           },
26821           {
26822             "group": "Body",
26823             "type": "String",
26824             "optional": true,
26825             "field": "pickupgroup",
26826             "description": ""
26827           },
26828           {
26829             "group": "Body",
26830             "type": "String",
26831             "optional": true,
26832             "field": "namedpickupgroup",
26833             "description": ""
26834           },
26835           {
26836             "group": "Body",
26837             "type": "String",
26838             "optional": true,
26839             "field": "language",
26840             "description": ""
26841           },
26842           {
26843             "group": "Body",
26844             "type": "String",
26845             "optional": true,
26846             "field": "tonezone",
26847             "description": ""
26848           },
26849           {
26850             "group": "Body",
26851             "type": "String",
26852             "optional": true,
26853             "field": "disallow",
26854             "description": ""
26855           },
26856           {
26857             "group": "Body",
26858             "type": "String",
26859             "optional": false,
26860             "field": "allow",
26861             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
26862           },
26863           {
26864             "group": "Body",
26865             "type": "String",
26866             "allowedValues": [
26867               "\"yes\"",
26868               "\"no\""
26869             ],
26870             "optional": true,
26871             "field": "autoframing",
26872             "description": ""
26873           },
26874           {
26875             "group": "Body",
26876             "type": "String",
26877             "optional": true,
26878             "field": "insecure",
26879             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
26880           },
26881           {
26882             "group": "Body",
26883             "type": "String",
26884             "allowedValues": [
26885               "\"yes\"",
26886               "\"no\""
26887             ],
26888             "optional": true,
26889             "field": "trustrpid",
26890             "description": ""
26891           },
26892           {
26893             "group": "Body",
26894             "type": "String",
26895             "allowedValues": [
26896               "\"yes\"",
26897               "\"no\""
26898             ],
26899             "optional": true,
26900             "field": "trust_id_outbound",
26901             "description": ""
26902           },
26903           {
26904             "group": "Body",
26905             "type": "String",
26906             "allowedValues": [
26907               "\"yes\"",
26908               "\"no\"",
26909               "\"never\""
26910             ],
26911             "optional": true,
26912             "field": "progressinband",
26913             "description": ""
26914           },
26915           {
26916             "group": "Body",
26917             "type": "String",
26918             "allowedValues": [
26919               "\"yes\"",
26920               "\"no\""
26921             ],
26922             "optional": true,
26923             "field": "promiscredir",
26924             "description": ""
26925           },
26926           {
26927             "group": "Body",
26928             "type": "String",
26929             "allowedValues": [
26930               "\"yes\"",
26931               "\"no\""
26932             ],
26933             "optional": true,
26934             "field": "useclientcode",
26935             "description": ""
26936           },
26937           {
26938             "group": "Body",
26939             "type": "Integer",
26940             "optional": true,
26941             "field": "accountcode",
26942             "description": ""
26943           },
26944           {
26945             "group": "Body",
26946             "type": "String",
26947             "optional": true,
26948             "field": "setvar",
26949             "description": ""
26950           },
26951           {
26952             "group": "Body",
26953             "type": "String",
26954             "optional": true,
26955             "field": "callerid",
26956             "description": ""
26957           },
26958           {
26959             "group": "Body",
26960             "type": "String",
26961             "optional": true,
26962             "field": "amaflags",
26963             "description": ""
26964           },
26965           {
26966             "group": "Body",
26967             "type": "String",
26968             "allowedValues": [
26969               "\"yes\"",
26970               "\"no\""
26971             ],
26972             "optional": true,
26973             "field": "callcounter",
26974             "description": ""
26975           },
26976           {
26977             "group": "Body",
26978             "type": "Integer",
26979             "optional": true,
26980             "field": "busylevel",
26981             "description": ""
26982           },
26983           {
26984             "group": "Body",
26985             "type": "String",
26986             "allowedValues": [
26987               "\"yes\"",
26988               "\"no\""
26989             ],
26990             "optional": true,
26991             "field": "allowoverlap",
26992             "description": ""
26993           },
26994           {
26995             "group": "Body",
26996             "type": "String",
26997             "allowedValues": [
26998               "\"yes\"",
26999               "\"no\""
27000             ],
27001             "optional": true,
27002             "field": "allowsubscribe",
27003             "description": ""
27004           },
27005           {
27006             "group": "Body",
27007             "type": "String",
27008             "allowedValues": [
27009               "\"yes\"",
27010               "\"no\""
27011             ],
27012             "optional": true,
27013             "field": "allowtransfer",
27014             "description": ""
27015           },
27016           {
27017             "group": "Body",
27018             "type": "String",
27019             "allowedValues": [
27020               "\"yes\"",
27021               "\"no\""
27022             ],
27023             "optional": true,
27024             "field": "ignoresdpversion",
27025             "description": ""
27026           },
27027           {
27028             "group": "Body",
27029             "type": "String",
27030             "optional": true,
27031             "field": "subscribecontext",
27032             "description": ""
27033           },
27034           {
27035             "group": "Body",
27036             "type": "String",
27037             "optional": true,
27038             "field": "template",
27039             "description": ""
27040           },
27041           {
27042             "group": "Body",
27043             "type": "String",
27044             "allowedValues": [
27045               "\"yes\"",
27046               "\"no\"",
27047               "\"always\""
27048             ],
27049             "optional": true,
27050             "field": "videosupport",
27051             "description": ""
27052           },
27053           {
27054             "group": "Body",
27055             "type": "Integer",
27056             "optional": true,
27057             "field": "maxcallbitrate",
27058             "description": ""
27059           },
27060           {
27061             "group": "Body",
27062             "type": "String",
27063             "allowedValues": [
27064               "\"yes\"",
27065               "\"no\""
27066             ],
27067             "optional": true,
27068             "field": "rfc2833compensate",
27069             "description": ""
27070           },
27071           {
27072             "group": "Body",
27073             "type": "String",
27074             "optional": true,
27075             "field": "mailbox",
27076             "description": ""
27077           },
27078           {
27079             "group": "Body",
27080             "type": "String",
27081             "allowedValues": [
27082               "\"accept\"",
27083               "\"refuse\"",
27084               "\"originate\""
27085             ],
27086             "optional": true,
27087             "field": "session_timers",
27088             "description": ""
27089           },
27090           {
27091             "group": "Body",
27092             "type": "Integer",
27093             "optional": true,
27094             "field": "session_expires",
27095             "description": ""
27096           },
27097           {
27098             "group": "Body",
27099             "type": "Integer",
27100             "optional": true,
27101             "field": "session_minse",
27102             "description": ""
27103           },
27104           {
27105             "group": "Body",
27106             "type": "String",
27107             "allowedValues": [
27108               "\"uac\"",
27109               "\"uas\""
27110             ],
27111             "optional": true,
27112             "field": "session_refresher",
27113             "description": ""
27114           },
27115           {
27116             "group": "Body",
27117             "type": "String",
27118             "optional": true,
27119             "field": "t38pt_usertpsource",
27120             "description": ""
27121           },
27122           {
27123             "group": "Body",
27124             "type": "String",
27125             "optional": true,
27126             "field": "regexten",
27127             "description": ""
27128           },
27129           {
27130             "group": "Body",
27131             "type": "String",
27132             "optional": true,
27133             "field": "fromdomain",
27134             "description": ""
27135           },
27136           {
27137             "group": "Body",
27138             "type": "String",
27139             "optional": true,
27140             "field": "fromuser",
27141             "description": ""
27142           },
27143           {
27144             "group": "Body",
27145             "type": "Integer",
27146             "optional": true,
27147             "field": "port",
27148             "description": ""
27149           },
27150           {
27151             "group": "Body",
27152             "type": "String",
27153             "allowedValues": [
27154               "\"yes\"",
27155               "\"no\""
27156             ],
27157             "optional": true,
27158             "field": "qualify",
27159             "description": ""
27160           },
27161           {
27162             "group": "Body",
27163             "type": "Integer",
27164             "optional": true,
27165             "field": "keepalive",
27166             "description": ""
27167           },
27168           {
27169             "group": "Body",
27170             "type": "String",
27171             "optional": true,
27172             "field": "defaultip",
27173             "description": ""
27174           },
27175           {
27176             "group": "Body",
27177             "type": "String",
27178             "optional": true,
27179             "field": "defaultuser",
27180             "description": ""
27181           },
27182           {
27183             "group": "Body",
27184             "type": "Integer",
27185             "optional": true,
27186             "field": "rtptimeout",
27187             "description": ""
27188           },
27189           {
27190             "group": "Body",
27191             "type": "Integer",
27192             "optional": true,
27193             "field": "rtpholdtimeout",
27194             "description": ""
27195           },
27196           {
27197             "group": "Body",
27198             "type": "Integer",
27199             "optional": true,
27200             "field": "rtpkeepalive",
27201             "description": ""
27202           },
27203           {
27204             "group": "Body",
27205             "type": "String",
27206             "allowedValues": [
27207               "\"yes\"",
27208               "\"no\"",
27209               "\"pai\""
27210             ],
27211             "optional": true,
27212             "field": "sendrpid",
27213             "description": ""
27214           },
27215           {
27216             "group": "Body",
27217             "type": "String",
27218             "optional": true,
27219             "field": "outboundproxy",
27220             "description": ""
27221           },
27222           {
27223             "group": "Body",
27224             "type": "String",
27225             "optional": true,
27226             "field": "callbackextension",
27227             "description": ""
27228           },
27229           {
27230             "group": "Body",
27231             "type": "Integer",
27232             "optional": true,
27233             "field": "timert1",
27234             "description": ""
27235           },
27236           {
27237             "group": "Body",
27238             "type": "Integer",
27239             "optional": true,
27240             "field": "timerb",
27241             "description": ""
27242           },
27243           {
27244             "group": "Body",
27245             "type": "Integer",
27246             "optional": true,
27247             "field": "qualifyfreq",
27248             "description": ""
27249           },
27250           {
27251             "group": "Body",
27252             "type": "String",
27253             "optional": true,
27254             "field": "contactpermit",
27255             "description": ""
27256           },
27257           {
27258             "group": "Body",
27259             "type": "String",
27260             "optional": true,
27261             "field": "contactdeny",
27262             "description": ""
27263           },
27264           {
27265             "group": "Body",
27266             "type": "String",
27267             "optional": true,
27268             "field": "contactacl",
27269             "description": ""
27270           },
27271           {
27272             "group": "Body",
27273             "type": "String",
27274             "optional": true,
27275             "field": "unsolicited_mailbox",
27276             "description": ""
27277           },
27278           {
27279             "group": "Body",
27280             "type": "String",
27281             "optional": true,
27282             "field": "use_q850_reason",
27283             "description": ""
27284           },
27285           {
27286             "group": "Body",
27287             "type": "Integer",
27288             "optional": true,
27289             "field": "maxforwards",
27290             "description": ""
27291           },
27292           {
27293             "group": "Body",
27294             "type": "String",
27295             "allowedValues": [
27296               "\"yes\"",
27297               "\"no\""
27298             ],
27299             "optional": true,
27300             "field": "encryption",
27301             "description": ""
27302           },
27303           {
27304             "group": "Body",
27305             "type": "String",
27306             "allowedValues": [
27307               "\"yes\"",
27308               "\"no\""
27309             ],
27310             "optional": true,
27311             "field": "avpf",
27312             "description": ""
27313           },
27314           {
27315             "group": "Body",
27316             "type": "String",
27317             "allowedValues": [
27318               "\"yes\"",
27319               "\"no\""
27320             ],
27321             "optional": true,
27322             "field": "force_avp",
27323             "description": ""
27324           },
27325           {
27326             "group": "Body",
27327             "type": "String",
27328             "allowedValues": [
27329               "\"yes\"",
27330               "\"no\""
27331             ],
27332             "optional": true,
27333             "field": "icesupport",
27334             "description": ""
27335           },
27336           {
27337             "group": "Body",
27338             "type": "String",
27339             "allowedValues": [
27340               "\"yes\"",
27341               "\"no\""
27342             ],
27343             "optional": true,
27344             "field": "dtlsenable",
27345             "description": ""
27346           },
27347           {
27348             "group": "Body",
27349             "type": "String",
27350             "allowedValues": [
27351               "\"yes\"",
27352               "\"no\"",
27353               "\"fingerprint\"",
27354               "\"certificate\""
27355             ],
27356             "optional": true,
27357             "field": "dtlsverify",
27358             "description": ""
27359           },
27360           {
27361             "group": "Body",
27362             "type": "Integer",
27363             "optional": true,
27364             "field": "dtlsrekey",
27365             "description": ""
27366           },
27367           {
27368             "group": "Body",
27369             "type": "String",
27370             "optional": true,
27371             "field": "dtlscertfile",
27372             "description": ""
27373           },
27374           {
27375             "group": "Body",
27376             "type": "String",
27377             "optional": true,
27378             "field": "dtlsprivatekey",
27379             "description": ""
27380           },
27381           {
27382             "group": "Body",
27383             "type": "String",
27384             "optional": true,
27385             "field": "dtlscipher",
27386             "description": ""
27387           },
27388           {
27389             "group": "Body",
27390             "type": "String",
27391             "optional": true,
27392             "field": "dtlscafile",
27393             "description": ""
27394           },
27395           {
27396             "group": "Body",
27397             "type": "String",
27398             "optional": true,
27399             "field": "dtlscapath",
27400             "description": ""
27401           },
27402           {
27403             "group": "Body",
27404             "type": "String",
27405             "allowedValues": [
27406               "\"active\"",
27407               "\"passive\"",
27408               "\"actpass\""
27409             ],
27410             "optional": true,
27411             "field": "dtlssetup",
27412             "description": ""
27413           },
27414           {
27415             "group": "Body",
27416             "type": "String",
27417             "optional": true,
27418             "field": "dtlsfingerprint",
27419             "description": ""
27420           },
27421           {
27422             "group": "Body",
27423             "type": "String",
27424             "allowedValues": [
27425               "\"yes\"",
27426               "\"no\""
27427             ],
27428             "optional": true,
27429             "field": "usereqphone",
27430             "description": ""
27431           },
27432           {
27433             "group": "Body",
27434             "type": "String",
27435             "optional": true,
27436             "field": "recordonfeature",
27437             "description": ""
27438           },
27439           {
27440             "group": "Body",
27441             "type": "String",
27442             "optional": true,
27443             "field": "recordofffeature",
27444             "description": ""
27445           },
27446           {
27447             "group": "Body",
27448             "type": "Integer",
27449             "optional": true,
27450             "field": "call_limit",
27451             "description": ""
27452           },
27453           {
27454             "group": "Body",
27455             "type": "String",
27456             "allowedValues": [
27457               "\"yes\"",
27458               "\"no\""
27459             ],
27460             "optional": true,
27461             "field": "registertrying",
27462             "description": ""
27463           },
27464           {
27465             "group": "Body",
27466             "type": "String",
27467             "allowedValues": [
27468               "\"yes\"",
27469               "\"no\""
27470             ],
27471             "optional": true,
27472             "field": "subscribemwi",
27473             "description": ""
27474           },
27475           {
27476             "group": "Body",
27477             "type": "String",
27478             "optional": true,
27479             "field": "vmexten",
27480             "description": ""
27481           },
27482           {
27483             "group": "Body",
27484             "type": "String",
27485             "optional": true,
27486             "field": "mohinterpret",
27487             "description": ""
27488           },
27489           {
27490             "group": "Body",
27491             "type": "String",
27492             "optional": true,
27493             "field": "mohsuggest",
27494             "description": ""
27495           },
27496           {
27497             "group": "Body",
27498             "type": "String",
27499             "optional": true,
27500             "field": "parkinglot",
27501             "description": ""
27502           },
27503           {
27504             "group": "Body",
27505             "type": "String",
27506             "optional": true,
27507             "field": "description",
27508             "description": ""
27509           },
27510           {
27511             "group": "Body",
27512             "type": "String",
27513             "optional": true,
27514             "field": "host",
27515             "description": ""
27516           },
27517           {
27518             "group": "Body",
27519             "type": "String",
27520             "allowedValues": [
27521               "\"yes\"",
27522               "\"no\"",
27523               "\"nonat\"",
27524               "\"update\"",
27525               "\"update,nonat\""
27526             ],
27527             "optional": true,
27528             "field": "canreinvite",
27529             "description": ""
27530           },
27531           {
27532             "group": "Body",
27533             "type": "String",
27534             "optional": true,
27535             "field": "registry",
27536             "description": ""
27537           },
27538           {
27539             "group": "Body",
27540             "type": "String",
27541             "optional": true,
27542             "field": "otherFields",
27543             "description": ""
27544           },
27545           {
27546             "group": "Body",
27547             "type": "Boolean",
27548             "optional": false,
27549             "field": "active",
27550             "description": ""
27551           },
27552           {
27553             "group": "Body",
27554             "type": "String",
27555             "optional": true,
27556             "field": "t38pt_udptl",
27557             "description": ""
27558           }
27559         ]
27560       }
27561     },
27562     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27563     "version": "0.0.0",
27564     "filename": "server/api/trunk/index.js",
27565     "groupTitle": "Trunks"
27566   },
27567   {
27568     "type": "delete",
27569     "url": "/api/trunks/{id}",
27570     "title": "Deletes a trunk",
27571     "examples": [
27572       {
27573         "title": "Example usage:",
27574         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
27575         "type": "json"
27576       }
27577     ],
27578     "name": "Delete",
27579     "group": "Trunks",
27580     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27581     "version": "0.0.0",
27582     "filename": "server/api/trunk/index.js",
27583     "groupTitle": "Trunks"
27584   },
27585   {
27586     "type": "get",
27587     "url": "/api/trunks",
27588     "title": "Gets a list of Trunks",
27589     "examples": [
27590       {
27591         "title": "Example usage:",
27592         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
27593         "type": "json"
27594       }
27595     ],
27596     "name": "GetTrunks",
27597     "group": "Trunks",
27598     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27599     "version": "0.0.0",
27600     "filename": "server/api/trunk/index.js",
27601     "groupTitle": "Trunks"
27602   },
27603   {
27604     "type": "get",
27605     "url": "/api/trunks/{id}",
27606     "title": "Gets a single Trunk",
27607     "examples": [
27608       {
27609         "title": "Example usage:",
27610         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
27611         "type": "json"
27612       }
27613     ],
27614     "name": "ShowTrunks",
27615     "group": "Trunks",
27616     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27617     "version": "0.0.0",
27618     "filename": "server/api/trunk/index.js",
27619     "groupTitle": "Trunks"
27620   },
27621   {
27622     "type": "put",
27623     "url": "/api/trunks/{id}",
27624     "title": "Update an existing trunk",
27625     "examples": [
27626       {
27627         "title": "Example usage:",
27628         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27629         "type": "json"
27630       }
27631     ],
27632     "name": "Update",
27633     "group": "Trunks",
27634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27635     "version": "0.0.0",
27636     "filename": "server/api/trunk/index.js",
27637     "groupTitle": "Trunks"
27638   },
27639   {
27640     "type": "post",
27641     "url": "/api/userProfile/resources",
27642     "title": "Creates a new User Profile Resource",
27643     "examples": [
27644       {
27645         "title": "Example usage:",
27646         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27647         "type": "json"
27648       }
27649     ],
27650     "name": "CreateUser_Profile_Resources",
27651     "group": "User_Profile_Resources",
27652     "parameter": {
27653       "fields": {
27654         "Body": [
27655           {
27656             "group": "Body",
27657             "type": "String",
27658             "optional": false,
27659             "field": "name",
27660             "description": ""
27661           },
27662           {
27663             "group": "Body",
27664             "type": "Integer",
27665             "optional": false,
27666             "field": "resourceId",
27667             "description": ""
27668           },
27669           {
27670             "group": "Body",
27671             "type": "String",
27672             "optional": false,
27673             "field": "type",
27674             "description": ""
27675           }
27676         ]
27677       }
27678     },
27679     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27680     "version": "0.0.0",
27681     "filename": "server/api/userProfileResource/index.js",
27682     "groupTitle": "User_Profile_Resources"
27683   },
27684   {
27685     "type": "delete",
27686     "url": "/api/userProfile/resources/{id}",
27687     "title": "Deletes a User Profile Resource",
27688     "examples": [
27689       {
27690         "title": "Example usage:",
27691         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27692         "type": "json"
27693       }
27694     ],
27695     "name": "DeleteUser_Profile_Resources",
27696     "group": "User_Profile_Resources",
27697     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27698     "version": "0.0.0",
27699     "filename": "server/api/userProfileResource/index.js",
27700     "groupTitle": "User_Profile_Resources"
27701   },
27702   {
27703     "type": "get",
27704     "url": "/api/userProfile/resources/describe",
27705     "title": "Gets table info about User Profile Resources",
27706     "examples": [
27707       {
27708         "title": "Example usage:",
27709         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27710         "type": "json"
27711       }
27712     ],
27713     "name": "DescribeUser_Profile_Resources",
27714     "group": "User_Profile_Resources",
27715     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27716     "version": "0.0.0",
27717     "filename": "server/api/userProfileResource/index.js",
27718     "groupTitle": "User_Profile_Resources"
27719   },
27720   {
27721     "type": "get",
27722     "url": "/api/userProfile/resources",
27723     "title": "Gets a list of User Profile Resources",
27724     "examples": [
27725       {
27726         "title": "Example usage:",
27727         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27728         "type": "json"
27729       }
27730     ],
27731     "name": "GetUser_Profile_Resources",
27732     "group": "User_Profile_Resources",
27733     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27734     "version": "0.0.0",
27735     "filename": "server/api/userProfileResource/index.js",
27736     "groupTitle": "User_Profile_Resources"
27737   },
27738   {
27739     "type": "get",
27740     "url": "/api/userProfile/resources/{id}",
27741     "title": "Gets a single User Profile Resource",
27742     "examples": [
27743       {
27744         "title": "Example usage:",
27745         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27746         "type": "json"
27747       }
27748     ],
27749     "name": "ShowUser_Profile_Resources",
27750     "group": "User_Profile_Resources",
27751     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27752     "version": "0.0.0",
27753     "filename": "server/api/userProfileResource/index.js",
27754     "groupTitle": "User_Profile_Resources"
27755   },
27756   {
27757     "type": "put",
27758     "url": "/api/userProfile/resources/{id}",
27759     "title": "Update an existing User Profile Resource",
27760     "examples": [
27761       {
27762         "title": "Example usage:",
27763         "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",
27764         "type": "json"
27765       }
27766     ],
27767     "name": "updateUser_Profile_Resources",
27768     "group": "User_Profile_Resources",
27769     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27770     "version": "0.0.0",
27771     "filename": "server/api/userProfileResource/index.js",
27772     "groupTitle": "User_Profile_Resources"
27773   },
27774   {
27775     "type": "post",
27776     "url": "/api/userProfile/sections",
27777     "title": "Creates a new User Profile Section",
27778     "examples": [
27779       {
27780         "title": "Example usage:",
27781         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27782         "type": "json"
27783       }
27784     ],
27785     "name": "CreateUser_Profile_Sections",
27786     "group": "User_Profile_Sections",
27787     "parameter": {
27788       "fields": {
27789         "Body": [
27790           {
27791             "group": "Body",
27792             "type": "String",
27793             "optional": false,
27794             "field": "name",
27795             "description": ""
27796           },
27797           {
27798             "group": "Body",
27799             "type": "String",
27800             "optional": false,
27801             "field": "category",
27802             "description": ""
27803           },
27804           {
27805             "group": "Body",
27806             "type": "Integer",
27807             "optional": false,
27808             "field": "sectionId",
27809             "description": ""
27810           },
27811           {
27812             "group": "Body",
27813             "type": "Boolean",
27814             "optional": true,
27815             "field": "enabled",
27816             "description": ""
27817           },
27818           {
27819             "group": "Body",
27820             "type": "Boolean",
27821             "optional": true,
27822             "field": "autoAssociation",
27823             "description": ""
27824           },
27825           {
27826             "group": "Body",
27827             "type": "String",
27828             "optional": true,
27829             "field": "crudPermissions",
27830             "description": ""
27831           }
27832         ]
27833       }
27834     },
27835     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27836     "version": "0.0.0",
27837     "filename": "server/api/userProfileSection/index.js",
27838     "groupTitle": "User_Profile_Sections"
27839   },
27840   {
27841     "type": "delete",
27842     "url": "/api/userProfile/sections/{id}",
27843     "title": "Deletes a User Profile Section",
27844     "examples": [
27845       {
27846         "title": "Example usage:",
27847         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
27848         "type": "json"
27849       }
27850     ],
27851     "name": "DeleteUser_Profile_Sections",
27852     "group": "User_Profile_Sections",
27853     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27854     "version": "0.0.0",
27855     "filename": "server/api/userProfileSection/index.js",
27856     "groupTitle": "User_Profile_Sections"
27857   },
27858   {
27859     "type": "get",
27860     "url": "/api/userProfile/sections/describe",
27861     "title": "Gets table info about User Profile Sections",
27862     "examples": [
27863       {
27864         "title": "Example usage:",
27865         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
27866         "type": "json"
27867       }
27868     ],
27869     "name": "DescribeUser_Profile_Sections",
27870     "group": "User_Profile_Sections",
27871     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27872     "version": "0.0.0",
27873     "filename": "server/api/userProfileSection/index.js",
27874     "groupTitle": "User_Profile_Sections"
27875   },
27876   {
27877     "type": "get",
27878     "url": "/api/userProfile/sections",
27879     "title": "Gets a list of User Profile Sections",
27880     "examples": [
27881       {
27882         "title": "Example usage:",
27883         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
27884         "type": "json"
27885       }
27886     ],
27887     "name": "GetUser_Profile_Sections",
27888     "group": "User_Profile_Sections",
27889     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27890     "version": "0.0.0",
27891     "filename": "server/api/userProfileSection/index.js",
27892     "groupTitle": "User_Profile_Sections"
27893   },
27894   {
27895     "type": "get",
27896     "url": "/api/userProfile/sections/{id}",
27897     "title": "Gets a single User Profile Section",
27898     "examples": [
27899       {
27900         "title": "Example usage:",
27901         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
27902         "type": "json"
27903       }
27904     ],
27905     "name": "ShowUser_Profile_Sections",
27906     "group": "User_Profile_Sections",
27907     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27908     "version": "0.0.0",
27909     "filename": "server/api/userProfileSection/index.js",
27910     "groupTitle": "User_Profile_Sections"
27911   },
27912   {
27913     "type": "put",
27914     "url": "/api/userProfile/sections/{id}",
27915     "title": "Update an existing User Profile Section",
27916     "examples": [
27917       {
27918         "title": "Example usage:",
27919         "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",
27920         "type": "json"
27921       }
27922     ],
27923     "name": "updateUser_Profile_Sections",
27924     "group": "User_Profile_Sections",
27925     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27926     "version": "0.0.0",
27927     "filename": "server/api/userProfileSection/index.js",
27928     "groupTitle": "User_Profile_Sections"
27929   },
27930   {
27931     "type": "post",
27932     "url": "/api/userProfiles/{id}/resources",
27933     "title": "Add resources' permissions to User Profile",
27934     "examples": [
27935       {
27936         "title": "Example usage:",
27937         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27938         "type": "json"
27939       }
27940     ],
27941     "name": "AddResources",
27942     "group": "User_Profiles",
27943     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27944     "version": "0.0.0",
27945     "filename": "server/api/userProfile/index.js",
27946     "groupTitle": "User_Profiles"
27947   },
27948   {
27949     "type": "post",
27950     "url": "/api/userProfiles/{id}/sections",
27951     "title": "Add sections' permissions to User Profile",
27952     "examples": [
27953       {
27954         "title": "Example usage:",
27955         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27956         "type": "json"
27957       }
27958     ],
27959     "name": "AddSections",
27960     "group": "User_Profiles",
27961     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27962     "version": "0.0.0",
27963     "filename": "server/api/userProfile/index.js",
27964     "groupTitle": "User_Profiles"
27965   },
27966   {
27967     "type": "post",
27968     "url": "/api/userProfiles/clone",
27969     "title": "Clone an existing User Profile",
27970     "examples": [
27971       {
27972         "title": "Example usage:",
27973         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27974         "type": "json"
27975       }
27976     ],
27977     "name": "CloneUser_Profiles",
27978     "group": "User_Profiles",
27979     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27980     "version": "0.0.0",
27981     "filename": "server/api/userProfile/index.js",
27982     "groupTitle": "User_Profiles"
27983   },
27984   {
27985     "type": "post",
27986     "url": "/api/userProfiles",
27987     "title": "Creates a new User Profile",
27988     "examples": [
27989       {
27990         "title": "Example usage:",
27991         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27992         "type": "json"
27993       }
27994     ],
27995     "name": "CreateUser_Profiles",
27996     "group": "User_Profiles",
27997     "parameter": {
27998       "fields": {
27999         "Body": [
28000           {
28001             "group": "Body",
28002             "type": "String",
28003             "optional": false,
28004             "field": "name",
28005             "description": ""
28006           },
28007           {
28008             "group": "Body",
28009             "type": "String",
28010             "optional": false,
28011             "field": "crudPermissions",
28012             "description": ""
28013           },
28014           {
28015             "group": "Body",
28016             "type": "String",
28017             "optional": true,
28018             "field": "description",
28019             "description": ""
28020           }
28021         ]
28022       }
28023     },
28024     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28025     "version": "0.0.0",
28026     "filename": "server/api/userProfile/index.js",
28027     "groupTitle": "User_Profiles"
28028   },
28029   {
28030     "type": "delete",
28031     "url": "/api/userProfiles/{id}",
28032     "title": "Deletes a User Profile",
28033     "examples": [
28034       {
28035         "title": "Example usage:",
28036         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
28037         "type": "json"
28038       }
28039     ],
28040     "name": "DeleteUser_Profiles",
28041     "group": "User_Profiles",
28042     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28043     "version": "0.0.0",
28044     "filename": "server/api/userProfile/index.js",
28045     "groupTitle": "User_Profiles"
28046   },
28047   {
28048     "type": "get",
28049     "url": "/api/userProfiles/describe",
28050     "title": "Gets table info about User Profiles",
28051     "examples": [
28052       {
28053         "title": "Example usage:",
28054         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
28055         "type": "json"
28056       }
28057     ],
28058     "name": "DescribeUser_Profiles",
28059     "group": "User_Profiles",
28060     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28061     "version": "0.0.0",
28062     "filename": "server/api/userProfile/index.js",
28063     "groupTitle": "User_Profiles"
28064   },
28065   {
28066     "type": "get",
28067     "url": "/api/userProfiles/{id}/resources?section={section}",
28068     "title": "Get Resources assigned to a Section",
28069     "examples": [
28070       {
28071         "title": "Example usage:",
28072         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
28073         "type": "json"
28074       }
28075     ],
28076     "name": "GetResources",
28077     "group": "User_Profiles",
28078     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28079     "version": "0.0.0",
28080     "filename": "server/api/userProfile/index.js",
28081     "groupTitle": "User_Profiles"
28082   },
28083   {
28084     "type": "get",
28085     "url": "/api/userProfiles/{id}/sections",
28086     "title": "Get sections associated to a User Profile",
28087     "examples": [
28088       {
28089         "title": "Example usage:",
28090         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
28091         "type": "json"
28092       }
28093     ],
28094     "name": "GetSections",
28095     "group": "User_Profiles",
28096     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28097     "version": "0.0.0",
28098     "filename": "server/api/userProfile/index.js",
28099     "groupTitle": "User_Profiles"
28100   },
28101   {
28102     "type": "get",
28103     "url": "/api/userProfiles",
28104     "title": "Gets a list of User Profiles",
28105     "examples": [
28106       {
28107         "title": "Example usage:",
28108         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
28109         "type": "json"
28110       }
28111     ],
28112     "name": "GetUser_Profiles",
28113     "group": "User_Profiles",
28114     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28115     "version": "0.0.0",
28116     "filename": "server/api/userProfile/index.js",
28117     "groupTitle": "User_Profiles"
28118   },
28119   {
28120     "type": "delete",
28121     "url": "/api/userProfiles/{id}/resources",
28122     "title": "Removes resources' permissions from User Profile",
28123     "examples": [
28124       {
28125         "title": "Example usage:",
28126         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28127         "type": "json"
28128       }
28129     ],
28130     "name": "RemoveResources",
28131     "group": "User_Profiles",
28132     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28133     "version": "0.0.0",
28134     "filename": "server/api/userProfile/index.js",
28135     "groupTitle": "User_Profiles"
28136   },
28137   {
28138     "type": "delete",
28139     "url": "/api/userProfiles/{id}/sections",
28140     "title": "Removes sections' permissions from User Profile",
28141     "examples": [
28142       {
28143         "title": "Example usage:",
28144         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
28145         "type": "json"
28146       }
28147     ],
28148     "name": "RemoveSections",
28149     "group": "User_Profiles",
28150     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28151     "version": "0.0.0",
28152     "filename": "server/api/userProfile/index.js",
28153     "groupTitle": "User_Profiles"
28154   },
28155   {
28156     "type": "get",
28157     "url": "/api/userProfiles/{id}",
28158     "title": "Gets a single User Profile",
28159     "examples": [
28160       {
28161         "title": "Example usage:",
28162         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
28163         "type": "json"
28164       }
28165     ],
28166     "name": "ShowUser_Profiles",
28167     "group": "User_Profiles",
28168     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28169     "version": "0.0.0",
28170     "filename": "server/api/userProfile/index.js",
28171     "groupTitle": "User_Profiles"
28172   },
28173   {
28174     "type": "put",
28175     "url": "/api/userProfiles/{id}",
28176     "title": "Update an existing User Profile",
28177     "examples": [
28178       {
28179         "title": "Example usage:",
28180         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
28181         "type": "json"
28182       }
28183     ],
28184     "name": "updateUser_Profiles",
28185     "group": "User_Profiles",
28186     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28187     "version": "0.0.0",
28188     "filename": "server/api/userProfile/index.js",
28189     "groupTitle": "User_Profiles"
28190   },
28191   {
28192     "type": "post",
28193     "url": "/api/users/{id}/chat_interactions",
28194     "title": "Add chat interaction tabs to an agent",
28195     "examples": [
28196       {
28197         "title": "Example usage:",
28198         "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",
28199         "type": "json"
28200       }
28201     ],
28202     "name": "AddChatInteractions",
28203     "group": "Users",
28204     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28205     "version": "0.0.0",
28206     "filename": "server/api/user/index.js",
28207     "groupTitle": "Users"
28208   },
28209   {
28210     "type": "post",
28211     "url": "/api/users/{id}/chat_websites",
28212     "title": "Add a Chat Website to a user",
28213     "examples": [
28214       {
28215         "title": "Example usage:",
28216         "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",
28217         "type": "json"
28218       }
28219     ],
28220     "name": "AddChatWebsites",
28221     "group": "Users",
28222     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28223     "version": "0.0.0",
28224     "filename": "server/api/user/index.js",
28225     "groupTitle": "Users"
28226   },
28227   {
28228     "type": "post",
28229     "url": "/api/users/{id}/contacts",
28230     "title": "Add contacts to a user",
28231     "examples": [
28232       {
28233         "title": "Example usage:",
28234         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28235         "type": "json"
28236       }
28237     ],
28238     "name": "AddContacts",
28239     "group": "Users",
28240     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28241     "version": "0.0.0",
28242     "filename": "server/api/user/index.js",
28243     "groupTitle": "Users"
28244   },
28245   {
28246     "type": "post",
28247     "url": "/api/users/{id}/fax_accounts",
28248     "title": "Add a Fax Account to a user",
28249     "examples": [
28250       {
28251         "title": "Example usage:",
28252         "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",
28253         "type": "json"
28254       }
28255     ],
28256     "name": "AddFaxAccounts",
28257     "group": "Users",
28258     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28259     "version": "0.0.0",
28260     "filename": "server/api/user/index.js",
28261     "groupTitle": "Users"
28262   },
28263   {
28264     "type": "post",
28265     "url": "/api/users/{id}/fax_interactions",
28266     "title": "Add fax interaction tabs to an agent",
28267     "examples": [
28268       {
28269         "title": "Example usage:",
28270         "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",
28271         "type": "json"
28272       }
28273     ],
28274     "name": "AddFaxInteractions",
28275     "group": "Users",
28276     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28277     "version": "0.0.0",
28278     "filename": "server/api/user/index.js",
28279     "groupTitle": "Users"
28280   },
28281   {
28282     "type": "post",
28283     "url": "/api/users/{id}/mail_accounts",
28284     "title": "Add a Mail Account to a user",
28285     "examples": [
28286       {
28287         "title": "Example usage:",
28288         "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",
28289         "type": "json"
28290       }
28291     ],
28292     "name": "AddMailAccounts",
28293     "group": "Users",
28294     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28295     "version": "0.0.0",
28296     "filename": "server/api/user/index.js",
28297     "groupTitle": "Users"
28298   },
28299   {
28300     "type": "post",
28301     "url": "/api/users/{id}/mail_interactions",
28302     "title": "Add mail interaction tabs to an agent",
28303     "examples": [
28304       {
28305         "title": "Example usage:",
28306         "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",
28307         "type": "json"
28308       }
28309     ],
28310     "name": "AddMailInteractions",
28311     "group": "Users",
28312     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28313     "version": "0.0.0",
28314     "filename": "server/api/user/index.js",
28315     "groupTitle": "Users"
28316   },
28317   {
28318     "type": "post",
28319     "url": "/api/users/{id}/openchannel_accounts",
28320     "title": "Add a Open Channel Account to a user",
28321     "examples": [
28322       {
28323         "title": "Example usage:",
28324         "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",
28325         "type": "json"
28326       }
28327     ],
28328     "name": "AddOpenchannelAccounts",
28329     "group": "Users",
28330     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28331     "version": "0.0.0",
28332     "filename": "server/api/user/index.js",
28333     "groupTitle": "Users"
28334   },
28335   {
28336     "type": "post",
28337     "url": "/api/users/{id}/openchannel_interactions",
28338     "title": "Add openchannel interaction tabs to an agent",
28339     "examples": [
28340       {
28341         "title": "Example usage:",
28342         "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",
28343         "type": "json"
28344       }
28345     ],
28346     "name": "AddOpenchannelInteractions",
28347     "group": "Users",
28348     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28349     "version": "0.0.0",
28350     "filename": "server/api/user/index.js",
28351     "groupTitle": "Users"
28352   },
28353   {
28354     "type": "post",
28355     "url": "/api/users/{id}/queues",
28356     "title": "Add queues to an agent",
28357     "examples": [
28358       {
28359         "title": "Example usage:",
28360         "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",
28361         "type": "json"
28362       }
28363     ],
28364     "name": "AddQueues",
28365     "group": "Users",
28366     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28367     "version": "0.0.0",
28368     "filename": "server/api/user/index.js",
28369     "groupTitle": "Users"
28370   },
28371   {
28372     "type": "post",
28373     "url": "/api/users/{id}/sms_accounts",
28374     "title": "Add a Sms Account to a user",
28375     "examples": [
28376       {
28377         "title": "Example usage:",
28378         "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",
28379         "type": "json"
28380       }
28381     ],
28382     "name": "AddSmsAccounts",
28383     "group": "Users",
28384     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28385     "version": "0.0.0",
28386     "filename": "server/api/user/index.js",
28387     "groupTitle": "Users"
28388   },
28389   {
28390     "type": "post",
28391     "url": "/api/users/{id}/sms_interactions",
28392     "title": "Add sms interaction tabs to an agent",
28393     "examples": [
28394       {
28395         "title": "Example usage:",
28396         "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",
28397         "type": "json"
28398       }
28399     ],
28400     "name": "AddSmsInteractions",
28401     "group": "Users",
28402     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28403     "version": "0.0.0",
28404     "filename": "server/api/user/index.js",
28405     "groupTitle": "Users"
28406   },
28407   {
28408     "type": "post",
28409     "url": "/api/users/{id}/square_projects",
28410     "title": "Add a Square Project to a user",
28411     "examples": [
28412       {
28413         "title": "Example usage:",
28414         "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",
28415         "type": "json"
28416       }
28417     ],
28418     "name": "AddSquareProjects",
28419     "group": "Users",
28420     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28421     "version": "0.0.0",
28422     "filename": "server/api/user/index.js",
28423     "groupTitle": "Users"
28424   },
28425   {
28426     "type": "post",
28427     "url": "/api/users/{id}/teams",
28428     "title": "Add teams to an agent",
28429     "examples": [
28430       {
28431         "title": "Example usage:",
28432         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28433         "type": "json"
28434       }
28435     ],
28436     "name": "AddTeams",
28437     "group": "Users",
28438     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28439     "version": "0.0.0",
28440     "filename": "server/api/user/index.js",
28441     "groupTitle": "Users"
28442   },
28443   {
28444     "type": "post",
28445     "url": "/api/users/{id}/whatsapp_accounts",
28446     "title": "Add a Whatsapp Account to a user",
28447     "examples": [
28448       {
28449         "title": "Example usage:",
28450         "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",
28451         "type": "json"
28452       }
28453     ],
28454     "name": "AddWhatsappAccounts",
28455     "group": "Users",
28456     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28457     "version": "0.0.0",
28458     "filename": "server/api/user/index.js",
28459     "groupTitle": "Users"
28460   },
28461   {
28462     "type": "post",
28463     "url": "/api/users/{id}/whatsapp_interactions",
28464     "title": "Add Whatsapp interaction tabs to an agent",
28465     "examples": [
28466       {
28467         "title": "Example usage:",
28468         "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",
28469         "type": "json"
28470       }
28471     ],
28472     "name": "AddWhatsappInteractions",
28473     "group": "Users",
28474     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28475     "version": "0.0.0",
28476     "filename": "server/api/user/index.js",
28477     "groupTitle": "Users"
28478   },
28479   {
28480     "type": "put",
28481     "url": "/api/users/{id}/password",
28482     "title": "Change user password",
28483     "examples": [
28484       {
28485         "title": "Example usage:",
28486         "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",
28487         "type": "json"
28488       }
28489     ],
28490     "name": "ChangePwd",
28491     "group": "Users",
28492     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28493     "version": "0.0.0",
28494     "filename": "server/api/user/index.js",
28495     "groupTitle": "Users"
28496   },
28497   {
28498     "type": "post",
28499     "url": "/api/users",
28500     "title": "Create a new user",
28501     "examples": [
28502       {
28503         "title": "Example usage:",
28504         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28505         "type": "json"
28506       }
28507     ],
28508     "name": "Create",
28509     "group": "Users",
28510     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28511     "version": "0.0.0",
28512     "filename": "server/api/user/index.js",
28513     "groupTitle": "Users"
28514   },
28515   {
28516     "type": "post",
28517     "url": "/api/users/{id}/api_key",
28518     "title": "Create a new API access key for the user",
28519     "examples": [
28520       {
28521         "title": "Example usage:",
28522         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
28523         "type": "json"
28524       }
28525     ],
28526     "name": "CreateApiKey",
28527     "group": "Users",
28528     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28529     "version": "0.0.0",
28530     "filename": "server/api/user/index.js",
28531     "groupTitle": "Users"
28532   },
28533   {
28534     "type": "delete",
28535     "url": "/api/users/{id}",
28536     "title": "Deletes a user",
28537     "examples": [
28538       {
28539         "title": "Example usage:",
28540         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
28541         "type": "json"
28542       }
28543     ],
28544     "name": "Delete",
28545     "group": "Users",
28546     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28547     "version": "0.0.0",
28548     "filename": "server/api/user/index.js",
28549     "groupTitle": "Users"
28550   },
28551   {
28552     "type": "get",
28553     "url": "/api/users/describe",
28554     "title": "Gets table info about Users",
28555     "examples": [
28556       {
28557         "title": "Example usage:",
28558         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
28559         "type": "json"
28560       }
28561     ],
28562     "name": "DescribeUsers",
28563     "group": "Users",
28564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28565     "version": "0.0.0",
28566     "filename": "server/api/user/index.js",
28567     "groupTitle": "Users"
28568   },
28569   {
28570     "type": "get",
28571     "url": "/api/users/{id}/agents",
28572     "title": "GetAgents",
28573     "examples": [
28574       {
28575         "title": "Example usage:",
28576         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
28577         "type": "json"
28578       }
28579     ],
28580     "name": "GetAgents",
28581     "group": "Users",
28582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28583     "version": "0.0.0",
28584     "filename": "server/api/user/index.js",
28585     "groupTitle": "Users"
28586   },
28587   {
28588     "type": "get",
28589     "url": "/api/users/{id}/api_key",
28590     "title": "Get the API access key for the user",
28591     "examples": [
28592       {
28593         "title": "Example usage:",
28594         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
28595         "type": "json"
28596       }
28597     ],
28598     "name": "GetApiKey",
28599     "group": "Users",
28600     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28601     "version": "0.0.0",
28602     "filename": "server/api/user/index.js",
28603     "groupTitle": "Users"
28604   },
28605   {
28606     "type": "get",
28607     "url": "/api/users/{id}/groups",
28608     "title": "GetChatGroups",
28609     "examples": [
28610       {
28611         "title": "Example usage:",
28612         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
28613         "type": "json"
28614       }
28615     ],
28616     "name": "GetChatGroups",
28617     "group": "Users",
28618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28619     "version": "0.0.0",
28620     "filename": "server/api/user/index.js",
28621     "groupTitle": "Users"
28622   },
28623   {
28624     "type": "get",
28625     "url": "/api/users/{id}/chat/interactions",
28626     "title": "GetChatInteractions",
28627     "examples": [
28628       {
28629         "title": "Example usage:",
28630         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
28631         "type": "json"
28632       }
28633     ],
28634     "name": "GetChatInteractions",
28635     "group": "Users",
28636     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/user/index.js",
28639     "groupTitle": "Users"
28640   },
28641   {
28642     "type": "get",
28643     "url": "/api/users/{id}/chat_websites",
28644     "title": "GetChatWebsites",
28645     "examples": [
28646       {
28647         "title": "Example usage:",
28648         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
28649         "type": "json"
28650       }
28651     ],
28652     "name": "GetChatWebsites",
28653     "group": "Users",
28654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28655     "version": "0.0.0",
28656     "filename": "server/api/user/index.js",
28657     "groupTitle": "Users"
28658   },
28659   {
28660     "type": "get",
28661     "url": "/api/users/{id}/contacts",
28662     "title": "GetContacts",
28663     "examples": [
28664       {
28665         "title": "Example usage:",
28666         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
28667         "type": "json"
28668       }
28669     ],
28670     "name": "GetContacts",
28671     "group": "Users",
28672     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28673     "version": "0.0.0",
28674     "filename": "server/api/user/index.js",
28675     "groupTitle": "Users"
28676   },
28677   {
28678     "type": "get",
28679     "url": "/api/users/{id}/fax_accounts",
28680     "title": "GetFaxAccounts",
28681     "examples": [
28682       {
28683         "title": "Example usage:",
28684         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
28685         "type": "json"
28686       }
28687     ],
28688     "name": "GetFaxAccounts",
28689     "group": "Users",
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/user/index.js",
28693     "groupTitle": "Users"
28694   },
28695   {
28696     "type": "get",
28697     "url": "/api/users/{id}/fax/interactions",
28698     "title": "GetFaxInteractions",
28699     "examples": [
28700       {
28701         "title": "Example usage:",
28702         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
28703         "type": "json"
28704       }
28705     ],
28706     "name": "GetFaxInteractions",
28707     "group": "Users",
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/user/index.js",
28711     "groupTitle": "Users"
28712   },
28713   {
28714     "type": "get",
28715     "url": "/api/users/{id}/lists",
28716     "title": "GetLists",
28717     "examples": [
28718       {
28719         "title": "Example usage:",
28720         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
28721         "type": "json"
28722       }
28723     ],
28724     "name": "GetLists",
28725     "group": "Users",
28726     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28727     "version": "0.0.0",
28728     "filename": "server/api/user/index.js",
28729     "groupTitle": "Users"
28730   },
28731   {
28732     "type": "get",
28733     "url": "/api/users/{id}/mail_accounts",
28734     "title": "GetMailAccounts",
28735     "examples": [
28736       {
28737         "title": "Example usage:",
28738         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
28739         "type": "json"
28740       }
28741     ],
28742     "name": "GetMailAccounts",
28743     "group": "Users",
28744     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28745     "version": "0.0.0",
28746     "filename": "server/api/user/index.js",
28747     "groupTitle": "Users"
28748   },
28749   {
28750     "type": "get",
28751     "url": "/api/users/{id}/mail/interactions",
28752     "title": "GetMailInteractions",
28753     "examples": [
28754       {
28755         "title": "Example usage:",
28756         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
28757         "type": "json"
28758       }
28759     ],
28760     "name": "GetMailInteractions",
28761     "group": "Users",
28762     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28763     "version": "0.0.0",
28764     "filename": "server/api/user/index.js",
28765     "groupTitle": "Users"
28766   },
28767   {
28768     "type": "get",
28769     "url": "/api/users/{id}/openchannel_accounts",
28770     "title": "GetOpenchannelAccounts",
28771     "examples": [
28772       {
28773         "title": "Example usage:",
28774         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
28775         "type": "json"
28776       }
28777     ],
28778     "name": "GetOpenchannelAccounts",
28779     "group": "Users",
28780     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28781     "version": "0.0.0",
28782     "filename": "server/api/user/index.js",
28783     "groupTitle": "Users"
28784   },
28785   {
28786     "type": "get",
28787     "url": "/api/users/{id}/openchannel/interactions",
28788     "title": "GetOpenchannelInteractions",
28789     "examples": [
28790       {
28791         "title": "Example usage:",
28792         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
28793         "type": "json"
28794       }
28795     ],
28796     "name": "GetOpenchannelInteractions",
28797     "group": "Users",
28798     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28799     "version": "0.0.0",
28800     "filename": "server/api/user/index.js",
28801     "groupTitle": "Users"
28802   },
28803   {
28804     "type": "get",
28805     "url": "/api/users/{id}/prefixes",
28806     "title": "GetPrefixes",
28807     "examples": [
28808       {
28809         "title": "Example usage:",
28810         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
28811         "type": "json"
28812       }
28813     ],
28814     "name": "GetPrefixes",
28815     "group": "Users",
28816     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28817     "version": "0.0.0",
28818     "filename": "server/api/user/index.js",
28819     "groupTitle": "Users"
28820   },
28821   {
28822     "type": "get",
28823     "url": "/api/users/{id}/queues?channel={channel}",
28824     "title": "Gets Queues list",
28825     "examples": [
28826       {
28827         "title": "Example usage:",
28828         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
28829         "type": "json"
28830       }
28831     ],
28832     "name": "GetQueues",
28833     "group": "Users",
28834     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28835     "version": "0.0.0",
28836     "filename": "server/api/user/index.js",
28837     "groupTitle": "Users"
28838   },
28839   {
28840     "type": "get",
28841     "url": "/api/users/{id}/recordings",
28842     "title": "GetRecordings",
28843     "examples": [
28844       {
28845         "title": "Example usage:",
28846         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
28847         "type": "json"
28848       }
28849     ],
28850     "name": "GetRecordings",
28851     "group": "Users",
28852     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28853     "version": "0.0.0",
28854     "filename": "server/api/user/index.js",
28855     "groupTitle": "Users"
28856   },
28857   {
28858     "type": "get",
28859     "url": "/api/users/{id}/scheduled_calls",
28860     "title": "GetScheduledCalls",
28861     "examples": [
28862       {
28863         "title": "Example usage:",
28864         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
28865         "type": "json"
28866       }
28867     ],
28868     "name": "GetScheduledCalls",
28869     "group": "Users",
28870     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28871     "version": "0.0.0",
28872     "filename": "server/api/user/index.js",
28873     "groupTitle": "Users"
28874   },
28875   {
28876     "type": "get",
28877     "url": "/api/users/{id}/screen_recordings",
28878     "title": "GetScreenRecordings",
28879     "examples": [
28880       {
28881         "title": "Example usage:",
28882         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
28883         "type": "json"
28884       }
28885     ],
28886     "name": "GetScreenRecordings",
28887     "group": "Users",
28888     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28889     "version": "0.0.0",
28890     "filename": "server/api/user/index.js",
28891     "groupTitle": "Users"
28892   },
28893   {
28894     "type": "get",
28895     "url": "/api/users/{id}/sms_accounts",
28896     "title": "GetSmsAccounts",
28897     "examples": [
28898       {
28899         "title": "Example usage:",
28900         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
28901         "type": "json"
28902       }
28903     ],
28904     "name": "GetSmsAccounts",
28905     "group": "Users",
28906     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28907     "version": "0.0.0",
28908     "filename": "server/api/user/index.js",
28909     "groupTitle": "Users"
28910   },
28911   {
28912     "type": "get",
28913     "url": "/api/users/{id}/sms/interactions",
28914     "title": "GetSmsInteractions",
28915     "examples": [
28916       {
28917         "title": "Example usage:",
28918         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
28919         "type": "json"
28920       }
28921     ],
28922     "name": "GetSmsInteractions",
28923     "group": "Users",
28924     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28925     "version": "0.0.0",
28926     "filename": "server/api/user/index.js",
28927     "groupTitle": "Users"
28928   },
28929   {
28930     "type": "get",
28931     "url": "/api/users/{id}/square_projects",
28932     "title": "GetSquareProjects",
28933     "examples": [
28934       {
28935         "title": "Example usage:",
28936         "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
28937         "type": "json"
28938       }
28939     ],
28940     "name": "GetSquareProjects",
28941     "group": "Users",
28942     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28943     "version": "0.0.0",
28944     "filename": "server/api/user/index.js",
28945     "groupTitle": "Users"
28946   },
28947   {
28948     "type": "get",
28949     "url": "/api/users/{id}/teams",
28950     "title": "GetTeams",
28951     "examples": [
28952       {
28953         "title": "Example usage:",
28954         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
28955         "type": "json"
28956       }
28957     ],
28958     "name": "GetTeams",
28959     "group": "Users",
28960     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28961     "version": "0.0.0",
28962     "filename": "server/api/user/index.js",
28963     "groupTitle": "Users"
28964   },
28965   {
28966     "type": "get",
28967     "url": "/api/users",
28968     "title": "Gets a list of Users",
28969     "examples": [
28970       {
28971         "title": "Example usage:",
28972         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
28973         "type": "json"
28974       }
28975     ],
28976     "name": "GetUsers",
28977     "group": "Users",
28978     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
28979     "version": "0.0.0",
28980     "filename": "server/api/user/index.js",
28981     "groupTitle": "Users"
28982   },
28983   {
28984     "type": "get",
28985     "url": "/api/users/{id}/queues_rt",
28986     "title": "GetVoiceQueuesRt",
28987     "examples": [
28988       {
28989         "title": "Example usage:",
28990         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
28991         "type": "json"
28992       }
28993     ],
28994     "name": "GetVoiceQueuesRt",
28995     "group": "Users",
28996     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
28997     "version": "0.0.0",
28998     "filename": "server/api/user/index.js",
28999     "groupTitle": "Users"
29000   },
29001   {
29002     "type": "get",
29003     "url": "/api/users/{id}/whatsapp_accounts",
29004     "title": "GetWhatsappAccounts",
29005     "examples": [
29006       {
29007         "title": "Example usage:",
29008         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts -v -u {name}:{password} -X GET",
29009         "type": "json"
29010       }
29011     ],
29012     "name": "GetWhatsappAccounts",
29013     "group": "Users",
29014     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29015     "version": "0.0.0",
29016     "filename": "server/api/user/index.js",
29017     "groupTitle": "Users"
29018   },
29019   {
29020     "type": "get",
29021     "url": "/api/users/{id}/whatsapp/interactions",
29022     "title": "GetWhatsappInteractions",
29023     "examples": [
29024       {
29025         "title": "Example usage:",
29026         "content": "curl https://{domain}/api/users/{id}/whatsapp/interactions -v -u {name}:{password} -X GET",
29027         "type": "json"
29028       }
29029     ],
29030     "name": "GetWhatsappInteractions",
29031     "group": "Users",
29032     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29033     "version": "0.0.0",
29034     "filename": "server/api/user/index.js",
29035     "groupTitle": "Users"
29036   },
29037   {
29038     "type": "post",
29039     "url": "/api/users/{id}/login",
29040     "title": "Login",
29041     "examples": [
29042       {
29043         "title": "Example usage:",
29044         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
29045         "type": "json"
29046       }
29047     ],
29048     "name": "Login",
29049     "group": "Users",
29050     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29051     "version": "0.0.0",
29052     "filename": "server/api/user/index.js",
29053     "groupTitle": "Users"
29054   },
29055   {
29056     "type": "post",
29057     "url": "/api/users/{id}/logout",
29058     "title": "Logout",
29059     "examples": [
29060       {
29061         "title": "Example usage:",
29062         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29063         "type": "json"
29064       }
29065     ],
29066     "name": "Logout",
29067     "group": "Users",
29068     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29069     "version": "0.0.0",
29070     "filename": "server/api/user/index.js",
29071     "groupTitle": "Users"
29072   },
29073   {
29074     "type": "post",
29075     "url": "/api/users/{id}/pause",
29076     "title": "Pause",
29077     "examples": [
29078       {
29079         "title": "Example usage:",
29080         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29081         "type": "json"
29082       }
29083     ],
29084     "name": "Pause",
29085     "group": "Users",
29086     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29087     "version": "0.0.0",
29088     "filename": "server/api/user/index.js",
29089     "groupTitle": "Users"
29090   },
29091   {
29092     "type": "delete",
29093     "url": "/api/users/{id}/api_key",
29094     "title": "Remove API access key for the user",
29095     "examples": [
29096       {
29097         "title": "Example usage:",
29098         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29099         "type": "json"
29100       }
29101     ],
29102     "name": "RemoveApiKey",
29103     "group": "Users",
29104     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29105     "version": "0.0.0",
29106     "filename": "server/api/user/index.js",
29107     "groupTitle": "Users"
29108   },
29109   {
29110     "type": "delete",
29111     "url": "/api/users/{id}/chat_interactions",
29112     "title": "Removes interactions from an agent",
29113     "examples": [
29114       {
29115         "title": "Example usage:",
29116         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29117         "type": "json"
29118       }
29119     ],
29120     "name": "RemoveChatInteractions",
29121     "group": "Users",
29122     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29123     "version": "0.0.0",
29124     "filename": "server/api/user/index.js",
29125     "groupTitle": "Users"
29126   },
29127   {
29128     "type": "delete",
29129     "url": "/api/users/{id}/chat_websites",
29130     "title": "Removes a Chat Website from a user",
29131     "examples": [
29132       {
29133         "title": "Example usage:",
29134         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29135         "type": "json"
29136       }
29137     ],
29138     "name": "RemoveChatWebsites",
29139     "group": "Users",
29140     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29141     "version": "0.0.0",
29142     "filename": "server/api/user/index.js",
29143     "groupTitle": "Users"
29144   },
29145   {
29146     "type": "delete",
29147     "url": "/api/users/{id}/fax_accounts",
29148     "title": "Removes a Fax Account from a user",
29149     "examples": [
29150       {
29151         "title": "Example usage:",
29152         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29153         "type": "json"
29154       }
29155     ],
29156     "name": "RemoveFaxAccounts",
29157     "group": "Users",
29158     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29159     "version": "0.0.0",
29160     "filename": "server/api/user/index.js",
29161     "groupTitle": "Users"
29162   },
29163   {
29164     "type": "delete",
29165     "url": "/api/users/{id}/fax_interactions",
29166     "title": "Removes interactions from an agent",
29167     "examples": [
29168       {
29169         "title": "Example usage:",
29170         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29171         "type": "json"
29172       }
29173     ],
29174     "name": "RemoveFaxInteractions",
29175     "group": "Users",
29176     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29177     "version": "0.0.0",
29178     "filename": "server/api/user/index.js",
29179     "groupTitle": "Users"
29180   },
29181   {
29182     "type": "delete",
29183     "url": "/api/users/{id}/mail_accounts",
29184     "title": "Removes a Mail Account from a user",
29185     "examples": [
29186       {
29187         "title": "Example usage:",
29188         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29189         "type": "json"
29190       }
29191     ],
29192     "name": "RemoveMailAccounts",
29193     "group": "Users",
29194     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29195     "version": "0.0.0",
29196     "filename": "server/api/user/index.js",
29197     "groupTitle": "Users"
29198   },
29199   {
29200     "type": "delete",
29201     "url": "/api/users/{id}/mail_interactions",
29202     "title": "Removes interactions from an agent",
29203     "examples": [
29204       {
29205         "title": "Example usage:",
29206         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29207         "type": "json"
29208       }
29209     ],
29210     "name": "RemoveMailInteractions",
29211     "group": "Users",
29212     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29213     "version": "0.0.0",
29214     "filename": "server/api/user/index.js",
29215     "groupTitle": "Users"
29216   },
29217   {
29218     "type": "delete",
29219     "url": "/api/users/{id}/openchannel_accounts",
29220     "title": "Removes a Open Channel Account from a user",
29221     "examples": [
29222       {
29223         "title": "Example usage:",
29224         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29225         "type": "json"
29226       }
29227     ],
29228     "name": "RemoveOpenchannelAccounts",
29229     "group": "Users",
29230     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29231     "version": "0.0.0",
29232     "filename": "server/api/user/index.js",
29233     "groupTitle": "Users"
29234   },
29235   {
29236     "type": "delete",
29237     "url": "/api/users/{id}/openchannel_interactions",
29238     "title": "Removes openchannel interactions from an agent",
29239     "examples": [
29240       {
29241         "title": "Example usage:",
29242         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29243         "type": "json"
29244       }
29245     ],
29246     "name": "RemoveOpenchannelInteractions",
29247     "group": "Users",
29248     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29249     "version": "0.0.0",
29250     "filename": "server/api/user/index.js",
29251     "groupTitle": "Users"
29252   },
29253   {
29254     "type": "delete",
29255     "url": "/api/users/{id}/queues",
29256     "title": "Remove queues to an agent",
29257     "examples": [
29258       {
29259         "title": "Example usage:",
29260         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29261         "type": "json"
29262       }
29263     ],
29264     "name": "RemoveQueues",
29265     "group": "Users",
29266     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29267     "version": "0.0.0",
29268     "filename": "server/api/user/index.js",
29269     "groupTitle": "Users"
29270   },
29271   {
29272     "type": "delete",
29273     "url": "/api/users/{id}/sms_accounts",
29274     "title": "Removes a Sms Account from a user",
29275     "examples": [
29276       {
29277         "title": "Example usage:",
29278         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29279         "type": "json"
29280       }
29281     ],
29282     "name": "RemoveSmsAccounts",
29283     "group": "Users",
29284     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29285     "version": "0.0.0",
29286     "filename": "server/api/user/index.js",
29287     "groupTitle": "Users"
29288   },
29289   {
29290     "type": "delete",
29291     "url": "/api/users/{id}/sms_interactions",
29292     "title": "Removes interactions from an agent",
29293     "examples": [
29294       {
29295         "title": "Example usage:",
29296         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29297         "type": "json"
29298       }
29299     ],
29300     "name": "RemoveSmsInteractions",
29301     "group": "Users",
29302     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29303     "version": "0.0.0",
29304     "filename": "server/api/user/index.js",
29305     "groupTitle": "Users"
29306   },
29307   {
29308     "type": "delete",
29309     "url": "/api/users/{id}/square_projects",
29310     "title": "Removes a Square Project from a user",
29311     "examples": [
29312       {
29313         "title": "Example usage:",
29314         "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29315         "type": "json"
29316       }
29317     ],
29318     "name": "RemoveSquareProjects",
29319     "group": "Users",
29320     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29321     "version": "0.0.0",
29322     "filename": "server/api/user/index.js",
29323     "groupTitle": "Users"
29324   },
29325   {
29326     "type": "delete",
29327     "url": "/api/users/{id}/teams",
29328     "title": "Removes teams from an agent",
29329     "examples": [
29330       {
29331         "title": "Example usage:",
29332         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29333         "type": "json"
29334       }
29335     ],
29336     "name": "RemoveTeams",
29337     "group": "Users",
29338     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29339     "version": "0.0.0",
29340     "filename": "server/api/user/index.js",
29341     "groupTitle": "Users"
29342   },
29343   {
29344     "type": "delete",
29345     "url": "/api/users/{id}/whatsapp_accounts",
29346     "title": "Removes a Whatsapp Account from a user",
29347     "examples": [
29348       {
29349         "title": "Example usage:",
29350         "content": "curl https://{domain}/api/users/{id}/whatsapp_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29351         "type": "json"
29352       }
29353     ],
29354     "name": "RemoveWhatsappAccounts",
29355     "group": "Users",
29356     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29357     "version": "0.0.0",
29358     "filename": "server/api/user/index.js",
29359     "groupTitle": "Users"
29360   },
29361   {
29362     "type": "delete",
29363     "url": "/api/users/{id}/whatsapp_interactions",
29364     "title": "Removes Whatsapp interactions from an agent",
29365     "examples": [
29366       {
29367         "title": "Example usage:",
29368         "content": "curl https://{domain}/api/users/{id}/whatsapp_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29369         "type": "json"
29370       }
29371     ],
29372     "name": "RemoveWhatsappInteractions",
29373     "group": "Users",
29374     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29375     "version": "0.0.0",
29376     "filename": "server/api/user/index.js",
29377     "groupTitle": "Users"
29378   },
29379   {
29380     "type": "get",
29381     "url": "/api/users/{id}",
29382     "title": "Gets a single User",
29383     "examples": [
29384       {
29385         "title": "Example usage:",
29386         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
29387         "type": "json"
29388       }
29389     ],
29390     "name": "ShowUsers",
29391     "group": "Users",
29392     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29393     "version": "0.0.0",
29394     "filename": "server/api/user/index.js",
29395     "groupTitle": "Users"
29396   },
29397   {
29398     "type": "post",
29399     "url": "/api/users/{id}/unpause",
29400     "title": "Unpause",
29401     "examples": [
29402       {
29403         "title": "Example usage:",
29404         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
29405         "type": "json"
29406       }
29407     ],
29408     "name": "Unpause",
29409     "group": "Users",
29410     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29411     "version": "0.0.0",
29412     "filename": "server/api/user/index.js",
29413     "groupTitle": "Users"
29414   },
29415   {
29416     "type": "get",
29417     "url": "/api/users/whoami",
29418     "title": "WhoAmI",
29419     "examples": [
29420       {
29421         "title": "Example usage:",
29422         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
29423         "type": "json"
29424       }
29425     ],
29426     "name": "WhoAmI",
29427     "group": "Users",
29428     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29429     "version": "0.0.0",
29430     "filename": "server/api/user/index.js",
29431     "groupTitle": "Users"
29432   },
29433   {
29434     "type": "post",
29435     "url": "/api/users/{id}/avatar",
29436     "title": "Add avatar",
29437     "examples": [
29438       {
29439         "title": "Example usage:",
29440         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
29441         "type": "json"
29442       }
29443     ],
29444     "name": "addAvatar",
29445     "group": "Users",
29446     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29447     "version": "0.0.0",
29448     "filename": "server/api/user/index.js",
29449     "groupTitle": "Users"
29450   },
29451   {
29452     "type": "post",
29453     "url": "/api/users/create_many",
29454     "title": "Create Users",
29455     "examples": [
29456       {
29457         "title": "Example usage:",
29458         "content": "curl https://{domain}/api/users/create_many -d '[{\"name\": \"john.doe\", \"role\": \"user\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
29459         "type": "json"
29460       }
29461     ],
29462     "name": "bulkCreate",
29463     "group": "Users",
29464     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29465     "version": "0.0.0",
29466     "filename": "server/api/user/index.js",
29467     "groupTitle": "Users"
29468   },
29469   {
29470     "type": "get",
29471     "url": "/api/users/{id}/avatar",
29472     "title": "Get avatar",
29473     "examples": [
29474       {
29475         "title": "Example usage:",
29476         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
29477         "type": "json"
29478       }
29479     ],
29480     "name": "getAvatar",
29481     "group": "Users",
29482     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29483     "version": "0.0.0",
29484     "filename": "server/api/user/index.js",
29485     "groupTitle": "Users"
29486   },
29487   {
29488     "type": "put",
29489     "url": "/api/users/{id}",
29490     "title": "Update an existing User",
29491     "examples": [
29492       {
29493         "title": "Example usage:",
29494         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29495         "type": "json"
29496       }
29497     ],
29498     "name": "updateUsers",
29499     "group": "Users",
29500     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29501     "version": "0.0.0",
29502     "filename": "server/api/user/index.js",
29503     "groupTitle": "Users"
29504   },
29505   {
29506     "type": "post",
29507     "url": "/api/variables",
29508     "title": "Creates a new Variable",
29509     "examples": [
29510       {
29511         "title": "Example usage:",
29512         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29513         "type": "json"
29514       }
29515     ],
29516     "name": "CreateVariables",
29517     "group": "Variables",
29518     "parameter": {
29519       "fields": {
29520         "Body": [
29521           {
29522             "group": "Body",
29523             "type": "String",
29524             "optional": false,
29525             "field": "name",
29526             "description": ""
29527           },
29528           {
29529             "group": "Body",
29530             "type": "String",
29531             "optional": true,
29532             "field": "description",
29533             "description": ""
29534           }
29535         ]
29536       }
29537     },
29538     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29539     "version": "0.0.0",
29540     "filename": "server/api/variable/index.js",
29541     "groupTitle": "Variables"
29542   },
29543   {
29544     "type": "delete",
29545     "url": "/api/variables/{id}",
29546     "title": "Deletes a Variable",
29547     "examples": [
29548       {
29549         "title": "Example usage:",
29550         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
29551         "type": "json"
29552       }
29553     ],
29554     "name": "DeleteVariables",
29555     "group": "Variables",
29556     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29557     "version": "0.0.0",
29558     "filename": "server/api/variable/index.js",
29559     "groupTitle": "Variables"
29560   },
29561   {
29562     "type": "get",
29563     "url": "/api/variables",
29564     "title": "Gets a list of Variables",
29565     "examples": [
29566       {
29567         "title": "Example usage:",
29568         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
29569         "type": "json"
29570       }
29571     ],
29572     "name": "GetVariables",
29573     "group": "Variables",
29574     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29575     "version": "0.0.0",
29576     "filename": "server/api/variable/index.js",
29577     "groupTitle": "Variables"
29578   },
29579   {
29580     "type": "get",
29581     "url": "/api/variables/{id}",
29582     "title": "Gets a single Variable",
29583     "examples": [
29584       {
29585         "title": "Example usage:",
29586         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
29587         "type": "json"
29588       }
29589     ],
29590     "name": "ShowVariables",
29591     "group": "Variables",
29592     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29593     "version": "0.0.0",
29594     "filename": "server/api/variable/index.js",
29595     "groupTitle": "Variables"
29596   },
29597   {
29598     "type": "put",
29599     "url": "/api/variables/{id}",
29600     "title": "Update an existing Variable",
29601     "examples": [
29602       {
29603         "title": "Example usage:",
29604         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
29605         "type": "json"
29606       }
29607     ],
29608     "name": "updateVariables",
29609     "group": "Variables",
29610     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29611     "version": "0.0.0",
29612     "filename": "server/api/variable/index.js",
29613     "groupTitle": "Variables"
29614   },
29615   {
29616     "type": "get",
29617     "url": "/api/version/fetch",
29618     "title": "Fetch git version",
29619     "examples": [
29620       {
29621         "title": "Example usage:",
29622         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
29623         "type": "json"
29624       }
29625     ],
29626     "name": "FetchVersion",
29627     "group": "Version",
29628     "description": "<p>Motion run the following command: git fetch origin master</p>",
29629     "version": "0.0.0",
29630     "filename": "server/api/version/index.js",
29631     "groupTitle": "Version"
29632   },
29633   {
29634     "type": "get",
29635     "url": "/api/version",
29636     "title": "Gets version",
29637     "examples": [
29638       {
29639         "title": "Example usage:",
29640         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
29641         "type": "json"
29642       }
29643     ],
29644     "name": "GetVersion",
29645     "group": "Version",
29646     "description": "<p>Motion returns the current and latest motion version.</p>",
29647     "version": "0.0.0",
29648     "filename": "server/api/version/index.js",
29649     "groupTitle": "Version"
29650   },
29651   {
29652     "type": "get",
29653     "url": "/api/version/migrations",
29654     "title": "Launch database migrations",
29655     "examples": [
29656       {
29657         "title": "Example usage:",
29658         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
29659         "type": "json"
29660       }
29661     ],
29662     "name": "MigrateVersion",
29663     "group": "Version",
29664     "description": "<p>Motion launch the database migrations, according to the application version</p>",
29665     "version": "0.0.0",
29666     "filename": "server/api/version/index.js",
29667     "groupTitle": "Version"
29668   },
29669   {
29670     "type": "get",
29671     "url": "/api/version/pull",
29672     "title": "Pull git version",
29673     "examples": [
29674       {
29675         "title": "Example usage:",
29676         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
29677         "type": "json"
29678       }
29679     ],
29680     "name": "PullVersion",
29681     "group": "Version",
29682     "description": "<p>Motion run the following command: git pull</p>",
29683     "version": "0.0.0",
29684     "filename": "server/api/version/index.js",
29685     "groupTitle": "Version"
29686   },
29687   {
29688     "type": "get",
29689     "url": "/api/version/reset",
29690     "title": "Reset git version",
29691     "examples": [
29692       {
29693         "title": "Example usage:",
29694         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
29695         "type": "json"
29696       }
29697     ],
29698     "name": "ResetVersion",
29699     "group": "Version",
29700     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
29701     "version": "0.0.0",
29702     "filename": "server/api/version/index.js",
29703     "groupTitle": "Version"
29704   },
29705   {
29706     "type": "get",
29707     "url": "/api/version/restart",
29708     "title": "Restart motion2 after update",
29709     "examples": [
29710       {
29711         "title": "Example usage:",
29712         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
29713         "type": "json"
29714       }
29715     ],
29716     "name": "RestartVersion",
29717     "group": "Version",
29718     "description": "<p>Motion run the following command: pm2 restart motion</p>",
29719     "version": "0.0.0",
29720     "filename": "server/api/version/index.js",
29721     "groupTitle": "Version"
29722   },
29723   {
29724     "type": "get",
29725     "url": "/api/voice/agents/reports/describe",
29726     "title": "Gets table info about Agent Reports",
29727     "examples": [
29728       {
29729         "title": "Example usage:",
29730         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
29731         "type": "json"
29732       }
29733     ],
29734     "name": "DescribeAgent_Reports",
29735     "group": "Voice_Agent_Reports",
29736     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29737     "version": "0.0.0",
29738     "filename": "server/api/voiceAgentReport/index.js",
29739     "groupTitle": "Voice_Agent_Reports"
29740   },
29741   {
29742     "type": "get",
29743     "url": "/api/voice/agents/reports",
29744     "title": "Gets a list of Agent Reports",
29745     "examples": [
29746       {
29747         "title": "Example usage:",
29748         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
29749         "type": "json"
29750       }
29751     ],
29752     "name": "GetAgent_Reports",
29753     "group": "Voice_Agent_Reports",
29754     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29755     "version": "0.0.0",
29756     "filename": "server/api/voiceAgentReport/index.js",
29757     "groupTitle": "Voice_Agent_Reports"
29758   },
29759   {
29760     "type": "get",
29761     "url": "/api/voice/agents/reports/{id}",
29762     "title": "Gets a single Agent Report",
29763     "examples": [
29764       {
29765         "title": "Example usage:",
29766         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
29767         "type": "json"
29768       }
29769     ],
29770     "name": "ShowAgent_Reports",
29771     "group": "Voice_Agent_Reports",
29772     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29773     "version": "0.0.0",
29774     "filename": "server/api/voiceAgentReport/index.js",
29775     "groupTitle": "Voice_Agent_Reports"
29776   },
29777   {
29778     "type": "get",
29779     "url": "/api/voice/calls/reports/describe",
29780     "title": "Gets table info about Call Reports",
29781     "examples": [
29782       {
29783         "title": "Example usage:",
29784         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
29785         "type": "json"
29786       }
29787     ],
29788     "name": "DescribeCall_Reports",
29789     "group": "Voice_Call_Reports",
29790     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29791     "version": "0.0.0",
29792     "filename": "server/api/voiceCallReport/index.js",
29793     "groupTitle": "Voice_Call_Reports"
29794   },
29795   {
29796     "type": "get",
29797     "url": "/api/voice/calls/reports",
29798     "title": "Gets a list of Call Reports",
29799     "examples": [
29800       {
29801         "title": "Example usage:",
29802         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
29803         "type": "json"
29804       }
29805     ],
29806     "name": "GetCall_Reports",
29807     "group": "Voice_Call_Reports",
29808     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29809     "version": "0.0.0",
29810     "filename": "server/api/voiceCallReport/index.js",
29811     "groupTitle": "Voice_Call_Reports"
29812   },
29813   {
29814     "type": "get",
29815     "url": "/api/voice/calls/reports/{id}",
29816     "title": "Gets a single Call Report",
29817     "examples": [
29818       {
29819         "title": "Example usage:",
29820         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
29821         "type": "json"
29822       }
29823     ],
29824     "name": "ShowCall_Reports",
29825     "group": "Voice_Call_Reports",
29826     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29827     "version": "0.0.0",
29828     "filename": "server/api/voiceCallReport/index.js",
29829     "groupTitle": "Voice_Call_Reports"
29830   },
29831   {
29832     "type": "put",
29833     "url": "/api/voice/calls/reports/{id}",
29834     "title": "Update a single cdr",
29835     "examples": [
29836       {
29837         "title": "Example usage:",
29838         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
29839         "type": "json"
29840       }
29841     ],
29842     "name": "update",
29843     "group": "Voice_Call_Reports",
29844     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29845     "version": "0.0.0",
29846     "filename": "server/api/voiceCallReport/index.js",
29847     "groupTitle": "Voice_Call_Reports"
29848   },
29849   {
29850     "type": "post",
29851     "url": "/api/voice/chanspy",
29852     "title": "Creates a new ChanSpy",
29853     "examples": [
29854       {
29855         "title": "Example usage:",
29856         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
29857         "type": "json"
29858       }
29859     ],
29860     "name": "CreateChanSpy",
29861     "group": "Voice_ChanSpy",
29862     "parameter": {
29863       "fields": {
29864         "Body": [
29865           {
29866             "group": "Body",
29867             "type": "String",
29868             "optional": true,
29869             "field": "name",
29870             "description": ""
29871           },
29872           {
29873             "group": "Body",
29874             "type": "String",
29875             "optional": false,
29876             "field": "prefix",
29877             "description": ""
29878           },
29879           {
29880             "group": "Body",
29881             "type": "String",
29882             "optional": true,
29883             "field": "options",
29884             "description": ""
29885           },
29886           {
29887             "group": "Body",
29888             "type": "Boolean",
29889             "optional": true,
29890             "field": "auth",
29891             "description": ""
29892           },
29893           {
29894             "group": "Body",
29895             "type": "String",
29896             "optional": true,
29897             "field": "password",
29898             "description": ""
29899           },
29900           {
29901             "group": "Body",
29902             "type": "Boolean",
29903             "optional": true,
29904             "field": "record",
29905             "description": ""
29906           },
29907           {
29908             "group": "Body",
29909             "type": "String",
29910             "optional": true,
29911             "field": "recordingFormat",
29912             "description": ""
29913           },
29914           {
29915             "group": "Body",
29916             "type": "String",
29917             "optional": true,
29918             "field": "description",
29919             "description": ""
29920           }
29921         ]
29922       }
29923     },
29924     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29925     "version": "0.0.0",
29926     "filename": "server/api/voiceChanSpy/index.js",
29927     "groupTitle": "Voice_ChanSpy"
29928   },
29929   {
29930     "type": "delete",
29931     "url": "/api/voice/chanspy/{id}",
29932     "title": "Deletes a ChanSpy",
29933     "examples": [
29934       {
29935         "title": "Example usage:",
29936         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
29937         "type": "json"
29938       }
29939     ],
29940     "name": "DeleteChanSpy",
29941     "group": "Voice_ChanSpy",
29942     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29943     "version": "0.0.0",
29944     "filename": "server/api/voiceChanSpy/index.js",
29945     "groupTitle": "Voice_ChanSpy"
29946   },
29947   {
29948     "type": "get",
29949     "url": "/api/voice/chanspy",
29950     "title": "Gets a list of ChanSpy",
29951     "examples": [
29952       {
29953         "title": "Example usage:",
29954         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
29955         "type": "json"
29956       }
29957     ],
29958     "name": "GetChanSpy",
29959     "group": "Voice_ChanSpy",
29960     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29961     "version": "0.0.0",
29962     "filename": "server/api/voiceChanSpy/index.js",
29963     "groupTitle": "Voice_ChanSpy"
29964   },
29965   {
29966     "type": "get",
29967     "url": "/api/voice/chanspy/{id}",
29968     "title": "Gets a single ChanSpy",
29969     "examples": [
29970       {
29971         "title": "Example usage:",
29972         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
29973         "type": "json"
29974       }
29975     ],
29976     "name": "ShowChanSpy",
29977     "group": "Voice_ChanSpy",
29978     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29979     "version": "0.0.0",
29980     "filename": "server/api/voiceChanSpy/index.js",
29981     "groupTitle": "Voice_ChanSpy"
29982   },
29983   {
29984     "type": "put",
29985     "url": "/api/voice/chanspy/{id}",
29986     "title": "Update an existing ChanSpy",
29987     "examples": [
29988       {
29989         "title": "Example usage:",
29990         "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",
29991         "type": "json"
29992       }
29993     ],
29994     "name": "updateChanSpy",
29995     "group": "Voice_ChanSpy",
29996     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29997     "version": "0.0.0",
29998     "filename": "server/api/voiceChanSpy/index.js",
29999     "groupTitle": "Voice_ChanSpy"
30000   },
30001   {
30002     "type": "post",
30003     "url": "/api/voice/contexts",
30004     "title": "Create a new context",
30005     "examples": [
30006       {
30007         "title": "Example usage:",
30008         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30009         "type": "json"
30010       }
30011     ],
30012     "name": "Create",
30013     "group": "Voice_Contexts",
30014     "parameter": {
30015       "fields": {
30016         "Body": [
30017           {
30018             "group": "Body",
30019             "type": "String",
30020             "optional": true,
30021             "field": "name",
30022             "description": ""
30023           },
30024           {
30025             "group": "Body",
30026             "type": "String",
30027             "optional": true,
30028             "field": "description",
30029             "description": ""
30030           },
30031           {
30032             "group": "Body",
30033             "type": "Boolean",
30034             "optional": true,
30035             "field": "defaultEntry",
30036             "description": ""
30037           }
30038         ]
30039       }
30040     },
30041     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30042     "version": "0.0.0",
30043     "filename": "server/api/voiceContext/index.js",
30044     "groupTitle": "Voice_Contexts"
30045   },
30046   {
30047     "type": "delete",
30048     "url": "/api/voice/contexts/{id}",
30049     "title": "Deletes a context",
30050     "examples": [
30051       {
30052         "title": "Example usage:",
30053         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30054         "type": "json"
30055       }
30056     ],
30057     "name": "Delete",
30058     "group": "Voice_Contexts",
30059     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30060     "version": "0.0.0",
30061     "filename": "server/api/voiceContext/index.js",
30062     "groupTitle": "Voice_Contexts"
30063   },
30064   {
30065     "type": "get",
30066     "url": "/api/voice/contexts",
30067     "title": "Gets a list of Contexts",
30068     "examples": [
30069       {
30070         "title": "Example usage:",
30071         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30072         "type": "json"
30073       }
30074     ],
30075     "name": "GetContexts",
30076     "group": "Voice_Contexts",
30077     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30078     "version": "0.0.0",
30079     "filename": "server/api/voiceContext/index.js",
30080     "groupTitle": "Voice_Contexts"
30081   },
30082   {
30083     "type": "get",
30084     "url": "/api/voice/contexts/{id}",
30085     "title": "Gets a single Context",
30086     "examples": [
30087       {
30088         "title": "Example usage:",
30089         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30090         "type": "json"
30091       }
30092     ],
30093     "name": "ShowContexts",
30094     "group": "Voice_Contexts",
30095     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30096     "version": "0.0.0",
30097     "filename": "server/api/voiceContext/index.js",
30098     "groupTitle": "Voice_Contexts"
30099   },
30100   {
30101     "type": "put",
30102     "url": "/api/voice/contexts/{id}",
30103     "title": "Update an existing context",
30104     "examples": [
30105       {
30106         "title": "Example usage:",
30107         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30108         "type": "json"
30109       }
30110     ],
30111     "name": "Update",
30112     "group": "Voice_Contexts",
30113     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30114     "version": "0.0.0",
30115     "filename": "server/api/voiceContext/index.js",
30116     "groupTitle": "Voice_Contexts"
30117   },
30118   {
30119     "type": "get",
30120     "url": "/api/voice/dials/reports/describe",
30121     "title": "Gets table info about Dial Reports",
30122     "examples": [
30123       {
30124         "title": "Example usage:",
30125         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30126         "type": "json"
30127       }
30128     ],
30129     "name": "DescribeDial_Reports",
30130     "group": "Voice_Dial_Reports",
30131     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30132     "version": "0.0.0",
30133     "filename": "server/api/voiceDialReport/index.js",
30134     "groupTitle": "Voice_Dial_Reports"
30135   },
30136   {
30137     "type": "get",
30138     "url": "/api/voice/dials/reports",
30139     "title": "Gets a list of Dial Reports",
30140     "examples": [
30141       {
30142         "title": "Example usage:",
30143         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30144         "type": "json"
30145       }
30146     ],
30147     "name": "GetDial_Reports",
30148     "group": "Voice_Dial_Reports",
30149     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30150     "version": "0.0.0",
30151     "filename": "server/api/voiceDialReport/index.js",
30152     "groupTitle": "Voice_Dial_Reports"
30153   },
30154   {
30155     "type": "get",
30156     "url": "/api/voice/dials/reports/{id}",
30157     "title": "Gets a single Dial Report",
30158     "examples": [
30159       {
30160         "title": "Example usage:",
30161         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30162         "type": "json"
30163       }
30164     ],
30165     "name": "ShowDial_Reports",
30166     "group": "Voice_Dial_Reports",
30167     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30168     "version": "0.0.0",
30169     "filename": "server/api/voiceDialReport/index.js",
30170     "groupTitle": "Voice_Dial_Reports"
30171   },
30172   {
30173     "type": "delete",
30174     "url": "/api/voice/extensions/{id}",
30175     "title": "Deletes a Extension",
30176     "examples": [
30177       {
30178         "title": "Example usage:",
30179         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30180         "type": "json"
30181       }
30182     ],
30183     "name": "DeleteExtensions",
30184     "group": "Voice_Extensions",
30185     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30186     "version": "0.0.0",
30187     "filename": "server/api/voiceExtension/index.js",
30188     "groupTitle": "Voice_Extensions"
30189   },
30190   {
30191     "type": "get",
30192     "url": "/api/voice/extensions",
30193     "title": "Gets a list of Extensions",
30194     "examples": [
30195       {
30196         "title": "Example usage:",
30197         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30198         "type": "json"
30199       }
30200     ],
30201     "name": "GetExtensions",
30202     "group": "Voice_Extensions",
30203     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30204     "version": "0.0.0",
30205     "filename": "server/api/voiceExtension/index.js",
30206     "groupTitle": "Voice_Extensions"
30207   },
30208   {
30209     "type": "get",
30210     "url": "/api/voice/extensions/{id}",
30211     "title": "Gets a single Extension",
30212     "examples": [
30213       {
30214         "title": "Example usage:",
30215         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30216         "type": "json"
30217       }
30218     ],
30219     "name": "ShowExtensions",
30220     "group": "Voice_Extensions",
30221     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30222     "version": "0.0.0",
30223     "filename": "server/api/voiceExtension/index.js",
30224     "groupTitle": "Voice_Extensions"
30225   },
30226   {
30227     "type": "post",
30228     "url": "/api/voice/extensions",
30229     "title": "Create new applications",
30230     "examples": [
30231       {
30232         "title": "Example usage:",
30233         "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",
30234         "type": "json"
30235       }
30236     ],
30237     "name": "addApplications",
30238     "group": "Voice_Extensions",
30239     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30240     "version": "0.0.0",
30241     "filename": "server/api/voiceExtension/index.js",
30242     "groupTitle": "Voice_Extensions"
30243   },
30244   {
30245     "type": "post",
30246     "url": "/api/voice/extensions",
30247     "title": "Create an extension",
30248     "examples": [
30249       {
30250         "title": "Example usage:",
30251         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30252         "type": "json"
30253       }
30254     ],
30255     "name": "create",
30256     "group": "Voice_Extensions",
30257     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30258     "version": "0.0.0",
30259     "filename": "server/api/voiceExtension/index.js",
30260     "groupTitle": "Voice_Extensions"
30261   },
30262   {
30263     "type": "put",
30264     "url": "/api/voice/extensions/{id}",
30265     "title": "Update an extension",
30266     "examples": [
30267       {
30268         "title": "Example usage:",
30269         "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",
30270         "type": "json"
30271       }
30272     ],
30273     "name": "update",
30274     "group": "Voice_Extensions",
30275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30276     "version": "0.0.0",
30277     "filename": "server/api/voiceExtension/index.js",
30278     "groupTitle": "Voice_Extensions"
30279   },
30280   {
30281     "type": "post",
30282     "url": "/api/voice/mohs",
30283     "title": "Create a new a new MOH",
30284     "examples": [
30285       {
30286         "title": "Example usage:",
30287         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30288         "type": "json"
30289       }
30290     ],
30291     "name": "AddMoh",
30292     "group": "Voice_MOHs",
30293     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30294     "version": "0.0.0",
30295     "filename": "server/api/voiceMusicOnHold/index.js",
30296     "groupTitle": "Voice_MOHs"
30297   },
30298   {
30299     "type": "post",
30300     "url": "/api/voice/mohs/{id}/sounds",
30301     "title": "Add sound to MOH",
30302     "examples": [
30303       {
30304         "title": "Example usage:",
30305         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30306         "type": "json"
30307       }
30308     ],
30309     "name": "AddSound",
30310     "group": "Voice_MOHs",
30311     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30312     "version": "0.0.0",
30313     "filename": "server/api/voiceMusicOnHold/index.js",
30314     "groupTitle": "Voice_MOHs"
30315   },
30316   {
30317     "type": "delete",
30318     "url": "/api/voice/mohs/{id}",
30319     "title": "Deletes an MOH",
30320     "examples": [
30321       {
30322         "title": "Example usage:",
30323         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
30324         "type": "json"
30325       }
30326     ],
30327     "name": "DestroyMoh",
30328     "group": "Voice_MOHs",
30329     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30330     "version": "0.0.0",
30331     "filename": "server/api/voiceMusicOnHold/index.js",
30332     "groupTitle": "Voice_MOHs"
30333   },
30334   {
30335     "type": "get",
30336     "url": "/api/voice/mohs",
30337     "title": "Gets a list of Music On Holds",
30338     "examples": [
30339       {
30340         "title": "Example usage:",
30341         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
30342         "type": "json"
30343       }
30344     ],
30345     "name": "GetMusic_On_Holds",
30346     "group": "Voice_MOHs",
30347     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30348     "version": "0.0.0",
30349     "filename": "server/api/voiceMusicOnHold/index.js",
30350     "groupTitle": "Voice_MOHs"
30351   },
30352   {
30353     "type": "get",
30354     "url": "/api/voice/mohs/{id}/sounds",
30355     "title": "Gets sounds from MOH",
30356     "examples": [
30357       {
30358         "title": "Example usage:",
30359         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
30360         "type": "json"
30361       }
30362     ],
30363     "name": "GetSounds",
30364     "group": "Voice_MOHs",
30365     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30366     "version": "0.0.0",
30367     "filename": "server/api/voiceMusicOnHold/index.js",
30368     "groupTitle": "Voice_MOHs"
30369   },
30370   {
30371     "type": "delete",
30372     "url": "/api/voice/mohs/{id}/sounds/{id2}",
30373     "title": "Remove sound from MOH",
30374     "examples": [
30375       {
30376         "title": "Example usage:",
30377         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
30378         "type": "json"
30379       }
30380     ],
30381     "name": "RemoveSound",
30382     "group": "Voice_MOHs",
30383     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30384     "version": "0.0.0",
30385     "filename": "server/api/voiceMusicOnHold/index.js",
30386     "groupTitle": "Voice_MOHs"
30387   },
30388   {
30389     "type": "get",
30390     "url": "/api/voice/mohs/{id}",
30391     "title": "Gets a single Music On Hold",
30392     "examples": [
30393       {
30394         "title": "Example usage:",
30395         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
30396         "type": "json"
30397       }
30398     ],
30399     "name": "ShowMusic_On_Holds",
30400     "group": "Voice_MOHs",
30401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30402     "version": "0.0.0",
30403     "filename": "server/api/voiceMusicOnHold/index.js",
30404     "groupTitle": "Voice_MOHs"
30405   },
30406   {
30407     "type": "put",
30408     "url": "/api/voice/mohs/{id}",
30409     "title": "Update an existing Music On Hold",
30410     "examples": [
30411       {
30412         "title": "Example usage:",
30413         "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",
30414         "type": "json"
30415       }
30416     ],
30417     "name": "updateMusic_On_Holds",
30418     "group": "Voice_MOHs",
30419     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30420     "version": "0.0.0",
30421     "filename": "server/api/voiceMusicOnHold/index.js",
30422     "groupTitle": "Voice_MOHs"
30423   },
30424   {
30425     "type": "post",
30426     "url": "/api/voice/mails",
30427     "title": "Creates a new Mail",
30428     "examples": [
30429       {
30430         "title": "Example usage:",
30431         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30432         "type": "json"
30433       }
30434     ],
30435     "name": "CreateMails",
30436     "group": "Voice_Mails",
30437     "parameter": {
30438       "fields": {
30439         "Body": [
30440           {
30441             "group": "Body",
30442             "type": "String",
30443             "optional": true,
30444             "field": "customer_id",
30445             "description": ""
30446           },
30447           {
30448             "group": "Body",
30449             "type": "String",
30450             "optional": true,
30451             "field": "context",
30452             "description": ""
30453           },
30454           {
30455             "group": "Body",
30456             "type": "String",
30457             "optional": false,
30458             "field": "mailbox",
30459             "description": ""
30460           },
30461           {
30462             "group": "Body",
30463             "type": "String",
30464             "optional": true,
30465             "field": "password",
30466             "description": ""
30467           },
30468           {
30469             "group": "Body",
30470             "type": "String",
30471             "optional": true,
30472             "field": "fullname",
30473             "description": ""
30474           },
30475           {
30476             "group": "Body",
30477             "type": "String",
30478             "optional": true,
30479             "field": "email",
30480             "description": ""
30481           },
30482           {
30483             "group": "Body",
30484             "type": "String",
30485             "optional": true,
30486             "field": "pager",
30487             "description": ""
30488           },
30489           {
30490             "group": "Body",
30491             "type": "String",
30492             "optional": true,
30493             "field": "tz",
30494             "description": ""
30495           },
30496           {
30497             "group": "Body",
30498             "type": "String",
30499             "allowedValues": [
30500               "\"yes\"",
30501               "\"no\""
30502             ],
30503             "optional": false,
30504             "field": "attach",
30505             "description": ""
30506           },
30507           {
30508             "group": "Body",
30509             "type": "String",
30510             "allowedValues": [
30511               "\"yes\"",
30512               "\"no\""
30513             ],
30514             "optional": false,
30515             "field": "saycid",
30516             "description": ""
30517           },
30518           {
30519             "group": "Body",
30520             "type": "String",
30521             "optional": true,
30522             "field": "dialout",
30523             "description": ""
30524           },
30525           {
30526             "group": "Body",
30527             "type": "String",
30528             "optional": true,
30529             "field": "callback",
30530             "description": ""
30531           },
30532           {
30533             "group": "Body",
30534             "type": "String",
30535             "allowedValues": [
30536               "\"yes\"",
30537               "\"no\""
30538             ],
30539             "optional": false,
30540             "field": "review",
30541             "description": ""
30542           },
30543           {
30544             "group": "Body",
30545             "type": "String",
30546             "allowedValues": [
30547               "\"yes\"",
30548               "\"no\""
30549             ],
30550             "optional": false,
30551             "field": "operator",
30552             "description": ""
30553           },
30554           {
30555             "group": "Body",
30556             "type": "String",
30557             "allowedValues": [
30558               "\"yes\"",
30559               "\"no\""
30560             ],
30561             "optional": false,
30562             "field": "envelope",
30563             "description": ""
30564           },
30565           {
30566             "group": "Body",
30567             "type": "String",
30568             "allowedValues": [
30569               "\"yes\"",
30570               "\"no\""
30571             ],
30572             "optional": false,
30573             "field": "sayduration",
30574             "description": ""
30575           },
30576           {
30577             "group": "Body",
30578             "type": "String",
30579             "optional": false,
30580             "field": "saydurationm",
30581             "description": ""
30582           },
30583           {
30584             "group": "Body",
30585             "type": "String",
30586             "allowedValues": [
30587               "\"yes\"",
30588               "\"no\""
30589             ],
30590             "optional": false,
30591             "field": "sendvoicemail",
30592             "description": ""
30593           },
30594           {
30595             "group": "Body",
30596             "type": "String",
30597             "allowedValues": [
30598               "\"yes\"",
30599               "\"no\""
30600             ],
30601             "optional": false,
30602             "field": "delete",
30603             "description": ""
30604           },
30605           {
30606             "group": "Body",
30607             "type": "String",
30608             "allowedValues": [
30609               "\"yes\"",
30610               "\"no\""
30611             ],
30612             "optional": false,
30613             "field": "nextaftercmd",
30614             "description": ""
30615           },
30616           {
30617             "group": "Body",
30618             "type": "String",
30619             "allowedValues": [
30620               "\"yes\"",
30621               "\"no\""
30622             ],
30623             "optional": false,
30624             "field": "forcename",
30625             "description": ""
30626           },
30627           {
30628             "group": "Body",
30629             "type": "String",
30630             "allowedValues": [
30631               "\"yes\"",
30632               "\"no\""
30633             ],
30634             "optional": false,
30635             "field": "forcegreetings",
30636             "description": ""
30637           },
30638           {
30639             "group": "Body",
30640             "type": "String",
30641             "allowedValues": [
30642               "\"yes\"",
30643               "\"no\""
30644             ],
30645             "optional": false,
30646             "field": "hidefromdir",
30647             "description": ""
30648           },
30649           {
30650             "group": "Body",
30651             "type": "String",
30652             "optional": true,
30653             "field": "stamp",
30654             "description": ""
30655           },
30656           {
30657             "group": "Body",
30658             "type": "String",
30659             "optional": true,
30660             "field": "emailsubject",
30661             "description": ""
30662           },
30663           {
30664             "group": "Body",
30665             "type": "String",
30666             "optional": true,
30667             "field": "emailbody",
30668             "description": ""
30669           },
30670           {
30671             "group": "Body",
30672             "type": "Integer",
30673             "optional": false,
30674             "field": "maxsecs",
30675             "description": ""
30676           },
30677           {
30678             "group": "Body",
30679             "type": "Integer",
30680             "optional": false,
30681             "field": "maxmsg",
30682             "description": ""
30683           },
30684           {
30685             "group": "Body",
30686             "type": "Virtual",
30687             "optional": true,
30688             "field": "name",
30689             "description": ""
30690           }
30691         ]
30692       }
30693     },
30694     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30695     "version": "0.0.0",
30696     "filename": "server/api/voiceMail/index.js",
30697     "groupTitle": "Voice_Mails"
30698   },
30699   {
30700     "type": "delete",
30701     "url": "/api/voice/mails/{id}",
30702     "title": "Deletes a Mail",
30703     "examples": [
30704       {
30705         "title": "Example usage:",
30706         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
30707         "type": "json"
30708       }
30709     ],
30710     "name": "DeleteMails",
30711     "group": "Voice_Mails",
30712     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30713     "version": "0.0.0",
30714     "filename": "server/api/voiceMail/index.js",
30715     "groupTitle": "Voice_Mails"
30716   },
30717   {
30718     "type": "get",
30719     "url": "/api/voice/mails",
30720     "title": "Gets a list of Mails",
30721     "examples": [
30722       {
30723         "title": "Example usage:",
30724         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
30725         "type": "json"
30726       }
30727     ],
30728     "name": "GetMails",
30729     "group": "Voice_Mails",
30730     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30731     "version": "0.0.0",
30732     "filename": "server/api/voiceMail/index.js",
30733     "groupTitle": "Voice_Mails"
30734   },
30735   {
30736     "type": "get",
30737     "url": "/api/voice/mails/{id}",
30738     "title": "Gets a single Mail",
30739     "examples": [
30740       {
30741         "title": "Example usage:",
30742         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
30743         "type": "json"
30744       }
30745     ],
30746     "name": "ShowMails",
30747     "group": "Voice_Mails",
30748     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30749     "version": "0.0.0",
30750     "filename": "server/api/voiceMail/index.js",
30751     "groupTitle": "Voice_Mails"
30752   },
30753   {
30754     "type": "get",
30755     "url": "/api/voice/mails/{id}/messages",
30756     "title": "Gets voice mail messages",
30757     "examples": [
30758       {
30759         "title": "Example usage:",
30760         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
30761         "type": "json"
30762       }
30763     ],
30764     "name": "getMessages",
30765     "group": "Voice_Mails",
30766     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30767     "version": "0.0.0",
30768     "filename": "server/api/voiceMail/index.js",
30769     "groupTitle": "Voice_Mails"
30770   },
30771   {
30772     "type": "put",
30773     "url": "/api/voice/mails/{id}",
30774     "title": "Update an existing Mail",
30775     "examples": [
30776       {
30777         "title": "Example usage:",
30778         "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",
30779         "type": "json"
30780       }
30781     ],
30782     "name": "updateMails",
30783     "group": "Voice_Mails",
30784     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30785     "version": "0.0.0",
30786     "filename": "server/api/voiceMail/index.js",
30787     "groupTitle": "Voice_Mails"
30788   },
30789   {
30790     "type": "post",
30791     "url": "/api/voice/mails/messages",
30792     "title": "Creates a new Message",
30793     "examples": [
30794       {
30795         "title": "Example usage:",
30796         "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",
30797         "type": "json"
30798       }
30799     ],
30800     "name": "CreateMessages",
30801     "group": "Voice_Messages",
30802     "parameter": {
30803       "fields": {
30804         "Body": [
30805           {
30806             "group": "Body",
30807             "type": "Virtual",
30808             "optional": true,
30809             "field": "name",
30810             "description": ""
30811           },
30812           {
30813             "group": "Body",
30814             "type": "Integer",
30815             "optional": false,
30816             "field": "msgnum",
30817             "description": ""
30818           },
30819           {
30820             "group": "Body",
30821             "type": "String",
30822             "optional": true,
30823             "field": "dir",
30824             "description": ""
30825           },
30826           {
30827             "group": "Body",
30828             "type": "String",
30829             "optional": true,
30830             "field": "context",
30831             "description": ""
30832           },
30833           {
30834             "group": "Body",
30835             "type": "String",
30836             "optional": true,
30837             "field": "macrocontext",
30838             "description": ""
30839           },
30840           {
30841             "group": "Body",
30842             "type": "String",
30843             "optional": true,
30844             "field": "callerid",
30845             "description": ""
30846           },
30847           {
30848             "group": "Body",
30849             "type": "String",
30850             "optional": true,
30851             "field": "origtime",
30852             "description": ""
30853           },
30854           {
30855             "group": "Body",
30856             "type": "String",
30857             "optional": true,
30858             "field": "duration",
30859             "description": ""
30860           },
30861           {
30862             "group": "Body",
30863             "type": "String",
30864             "optional": true,
30865             "field": "mailboxuser",
30866             "description": ""
30867           },
30868           {
30869             "group": "Body",
30870             "type": "String",
30871             "optional": true,
30872             "field": "mailboxcontext",
30873             "description": ""
30874           },
30875           {
30876             "group": "Body",
30877             "type": "Blob",
30878             "optional": true,
30879             "field": "recording",
30880             "description": ""
30881           },
30882           {
30883             "group": "Body",
30884             "type": "String",
30885             "optional": true,
30886             "field": "flag",
30887             "description": ""
30888           },
30889           {
30890             "group": "Body",
30891             "type": "String",
30892             "optional": true,
30893             "field": "msg_id",
30894             "description": ""
30895           },
30896           {
30897             "group": "Body",
30898             "type": "String",
30899             "optional": false,
30900             "field": "stamp",
30901             "description": ""
30902           }
30903         ]
30904       }
30905     },
30906     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30907     "version": "0.0.0",
30908     "filename": "server/api/voiceMailMessage/index.js",
30909     "groupTitle": "Voice_Messages"
30910   },
30911   {
30912     "type": "delete",
30913     "url": "/api/voice/mails/messages/{id}",
30914     "title": "Deletes a Message",
30915     "examples": [
30916       {
30917         "title": "Example usage:",
30918         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
30919         "type": "json"
30920       }
30921     ],
30922     "name": "DeleteMessages",
30923     "group": "Voice_Messages",
30924     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30925     "version": "0.0.0",
30926     "filename": "server/api/voiceMailMessage/index.js",
30927     "groupTitle": "Voice_Messages"
30928   },
30929   {
30930     "type": "get",
30931     "url": "/api/voice/mails/messages",
30932     "title": "Gets a list of Messages",
30933     "examples": [
30934       {
30935         "title": "Example usage:",
30936         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
30937         "type": "json"
30938       }
30939     ],
30940     "name": "GetMessages",
30941     "group": "Voice_Messages",
30942     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30943     "version": "0.0.0",
30944     "filename": "server/api/voiceMailMessage/index.js",
30945     "groupTitle": "Voice_Messages"
30946   },
30947   {
30948     "type": "get",
30949     "url": "/api/voice/mails/messages/{id}",
30950     "title": "Gets a single Message",
30951     "examples": [
30952       {
30953         "title": "Example usage:",
30954         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
30955         "type": "json"
30956       }
30957     ],
30958     "name": "ShowMessages",
30959     "group": "Voice_Messages",
30960     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30961     "version": "0.0.0",
30962     "filename": "server/api/voiceMailMessage/index.js",
30963     "groupTitle": "Voice_Messages"
30964   },
30965   {
30966     "type": "get",
30967     "url": "voice/mails/messages/{id}/download",
30968     "title": "Download Voice Message",
30969     "examples": [
30970       {
30971         "title": "Example usage:",
30972         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
30973         "type": "json"
30974       }
30975     ],
30976     "name": "download",
30977     "group": "Voice_Messages",
30978     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30979     "version": "0.0.0",
30980     "filename": "server/api/voiceMailMessage/index.js",
30981     "groupTitle": "Voice_Messages"
30982   },
30983   {
30984     "type": "put",
30985     "url": "/api/voice/mails/messages/{id}",
30986     "title": "Update an existing Message",
30987     "examples": [
30988       {
30989         "title": "Example usage:",
30990         "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",
30991         "type": "json"
30992       }
30993     ],
30994     "name": "updateMessages",
30995     "group": "Voice_Messages",
30996     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30997     "version": "0.0.0",
30998     "filename": "server/api/voiceMailMessage/index.js",
30999     "groupTitle": "Voice_Messages"
31000   },
31001   {
31002     "type": "post",
31003     "url": "/api/voice/prefixes/{id}/users",
31004     "title": "Add agents to a prefix",
31005     "examples": [
31006       {
31007         "title": "Example usage:",
31008         "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",
31009         "type": "json"
31010       }
31011     ],
31012     "name": "AddAgents",
31013     "group": "Voice_Prefixes",
31014     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31015     "version": "0.0.0",
31016     "filename": "server/api/voicePrefix/index.js",
31017     "groupTitle": "Voice_Prefixes"
31018   },
31019   {
31020     "type": "delete",
31021     "url": "/api/voice/prefixes/{id}",
31022     "title": "Deletes a Prefix",
31023     "examples": [
31024       {
31025         "title": "Example usage:",
31026         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31027         "type": "json"
31028       }
31029     ],
31030     "name": "DeletePrefixes",
31031     "group": "Voice_Prefixes",
31032     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31033     "version": "0.0.0",
31034     "filename": "server/api/voicePrefix/index.js",
31035     "groupTitle": "Voice_Prefixes"
31036   },
31037   {
31038     "type": "get",
31039     "url": "/api/voice/prefixes/describe",
31040     "title": "Gets table info about Prefixes",
31041     "examples": [
31042       {
31043         "title": "Example usage:",
31044         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31045         "type": "json"
31046       }
31047     ],
31048     "name": "DescribePrefixes",
31049     "group": "Voice_Prefixes",
31050     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31051     "version": "0.0.0",
31052     "filename": "server/api/voicePrefix/index.js",
31053     "groupTitle": "Voice_Prefixes"
31054   },
31055   {
31056     "type": "get",
31057     "url": "/api/voice/prefixes/{id}/users",
31058     "title": "Gets agents from prefix",
31059     "examples": [
31060       {
31061         "title": "Example usage:",
31062         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31063         "type": "json"
31064       }
31065     ],
31066     "name": "GetAgents",
31067     "group": "Voice_Prefixes",
31068     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31069     "version": "0.0.0",
31070     "filename": "server/api/voicePrefix/index.js",
31071     "groupTitle": "Voice_Prefixes"
31072   },
31073   {
31074     "type": "get",
31075     "url": "/api/voice/prefixes",
31076     "title": "Gets a list of Prefixes",
31077     "examples": [
31078       {
31079         "title": "Example usage:",
31080         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31081         "type": "json"
31082       }
31083     ],
31084     "name": "GetPrefixes",
31085     "group": "Voice_Prefixes",
31086     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31087     "version": "0.0.0",
31088     "filename": "server/api/voicePrefix/index.js",
31089     "groupTitle": "Voice_Prefixes"
31090   },
31091   {
31092     "type": "delete",
31093     "url": "/api/voice/prefixes/{id}/users",
31094     "title": "Removes agents from a prefix",
31095     "examples": [
31096       {
31097         "title": "Example usage:",
31098         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31099         "type": "json"
31100       }
31101     ],
31102     "name": "RemoveAgents",
31103     "group": "Voice_Prefixes",
31104     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31105     "version": "0.0.0",
31106     "filename": "server/api/voicePrefix/index.js",
31107     "groupTitle": "Voice_Prefixes"
31108   },
31109   {
31110     "type": "get",
31111     "url": "/api/voice/prefixes/{id}",
31112     "title": "Gets a single Prefix",
31113     "examples": [
31114       {
31115         "title": "Example usage:",
31116         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31117         "type": "json"
31118       }
31119     ],
31120     "name": "ShowPrefixes",
31121     "group": "Voice_Prefixes",
31122     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31123     "version": "0.0.0",
31124     "filename": "server/api/voicePrefix/index.js",
31125     "groupTitle": "Voice_Prefixes"
31126   },
31127   {
31128     "type": "put",
31129     "url": "/api/voice/prefixes/{id}",
31130     "title": "Update an existing prefix",
31131     "examples": [
31132       {
31133         "title": "Example usage:",
31134         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31135         "type": "json"
31136       }
31137     ],
31138     "name": "Update",
31139     "group": "Voice_Prefixes",
31140     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31141     "version": "0.0.0",
31142     "filename": "server/api/voicePrefix/index.js",
31143     "groupTitle": "Voice_Prefixes"
31144   },
31145   {
31146     "type": "post",
31147     "url": "/api/voice/prefixes",
31148     "title": "Create a prefix",
31149     "examples": [
31150       {
31151         "title": "Example usage:",
31152         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31153         "type": "json"
31154       }
31155     ],
31156     "name": "create",
31157     "group": "Voice_Prefixes",
31158     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31159     "version": "0.0.0",
31160     "filename": "server/api/voicePrefix/index.js",
31161     "groupTitle": "Voice_Prefixes"
31162   },
31163   {
31164     "type": "get",
31165     "url": "/api/voice/queues/reports/describe",
31166     "title": "Gets table info about Queue Reports",
31167     "examples": [
31168       {
31169         "title": "Example usage:",
31170         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31171         "type": "json"
31172       }
31173     ],
31174     "name": "DescribeQueue_Reports",
31175     "group": "Voice_Queue_Reports",
31176     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31177     "version": "0.0.0",
31178     "filename": "server/api/voiceQueueReport/index.js",
31179     "groupTitle": "Voice_Queue_Reports"
31180   },
31181   {
31182     "type": "get",
31183     "url": "/api/voice/queues/reports",
31184     "title": "Gets a list of Queue Reports",
31185     "examples": [
31186       {
31187         "title": "Example usage:",
31188         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31189         "type": "json"
31190       }
31191     ],
31192     "name": "GetQueue_Reports",
31193     "group": "Voice_Queue_Reports",
31194     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31195     "version": "0.0.0",
31196     "filename": "server/api/voiceQueueReport/index.js",
31197     "groupTitle": "Voice_Queue_Reports"
31198   },
31199   {
31200     "type": "get",
31201     "url": "/api/voice/queues/reports/{id}",
31202     "title": "Gets a single Queue Report",
31203     "examples": [
31204       {
31205         "title": "Example usage:",
31206         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31207         "type": "json"
31208       }
31209     ],
31210     "name": "ShowQueue_Reports",
31211     "group": "Voice_Queue_Reports",
31212     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31213     "version": "0.0.0",
31214     "filename": "server/api/voiceQueueReport/index.js",
31215     "groupTitle": "Voice_Queue_Reports"
31216   },
31217   {
31218     "type": "get",
31219     "url": "/api/voice/queues/reports/index",
31220     "title": "Get Voice Queues Report",
31221     "examples": [
31222       {
31223         "title": "Example usage:",
31224         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31225         "type": "json"
31226       }
31227     ],
31228     "name": "getVoiceQueuesReport",
31229     "group": "Voice_Queue_Reports",
31230     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31231     "version": "0.0.0",
31232     "filename": "server/api/voiceQueueReport/index.js",
31233     "groupTitle": "Voice_Queue_Reports"
31234   },
31235   {
31236     "type": "post",
31237     "url": "/api/voice/queues/{id}/users",
31238     "title": "Add agents to queue",
31239     "examples": [
31240       {
31241         "title": "Example usage:",
31242         "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",
31243         "type": "json"
31244       }
31245     ],
31246     "name": "AddAgents",
31247     "group": "Voice_Queues",
31248     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31249     "version": "0.0.0",
31250     "filename": "server/api/voiceQueue/index.js",
31251     "groupTitle": "Voice_Queues"
31252   },
31253   {
31254     "type": "post",
31255     "url": "/api/voice/queues/{id}/blacklists",
31256     "title": "Add blacklists to a queue",
31257     "examples": [
31258       {
31259         "title": "Example usage:",
31260         "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",
31261         "type": "json"
31262       }
31263     ],
31264     "name": "AddBlackLists",
31265     "group": "Voice_Queues",
31266     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31267     "version": "0.0.0",
31268     "filename": "server/api/voiceQueue/index.js",
31269     "groupTitle": "Voice_Queues"
31270   },
31271   {
31272     "type": "post",
31273     "url": "/api/voice/queues/{id}/lists",
31274     "title": "Add lists to a queue",
31275     "examples": [
31276       {
31277         "title": "Example usage:",
31278         "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",
31279         "type": "json"
31280       }
31281     ],
31282     "name": "AddLists",
31283     "group": "Voice_Queues",
31284     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31285     "version": "0.0.0",
31286     "filename": "server/api/voiceQueue/index.js",
31287     "groupTitle": "Voice_Queues"
31288   },
31289   {
31290     "type": "post",
31291     "url": "/api/voice/queues/{id}/teams",
31292     "title": "Add teams to queue",
31293     "examples": [
31294       {
31295         "title": "Example usage:",
31296         "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",
31297         "type": "json"
31298       }
31299     ],
31300     "name": "AddTeams",
31301     "group": "Voice_Queues",
31302     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31303     "version": "0.0.0",
31304     "filename": "server/api/voiceQueue/index.js",
31305     "groupTitle": "Voice_Queues"
31306   },
31307   {
31308     "type": "post",
31309     "url": "/api/voice/queues/clone",
31310     "title": "Clone an existing Queue",
31311     "examples": [
31312       {
31313         "title": "Example usage:",
31314         "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",
31315         "type": "json"
31316       }
31317     ],
31318     "name": "CloneQueues",
31319     "group": "Voice_Queues",
31320     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31321     "version": "0.0.0",
31322     "filename": "server/api/voiceQueue/index.js",
31323     "groupTitle": "Voice_Queues"
31324   },
31325   {
31326     "type": "post",
31327     "url": "/api/voice/queues",
31328     "title": "Creates a new Queue",
31329     "examples": [
31330       {
31331         "title": "Example usage:",
31332         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31333         "type": "json"
31334       }
31335     ],
31336     "name": "CreateQueues",
31337     "group": "Voice_Queues",
31338     "parameter": {
31339       "fields": {
31340         "Body": [
31341           {
31342             "group": "Body",
31343             "type": "String",
31344             "optional": false,
31345             "field": "name",
31346             "description": ""
31347           },
31348           {
31349             "group": "Body",
31350             "type": "String",
31351             "allowedValues": [
31352               "\"inbound\"",
31353               "\"outbound\""
31354             ],
31355             "optional": false,
31356             "field": "type",
31357             "description": ""
31358           },
31359           {
31360             "group": "Body",
31361             "type": "String",
31362             "optional": true,
31363             "field": "musiconhold",
31364             "description": ""
31365           },
31366           {
31367             "group": "Body",
31368             "type": "String",
31369             "optional": true,
31370             "field": "announce",
31371             "description": ""
31372           },
31373           {
31374             "group": "Body",
31375             "type": "String",
31376             "allowedValues": [
31377               "\"rr\"",
31378               "\"ringall\"",
31379               "\"leastrecent\"",
31380               "\"fewestcalls\"",
31381               "\"random\"",
31382               "\"rrmemory\"",
31383               "\"linear\"",
31384               "\"wrandom\"",
31385               "\"rrordered\""
31386             ],
31387             "optional": false,
31388             "field": "strategy",
31389             "description": ""
31390           },
31391           {
31392             "group": "Body",
31393             "type": "Integer",
31394             "optional": true,
31395             "field": "servicelevel",
31396             "description": ""
31397           },
31398           {
31399             "group": "Body",
31400             "type": "String",
31401             "optional": true,
31402             "field": "context",
31403             "description": ""
31404           },
31405           {
31406             "group": "Body",
31407             "type": "Integer",
31408             "optional": true,
31409             "field": "penaltymemberslimit",
31410             "description": ""
31411           },
31412           {
31413             "group": "Body",
31414             "type": "Integer",
31415             "optional": true,
31416             "field": "timeout",
31417             "description": ""
31418           },
31419           {
31420             "group": "Body",
31421             "type": "Integer",
31422             "optional": true,
31423             "field": "retry",
31424             "description": ""
31425           },
31426           {
31427             "group": "Body",
31428             "type": "String",
31429             "optional": true,
31430             "field": "timeoutpriority",
31431             "description": ""
31432           },
31433           {
31434             "group": "Body",
31435             "type": "Integer",
31436             "optional": true,
31437             "field": "weight",
31438             "description": ""
31439           },
31440           {
31441             "group": "Body",
31442             "type": "Integer",
31443             "optional": true,
31444             "field": "wrapuptime",
31445             "description": ""
31446           },
31447           {
31448             "group": "Body",
31449             "type": "String",
31450             "allowedValues": [
31451               "\"yes\"",
31452               "\"no\""
31453             ],
31454             "optional": true,
31455             "field": "autofill",
31456             "description": ""
31457           },
31458           {
31459             "group": "Body",
31460             "type": "String",
31461             "allowedValues": [
31462               "\"yes\"",
31463               "\"no\"",
31464               "\"all\""
31465             ],
31466             "optional": true,
31467             "field": "autopause",
31468             "description": ""
31469           },
31470           {
31471             "group": "Body",
31472             "type": "Integer",
31473             "optional": true,
31474             "field": "autopausedelay",
31475             "description": ""
31476           },
31477           {
31478             "group": "Body",
31479             "type": "String",
31480             "allowedValues": [
31481               "\"yes\"",
31482               "\"no\""
31483             ],
31484             "optional": true,
31485             "field": "autopausebusy",
31486             "description": ""
31487           },
31488           {
31489             "group": "Body",
31490             "type": "String",
31491             "allowedValues": [
31492               "\"yes\"",
31493               "\"no\""
31494             ],
31495             "optional": true,
31496             "field": "autopauseunavail",
31497             "description": ""
31498           },
31499           {
31500             "group": "Body",
31501             "type": "Integer",
31502             "optional": true,
31503             "field": "maxlen",
31504             "description": ""
31505           },
31506           {
31507             "group": "Body",
31508             "type": "String",
31509             "allowedValues": [
31510               "\"yes\"",
31511               "\"no\""
31512             ],
31513             "optional": true,
31514             "field": "setinterfacevar",
31515             "description": ""
31516           },
31517           {
31518             "group": "Body",
31519             "type": "String",
31520             "allowedValues": [
31521               "\"yes\"",
31522               "\"no\""
31523             ],
31524             "optional": true,
31525             "field": "setqueueentryvar",
31526             "description": ""
31527           },
31528           {
31529             "group": "Body",
31530             "type": "String",
31531             "allowedValues": [
31532               "\"yes\"",
31533               "\"no\""
31534             ],
31535             "optional": true,
31536             "field": "setqueuevar",
31537             "description": ""
31538           },
31539           {
31540             "group": "Body",
31541             "type": "String",
31542             "allowedValues": [
31543               "\"yes\"",
31544               "\"no\""
31545             ],
31546             "optional": true,
31547             "field": "eventmemberstatus",
31548             "description": ""
31549           },
31550           {
31551             "group": "Body",
31552             "type": "String",
31553             "optional": true,
31554             "field": "membermacro",
31555             "description": ""
31556           },
31557           {
31558             "group": "Body",
31559             "type": "String",
31560             "optional": true,
31561             "field": "membergosub",
31562             "description": ""
31563           },
31564           {
31565             "group": "Body",
31566             "type": "Integer",
31567             "optional": true,
31568             "field": "announce_frequency",
31569             "description": ""
31570           },
31571           {
31572             "group": "Body",
31573             "type": "Integer",
31574             "optional": true,
31575             "field": "min_announce_frequency",
31576             "description": ""
31577           },
31578           {
31579             "group": "Body",
31580             "type": "Integer",
31581             "optional": true,
31582             "field": "periodic_announce_frequency",
31583             "description": ""
31584           },
31585           {
31586             "group": "Body",
31587             "type": "String",
31588             "allowedValues": [
31589               "\"yes\"",
31590               "\"no\""
31591             ],
31592             "optional": true,
31593             "field": "random_periodic_announce",
31594             "description": ""
31595           },
31596           {
31597             "group": "Body",
31598             "type": "String",
31599             "allowedValues": [
31600               "\"yes\"",
31601               "\"no\""
31602             ],
31603             "optional": true,
31604             "field": "relative_periodic_announce",
31605             "description": ""
31606           },
31607           {
31608             "group": "Body",
31609             "type": "String",
31610             "allowedValues": [
31611               "\"yes\"",
31612               "\"no\"",
31613               "\"once\""
31614             ],
31615             "optional": true,
31616             "field": "announce_holdtime",
31617             "description": ""
31618           },
31619           {
31620             "group": "Body",
31621             "type": "String",
31622             "optional": true,
31623             "field": "announce_position",
31624             "description": ""
31625           },
31626           {
31627             "group": "Body",
31628             "type": "String",
31629             "allowedValues": [
31630               "\"yes\"",
31631               "\"no\""
31632             ],
31633             "optional": true,
31634             "field": "announce_to_first_user",
31635             "description": ""
31636           },
31637           {
31638             "group": "Body",
31639             "type": "Integer",
31640             "optional": true,
31641             "field": "announce_position_limit",
31642             "description": ""
31643           },
31644           {
31645             "group": "Body",
31646             "type": "String",
31647             "allowedValues": [
31648               "\"0\"",
31649               "\"5\"",
31650               "\"10\"",
31651               "\"15\"",
31652               "\"20\"",
31653               "\"30\""
31654             ],
31655             "optional": true,
31656             "field": "announce_round_seconds",
31657             "description": ""
31658           },
31659           {
31660             "group": "Body",
31661             "type": "String",
31662             "optional": true,
31663             "field": "monitor_format",
31664             "description": ""
31665           },
31666           {
31667             "group": "Body",
31668             "type": "String",
31669             "optional": true,
31670             "field": "monitor_type",
31671             "description": ""
31672           },
31673           {
31674             "group": "Body",
31675             "type": "String",
31676             "optional": true,
31677             "field": "queue_youarenext",
31678             "description": ""
31679           },
31680           {
31681             "group": "Body",
31682             "type": "String",
31683             "optional": true,
31684             "field": "queue_thereare",
31685             "description": ""
31686           },
31687           {
31688             "group": "Body",
31689             "type": "String",
31690             "optional": true,
31691             "field": "queue_callswaiting",
31692             "description": ""
31693           },
31694           {
31695             "group": "Body",
31696             "type": "String",
31697             "optional": true,
31698             "field": "queue_holdtime",
31699             "description": ""
31700           },
31701           {
31702             "group": "Body",
31703             "type": "String",
31704             "optional": true,
31705             "field": "queue_minute",
31706             "description": ""
31707           },
31708           {
31709             "group": "Body",
31710             "type": "String",
31711             "optional": true,
31712             "field": "queue_minutes",
31713             "description": ""
31714           },
31715           {
31716             "group": "Body",
31717             "type": "String",
31718             "optional": true,
31719             "field": "queue_seconds",
31720             "description": ""
31721           },
31722           {
31723             "group": "Body",
31724             "type": "String",
31725             "optional": true,
31726             "field": "queue_thankyou",
31727             "description": ""
31728           },
31729           {
31730             "group": "Body",
31731             "type": "String",
31732             "optional": true,
31733             "field": "queue_reporthold",
31734             "description": ""
31735           },
31736           {
31737             "group": "Body",
31738             "type": "String",
31739             "optional": true,
31740             "field": "queue_quantity1",
31741             "description": ""
31742           },
31743           {
31744             "group": "Body",
31745             "type": "String",
31746             "optional": true,
31747             "field": "queue_quantity2",
31748             "description": ""
31749           },
31750           {
31751             "group": "Body",
31752             "type": "String",
31753             "optional": true,
31754             "field": "queue_periodic_announce",
31755             "description": ""
31756           },
31757           {
31758             "group": "Body",
31759             "type": "String",
31760             "optional": true,
31761             "field": "queue_less_than",
31762             "description": ""
31763           },
31764           {
31765             "group": "Body",
31766             "type": "Text",
31767             "optional": true,
31768             "field": "periodic_announce",
31769             "description": ""
31770           },
31771           {
31772             "group": "Body",
31773             "type": "String",
31774             "optional": true,
31775             "field": "joinempty",
31776             "description": ""
31777           },
31778           {
31779             "group": "Body",
31780             "type": "String",
31781             "optional": true,
31782             "field": "leavewhenempty",
31783             "description": ""
31784           },
31785           {
31786             "group": "Body",
31787             "type": "String",
31788             "allowedValues": [
31789               "\"yes\"",
31790               "\"no\""
31791             ],
31792             "optional": true,
31793             "field": "reportholdtime",
31794             "description": ""
31795           },
31796           {
31797             "group": "Body",
31798             "type": "String",
31799             "allowedValues": [
31800               "\"yes\"",
31801               "\"no\""
31802             ],
31803             "optional": true,
31804             "field": "ringinuse",
31805             "description": ""
31806           },
31807           {
31808             "group": "Body",
31809             "type": "Integer",
31810             "optional": true,
31811             "field": "memberdelay",
31812             "description": ""
31813           },
31814           {
31815             "group": "Body",
31816             "type": "String",
31817             "allowedValues": [
31818               "\"yes\"",
31819               "\"no\""
31820             ],
31821             "optional": true,
31822             "field": "timeoutrestart",
31823             "description": ""
31824           },
31825           {
31826             "group": "Body",
31827             "type": "String",
31828             "optional": true,
31829             "field": "defaultrule",
31830             "description": ""
31831           },
31832           {
31833             "group": "Body",
31834             "type": "String",
31835             "optional": true,
31836             "field": "description",
31837             "description": ""
31838           },
31839           {
31840             "group": "Body",
31841             "type": "Boolean",
31842             "optional": true,
31843             "field": "acw",
31844             "description": ""
31845           },
31846           {
31847             "group": "Body",
31848             "type": "Integer",
31849             "optional": true,
31850             "field": "acwTimeout",
31851             "description": ""
31852           },
31853           {
31854             "group": "Body",
31855             "type": "Boolean",
31856             "optional": true,
31857             "field": "dialActive",
31858             "description": "<p>Active/Disactive Campaign</p>"
31859           },
31860           {
31861             "group": "Body",
31862             "type": "String",
31863             "allowedValues": [
31864               "\"preview\"",
31865               "\"progressive\"",
31866               "\"power\"",
31867               "\"predictive\"",
31868               "\"booked\""
31869             ],
31870             "optional": true,
31871             "field": "dialMethod",
31872             "description": "<p>Dial Method.</p>"
31873           },
31874           {
31875             "group": "Body",
31876             "type": "Integer",
31877             "optional": true,
31878             "field": "dialLimitChannel",
31879             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
31880           },
31881           {
31882             "group": "Body",
31883             "type": "Integer",
31884             "optional": true,
31885             "field": "dialLimitQueue",
31886             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
31887           },
31888           {
31889             "group": "Body",
31890             "type": "Float",
31891             "optional": true,
31892             "field": "dialPowerLevel",
31893             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
31894           },
31895           {
31896             "group": "Body",
31897             "type": "String",
31898             "allowedValues": [
31899               "\"agentBusyFactor\"",
31900               "\"dropRate\""
31901             ],
31902             "optional": true,
31903             "field": "dialPredictiveOptimization",
31904             "description": "<p>Only for predictive method.</p>"
31905           },
31906           {
31907             "group": "Body",
31908             "type": "Float",
31909             "optional": true,
31910             "field": "dialPredictiveOptimizationPercentage",
31911             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
31912           },
31913           {
31914             "group": "Body",
31915             "type": "Integer",
31916             "optional": true,
31917             "field": "dialPredictiveInterval",
31918             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
31919           },
31920           {
31921             "group": "Body",
31922             "type": "String",
31923             "optional": true,
31924             "field": "dialOriginateCallerIdName",
31925             "description": ""
31926           },
31927           {
31928             "group": "Body",
31929             "type": "String",
31930             "optional": true,
31931             "field": "dialOriginateCallerIdNumber",
31932             "description": ""
31933           },
31934           {
31935             "group": "Body",
31936             "type": "Integer",
31937             "optional": true,
31938             "field": "dialOriginateTimeout",
31939             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
31940           },
31941           {
31942             "group": "Body",
31943             "type": "String",
31944             "optional": true,
31945             "field": "dialQueueOptions",
31946             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
31947           },
31948           {
31949             "group": "Body",
31950             "type": "Integer",
31951             "optional": true,
31952             "field": "dialQueueTimeout",
31953             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
31954           },
31955           {
31956             "group": "Body",
31957             "type": "String",
31958             "optional": true,
31959             "field": "dialQueueProject",
31960             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
31961           },
31962           {
31963             "group": "Body",
31964             "type": "Integer",
31965             "optional": true,
31966             "field": "dialCongestionMaxRetry",
31967             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
31968           },
31969           {
31970             "group": "Body",
31971             "type": "Integer",
31972             "optional": true,
31973             "field": "dialCongestionRetryFrequency",
31974             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
31975           },
31976           {
31977             "group": "Body",
31978             "type": "Integer",
31979             "optional": true,
31980             "field": "dialBusyMaxRetry",
31981             "description": "<p>#Busy Retry (min:1, max:999)</p>"
31982           },
31983           {
31984             "group": "Body",
31985             "type": "Integer",
31986             "optional": true,
31987             "field": "dialBusyRetryFrequency",
31988             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
31989           },
31990           {
31991             "group": "Body",
31992             "type": "Integer",
31993             "optional": true,
31994             "field": "dialNoAnswerMaxRetry",
31995             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
31996           },
31997           {
31998             "group": "Body",
31999             "type": "Integer",
32000             "optional": true,
32001             "field": "dialNoAnswerRetryFrequency",
32002             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32003           },
32004           {
32005             "group": "Body",
32006             "type": "Integer",
32007             "optional": true,
32008             "field": "dialGlobalMaxRetry",
32009             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32010           },
32011           {
32012             "group": "Body",
32013             "type": "String",
32014             "optional": true,
32015             "field": "dialTimezone",
32016             "description": ""
32017           },
32018           {
32019             "group": "Body",
32020             "type": "String",
32021             "optional": true,
32022             "field": "dialGlobalInterval",
32023             "description": ""
32024           },
32025           {
32026             "group": "Body",
32027             "type": "String",
32028             "optional": true,
32029             "field": "dialPrefix",
32030             "description": ""
32031           },
32032           {
32033             "group": "Body",
32034             "type": "String",
32035             "allowedValues": [
32036               "\"always\"",
32037               "\"never\"",
32038               "\"onlyIfOpen\""
32039             ],
32040             "optional": true,
32041             "field": "dialCheckDuplicateType",
32042             "description": ""
32043           },
32044           {
32045             "group": "Body",
32046             "type": "Boolean",
32047             "optional": true,
32048             "field": "dialAMDActive",
32049             "description": "<p>Active/Disactive AMD</p>"
32050           },
32051           {
32052             "group": "Body",
32053             "type": "Integer",
32054             "optional": true,
32055             "field": "dialAMDInitialSilence",
32056             "description": "<p>#AMD Initial Silence</p>"
32057           },
32058           {
32059             "group": "Body",
32060             "type": "Integer",
32061             "optional": true,
32062             "field": "dialAMDGreeting",
32063             "description": "<p>#AMD Greeting</p>"
32064           },
32065           {
32066             "group": "Body",
32067             "type": "Integer",
32068             "optional": true,
32069             "field": "dialAMDAfterGreetingSilence",
32070             "description": "<p>#AMD After Greeting Silence</p>"
32071           },
32072           {
32073             "group": "Body",
32074             "type": "Integer",
32075             "optional": true,
32076             "field": "dialAMDTotalAnalysisTime",
32077             "description": "<p>#AMD Total Analysis Time</p>"
32078           },
32079           {
32080             "group": "Body",
32081             "type": "Integer",
32082             "optional": true,
32083             "field": "dialAMDMinWordLength",
32084             "description": "<p>#AMD Min Word Length</p>"
32085           },
32086           {
32087             "group": "Body",
32088             "type": "Integer",
32089             "optional": true,
32090             "field": "dialAMDBetweenWordsSilence",
32091             "description": "<p>#AMD Between Words Silence</p>"
32092           },
32093           {
32094             "group": "Body",
32095             "type": "Integer",
32096             "optional": true,
32097             "field": "dialAMDMaximumNumberOfWords",
32098             "description": "<p>#AMD Maximum Number Of Words</p>"
32099           },
32100           {
32101             "group": "Body",
32102             "type": "Integer",
32103             "optional": true,
32104             "field": "dialAMDSilenceThreshold",
32105             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32106           },
32107           {
32108             "group": "Body",
32109             "type": "Integer",
32110             "optional": true,
32111             "field": "dialAMDMaximumWordLength",
32112             "description": "<p>#AMD Maximum Word Length</p>"
32113           },
32114           {
32115             "group": "Body",
32116             "type": "Integer",
32117             "optional": true,
32118             "field": "dialRecallMeTimeout",
32119             "description": "<p>#RecallMe Timeout (min:1)</p>"
32120           },
32121           {
32122             "group": "Body",
32123             "type": "Boolean",
32124             "optional": true,
32125             "field": "dialRecallInQueue",
32126             "description": "<p>Active/Disactive Recall In Queue</p>"
32127           },
32128           {
32129             "group": "Body",
32130             "type": "String",
32131             "allowedValues": [
32132               "\"DESC\"",
32133               "\"ASC\""
32134             ],
32135             "optional": true,
32136             "field": "dialOrderByScheduledAt",
32137             "description": ""
32138           },
32139           {
32140             "group": "Body",
32141             "type": "String",
32142             "optional": true,
32143             "field": "dialQueueProject2",
32144             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32145           },
32146           {
32147             "group": "Body",
32148             "type": "Boolean",
32149             "optional": true,
32150             "field": "dialAgiAfterHangupClient",
32151             "description": ""
32152           },
32153           {
32154             "group": "Body",
32155             "type": "Boolean",
32156             "optional": true,
32157             "field": "dialAgiAfterHangupAgent",
32158             "description": ""
32159           },
32160           {
32161             "group": "Body",
32162             "type": "Integer",
32163             "optional": true,
32164             "field": "dialRandomLastDigitCallerIdNumber",
32165             "description": "<p>Random Last Digit (min:1, max:15)</p>"
32166           },
32167           {
32168             "group": "Body",
32169             "type": "Integer",
32170             "optional": true,
32171             "field": "dialCutDigit",
32172             "description": "<p>Cut Digit (min:1, max:15)</p>"
32173           },
32174           {
32175             "group": "Body",
32176             "type": "Integer",
32177             "optional": true,
32178             "field": "dialNoSuchNumberMaxRetry",
32179             "description": "<p>#NoSuchNumber Retry (min:1, max:999)</p>"
32180           },
32181           {
32182             "group": "Body",
32183             "type": "Integer",
32184             "optional": true,
32185             "field": "dialNoSuchNumberRetryFrequency",
32186             "description": "<p>NoSuchNumber Retry Frequency Minutes (min:1, max:99999)</p>"
32187           },
32188           {
32189             "group": "Body",
32190             "type": "Integer",
32191             "optional": true,
32192             "field": "dialDropMaxRetry",
32193             "description": "<p>#Drop Retry (min:1, max:999)</p>"
32194           },
32195           {
32196             "group": "Body",
32197             "type": "Integer",
32198             "optional": true,
32199             "field": "dialDropRetryFrequency",
32200             "description": "<p>Drop Retry Frequency Minutes (min:1, max:99999)</p>"
32201           },
32202           {
32203             "group": "Body",
32204             "type": "Integer",
32205             "optional": true,
32206             "field": "dialAbandonedMaxRetry",
32207             "description": "<p>#Abandoned Retry (min:1, max:999)</p>"
32208           },
32209           {
32210             "group": "Body",
32211             "type": "Integer",
32212             "optional": true,
32213             "field": "dialAbandonedRetryFrequency",
32214             "description": "<p>Abandoned Retry Frequency Minutes (min:1, max:99999)</p>"
32215           },
32216           {
32217             "group": "Body",
32218             "type": "Integer",
32219             "optional": true,
32220             "field": "dialMachineMaxRetry",
32221             "description": "<p>#Machine Retry (min:1, max:999)</p>"
32222           },
32223           {
32224             "group": "Body",
32225             "type": "Integer",
32226             "optional": true,
32227             "field": "dialMachineRetryFrequency",
32228             "description": "<p>Machine Retry Frequency Minutes (min:1, max:99999)</p>"
32229           },
32230           {
32231             "group": "Body",
32232             "type": "Integer",
32233             "optional": true,
32234             "field": "dialAgentRejectMaxRetry",
32235             "description": "<p>#AgentReject Retry (min:1, max:999)</p>"
32236           },
32237           {
32238             "group": "Body",
32239             "type": "Integer",
32240             "optional": true,
32241             "field": "dialAgentRejectRetryFrequency",
32242             "description": "<p>AgentReject Retry Frequency Minutes (min:1, max:99999)</p>"
32243           },
32244           {
32245             "group": "Body",
32246             "type": "Integer",
32247             "optional": true,
32248             "field": "mandatoryDispositionPauseId",
32249             "description": "<p>Status to put when mandatory disposition is enabled</p>"
32250           },
32251           {
32252             "group": "Body",
32253             "type": "Boolean",
32254             "optional": true,
32255             "field": "mandatoryDisposition",
32256             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32257           },
32258           {
32259             "group": "Body",
32260             "type": "Integer",
32261             "optional": true,
32262             "field": "dialPredictiveIntervalMaxThreshold",
32263             "description": ""
32264           },
32265           {
32266             "group": "Body",
32267             "type": "Integer",
32268             "optional": true,
32269             "field": "dialPredictiveIntervalMinThreshold",
32270             "description": ""
32271           }
32272         ]
32273       }
32274     },
32275     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32276     "version": "0.0.0",
32277     "filename": "server/api/voiceQueue/index.js",
32278     "groupTitle": "Voice_Queues"
32279   },
32280   {
32281     "type": "delete",
32282     "url": "/api/voice/queues/{id}",
32283     "title": "Deletes a Queue",
32284     "examples": [
32285       {
32286         "title": "Example usage:",
32287         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32288         "type": "json"
32289       }
32290     ],
32291     "name": "DeleteQueues",
32292     "group": "Voice_Queues",
32293     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32294     "version": "0.0.0",
32295     "filename": "server/api/voiceQueue/index.js",
32296     "groupTitle": "Voice_Queues"
32297   },
32298   {
32299     "type": "get",
32300     "url": "/api/voice/queues/{id}/users",
32301     "title": "Gets queue agents",
32302     "examples": [
32303       {
32304         "title": "Example usage:",
32305         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32306         "type": "json"
32307       }
32308     ],
32309     "name": "GetAgents",
32310     "group": "Voice_Queues",
32311     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32312     "version": "0.0.0",
32313     "filename": "server/api/voiceQueue/index.js",
32314     "groupTitle": "Voice_Queues"
32315   },
32316   {
32317     "type": "get",
32318     "url": "/api/voice/queues/{id}/blacklists",
32319     "title": "Get queue blacklists",
32320     "examples": [
32321       {
32322         "title": "Example usage:",
32323         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32324         "type": "json"
32325       }
32326     ],
32327     "name": "GetBlackLists",
32328     "group": "Voice_Queues",
32329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32330     "version": "0.0.0",
32331     "filename": "server/api/voiceQueue/index.js",
32332     "groupTitle": "Voice_Queues"
32333   },
32334   {
32335     "type": "get",
32336     "url": "/api/voice/queues/{id}/finals",
32337     "title": "Gets queue hopper finals",
32338     "examples": [
32339       {
32340         "title": "Example usage:",
32341         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
32342         "type": "json"
32343       }
32344     ],
32345     "name": "GetHopperFinals",
32346     "group": "Voice_Queues",
32347     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32348     "version": "0.0.0",
32349     "filename": "server/api/voiceQueue/index.js",
32350     "groupTitle": "Voice_Queues"
32351   },
32352   {
32353     "type": "get",
32354     "url": "/api/voice/queues/{id}/hopper_histories",
32355     "title": "Gets queue hopper histories",
32356     "examples": [
32357       {
32358         "title": "Example usage:",
32359         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
32360         "type": "json"
32361       }
32362     ],
32363     "name": "GetHopperHistories",
32364     "group": "Voice_Queues",
32365     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32366     "version": "0.0.0",
32367     "filename": "server/api/voiceQueue/index.js",
32368     "groupTitle": "Voice_Queues"
32369   },
32370   {
32371     "type": "get",
32372     "url": "/api/voice/queues/{id}/hoppers",
32373     "title": "Gets queue hoppers",
32374     "examples": [
32375       {
32376         "title": "Example usage:",
32377         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
32378         "type": "json"
32379       }
32380     ],
32381     "name": "GetHoppers",
32382     "group": "Voice_Queues",
32383     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32384     "version": "0.0.0",
32385     "filename": "server/api/voiceQueue/index.js",
32386     "groupTitle": "Voice_Queues"
32387   },
32388   {
32389     "type": "get",
32390     "url": "/api/voice/queues/{id}/lists",
32391     "title": "Get queue lists",
32392     "examples": [
32393       {
32394         "title": "Example usage:",
32395         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
32396         "type": "json"
32397       }
32398     ],
32399     "name": "GetLists",
32400     "group": "Voice_Queues",
32401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32402     "version": "0.0.0",
32403     "filename": "server/api/voiceQueue/index.js",
32404     "groupTitle": "Voice_Queues"
32405   },
32406   {
32407     "type": "get",
32408     "url": "/api/voice/queues/{id}/members",
32409     "title": "Gets queue members",
32410     "examples": [
32411       {
32412         "title": "Example usage:",
32413         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
32414         "type": "json"
32415       }
32416     ],
32417     "name": "GetMembers",
32418     "group": "Voice_Queues",
32419     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32420     "version": "0.0.0",
32421     "filename": "server/api/voiceQueue/index.js",
32422     "groupTitle": "Voice_Queues"
32423   },
32424   {
32425     "type": "get",
32426     "url": "/api/voice/queues",
32427     "title": "Gets a list of Queues",
32428     "examples": [
32429       {
32430         "title": "Example usage:",
32431         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
32432         "type": "json"
32433       }
32434     ],
32435     "name": "GetQueues",
32436     "group": "Voice_Queues",
32437     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32438     "version": "0.0.0",
32439     "filename": "server/api/voiceQueue/index.js",
32440     "groupTitle": "Voice_Queues"
32441   },
32442   {
32443     "type": "get",
32444     "url": "/api/voice/queues/{id}/teams",
32445     "title": "Gets queue team",
32446     "examples": [
32447       {
32448         "title": "Example usage:",
32449         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
32450         "type": "json"
32451       }
32452     ],
32453     "name": "GetTeams",
32454     "group": "Voice_Queues",
32455     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32456     "version": "0.0.0",
32457     "filename": "server/api/voiceQueue/index.js",
32458     "groupTitle": "Voice_Queues"
32459   },
32460   {
32461     "type": "delete",
32462     "url": "/api/voice/queues/{id}/users",
32463     "title": "Removes agents from a queue",
32464     "examples": [
32465       {
32466         "title": "Example usage:",
32467         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32468         "type": "json"
32469       }
32470     ],
32471     "name": "RemoveAgents",
32472     "group": "Voice_Queues",
32473     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32474     "version": "0.0.0",
32475     "filename": "server/api/voiceQueue/index.js",
32476     "groupTitle": "Voice_Queues"
32477   },
32478   {
32479     "type": "delete",
32480     "url": "/api/voice/queues/{id}/blacklists",
32481     "title": "Remove blacklists from a queue",
32482     "examples": [
32483       {
32484         "title": "Example usage:",
32485         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32486         "type": "json"
32487       }
32488     ],
32489     "name": "RemoveBlackLists",
32490     "group": "Voice_Queues",
32491     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32492     "version": "0.0.0",
32493     "filename": "server/api/voiceQueue/index.js",
32494     "groupTitle": "Voice_Queues"
32495   },
32496   {
32497     "type": "delete",
32498     "url": "/api/voice/queues/{id}/lists",
32499     "title": "Remove lists from a queue",
32500     "examples": [
32501       {
32502         "title": "Example usage:",
32503         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
32504         "type": "json"
32505       }
32506     ],
32507     "name": "RemoveLists",
32508     "group": "Voice_Queues",
32509     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32510     "version": "0.0.0",
32511     "filename": "server/api/voiceQueue/index.js",
32512     "groupTitle": "Voice_Queues"
32513   },
32514   {
32515     "type": "get",
32516     "url": "/api/voice/queues/{id}",
32517     "title": "Gets a single Queue",
32518     "examples": [
32519       {
32520         "title": "Example usage:",
32521         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
32522         "type": "json"
32523       }
32524     ],
32525     "name": "ShowQueues",
32526     "group": "Voice_Queues",
32527     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32528     "version": "0.0.0",
32529     "filename": "server/api/voiceQueue/index.js",
32530     "groupTitle": "Voice_Queues"
32531   },
32532   {
32533     "type": "get",
32534     "url": "/api/voice/queues/{id}/blacks",
32535     "title": "Gets queue hopper blacks",
32536     "examples": [
32537       {
32538         "title": "Example usage:",
32539         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
32540         "type": "json"
32541       }
32542     ],
32543     "name": "getHopperBlacks",
32544     "group": "Voice_Queues",
32545     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32546     "version": "0.0.0",
32547     "filename": "server/api/voiceQueue/index.js",
32548     "groupTitle": "Voice_Queues"
32549   },
32550   {
32551     "type": "put",
32552     "url": "/api/voice/queues/{id}",
32553     "title": "Update an existing Queue",
32554     "examples": [
32555       {
32556         "title": "Example usage:",
32557         "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",
32558         "type": "json"
32559       }
32560     ],
32561     "name": "updateQueues",
32562     "group": "Voice_Queues",
32563     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32564     "version": "0.0.0",
32565     "filename": "server/api/voiceQueue/index.js",
32566     "groupTitle": "Voice_Queues"
32567   },
32568   {
32569     "type": "post",
32570     "url": "/api/voice/recordings",
32571     "title": "Creates a new Recording",
32572     "examples": [
32573       {
32574         "title": "Example usage:",
32575         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32576         "type": "json"
32577       }
32578     ],
32579     "name": "CreateRecordings",
32580     "group": "Voice_Recordings",
32581     "parameter": {
32582       "fields": {
32583         "Body": [
32584           {
32585             "group": "Body",
32586             "type": "Virtual",
32587             "optional": true,
32588             "field": "format",
32589             "description": ""
32590           },
32591           {
32592             "group": "Body",
32593             "type": "String",
32594             "optional": true,
32595             "field": "uniqueid",
32596             "description": ""
32597           },
32598           {
32599             "group": "Body",
32600             "type": "String",
32601             "optional": true,
32602             "field": "channel",
32603             "description": ""
32604           },
32605           {
32606             "group": "Body",
32607             "type": "String",
32608             "optional": true,
32609             "field": "membername",
32610             "description": ""
32611           },
32612           {
32613             "group": "Body",
32614             "type": "String",
32615             "optional": true,
32616             "field": "calleridnum",
32617             "description": ""
32618           },
32619           {
32620             "group": "Body",
32621             "type": "String",
32622             "optional": true,
32623             "field": "calleridname",
32624             "description": ""
32625           },
32626           {
32627             "group": "Body",
32628             "type": "String",
32629             "optional": true,
32630             "field": "connectedlinenum",
32631             "description": ""
32632           },
32633           {
32634             "group": "Body",
32635             "type": "String",
32636             "optional": true,
32637             "field": "connectedlinename",
32638             "description": ""
32639           },
32640           {
32641             "group": "Body",
32642             "type": "String",
32643             "optional": true,
32644             "field": "accountcode",
32645             "description": ""
32646           },
32647           {
32648             "group": "Body",
32649             "type": "String",
32650             "optional": true,
32651             "field": "context",
32652             "description": ""
32653           },
32654           {
32655             "group": "Body",
32656             "type": "String",
32657             "optional": true,
32658             "field": "exten",
32659             "description": ""
32660           },
32661           {
32662             "group": "Body",
32663             "type": "String",
32664             "optional": true,
32665             "field": "value",
32666             "description": ""
32667           },
32668           {
32669             "group": "Body",
32670             "type": "String",
32671             "optional": true,
32672             "field": "type",
32673             "description": ""
32674           },
32675           {
32676             "group": "Body",
32677             "type": "Integer",
32678             "optional": true,
32679             "field": "rating",
32680             "description": ""
32681           },
32682           {
32683             "group": "Body",
32684             "type": "String",
32685             "optional": true,
32686             "field": "queue",
32687             "description": ""
32688           },
32689           {
32690             "group": "Body",
32691             "type": "String",
32692             "optional": true,
32693             "field": "userDisposition",
32694             "description": ""
32695           },
32696           {
32697             "group": "Body",
32698             "type": "String",
32699             "optional": true,
32700             "field": "userSecondDisposition",
32701             "description": ""
32702           },
32703           {
32704             "group": "Body",
32705             "type": "String",
32706             "optional": true,
32707             "field": "userThirdDisposition",
32708             "description": ""
32709           },
32710           {
32711             "group": "Body",
32712             "type": "Text",
32713             "optional": true,
32714             "field": "location",
32715             "description": ""
32716           },
32717           {
32718             "group": "Body",
32719             "type": "String",
32720             "optional": true,
32721             "field": "transcribeName",
32722             "description": ""
32723           },
32724           {
32725             "group": "Body",
32726             "type": "String",
32727             "optional": true,
32728             "field": "transcribeStatus",
32729             "description": ""
32730           },
32731           {
32732             "group": "Body",
32733             "type": "Text",
32734             "optional": true,
32735             "field": "fileUri",
32736             "description": ""
32737           },
32738           {
32739             "group": "Body",
32740             "type": "Text",
32741             "optional": true,
32742             "field": "fileText",
32743             "description": ""
32744           },
32745           {
32746             "group": "Body",
32747             "type": "Text",
32748             "optional": true,
32749             "field": "failureReason",
32750             "description": ""
32751           },
32752           {
32753             "group": "Body",
32754             "type": "String",
32755             "optional": true,
32756             "field": "sentiment",
32757             "description": ""
32758           },
32759           {
32760             "group": "Body",
32761             "type": "Float",
32762             "optional": true,
32763             "field": "sPositive",
32764             "description": ""
32765           },
32766           {
32767             "group": "Body",
32768             "type": "Float",
32769             "optional": true,
32770             "field": "sNegative",
32771             "description": ""
32772           },
32773           {
32774             "group": "Body",
32775             "type": "Float",
32776             "optional": true,
32777             "field": "sNeutral",
32778             "description": ""
32779           },
32780           {
32781             "group": "Body",
32782             "type": "Float",
32783             "optional": true,
32784             "field": "sMixed",
32785             "description": ""
32786           },
32787           {
32788             "group": "Body",
32789             "type": "Boolean",
32790             "optional": true,
32791             "field": "tempSentiment",
32792             "description": ""
32793           },
32794           {
32795             "group": "Body",
32796             "type": "String",
32797             "optional": true,
32798             "field": "createdAt",
32799             "description": ""
32800           },
32801           {
32802             "group": "Body",
32803             "type": "String",
32804             "optional": true,
32805             "field": "updatedAt",
32806             "description": ""
32807           }
32808         ]
32809       }
32810     },
32811     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32812     "version": "0.0.0",
32813     "filename": "server/api/voiceRecording/index.js",
32814     "groupTitle": "Voice_Recordings"
32815   },
32816   {
32817     "type": "get",
32818     "url": "/api/voice/recordings/describe",
32819     "title": "Gets table info about Recordings",
32820     "examples": [
32821       {
32822         "title": "Example usage:",
32823         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
32824         "type": "json"
32825       }
32826     ],
32827     "name": "DescribeRecordings",
32828     "group": "Voice_Recordings",
32829     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32830     "version": "0.0.0",
32831     "filename": "server/api/voiceRecording/index.js",
32832     "groupTitle": "Voice_Recordings"
32833   },
32834   {
32835     "type": "get",
32836     "url": "/api/voice/recordings",
32837     "title": "Gets a list of Recordings",
32838     "examples": [
32839       {
32840         "title": "Example usage:",
32841         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
32842         "type": "json"
32843       }
32844     ],
32845     "name": "GetRecordings",
32846     "group": "Voice_Recordings",
32847     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
32848     "version": "0.0.0",
32849     "filename": "server/api/voiceRecording/index.js",
32850     "groupTitle": "Voice_Recordings"
32851   },
32852   {
32853     "type": "get",
32854     "url": "/api/voice/recordings/{id}",
32855     "title": "Gets a single Recording",
32856     "examples": [
32857       {
32858         "title": "Example usage:",
32859         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
32860         "type": "json"
32861       }
32862     ],
32863     "name": "ShowRecordings",
32864     "group": "Voice_Recordings",
32865     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32866     "version": "0.0.0",
32867     "filename": "server/api/voiceRecording/index.js",
32868     "groupTitle": "Voice_Recordings"
32869   },
32870   {
32871     "type": "delete",
32872     "url": "/api/voice/recordings/{id}",
32873     "title": "Delete voice recording",
32874     "examples": [
32875       {
32876         "title": "Example usage:",
32877         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
32878         "type": "json"
32879       }
32880     ],
32881     "name": "destroy",
32882     "group": "Voice_Recordings",
32883     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32884     "version": "0.0.0",
32885     "filename": "server/api/voiceRecording/index.js",
32886     "groupTitle": "Voice_Recordings"
32887   },
32888   {
32889     "type": "get",
32890     "url": "/api/voice/recordings/{id}/download",
32891     "title": "Download Recording",
32892     "examples": [
32893       {
32894         "title": "Example usage:",
32895         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
32896         "type": "json"
32897       }
32898     ],
32899     "name": "download",
32900     "group": "Voice_Recordings",
32901     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32902     "version": "0.0.0",
32903     "filename": "server/api/voiceRecording/index.js",
32904     "groupTitle": "Voice_Recordings"
32905   },
32906   {
32907     "type": "get",
32908     "url": "/api/voice/recordings/{id}/downloads",
32909     "title": "Download Recording",
32910     "examples": [
32911       {
32912         "title": "Example usage:",
32913         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
32914         "type": "json"
32915       }
32916     ],
32917     "name": "downloads",
32918     "group": "Voice_Recordings",
32919     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32920     "version": "0.0.0",
32921     "filename": "server/api/voiceRecording/index.js",
32922     "groupTitle": "Voice_Recordings"
32923   },
32924   {
32925     "type": "get",
32926     "url": "/api/voice/recordings/{id}/transcribe",
32927     "title": "Run Transcribe Recording",
32928     "examples": [
32929       {
32930         "title": "Example usage:",
32931         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -v -u {name}:{password} -X GET",
32932         "type": "json"
32933       }
32934     ],
32935     "name": "transcribe",
32936     "group": "Voice_Recordings",
32937     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32938     "version": "0.0.0",
32939     "filename": "server/api/voiceRecording/index.js",
32940     "groupTitle": "Voice_Recordings"
32941   },
32942   {
32943     "type": "post",
32944     "url": "/api/voice/recordings/{id}/transcribe",
32945     "title": "Run Transcribe Recording",
32946     "examples": [
32947       {
32948         "title": "Example usage:",
32949         "content": "curl https://{domain}/api/voice/recordings/{id}/transcribe -d '{\"runSentiment\": \"true\"}' -v -u {name}:{password} -X POST",
32950         "type": "json"
32951       }
32952     ],
32953     "name": "transcribe",
32954     "group": "Voice_Recordings",
32955     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32956     "version": "0.0.0",
32957     "filename": "server/api/voiceRecording/index.js",
32958     "groupTitle": "Voice_Recordings"
32959   },
32960   {
32961     "type": "put",
32962     "url": "/api/voice/recordings/{id}",
32963     "title": "Update an existing Recording",
32964     "examples": [
32965       {
32966         "title": "Example usage:",
32967         "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",
32968         "type": "json"
32969       }
32970     ],
32971     "name": "updateRecordings",
32972     "group": "Voice_Recordings",
32973     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32974     "version": "0.0.0",
32975     "filename": "server/api/voiceRecording/index.js",
32976     "groupTitle": "Voice_Recordings"
32977   },
32978   {
32979     "type": "post",
32980     "url": "/api/voice/transfers/reports",
32981     "title": "Creates a new Transfer Report",
32982     "examples": [
32983       {
32984         "title": "Example usage:",
32985         "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",
32986         "type": "json"
32987       }
32988     ],
32989     "name": "CreateTransfer_Reports",
32990     "group": "Voice_Transfer_Reports",
32991     "parameter": {
32992       "fields": {
32993         "Body": [
32994           {
32995             "group": "Body",
32996             "type": "String",
32997             "allowedValues": [
32998               "\"blind\"",
32999               "\"attended\""
33000             ],
33001             "optional": true,
33002             "field": "type",
33003             "description": ""
33004           },
33005           {
33006             "group": "Body",
33007             "type": "String",
33008             "optional": true,
33009             "field": "result",
33010             "description": ""
33011           },
33012           {
33013             "group": "Body",
33014             "type": "String",
33015             "optional": true,
33016             "field": "transfererchannel",
33017             "description": ""
33018           },
33019           {
33020             "group": "Body",
33021             "type": "String",
33022             "optional": true,
33023             "field": "transferercalleridnum",
33024             "description": ""
33025           },
33026           {
33027             "group": "Body",
33028             "type": "String",
33029             "optional": true,
33030             "field": "transferercalleridname",
33031             "description": ""
33032           },
33033           {
33034             "group": "Body",
33035             "type": "String",
33036             "optional": true,
33037             "field": "transfererconnectedlinenum",
33038             "description": ""
33039           },
33040           {
33041             "group": "Body",
33042             "type": "String",
33043             "optional": true,
33044             "field": "transfererconnectedlinename",
33045             "description": ""
33046           },
33047           {
33048             "group": "Body",
33049             "type": "String",
33050             "optional": true,
33051             "field": "transfereraccountcode",
33052             "description": ""
33053           },
33054           {
33055             "group": "Body",
33056             "type": "String",
33057             "optional": true,
33058             "field": "transferercontext",
33059             "description": ""
33060           },
33061           {
33062             "group": "Body",
33063             "type": "String",
33064             "optional": true,
33065             "field": "transfererexten",
33066             "description": ""
33067           },
33068           {
33069             "group": "Body",
33070             "type": "String",
33071             "optional": true,
33072             "field": "transfererlinkedid",
33073             "description": ""
33074           },
33075           {
33076             "group": "Body",
33077             "type": "String",
33078             "optional": true,
33079             "field": "transfereechannel",
33080             "description": ""
33081           },
33082           {
33083             "group": "Body",
33084             "type": "String",
33085             "optional": true,
33086             "field": "transfereecalleridnum",
33087             "description": ""
33088           },
33089           {
33090             "group": "Body",
33091             "type": "String",
33092             "optional": true,
33093             "field": "transfereecalleridname",
33094             "description": ""
33095           },
33096           {
33097             "group": "Body",
33098             "type": "String",
33099             "optional": true,
33100             "field": "transfereeconnectedlinenum",
33101             "description": ""
33102           },
33103           {
33104             "group": "Body",
33105             "type": "String",
33106             "optional": true,
33107             "field": "transfereeconnectedlinename",
33108             "description": ""
33109           },
33110           {
33111             "group": "Body",
33112             "type": "String",
33113             "optional": true,
33114             "field": "transfereeaccountcode",
33115             "description": ""
33116           },
33117           {
33118             "group": "Body",
33119             "type": "String",
33120             "optional": true,
33121             "field": "transfereecontext",
33122             "description": ""
33123           },
33124           {
33125             "group": "Body",
33126             "type": "String",
33127             "optional": true,
33128             "field": "transfereeexten",
33129             "description": ""
33130           },
33131           {
33132             "group": "Body",
33133             "type": "String",
33134             "optional": true,
33135             "field": "transfereelinkedid",
33136             "description": ""
33137           },
33138           {
33139             "group": "Body",
33140             "type": "String",
33141             "allowedValues": [
33142               "\"Yes\"",
33143               "\"No\""
33144             ],
33145             "optional": true,
33146             "field": "isexternal",
33147             "description": ""
33148           },
33149           {
33150             "group": "Body",
33151             "type": "String",
33152             "optional": true,
33153             "field": "context",
33154             "description": ""
33155           },
33156           {
33157             "group": "Body",
33158             "type": "String",
33159             "optional": true,
33160             "field": "extension",
33161             "description": ""
33162           }
33163         ]
33164       }
33165     },
33166     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33167     "version": "0.0.0",
33168     "filename": "server/api/voiceTransferReport/index.js",
33169     "groupTitle": "Voice_Transfer_Reports"
33170   },
33171   {
33172     "type": "delete",
33173     "url": "/api/voice/transfers/reports/{id}",
33174     "title": "Deletes a Transfer Report",
33175     "examples": [
33176       {
33177         "title": "Example usage:",
33178         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33179         "type": "json"
33180       }
33181     ],
33182     "name": "DeleteTransfer_Reports",
33183     "group": "Voice_Transfer_Reports",
33184     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33185     "version": "0.0.0",
33186     "filename": "server/api/voiceTransferReport/index.js",
33187     "groupTitle": "Voice_Transfer_Reports"
33188   },
33189   {
33190     "type": "get",
33191     "url": "/api/voice/transfers/reports",
33192     "title": "Gets a list of Transfer Reports",
33193     "examples": [
33194       {
33195         "title": "Example usage:",
33196         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33197         "type": "json"
33198       }
33199     ],
33200     "name": "GetTransfer_Reports",
33201     "group": "Voice_Transfer_Reports",
33202     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33203     "version": "0.0.0",
33204     "filename": "server/api/voiceTransferReport/index.js",
33205     "groupTitle": "Voice_Transfer_Reports"
33206   },
33207   {
33208     "type": "get",
33209     "url": "/api/voice/transfers/reports/{id}",
33210     "title": "Gets a single Transfer Report",
33211     "examples": [
33212       {
33213         "title": "Example usage:",
33214         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33215         "type": "json"
33216       }
33217     ],
33218     "name": "ShowTransfer_Reports",
33219     "group": "Voice_Transfer_Reports",
33220     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33221     "version": "0.0.0",
33222     "filename": "server/api/voiceTransferReport/index.js",
33223     "groupTitle": "Voice_Transfer_Reports"
33224   },
33225   {
33226     "type": "put",
33227     "url": "/api/voice/transfers/reports/{id}",
33228     "title": "Update an existing Transfer Report",
33229     "examples": [
33230       {
33231         "title": "Example usage:",
33232         "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",
33233         "type": "json"
33234       }
33235     ],
33236     "name": "updateTransfer_Reports",
33237     "group": "Voice_Transfer_Reports",
33238     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33239     "version": "0.0.0",
33240     "filename": "server/api/voiceTransferReport/index.js",
33241     "groupTitle": "Voice_Transfer_Reports"
33242   },
33243   {
33244     "type": "post",
33245     "url": "/api/integrations/vtiger/accounts",
33246     "title": "Creates a new Vtiger Account",
33247     "examples": [
33248       {
33249         "title": "Example usage:",
33250         "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",
33251         "type": "json"
33252       }
33253     ],
33254     "name": "CreateVtiger_Accounts",
33255     "group": "Vtiger_Accounts",
33256     "parameter": {
33257       "fields": {
33258         "Body": [
33259           {
33260             "group": "Body",
33261             "type": "String",
33262             "optional": false,
33263             "field": "name",
33264             "description": ""
33265           },
33266           {
33267             "group": "Body",
33268             "type": "String",
33269             "optional": true,
33270             "field": "description",
33271             "description": ""
33272           },
33273           {
33274             "group": "Body",
33275             "type": "String",
33276             "optional": false,
33277             "field": "username",
33278             "description": ""
33279           },
33280           {
33281             "group": "Body",
33282             "type": "String",
33283             "optional": false,
33284             "field": "moduleName",
33285             "description": ""
33286           },
33287           {
33288             "group": "Body",
33289             "type": "String",
33290             "optional": false,
33291             "field": "remoteUri",
33292             "description": ""
33293           },
33294           {
33295             "group": "Body",
33296             "type": "String",
33297             "optional": true,
33298             "field": "serverUrl",
33299             "description": ""
33300           },
33301           {
33302             "group": "Body",
33303             "type": "String",
33304             "optional": false,
33305             "field": "accessKey",
33306             "description": ""
33307           }
33308         ]
33309       }
33310     },
33311     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33312     "version": "0.0.0",
33313     "filename": "server/api/intVtigerAccount/index.js",
33314     "groupTitle": "Vtiger_Accounts"
33315   },
33316   {
33317     "type": "delete",
33318     "url": "/api/integrations/vtiger/accounts/{id}",
33319     "title": "Deletes a Vtiger Account",
33320     "examples": [
33321       {
33322         "title": "Example usage:",
33323         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33324         "type": "json"
33325       }
33326     ],
33327     "name": "DeleteVtiger_Accounts",
33328     "group": "Vtiger_Accounts",
33329     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33330     "version": "0.0.0",
33331     "filename": "server/api/intVtigerAccount/index.js",
33332     "groupTitle": "Vtiger_Accounts"
33333   },
33334   {
33335     "type": "get",
33336     "url": "/api/integrations/vtiger/accounts",
33337     "title": "Gets a list of Vtiger Accounts",
33338     "examples": [
33339       {
33340         "title": "Example usage:",
33341         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33342         "type": "json"
33343       }
33344     ],
33345     "name": "GetVtiger_Accounts",
33346     "group": "Vtiger_Accounts",
33347     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33348     "version": "0.0.0",
33349     "filename": "server/api/intVtigerAccount/index.js",
33350     "groupTitle": "Vtiger_Accounts"
33351   },
33352   {
33353     "type": "get",
33354     "url": "/api/integrations/vtiger/accounts/{id}",
33355     "title": "Gets a single Vtiger Account",
33356     "examples": [
33357       {
33358         "title": "Example usage:",
33359         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33360         "type": "json"
33361       }
33362     ],
33363     "name": "ShowVtiger_Accounts",
33364     "group": "Vtiger_Accounts",
33365     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33366     "version": "0.0.0",
33367     "filename": "server/api/intVtigerAccount/index.js",
33368     "groupTitle": "Vtiger_Accounts"
33369   },
33370   {
33371     "type": "post",
33372     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33373     "title": "Creates new configuration",
33374     "examples": [
33375       {
33376         "title": "Example usage:",
33377         "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",
33378         "type": "json"
33379       }
33380     ],
33381     "name": "addConfiguration",
33382     "group": "Vtiger_Accounts",
33383     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33384     "version": "0.0.0",
33385     "filename": "server/api/intVtigerAccount/index.js",
33386     "groupTitle": "Vtiger_Accounts"
33387   },
33388   {
33389     "type": "get",
33390     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33391     "title": "Gets account configurations",
33392     "examples": [
33393       {
33394         "title": "Example usage:",
33395         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33396         "type": "json"
33397       }
33398     ],
33399     "name": "getConfigurations",
33400     "group": "Vtiger_Accounts",
33401     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33402     "version": "0.0.0",
33403     "filename": "server/api/intVtigerAccount/index.js",
33404     "groupTitle": "Vtiger_Accounts"
33405   },
33406   {
33407     "type": "get",
33408     "url": "/api/integrations/vtiger/accounts/{id}/fields",
33409     "title": "Gets account fields",
33410     "examples": [
33411       {
33412         "title": "Example usage:",
33413         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33414         "type": "json"
33415       }
33416     ],
33417     "name": "getFields",
33418     "group": "Vtiger_Accounts",
33419     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33420     "version": "0.0.0",
33421     "filename": "server/api/intVtigerAccount/index.js",
33422     "groupTitle": "Vtiger_Accounts"
33423   },
33424   {
33425     "type": "put",
33426     "url": "/api/integrations/vtiger/accounts/{id}",
33427     "title": "Update an existing Vtiger Account",
33428     "examples": [
33429       {
33430         "title": "Example usage:",
33431         "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",
33432         "type": "json"
33433       }
33434     ],
33435     "name": "updateVtiger_Accounts",
33436     "group": "Vtiger_Accounts",
33437     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33438     "version": "0.0.0",
33439     "filename": "server/api/intVtigerAccount/index.js",
33440     "groupTitle": "Vtiger_Accounts"
33441   },
33442   {
33443     "type": "post",
33444     "url": "/api/integrations/vtiger/configurations",
33445     "title": "Creates a new Vtiger Configuration",
33446     "examples": [
33447       {
33448         "title": "Example usage:",
33449         "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",
33450         "type": "json"
33451       }
33452     ],
33453     "name": "CreateVtiger_Configurations",
33454     "group": "Vtiger_Configurations",
33455     "parameter": {
33456       "fields": {
33457         "Body": [
33458           {
33459             "group": "Body",
33460             "type": "String",
33461             "optional": true,
33462             "field": "name",
33463             "description": ""
33464           },
33465           {
33466             "group": "Body",
33467             "type": "String",
33468             "optional": true,
33469             "field": "description",
33470             "description": ""
33471           }
33472         ]
33473       }
33474     },
33475     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33476     "version": "0.0.0",
33477     "filename": "server/api/intVtigerConfiguration/index.js",
33478     "groupTitle": "Vtiger_Configurations"
33479   },
33480   {
33481     "type": "delete",
33482     "url": "/api/integrations/vtiger/configurations/{id}",
33483     "title": "Deletes a Vtiger Configuration",
33484     "examples": [
33485       {
33486         "title": "Example usage:",
33487         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
33488         "type": "json"
33489       }
33490     ],
33491     "name": "DeleteVtiger_Configurations",
33492     "group": "Vtiger_Configurations",
33493     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33494     "version": "0.0.0",
33495     "filename": "server/api/intVtigerConfiguration/index.js",
33496     "groupTitle": "Vtiger_Configurations"
33497   },
33498   {
33499     "type": "get",
33500     "url": "/api/integrations/vtiger/configurations",
33501     "title": "Gets a list of Vtiger Configurations",
33502     "examples": [
33503       {
33504         "title": "Example usage:",
33505         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
33506         "type": "json"
33507       }
33508     ],
33509     "name": "GetVtiger_Configurations",
33510     "group": "Vtiger_Configurations",
33511     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33512     "version": "0.0.0",
33513     "filename": "server/api/intVtigerConfiguration/index.js",
33514     "groupTitle": "Vtiger_Configurations"
33515   },
33516   {
33517     "type": "get",
33518     "url": "/api/integrations/vtiger/configurations/{id}",
33519     "title": "Gets a single Vtiger Configuration",
33520     "examples": [
33521       {
33522         "title": "Example usage:",
33523         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
33524         "type": "json"
33525       }
33526     ],
33527     "name": "ShowVtiger_Configurations",
33528     "group": "Vtiger_Configurations",
33529     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33530     "version": "0.0.0",
33531     "filename": "server/api/intVtigerConfiguration/index.js",
33532     "groupTitle": "Vtiger_Configurations"
33533   },
33534   {
33535     "type": "get",
33536     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
33537     "title": "Gets configurations descriptions",
33538     "examples": [
33539       {
33540         "title": "Example usage:",
33541         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
33542         "type": "json"
33543       }
33544     ],
33545     "name": "getDescriptions",
33546     "group": "Vtiger_Configurations",
33547     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33548     "version": "0.0.0",
33549     "filename": "server/api/intVtigerConfiguration/index.js",
33550     "groupTitle": "Vtiger_Configurations"
33551   },
33552   {
33553     "type": "get",
33554     "url": "/api/integrations/vtiger/configurations/{id}/fields",
33555     "title": "Gets configurations fields",
33556     "examples": [
33557       {
33558         "title": "Example usage:",
33559         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
33560         "type": "json"
33561       }
33562     ],
33563     "name": "getFields",
33564     "group": "Vtiger_Configurations",
33565     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33566     "version": "0.0.0",
33567     "filename": "server/api/intVtigerConfiguration/index.js",
33568     "groupTitle": "Vtiger_Configurations"
33569   },
33570   {
33571     "type": "get",
33572     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
33573     "title": "Gets configurations subjects",
33574     "examples": [
33575       {
33576         "title": "Example usage:",
33577         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
33578         "type": "json"
33579       }
33580     ],
33581     "name": "getSubjects",
33582     "group": "Vtiger_Configurations",
33583     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33584     "version": "0.0.0",
33585     "filename": "server/api/intVtigerConfiguration/index.js",
33586     "groupTitle": "Vtiger_Configurations"
33587   },
33588   {
33589     "type": "put",
33590     "url": "/api/integrations/vtiger/configurations/{id}",
33591     "title": "Update an existing Vtiger Configuration",
33592     "examples": [
33593       {
33594         "title": "Example usage:",
33595         "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",
33596         "type": "json"
33597       }
33598     ],
33599     "name": "updateVtiger_Configurations",
33600     "group": "Vtiger_Configurations",
33601     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33602     "version": "0.0.0",
33603     "filename": "server/api/intVtigerConfiguration/index.js",
33604     "groupTitle": "Vtiger_Configurations"
33605   },
33606   {
33607     "type": "post",
33608     "url": "/api/integrations/vtiger/fields",
33609     "title": "Creates a new Vtiger Field",
33610     "examples": [
33611       {
33612         "title": "Example usage:",
33613         "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",
33614         "type": "json"
33615       }
33616     ],
33617     "name": "CreateVtiger_Fields",
33618     "group": "Vtiger_Fields",
33619     "parameter": {
33620       "fields": {
33621         "Body": [
33622           {
33623             "group": "Body",
33624             "type": "String",
33625             "allowedValues": [
33626               "\"string\"",
33627               "\"variable\"",
33628               "\"customVariable\"",
33629               "\"keyValue\""
33630             ],
33631             "optional": true,
33632             "field": "type",
33633             "description": ""
33634           },
33635           {
33636             "group": "Body",
33637             "type": "String",
33638             "optional": true,
33639             "field": "content",
33640             "description": ""
33641           },
33642           {
33643             "group": "Body",
33644             "type": "String",
33645             "optional": true,
33646             "field": "key",
33647             "description": ""
33648           },
33649           {
33650             "group": "Body",
33651             "type": "String",
33652             "allowedValues": [
33653               "\"string\"",
33654               "\"variable\"",
33655               "\"customVariable\""
33656             ],
33657             "optional": true,
33658             "field": "keyType",
33659             "description": ""
33660           },
33661           {
33662             "group": "Body",
33663             "type": "String",
33664             "optional": true,
33665             "field": "keyContent",
33666             "description": ""
33667           },
33668           {
33669             "group": "Body",
33670             "type": "String",
33671             "optional": true,
33672             "field": "idField",
33673             "description": ""
33674           },
33675           {
33676             "group": "Body",
33677             "type": "String",
33678             "optional": true,
33679             "field": "nameField",
33680             "description": ""
33681           },
33682           {
33683             "group": "Body",
33684             "type": "Boolean",
33685             "optional": true,
33686             "field": "customField",
33687             "description": ""
33688           },
33689           {
33690             "group": "Body",
33691             "type": "String",
33692             "optional": true,
33693             "field": "variableName",
33694             "description": ""
33695           }
33696         ]
33697       }
33698     },
33699     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33700     "version": "0.0.0",
33701     "filename": "server/api/intVtigerField/index.js",
33702     "groupTitle": "Vtiger_Fields"
33703   },
33704   {
33705     "type": "delete",
33706     "url": "/api/integrations/vtiger/fields/{id}",
33707     "title": "Deletes a Vtiger Field",
33708     "examples": [
33709       {
33710         "title": "Example usage:",
33711         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
33712         "type": "json"
33713       }
33714     ],
33715     "name": "DeleteVtiger_Fields",
33716     "group": "Vtiger_Fields",
33717     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33718     "version": "0.0.0",
33719     "filename": "server/api/intVtigerField/index.js",
33720     "groupTitle": "Vtiger_Fields"
33721   },
33722   {
33723     "type": "get",
33724     "url": "/api/integrations/vtiger/fields",
33725     "title": "Gets a list of Vtiger Fields",
33726     "examples": [
33727       {
33728         "title": "Example usage:",
33729         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
33730         "type": "json"
33731       }
33732     ],
33733     "name": "GetVtiger_Fields",
33734     "group": "Vtiger_Fields",
33735     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33736     "version": "0.0.0",
33737     "filename": "server/api/intVtigerField/index.js",
33738     "groupTitle": "Vtiger_Fields"
33739   },
33740   {
33741     "type": "get",
33742     "url": "/api/integrations/vtiger/fields/{id}",
33743     "title": "Gets a single Vtiger Field",
33744     "examples": [
33745       {
33746         "title": "Example usage:",
33747         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
33748         "type": "json"
33749       }
33750     ],
33751     "name": "ShowVtiger_Fields",
33752     "group": "Vtiger_Fields",
33753     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33754     "version": "0.0.0",
33755     "filename": "server/api/intVtigerField/index.js",
33756     "groupTitle": "Vtiger_Fields"
33757   },
33758   {
33759     "type": "put",
33760     "url": "/api/integrations/vtiger/fields/{id}",
33761     "title": "Update an existing Vtiger Field",
33762     "examples": [
33763       {
33764         "title": "Example usage:",
33765         "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",
33766         "type": "json"
33767       }
33768     ],
33769     "name": "updateVtiger_Fields",
33770     "group": "Vtiger_Fields",
33771     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33772     "version": "0.0.0",
33773     "filename": "server/api/intVtigerField/index.js",
33774     "groupTitle": "Vtiger_Fields"
33775   },
33776   {
33777     "type": "post",
33778     "url": "/api/webbar/answer",
33779     "title": "answer webrtc call",
33780     "examples": [
33781       {
33782         "title": "Example usage:",
33783         "content": "curl https://{domain}/api/webbar/answer -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33784         "type": "json"
33785       }
33786     ],
33787     "name": "Web_Bar_answer",
33788     "group": "WebBar",
33789     "parameter": {
33790       "fields": {
33791         "Body": [
33792           {
33793             "group": "Body",
33794             "type": "String",
33795             "optional": false,
33796             "field": "sessionId",
33797             "description": ""
33798           },
33799           {
33800             "group": "Body",
33801             "type": "number",
33802             "optional": false,
33803             "field": "userId",
33804             "description": ""
33805           }
33806         ]
33807       }
33808     },
33809     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33810     "version": "0.0.0",
33811     "filename": "server/api/webbar/index.js",
33812     "groupTitle": "WebBar"
33813   },
33814   {
33815     "type": "post",
33816     "url": "/api/webbar/calls",
33817     "title": "webrtc call list",
33818     "examples": [
33819       {
33820         "title": "Example usage:",
33821         "content": "curl https://{domain}/api/webbar/calls -d '{\"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33822         "type": "json"
33823       }
33824     ],
33825     "name": "Web_Bar_calls",
33826     "group": "WebBar",
33827     "parameter": {
33828       "fields": {
33829         "Body": [
33830           {
33831             "group": "Body",
33832             "type": "number",
33833             "optional": false,
33834             "field": "userId",
33835             "description": ""
33836           }
33837         ]
33838       }
33839     },
33840     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33841     "version": "0.0.0",
33842     "filename": "server/api/webbar/index.js",
33843     "groupTitle": "WebBar"
33844   },
33845   {
33846     "type": "post",
33847     "url": "/api/webbar/hangup",
33848     "title": "hangup webrtc call",
33849     "examples": [
33850       {
33851         "title": "Example usage:",
33852         "content": "curl https://{domain}/api/webbar/hangup -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33853         "type": "json"
33854       }
33855     ],
33856     "name": "Web_Bar_hangup",
33857     "group": "WebBar",
33858     "parameter": {
33859       "fields": {
33860         "Body": [
33861           {
33862             "group": "Body",
33863             "type": "String",
33864             "optional": false,
33865             "field": "sessionId",
33866             "description": ""
33867           },
33868           {
33869             "group": "Body",
33870             "type": "number",
33871             "optional": false,
33872             "field": "userId",
33873             "description": ""
33874           }
33875         ]
33876       }
33877     },
33878     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33879     "version": "0.0.0",
33880     "filename": "server/api/webbar/index.js",
33881     "groupTitle": "WebBar"
33882   },
33883   {
33884     "type": "post",
33885     "url": "/api/webbar/unhold",
33886     "title": "unhold webrtc call",
33887     "examples": [
33888       {
33889         "title": "Example usage:",
33890         "content": "curl https://{domain}/api/webbar/unhold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33891         "type": "json"
33892       }
33893     ],
33894     "name": "Web_Bar_hold",
33895     "group": "WebBar",
33896     "parameter": {
33897       "fields": {
33898         "Body": [
33899           {
33900             "group": "Body",
33901             "type": "String",
33902             "optional": false,
33903             "field": "sessionId",
33904             "description": ""
33905           },
33906           {
33907             "group": "Body",
33908             "type": "number",
33909             "optional": false,
33910             "field": "userId",
33911             "description": ""
33912           }
33913         ]
33914       }
33915     },
33916     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33917     "version": "0.0.0",
33918     "filename": "server/api/webbar/index.js",
33919     "groupTitle": "WebBar"
33920   },
33921   {
33922     "type": "post",
33923     "url": "/api/webbar/hold",
33924     "title": "hold webrtc call",
33925     "examples": [
33926       {
33927         "title": "Example usage:",
33928         "content": "curl https://{domain}/api/webbar/hold -d '{\"sessionId\": \"<sessionId>\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33929         "type": "json"
33930       }
33931     ],
33932     "name": "Web_Bar_hold",
33933     "group": "WebBar",
33934     "parameter": {
33935       "fields": {
33936         "Body": [
33937           {
33938             "group": "Body",
33939             "type": "String",
33940             "optional": true,
33941             "field": "sessionId",
33942             "description": ""
33943           },
33944           {
33945             "group": "Body",
33946             "type": "number",
33947             "optional": false,
33948             "field": "userId",
33949             "description": ""
33950           }
33951         ]
33952       }
33953     },
33954     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33955     "version": "0.0.0",
33956     "filename": "server/api/webbar/index.js",
33957     "groupTitle": "WebBar"
33958   },
33959   {
33960     "type": "post",
33961     "url": "/api/webbar/originate",
33962     "title": "Originate new webrtc call",
33963     "examples": [
33964       {
33965         "title": "Example usage:",
33966         "content": "curl https://{domain}/api/webbar/originate -d '{\"callNumber\": \"0119692844\", \"userId\": 54}' \\\n -H \"Content-Type: application/json\" -X POST",
33967         "type": "json"
33968       }
33969     ],
33970     "name": "Web_Bar_originate",
33971     "group": "WebBar",
33972     "parameter": {
33973       "fields": {
33974         "Body": [
33975           {
33976             "group": "Body",
33977             "type": "String",
33978             "optional": false,
33979             "field": "callNumber",
33980             "description": ""
33981           },
33982           {
33983             "group": "Body",
33984             "type": "number",
33985             "optional": false,
33986             "field": "userId",
33987             "description": ""
33988           },
33989           {
33990             "group": "Body",
33991             "type": "String",
33992             "optional": false,
33993             "field": "callerId",
33994             "description": ""
33995           },
33996           {
33997             "group": "Body",
33998             "type": "String",
33999             "optional": false,
34000             "field": "callbackUrl",
34001             "description": ""
34002           }
34003         ]
34004       }
34005     },
34006     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34007     "version": "0.0.0",
34008     "filename": "server/api/webbar/index.js",
34009     "groupTitle": "WebBar"
34010   },
34011   {
34012     "type": "post",
34013     "url": "/api/webbar/transfer",
34014     "title": "blind transfer webrtc call",
34015     "examples": [
34016       {
34017         "title": "Example usage:",
34018         "content": "curl https://{domain}/api/webbar/transfer -d '{\"userId\": 54, \"sessionId\":\"<sessionId>\", \"transferNumber\":\"<transferNumber>\"}' \\\n -H \"Content-Type: application/json\" -X POST",
34019         "type": "json"
34020       }
34021     ],
34022     "name": "Web_Bar_transfer",
34023     "group": "WebBar",
34024     "parameter": {
34025       "fields": {
34026         "Body": [
34027           {
34028             "group": "Body",
34029             "type": "number",
34030             "optional": false,
34031             "field": "userId",
34032             "description": ""
34033           },
34034           {
34035             "group": "Body",
34036             "type": "string",
34037             "optional": false,
34038             "field": "sessionId",
34039             "description": ""
34040           },
34041           {
34042             "group": "Body",
34043             "type": "string",
34044             "optional": false,
34045             "field": "transferNumber",
34046             "description": ""
34047           }
34048         ]
34049       }
34050     },
34051     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34052     "version": "0.0.0",
34053     "filename": "server/api/webbar/index.js",
34054     "groupTitle": "WebBar"
34055   },
34056   {
34057     "type": "post",
34058     "url": "/api/whatsapp/accounts/{id}/users",
34059     "title": "Add agents to a whatsapp account",
34060     "examples": [
34061       {
34062         "title": "Example usage:",
34063         "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",
34064         "type": "json"
34065       }
34066     ],
34067     "name": "AddAgents",
34068     "group": "Whatsapp_Accounts",
34069     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34070     "version": "0.0.0",
34071     "filename": "server/api/whatsappAccount/index.js",
34072     "groupTitle": "Whatsapp_Accounts"
34073   },
34074   {
34075     "type": "post",
34076     "url": "/api/whatsapp/accounts",
34077     "title": "Creates a new Account",
34078     "examples": [
34079       {
34080         "title": "Example usage:",
34081         "content": "curl https://{domain}/api/whatsapp/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34082         "type": "json"
34083       }
34084     ],
34085     "name": "CreateAccounts",
34086     "group": "Whatsapp_Accounts",
34087     "parameter": {
34088       "fields": {
34089         "Body": [
34090           {
34091             "group": "Body",
34092             "type": "String",
34093             "optional": false,
34094             "field": "name",
34095             "description": ""
34096           },
34097           {
34098             "group": "Body",
34099             "type": "String",
34100             "optional": false,
34101             "field": "key",
34102             "description": ""
34103           },
34104           {
34105             "group": "Body",
34106             "type": "String",
34107             "optional": false,
34108             "field": "remote",
34109             "description": ""
34110           },
34111           {
34112             "group": "Body",
34113             "type": "String",
34114             "optional": true,
34115             "field": "token",
34116             "description": ""
34117           },
34118           {
34119             "group": "Body",
34120             "type": "String",
34121             "optional": true,
34122             "field": "phone",
34123             "description": ""
34124           },
34125           {
34126             "group": "Body",
34127             "type": "String",
34128             "allowedValues": [
34129               "\"twilio\""
34130             ],
34131             "optional": true,
34132             "field": "type",
34133             "description": ""
34134           },
34135           {
34136             "group": "Body",
34137             "type": "String",
34138             "optional": true,
34139             "field": "accountSid",
34140             "description": ""
34141           },
34142           {
34143             "group": "Body",
34144             "type": "String",
34145             "optional": true,
34146             "field": "authToken",
34147             "description": ""
34148           },
34149           {
34150             "group": "Body",
34151             "type": "Text",
34152             "optional": true,
34153             "field": "notificationTemplate",
34154             "description": ""
34155           },
34156           {
34157             "group": "Body",
34158             "type": "Boolean",
34159             "optional": true,
34160             "field": "notificationSound",
34161             "description": ""
34162           },
34163           {
34164             "group": "Body",
34165             "type": "Boolean",
34166             "optional": true,
34167             "field": "notificationShake",
34168             "description": ""
34169           },
34170           {
34171             "group": "Body",
34172             "type": "Integer",
34173             "optional": true,
34174             "field": "waitForTheAssignedAgent",
34175             "description": ""
34176           },
34177           {
34178             "group": "Body",
34179             "type": "Boolean",
34180             "optional": true,
34181             "field": "queueTransfer",
34182             "description": ""
34183           },
34184           {
34185             "group": "Body",
34186             "type": "Integer",
34187             "optional": true,
34188             "field": "queueTransferTimeout",
34189             "description": ""
34190           },
34191           {
34192             "group": "Body",
34193             "type": "Boolean",
34194             "optional": true,
34195             "field": "agentTransfer",
34196             "description": ""
34197           },
34198           {
34199             "group": "Body",
34200             "type": "Integer",
34201             "optional": true,
34202             "field": "agentTransferTimeout",
34203             "description": ""
34204           },
34205           {
34206             "group": "Body",
34207             "type": "Integer",
34208             "optional": true,
34209             "field": "mandatoryDispositionPauseId",
34210             "description": "<p>Status to put when mandatory disposition is enabled</p>"
34211           },
34212           {
34213             "group": "Body",
34214             "type": "Boolean",
34215             "optional": true,
34216             "field": "mandatoryDisposition",
34217             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
34218           },
34219           {
34220             "group": "Body",
34221             "type": "String",
34222             "optional": true,
34223             "field": "description",
34224             "description": ""
34225           }
34226         ]
34227       }
34228     },
34229     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34230     "version": "0.0.0",
34231     "filename": "server/api/whatsappAccount/index.js",
34232     "groupTitle": "Whatsapp_Accounts"
34233   },
34234   {
34235     "type": "delete",
34236     "url": "/api/whatsapp/accounts/{id}",
34237     "title": "Deletes a Account",
34238     "examples": [
34239       {
34240         "title": "Example usage:",
34241         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password} -X DELETE",
34242         "type": "json"
34243       }
34244     ],
34245     "name": "DeleteAccounts",
34246     "group": "Whatsapp_Accounts",
34247     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34248     "version": "0.0.0",
34249     "filename": "server/api/whatsappAccount/index.js",
34250     "groupTitle": "Whatsapp_Accounts"
34251   },
34252   {
34253     "type": "get",
34254     "url": "/api/whatsapp/accounts/describe",
34255     "title": "Gets table info about Accounts",
34256     "examples": [
34257       {
34258         "title": "Example usage:",
34259         "content": "curl https://{domain}/api/whatsapp/accounts/describe -v -u {name}:{password}",
34260         "type": "json"
34261       }
34262     ],
34263     "name": "DescribeAccounts",
34264     "group": "Whatsapp_Accounts",
34265     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34266     "version": "0.0.0",
34267     "filename": "server/api/whatsappAccount/index.js",
34268     "groupTitle": "Whatsapp_Accounts"
34269   },
34270   {
34271     "type": "get",
34272     "url": "/api/whatsapp/accounts",
34273     "title": "Gets a list of Accounts",
34274     "examples": [
34275       {
34276         "title": "Example usage:",
34277         "content": "curl https://{domain}/api/whatsapp/accounts -v -u {name}:{password}",
34278         "type": "json"
34279       }
34280     ],
34281     "name": "GetAccounts",
34282     "group": "Whatsapp_Accounts",
34283     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34284     "version": "0.0.0",
34285     "filename": "server/api/whatsappAccount/index.js",
34286     "groupTitle": "Whatsapp_Accounts"
34287   },
34288   {
34289     "type": "get",
34290     "url": "/api/whatsapp/accounts/{id}/users",
34291     "title": "Gets agents from whatsapp account",
34292     "examples": [
34293       {
34294         "title": "Example usage:",
34295         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users -v -u {name}:{password} -X GET",
34296         "type": "json"
34297       }
34298     ],
34299     "name": "GetAgents",
34300     "group": "Whatsapp_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/whatsappAccount/index.js",
34304     "groupTitle": "Whatsapp_Accounts"
34305   },
34306   {
34307     "type": "delete",
34308     "url": "/api/whatsapp/accounts/{id}/users",
34309     "title": "Removes agents from a whatsapp account",
34310     "examples": [
34311       {
34312         "title": "Example usage:",
34313         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34314         "type": "json"
34315       }
34316     ],
34317     "name": "RemoveAgents",
34318     "group": "Whatsapp_Accounts",
34319     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/whatsappAccount/index.js",
34322     "groupTitle": "Whatsapp_Accounts"
34323   },
34324   {
34325     "type": "delete",
34326     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34327     "title": "Removes canned answers from account",
34328     "examples": [
34329       {
34330         "title": "Example usage:",
34331         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34332         "type": "json"
34333       }
34334     ],
34335     "name": "RemoveAnswers",
34336     "group": "Whatsapp_Accounts",
34337     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/whatsappAccount/index.js",
34340     "groupTitle": "Whatsapp_Accounts"
34341   },
34342   {
34343     "type": "delete",
34344     "url": "/api/whatsapp/accounts/{id}/dispositions",
34345     "title": "Removes dispositions from account",
34346     "examples": [
34347       {
34348         "title": "Example usage:",
34349         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
34350         "type": "json"
34351       }
34352     ],
34353     "name": "RemoveDispositions",
34354     "group": "Whatsapp_Accounts",
34355     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34356     "version": "0.0.0",
34357     "filename": "server/api/whatsappAccount/index.js",
34358     "groupTitle": "Whatsapp_Accounts"
34359   },
34360   {
34361     "type": "get",
34362     "url": "/api/whatsapp/accounts/{id}",
34363     "title": "Gets a single Account",
34364     "examples": [
34365       {
34366         "title": "Example usage:",
34367         "content": "curl https://{domain}/api/whatsapp/accounts/{id} -v -u {name}:{password}",
34368         "type": "json"
34369       }
34370     ],
34371     "name": "ShowAccounts",
34372     "group": "Whatsapp_Accounts",
34373     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34374     "version": "0.0.0",
34375     "filename": "server/api/whatsappAccount/index.js",
34376     "groupTitle": "Whatsapp_Accounts"
34377   },
34378   {
34379     "type": "put",
34380     "url": "/api/whatsapp/messages/{id}/accept",
34381     "title": "Accepts message",
34382     "examples": [
34383       {
34384         "title": "Example usage:",
34385         "content": "curl https://{domain}/api/whatsapp/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34386         "type": "json"
34387       }
34388     ],
34389     "name": "acceptMessage",
34390     "group": "Whatsapp_Accounts",
34391     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34392     "version": "0.0.0",
34393     "filename": "server/api/whatsappMessage/index.js",
34394     "groupTitle": "Whatsapp_Accounts"
34395   },
34396   {
34397     "type": "post",
34398     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34399     "title": "Creates new canned answer",
34400     "examples": [
34401       {
34402         "title": "Example usage:",
34403         "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",
34404         "type": "json"
34405       }
34406     ],
34407     "name": "addAnswer",
34408     "group": "Whatsapp_Accounts",
34409     "parameter": {
34410       "fields": {
34411         "Body": [
34412           {
34413             "group": "Body",
34414             "type": "String",
34415             "optional": false,
34416             "field": "key",
34417             "description": ""
34418           },
34419           {
34420             "group": "Body",
34421             "type": "Text",
34422             "optional": false,
34423             "field": "value",
34424             "description": ""
34425           },
34426           {
34427             "group": "Body",
34428             "type": "String",
34429             "optional": true,
34430             "field": "description",
34431             "description": ""
34432           },
34433           {
34434             "group": "Body",
34435             "type": "Virtual",
34436             "optional": true,
34437             "field": "name",
34438             "description": ""
34439           }
34440         ]
34441       }
34442     },
34443     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34444     "version": "0.0.0",
34445     "filename": "server/api/whatsappAccount/index.js",
34446     "groupTitle": "Whatsapp_Accounts"
34447   },
34448   {
34449     "type": "post",
34450     "url": "/api/whatsapp/accounts/{id}/applications",
34451     "title": "Creates new applications",
34452     "examples": [
34453       {
34454         "title": "Example usage:",
34455         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34456         "type": "json"
34457       }
34458     ],
34459     "name": "addApplications",
34460     "group": "Whatsapp_Accounts",
34461     "parameter": {
34462       "fields": {
34463         "Body": [
34464           {
34465             "group": "Body",
34466             "type": "Integer",
34467             "optional": false,
34468             "field": "priority",
34469             "description": ""
34470           },
34471           {
34472             "group": "Body",
34473             "type": "String",
34474             "optional": false,
34475             "field": "app",
34476             "description": ""
34477           },
34478           {
34479             "group": "Body",
34480             "type": "Text",
34481             "optional": true,
34482             "field": "appdata",
34483             "description": ""
34484           },
34485           {
34486             "group": "Body",
34487             "type": "String",
34488             "optional": true,
34489             "field": "description",
34490             "description": ""
34491           },
34492           {
34493             "group": "Body",
34494             "type": "String",
34495             "optional": true,
34496             "field": "interval",
34497             "description": ""
34498           }
34499         ]
34500       }
34501     },
34502     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34503     "version": "0.0.0",
34504     "filename": "server/api/whatsappAccount/index.js",
34505     "groupTitle": "Whatsapp_Accounts"
34506   },
34507   {
34508     "type": "post",
34509     "url": "/api/whatsapp/accounts/{id}/dispositions",
34510     "title": "Creates new disposition",
34511     "examples": [
34512       {
34513         "title": "Example usage:",
34514         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
34515         "type": "json"
34516       }
34517     ],
34518     "name": "addDisposition",
34519     "group": "Whatsapp_Accounts",
34520     "parameter": {
34521       "fields": {
34522         "Body": [
34523           {
34524             "group": "Body",
34525             "type": "String",
34526             "optional": false,
34527             "field": "name",
34528             "description": ""
34529           },
34530           {
34531             "group": "Body",
34532             "type": "String",
34533             "allowedValues": [
34534               "\"first\"",
34535               "\"second\"",
34536               "\"third\""
34537             ],
34538             "optional": false,
34539             "field": "level",
34540             "description": ""
34541           },
34542           {
34543             "group": "Body",
34544             "type": "String",
34545             "optional": true,
34546             "field": "description",
34547             "description": ""
34548           }
34549         ]
34550       }
34551     },
34552     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34553     "version": "0.0.0",
34554     "filename": "server/api/whatsappAccount/index.js",
34555     "groupTitle": "Whatsapp_Accounts"
34556   },
34557   {
34558     "type": "get",
34559     "url": "/api/whatsapp/accounts/{id}/canned_answers",
34560     "title": "Gets account canned answers",
34561     "examples": [
34562       {
34563         "title": "Example usage:",
34564         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
34565         "type": "json"
34566       }
34567     ],
34568     "name": "getAnswers",
34569     "group": "Whatsapp_Accounts",
34570     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34571     "version": "0.0.0",
34572     "filename": "server/api/whatsappAccount/index.js",
34573     "groupTitle": "Whatsapp_Accounts"
34574   },
34575   {
34576     "type": "get",
34577     "url": "/api/whatsapp/accounts/{id}/applications",
34578     "title": "Gets account applications",
34579     "examples": [
34580       {
34581         "title": "Example usage:",
34582         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/applications -v -u {name}:{password} -X GET",
34583         "type": "json"
34584       }
34585     ],
34586     "name": "getApplications",
34587     "group": "Whatsapp_Accounts",
34588     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34589     "version": "0.0.0",
34590     "filename": "server/api/whatsappAccount/index.js",
34591     "groupTitle": "Whatsapp_Accounts"
34592   },
34593   {
34594     "type": "get",
34595     "url": "/api/whatsapp/accounts/{id}/dispositions",
34596     "title": "Gets account dispositions",
34597     "examples": [
34598       {
34599         "title": "Example usage:",
34600         "content": "curl https://{domain}/api/whatsapp/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
34601         "type": "json"
34602       }
34603     ],
34604     "name": "getDispositions",
34605     "group": "Whatsapp_Accounts",
34606     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34607     "version": "0.0.0",
34608     "filename": "server/api/whatsappAccount/index.js",
34609     "groupTitle": "Whatsapp_Accounts"
34610   },
34611   {
34612     "type": "post",
34613     "url": "/api/whatsapp/accounts/{id}/notify",
34614     "title": "Notify new message",
34615     "examples": [
34616       {
34617         "title": "Example usage:",
34618         "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",
34619         "type": "json"
34620       }
34621     ],
34622     "name": "notify",
34623     "group": "Whatsapp_Accounts",
34624     "description": "<p>Motion 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>",
34625     "version": "0.0.0",
34626     "filename": "server/api/whatsappAccount/index.js",
34627     "groupTitle": "Whatsapp_Accounts"
34628   },
34629   {
34630     "type": "put",
34631     "url": "/api/whatsapp/messages/{id}/reject",
34632     "title": "Rejects message",
34633     "examples": [
34634       {
34635         "title": "Example usage:",
34636         "content": "curl https://{domain}/api/whatsapp/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
34637         "type": "json"
34638       }
34639     ],
34640     "name": "rejectMessage",
34641     "group": "Whatsapp_Accounts",
34642     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34643     "version": "0.0.0",
34644     "filename": "server/api/whatsappMessage/index.js",
34645     "groupTitle": "Whatsapp_Accounts"
34646   },
34647   {
34648     "type": "post",
34649     "url": "/api/whatsapp/accounts/{id}/send",
34650     "title": "Send new whatsapp message",
34651     "examples": [
34652       {
34653         "title": "Example usage:",
34654         "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",
34655         "type": "json"
34656       }
34657     ],
34658     "name": "sendWhatsapp",
34659     "group": "Whatsapp_Accounts",
34660     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34661     "version": "0.0.0",
34662     "filename": "server/api/whatsappAccount/index.js",
34663     "groupTitle": "Whatsapp_Accounts"
34664   },
34665   {
34666     "type": "post",
34667     "url": "/api/whatsapp/messages/{id}/status",
34668     "title": "Receive message status",
34669     "examples": [
34670       {
34671         "title": "Example usage:",
34672         "content": "curl https://{domain}/api/whatsapp/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
34673         "type": "json"
34674       }
34675     ],
34676     "name": "statusMessage",
34677     "group": "Whatsapp_Accounts",
34678     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34679     "version": "0.0.0",
34680     "filename": "server/api/whatsappMessage/index.js",
34681     "groupTitle": "Whatsapp_Accounts"
34682   },
34683   {
34684     "type": "put",
34685     "url": "/api/whatsapp/accounts/{id}",
34686     "title": "Update an existing Account",
34687     "examples": [
34688       {
34689         "title": "Example usage:",
34690         "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",
34691         "type": "json"
34692       }
34693     ],
34694     "name": "updateAccounts",
34695     "group": "Whatsapp_Accounts",
34696     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34697     "version": "0.0.0",
34698     "filename": "server/api/whatsappAccount/index.js",
34699     "groupTitle": "Whatsapp_Accounts"
34700   },
34701   {
34702     "type": "post",
34703     "url": "/api/whatsapp/applications",
34704     "title": "Creates a new Application",
34705     "examples": [
34706       {
34707         "title": "Example usage:",
34708         "content": "curl https://{domain}/api/whatsapp/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34709         "type": "json"
34710       }
34711     ],
34712     "name": "CreateApplications",
34713     "group": "Whatsapp_Applications",
34714     "parameter": {
34715       "fields": {
34716         "Body": [
34717           {
34718             "group": "Body",
34719             "type": "Integer",
34720             "optional": false,
34721             "field": "priority",
34722             "description": ""
34723           },
34724           {
34725             "group": "Body",
34726             "type": "String",
34727             "optional": false,
34728             "field": "app",
34729             "description": ""
34730           },
34731           {
34732             "group": "Body",
34733             "type": "Text",
34734             "optional": true,
34735             "field": "appdata",
34736             "description": ""
34737           },
34738           {
34739             "group": "Body",
34740             "type": "String",
34741             "optional": true,
34742             "field": "description",
34743             "description": ""
34744           },
34745           {
34746             "group": "Body",
34747             "type": "String",
34748             "optional": true,
34749             "field": "interval",
34750             "description": ""
34751           }
34752         ]
34753       }
34754     },
34755     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34756     "version": "0.0.0",
34757     "filename": "server/api/whatsappApplication/index.js",
34758     "groupTitle": "Whatsapp_Applications"
34759   },
34760   {
34761     "type": "delete",
34762     "url": "/api/whatsapp/applications/{id}",
34763     "title": "Deletes a Application",
34764     "examples": [
34765       {
34766         "title": "Example usage:",
34767         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password} -X DELETE",
34768         "type": "json"
34769       }
34770     ],
34771     "name": "DeleteApplications",
34772     "group": "Whatsapp_Applications",
34773     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34774     "version": "0.0.0",
34775     "filename": "server/api/whatsappApplication/index.js",
34776     "groupTitle": "Whatsapp_Applications"
34777   },
34778   {
34779     "type": "get",
34780     "url": "/api/whatsapp/applications",
34781     "title": "Gets a list of Applications",
34782     "examples": [
34783       {
34784         "title": "Example usage:",
34785         "content": "curl https://{domain}/api/whatsapp/applications -v -u {name}:{password}",
34786         "type": "json"
34787       }
34788     ],
34789     "name": "GetApplications",
34790     "group": "Whatsapp_Applications",
34791     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34792     "version": "0.0.0",
34793     "filename": "server/api/whatsappApplication/index.js",
34794     "groupTitle": "Whatsapp_Applications"
34795   },
34796   {
34797     "type": "get",
34798     "url": "/api/whatsapp/applications/{id}",
34799     "title": "Gets a single Application",
34800     "examples": [
34801       {
34802         "title": "Example usage:",
34803         "content": "curl https://{domain}/api/whatsapp/applications/{id} -v -u {name}:{password}",
34804         "type": "json"
34805       }
34806     ],
34807     "name": "ShowApplications",
34808     "group": "Whatsapp_Applications",
34809     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34810     "version": "0.0.0",
34811     "filename": "server/api/whatsappApplication/index.js",
34812     "groupTitle": "Whatsapp_Applications"
34813   },
34814   {
34815     "type": "put",
34816     "url": "/api/whatsapp/applications/{id}",
34817     "title": "Update an existing Application",
34818     "examples": [
34819       {
34820         "title": "Example usage:",
34821         "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",
34822         "type": "json"
34823       }
34824     ],
34825     "name": "updateApplications",
34826     "group": "Whatsapp_Applications",
34827     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34828     "version": "0.0.0",
34829     "filename": "server/api/whatsappApplication/index.js",
34830     "groupTitle": "Whatsapp_Applications"
34831   },
34832   {
34833     "type": "post",
34834     "url": "/api/whatsapp/interactions/{id}/tags",
34835     "title": "Add tags to the interaction",
34836     "examples": [
34837       {
34838         "title": "Example usage:",
34839         "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",
34840         "type": "json"
34841       }
34842     ],
34843     "name": "AddTags",
34844     "group": "Whatsapp_Interactions",
34845     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34846     "version": "0.0.0",
34847     "filename": "server/api/whatsappInteraction/index.js",
34848     "groupTitle": "Whatsapp_Interactions"
34849   },
34850   {
34851     "type": "post",
34852     "url": "/api/whatsapp/interactions",
34853     "title": "Creates a new Interaction",
34854     "examples": [
34855       {
34856         "title": "Example usage:",
34857         "content": "curl https://{domain}/api/whatsapp/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
34858         "type": "json"
34859       }
34860     ],
34861     "name": "CreateInteractions",
34862     "group": "Whatsapp_Interactions",
34863     "parameter": {
34864       "fields": {
34865         "Body": [
34866           {
34867             "group": "Body",
34868             "type": "Boolean",
34869             "optional": true,
34870             "field": "closed",
34871             "description": ""
34872           },
34873           {
34874             "group": "Body",
34875             "type": "String",
34876             "optional": true,
34877             "field": "closedAt",
34878             "description": ""
34879           },
34880           {
34881             "group": "Body",
34882             "type": "String",
34883             "optional": true,
34884             "field": "disposition",
34885             "description": ""
34886           },
34887           {
34888             "group": "Body",
34889             "type": "String",
34890             "optional": true,
34891             "field": "secondDisposition",
34892             "description": ""
34893           },
34894           {
34895             "group": "Body",
34896             "type": "String",
34897             "optional": true,
34898             "field": "thirdDisposition",
34899             "description": ""
34900           },
34901           {
34902             "group": "Body",
34903             "type": "String",
34904             "optional": true,
34905             "field": "note",
34906             "description": ""
34907           },
34908           {
34909             "group": "Body",
34910             "type": "String",
34911             "optional": true,
34912             "field": "phone",
34913             "description": ""
34914           },
34915           {
34916             "group": "Body",
34917             "type": "String",
34918             "optional": true,
34919             "field": "read1stAt",
34920             "description": ""
34921           },
34922           {
34923             "group": "Body",
34924             "type": "String",
34925             "allowedValues": [
34926               "\"in\"",
34927               "\"out\""
34928             ],
34929             "optional": false,
34930             "field": "firstMsgDirection",
34931             "description": ""
34932           },
34933           {
34934             "group": "Body",
34935             "type": "String",
34936             "optional": true,
34937             "field": "lastMsgAt",
34938             "description": ""
34939           },
34940           {
34941             "group": "Body",
34942             "type": "String",
34943             "allowedValues": [
34944               "\"in\"",
34945               "\"out\""
34946             ],
34947             "optional": false,
34948             "field": "lastMsgDirection",
34949             "description": ""
34950           }
34951         ]
34952       }
34953     },
34954     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34955     "version": "0.0.0",
34956     "filename": "server/api/whatsappInteraction/index.js",
34957     "groupTitle": "Whatsapp_Interactions"
34958   },
34959   {
34960     "type": "delete",
34961     "url": "/api/whatsapp/interactions/{id}",
34962     "title": "Deletes a Interaction",
34963     "examples": [
34964       {
34965         "title": "Example usage:",
34966         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password} -X DELETE",
34967         "type": "json"
34968       }
34969     ],
34970     "name": "DeleteInteractions",
34971     "group": "Whatsapp_Interactions",
34972     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34973     "version": "0.0.0",
34974     "filename": "server/api/whatsappInteraction/index.js",
34975     "groupTitle": "Whatsapp_Interactions"
34976   },
34977   {
34978     "type": "get",
34979     "url": "/api/whatsapp/interactions/describe",
34980     "title": "Gets table info about Interactions",
34981     "examples": [
34982       {
34983         "title": "Example usage:",
34984         "content": "curl https://{domain}/api/whatsapp/interactions/describe -v -u {name}:{password}",
34985         "type": "json"
34986       }
34987     ],
34988     "name": "DescribeInteractions",
34989     "group": "Whatsapp_Interactions",
34990     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34991     "version": "0.0.0",
34992     "filename": "server/api/whatsappInteraction/index.js",
34993     "groupTitle": "Whatsapp_Interactions"
34994   },
34995   {
34996     "type": "get",
34997     "url": "/api/whatsapp/interactions",
34998     "title": "Gets a list of Interactions",
34999     "examples": [
35000       {
35001         "title": "Example usage:",
35002         "content": "curl https://{domain}/api/whatsapp/interactions -v -u {name}:{password}",
35003         "type": "json"
35004       }
35005     ],
35006     "name": "GetInteractions",
35007     "group": "Whatsapp_Interactions",
35008     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35009     "version": "0.0.0",
35010     "filename": "server/api/whatsappInteraction/index.js",
35011     "groupTitle": "Whatsapp_Interactions"
35012   },
35013   {
35014     "type": "delete",
35015     "url": "/api/whatsapp/interactions/{id}/tags",
35016     "title": "Removes tags from interaction",
35017     "examples": [
35018       {
35019         "title": "Example usage:",
35020         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35021         "type": "json"
35022       }
35023     ],
35024     "name": "RemoveTags",
35025     "group": "Whatsapp_Interactions",
35026     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35027     "version": "0.0.0",
35028     "filename": "server/api/whatsappInteraction/index.js",
35029     "groupTitle": "Whatsapp_Interactions"
35030   },
35031   {
35032     "type": "get",
35033     "url": "/api/whatsapp/interactions/{id}",
35034     "title": "Gets a single Interaction",
35035     "examples": [
35036       {
35037         "title": "Example usage:",
35038         "content": "curl https://{domain}/api/whatsapp/interactions/{id} -v -u {name}:{password}",
35039         "type": "json"
35040       }
35041     ],
35042     "name": "ShowInteractions",
35043     "group": "Whatsapp_Interactions",
35044     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35045     "version": "0.0.0",
35046     "filename": "server/api/whatsappInteraction/index.js",
35047     "groupTitle": "Whatsapp_Interactions"
35048   },
35049   {
35050     "type": "post",
35051     "url": "/api/whatsapp/interactions/{id}/messages",
35052     "title": "Creates new messages",
35053     "examples": [
35054       {
35055         "title": "Example usage:",
35056         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
35057         "type": "json"
35058       }
35059     ],
35060     "name": "addMessage",
35061     "group": "Whatsapp_Interactions",
35062     "parameter": {
35063       "fields": {
35064         "Body": [
35065           {
35066             "group": "Body",
35067             "type": "Text",
35068             "optional": false,
35069             "field": "body",
35070             "description": ""
35071           },
35072           {
35073             "group": "Body",
35074             "type": "Boolean",
35075             "optional": true,
35076             "field": "read",
35077             "description": ""
35078           },
35079           {
35080             "group": "Body",
35081             "type": "String",
35082             "allowedValues": [
35083               "\"in\"",
35084               "\"out\""
35085             ],
35086             "optional": false,
35087             "field": "direction",
35088             "description": ""
35089           },
35090           {
35091             "group": "Body",
35092             "type": "String",
35093             "optional": true,
35094             "field": "messageId",
35095             "description": ""
35096           },
35097           {
35098             "group": "Body",
35099             "type": "String",
35100             "optional": true,
35101             "field": "phone",
35102             "description": ""
35103           },
35104           {
35105             "group": "Body",
35106             "type": "String",
35107             "optional": true,
35108             "field": "readAt",
35109             "description": ""
35110           },
35111           {
35112             "group": "Body",
35113             "type": "Boolean",
35114             "optional": true,
35115             "field": "secret",
35116             "description": ""
35117           }
35118         ]
35119       }
35120     },
35121     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35122     "version": "0.0.0",
35123     "filename": "server/api/whatsappInteraction/index.js",
35124     "groupTitle": "Whatsapp_Interactions"
35125   },
35126   {
35127     "type": "get",
35128     "url": "/api/whatsapp/interactions/{id}/download",
35129     "title": "Gets interaction",
35130     "examples": [
35131       {
35132         "title": "Example usage:",
35133         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/download -v -u {name}:{password} -X GET",
35134         "type": "json"
35135       }
35136     ],
35137     "name": "download",
35138     "group": "Whatsapp_Interactions",
35139     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35140     "version": "0.0.0",
35141     "filename": "server/api/whatsappInteraction/index.js",
35142     "groupTitle": "Whatsapp_Interactions"
35143   },
35144   {
35145     "type": "get",
35146     "url": "/api/whatsapp/interactions/{id}/messages",
35147     "title": "Gets interaction messages",
35148     "examples": [
35149       {
35150         "title": "Example usage:",
35151         "content": "curl https://{domain}/api/whatsapp/interactions/{id}/messages -v -u {name}:{password} -X GET",
35152         "type": "json"
35153       }
35154     ],
35155     "name": "getMessages",
35156     "group": "Whatsapp_Interactions",
35157     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35158     "version": "0.0.0",
35159     "filename": "server/api/whatsappInteraction/index.js",
35160     "groupTitle": "Whatsapp_Interactions"
35161   },
35162   {
35163     "type": "put",
35164     "url": "/api/whatsapp/interactions/{id}",
35165     "title": "Update an existing Interaction",
35166     "examples": [
35167       {
35168         "title": "Example usage:",
35169         "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",
35170         "type": "json"
35171       }
35172     ],
35173     "name": "updateInteractions",
35174     "group": "Whatsapp_Interactions",
35175     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35176     "version": "0.0.0",
35177     "filename": "server/api/whatsappInteraction/index.js",
35178     "groupTitle": "Whatsapp_Interactions"
35179   },
35180   {
35181     "type": "post",
35182     "url": "/api/whatsapp/messages",
35183     "title": "Creates a new Message",
35184     "examples": [
35185       {
35186         "title": "Example usage:",
35187         "content": "curl https://{domain}/api/whatsapp/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35188         "type": "json"
35189       }
35190     ],
35191     "name": "CreateMessages",
35192     "group": "Whatsapp_Messages",
35193     "parameter": {
35194       "fields": {
35195         "Body": [
35196           {
35197             "group": "Body",
35198             "type": "Text",
35199             "optional": false,
35200             "field": "body",
35201             "description": ""
35202           },
35203           {
35204             "group": "Body",
35205             "type": "Boolean",
35206             "optional": true,
35207             "field": "read",
35208             "description": ""
35209           },
35210           {
35211             "group": "Body",
35212             "type": "String",
35213             "allowedValues": [
35214               "\"in\"",
35215               "\"out\""
35216             ],
35217             "optional": false,
35218             "field": "direction",
35219             "description": ""
35220           },
35221           {
35222             "group": "Body",
35223             "type": "String",
35224             "optional": true,
35225             "field": "messageId",
35226             "description": ""
35227           },
35228           {
35229             "group": "Body",
35230             "type": "String",
35231             "optional": true,
35232             "field": "phone",
35233             "description": ""
35234           },
35235           {
35236             "group": "Body",
35237             "type": "String",
35238             "optional": true,
35239             "field": "readAt",
35240             "description": ""
35241           },
35242           {
35243             "group": "Body",
35244             "type": "Boolean",
35245             "optional": true,
35246             "field": "secret",
35247             "description": ""
35248           }
35249         ]
35250       }
35251     },
35252     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35253     "version": "0.0.0",
35254     "filename": "server/api/whatsappMessage/index.js",
35255     "groupTitle": "Whatsapp_Messages"
35256   },
35257   {
35258     "type": "delete",
35259     "url": "/api/whatsapp/messages/{id}",
35260     "title": "Deletes a Message",
35261     "examples": [
35262       {
35263         "title": "Example usage:",
35264         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password} -X DELETE",
35265         "type": "json"
35266       }
35267     ],
35268     "name": "DeleteMessages",
35269     "group": "Whatsapp_Messages",
35270     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35271     "version": "0.0.0",
35272     "filename": "server/api/whatsappMessage/index.js",
35273     "groupTitle": "Whatsapp_Messages"
35274   },
35275   {
35276     "type": "get",
35277     "url": "/api/whatsapp/messages/describe",
35278     "title": "Gets table info about Messages",
35279     "examples": [
35280       {
35281         "title": "Example usage:",
35282         "content": "curl https://{domain}/api/whatsapp/messages/describe -v -u {name}:{password}",
35283         "type": "json"
35284       }
35285     ],
35286     "name": "DescribeMessages",
35287     "group": "Whatsapp_Messages",
35288     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35289     "version": "0.0.0",
35290     "filename": "server/api/whatsappMessage/index.js",
35291     "groupTitle": "Whatsapp_Messages"
35292   },
35293   {
35294     "type": "get",
35295     "url": "/api/whatsapp/messages",
35296     "title": "Gets a list of Messages",
35297     "examples": [
35298       {
35299         "title": "Example usage:",
35300         "content": "curl https://{domain}/api/whatsapp/messages -v -u {name}:{password}",
35301         "type": "json"
35302       }
35303     ],
35304     "name": "GetMessages",
35305     "group": "Whatsapp_Messages",
35306     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35307     "version": "0.0.0",
35308     "filename": "server/api/whatsappMessage/index.js",
35309     "groupTitle": "Whatsapp_Messages"
35310   },
35311   {
35312     "type": "get",
35313     "url": "/api/whatsapp/messages/{id}",
35314     "title": "Gets a single Message",
35315     "examples": [
35316       {
35317         "title": "Example usage:",
35318         "content": "curl https://{domain}/api/whatsapp/messages/{id} -v -u {name}:{password}",
35319         "type": "json"
35320       }
35321     ],
35322     "name": "ShowMessages",
35323     "group": "Whatsapp_Messages",
35324     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35325     "version": "0.0.0",
35326     "filename": "server/api/whatsappMessage/index.js",
35327     "groupTitle": "Whatsapp_Messages"
35328   },
35329   {
35330     "type": "put",
35331     "url": "/api/whatsapp/messages/{id}",
35332     "title": "Update an existing Message",
35333     "examples": [
35334       {
35335         "title": "Example usage:",
35336         "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",
35337         "type": "json"
35338       }
35339     ],
35340     "name": "updateMessages",
35341     "group": "Whatsapp_Messages",
35342     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35343     "version": "0.0.0",
35344     "filename": "server/api/whatsappMessage/index.js",
35345     "groupTitle": "Whatsapp_Messages"
35346   },
35347   {
35348     "type": "post",
35349     "url": "/api/whatsapp/reports/queue",
35350     "title": "Creates a new Whatsapp Queue Report",
35351     "examples": [
35352       {
35353         "title": "Example usage:",
35354         "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",
35355         "type": "json"
35356       }
35357     ],
35358     "name": "CreateWhatsapp_Queue_Reports",
35359     "group": "Whatsapp_Queue_Reports",
35360     "parameter": {
35361       "fields": {
35362         "Body": [
35363           {
35364             "group": "Body",
35365             "type": "String",
35366             "optional": false,
35367             "field": "uniqueid",
35368             "description": ""
35369           },
35370           {
35371             "group": "Body",
35372             "type": "String",
35373             "optional": true,
35374             "field": "from",
35375             "description": ""
35376           },
35377           {
35378             "group": "Body",
35379             "type": "String",
35380             "optional": true,
35381             "field": "joinAt",
35382             "description": ""
35383           },
35384           {
35385             "group": "Body",
35386             "type": "String",
35387             "optional": true,
35388             "field": "leaveAt",
35389             "description": ""
35390           },
35391           {
35392             "group": "Body",
35393             "type": "String",
35394             "optional": true,
35395             "field": "acceptAt",
35396             "description": ""
35397           },
35398           {
35399             "group": "Body",
35400             "type": "String",
35401             "optional": true,
35402             "field": "exitAt",
35403             "description": ""
35404           },
35405           {
35406             "group": "Body",
35407             "type": "String",
35408             "optional": true,
35409             "field": "reason",
35410             "description": ""
35411           }
35412         ]
35413       }
35414     },
35415     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35416     "version": "0.0.0",
35417     "filename": "server/api/whatsappQueueReport/index.js",
35418     "groupTitle": "Whatsapp_Queue_Reports"
35419   },
35420   {
35421     "type": "delete",
35422     "url": "/api/whatsapp/reports/queue/{id}",
35423     "title": "Deletes a Whatsapp Queue Report",
35424     "examples": [
35425       {
35426         "title": "Example usage:",
35427         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password} -X DELETE",
35428         "type": "json"
35429       }
35430     ],
35431     "name": "DeleteWhatsapp_Queue_Reports",
35432     "group": "Whatsapp_Queue_Reports",
35433     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35434     "version": "0.0.0",
35435     "filename": "server/api/whatsappQueueReport/index.js",
35436     "groupTitle": "Whatsapp_Queue_Reports"
35437   },
35438   {
35439     "type": "get",
35440     "url": "/api/whatsapp/reports/queue/describe",
35441     "title": "Gets table info about Whatsapp Queue Reports",
35442     "examples": [
35443       {
35444         "title": "Example usage:",
35445         "content": "curl https://{domain}/api/whatsapp/reports/queue/describe -v -u {name}:{password}",
35446         "type": "json"
35447       }
35448     ],
35449     "name": "DescribeWhatsapp_Queue_Reports",
35450     "group": "Whatsapp_Queue_Reports",
35451     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35452     "version": "0.0.0",
35453     "filename": "server/api/whatsappQueueReport/index.js",
35454     "groupTitle": "Whatsapp_Queue_Reports"
35455   },
35456   {
35457     "type": "get",
35458     "url": "/api/whatsapp/reports/queue",
35459     "title": "Gets a list of Whatsapp Queue Reports",
35460     "examples": [
35461       {
35462         "title": "Example usage:",
35463         "content": "curl https://{domain}/api/whatsapp/reports/queue -v -u {name}:{password}",
35464         "type": "json"
35465       }
35466     ],
35467     "name": "GetWhatsapp_Queue_Reports",
35468     "group": "Whatsapp_Queue_Reports",
35469     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35470     "version": "0.0.0",
35471     "filename": "server/api/whatsappQueueReport/index.js",
35472     "groupTitle": "Whatsapp_Queue_Reports"
35473   },
35474   {
35475     "type": "get",
35476     "url": "/api/whatsapp/reports/queue/{id}",
35477     "title": "Gets a single Whatsapp Queue Report",
35478     "examples": [
35479       {
35480         "title": "Example usage:",
35481         "content": "curl https://{domain}/api/whatsapp/reports/queue/{id} -v -u {name}:{password}",
35482         "type": "json"
35483       }
35484     ],
35485     "name": "ShowWhatsapp_Queue_Reports",
35486     "group": "Whatsapp_Queue_Reports",
35487     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35488     "version": "0.0.0",
35489     "filename": "server/api/whatsappQueueReport/index.js",
35490     "groupTitle": "Whatsapp_Queue_Reports"
35491   },
35492   {
35493     "type": "put",
35494     "url": "/api/whatsapp/reports/queue/{id}",
35495     "title": "Update an existing Whatsapp Queue Report",
35496     "examples": [
35497       {
35498         "title": "Example usage:",
35499         "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",
35500         "type": "json"
35501       }
35502     ],
35503     "name": "updateWhatsapp_Queue_Reports",
35504     "group": "Whatsapp_Queue_Reports",
35505     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35506     "version": "0.0.0",
35507     "filename": "server/api/whatsappQueueReport/index.js",
35508     "groupTitle": "Whatsapp_Queue_Reports"
35509   },
35510   {
35511     "type": "post",
35512     "url": "/api/whatsapp/queues/{id}/users",
35513     "title": "Add agents to a queue",
35514     "examples": [
35515       {
35516         "title": "Example usage:",
35517         "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",
35518         "type": "json"
35519       }
35520     ],
35521     "name": "AddAgents",
35522     "group": "Whatsapp_Queues",
35523     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35524     "version": "0.0.0",
35525     "filename": "server/api/whatsappQueue/index.js",
35526     "groupTitle": "Whatsapp_Queues"
35527   },
35528   {
35529     "type": "post",
35530     "url": "/api/whatsapp/queues/{id}/teams",
35531     "title": "Add teams to a queue",
35532     "examples": [
35533       {
35534         "title": "Example usage:",
35535         "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",
35536         "type": "json"
35537       }
35538     ],
35539     "name": "AddTeams",
35540     "group": "Whatsapp_Queues",
35541     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35542     "version": "0.0.0",
35543     "filename": "server/api/whatsappQueue/index.js",
35544     "groupTitle": "Whatsapp_Queues"
35545   },
35546   {
35547     "type": "post",
35548     "url": "/api/whatsapp/queues",
35549     "title": "Creates a new Queue",
35550     "examples": [
35551       {
35552         "title": "Example usage:",
35553         "content": "curl https://{domain}/api/whatsapp/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35554         "type": "json"
35555       }
35556     ],
35557     "name": "CreateQueues",
35558     "group": "Whatsapp_Queues",
35559     "parameter": {
35560       "fields": {
35561         "Body": [
35562           {
35563             "group": "Body",
35564             "type": "String",
35565             "optional": true,
35566             "field": "name",
35567             "description": ""
35568           },
35569           {
35570             "group": "Body",
35571             "type": "Integer",
35572             "optional": true,
35573             "field": "timeout",
35574             "description": ""
35575           },
35576           {
35577             "group": "Body",
35578             "type": "String",
35579             "allowedValues": [
35580               "\"rrmemory\"",
35581               "\"beepall\"",
35582               "\"roundrobin\""
35583             ],
35584             "optional": true,
35585             "field": "strategy",
35586             "description": ""
35587           },
35588           {
35589             "group": "Body",
35590             "type": "String",
35591             "optional": true,
35592             "field": "description",
35593             "description": ""
35594           }
35595         ]
35596       }
35597     },
35598     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35599     "version": "0.0.0",
35600     "filename": "server/api/whatsappQueue/index.js",
35601     "groupTitle": "Whatsapp_Queues"
35602   },
35603   {
35604     "type": "delete",
35605     "url": "/api/whatsapp/queues/{id}",
35606     "title": "Deletes a Queue",
35607     "examples": [
35608       {
35609         "title": "Example usage:",
35610         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password} -X DELETE",
35611         "type": "json"
35612       }
35613     ],
35614     "name": "DeleteQueues",
35615     "group": "Whatsapp_Queues",
35616     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35617     "version": "0.0.0",
35618     "filename": "server/api/whatsappQueue/index.js",
35619     "groupTitle": "Whatsapp_Queues"
35620   },
35621   {
35622     "type": "get",
35623     "url": "/api/whatsapp/queues/describe",
35624     "title": "Gets table info about Queues",
35625     "examples": [
35626       {
35627         "title": "Example usage:",
35628         "content": "curl https://{domain}/api/whatsapp/queues/describe -v -u {name}:{password}",
35629         "type": "json"
35630       }
35631     ],
35632     "name": "DescribeQueues",
35633     "group": "Whatsapp_Queues",
35634     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35635     "version": "0.0.0",
35636     "filename": "server/api/whatsappQueue/index.js",
35637     "groupTitle": "Whatsapp_Queues"
35638   },
35639   {
35640     "type": "get",
35641     "url": "/api/whatsapp/queues/{id}/users",
35642     "title": "Gets queue agents",
35643     "examples": [
35644       {
35645         "title": "Example usage:",
35646         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users -v -u {name}:{password} -X POST",
35647         "type": "json"
35648       }
35649     ],
35650     "name": "GetAgents",
35651     "group": "Whatsapp_Queues",
35652     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35653     "version": "0.0.0",
35654     "filename": "server/api/whatsappQueue/index.js",
35655     "groupTitle": "Whatsapp_Queues"
35656   },
35657   {
35658     "type": "get",
35659     "url": "/api/whatsapp/queues/{id}/members",
35660     "title": "GetMembers",
35661     "examples": [
35662       {
35663         "title": "Example usage:",
35664         "content": "curl https://{domain}/api/whatsapp/queues/{id}/members  -v -u {name}:{password}",
35665         "type": "json"
35666       }
35667     ],
35668     "name": "GetMembers",
35669     "group": "Whatsapp_Queues",
35670     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35671     "version": "0.0.0",
35672     "filename": "server/api/whatsappQueue/index.js",
35673     "groupTitle": "Whatsapp_Queues"
35674   },
35675   {
35676     "type": "get",
35677     "url": "/api/whatsapp/queues",
35678     "title": "Gets a list of Queues",
35679     "examples": [
35680       {
35681         "title": "Example usage:",
35682         "content": "curl https://{domain}/api/whatsapp/queues -v -u {name}:{password}",
35683         "type": "json"
35684       }
35685     ],
35686     "name": "GetQueues",
35687     "group": "Whatsapp_Queues",
35688     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35689     "version": "0.0.0",
35690     "filename": "server/api/whatsappQueue/index.js",
35691     "groupTitle": "Whatsapp_Queues"
35692   },
35693   {
35694     "type": "get",
35695     "url": "/api/whatsapp/queues/{id}/teams",
35696     "title": "Gets queues list",
35697     "examples": [
35698       {
35699         "title": "Example usage:",
35700         "content": "curl https://{domain}/api/whatsapp/queues/{id}/teams -v -u {name}:{password}",
35701         "type": "json"
35702       }
35703     ],
35704     "name": "GetTeams",
35705     "group": "Whatsapp_Queues",
35706     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35707     "version": "0.0.0",
35708     "filename": "server/api/whatsappQueue/index.js",
35709     "groupTitle": "Whatsapp_Queues"
35710   },
35711   {
35712     "type": "delete",
35713     "url": "/api/whatsapp/queues/{id}/users",
35714     "title": "Removes agents from a queue",
35715     "examples": [
35716       {
35717         "title": "Example usage:",
35718         "content": "curl https://{domain}/api/whatsapp/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
35719         "type": "json"
35720       }
35721     ],
35722     "name": "RemoveAgents",
35723     "group": "Whatsapp_Queues",
35724     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35725     "version": "0.0.0",
35726     "filename": "server/api/whatsappQueue/index.js",
35727     "groupTitle": "Whatsapp_Queues"
35728   },
35729   {
35730     "type": "get",
35731     "url": "/api/whatsapp/queues/{id}",
35732     "title": "Gets a single Queue",
35733     "examples": [
35734       {
35735         "title": "Example usage:",
35736         "content": "curl https://{domain}/api/whatsapp/queues/{id} -v -u {name}:{password}",
35737         "type": "json"
35738       }
35739     ],
35740     "name": "ShowQueues",
35741     "group": "Whatsapp_Queues",
35742     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35743     "version": "0.0.0",
35744     "filename": "server/api/whatsappQueue/index.js",
35745     "groupTitle": "Whatsapp_Queues"
35746   },
35747   {
35748     "type": "put",
35749     "url": "/api/whatsapp/queues/{id}",
35750     "title": "Update an existing Queue",
35751     "examples": [
35752       {
35753         "title": "Example usage:",
35754         "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",
35755         "type": "json"
35756       }
35757     ],
35758     "name": "updateQueues",
35759     "group": "Whatsapp_Queues",
35760     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35761     "version": "0.0.0",
35762     "filename": "server/api/whatsappQueue/index.js",
35763     "groupTitle": "Whatsapp_Queues"
35764   },
35765   {
35766     "type": "post",
35767     "url": "/api/whatsapp/reports/transfer",
35768     "title": "Creates a new Whatsapp Transfer Report",
35769     "examples": [
35770       {
35771         "title": "Example usage:",
35772         "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",
35773         "type": "json"
35774       }
35775     ],
35776     "name": "CreateWhatsapp_Transfer_Reports",
35777     "group": "Whatsapp_Transfer_Reports",
35778     "parameter": {
35779       "fields": {
35780         "Body": [
35781           {
35782             "group": "Body",
35783             "type": "String",
35784             "optional": false,
35785             "field": "uniqueid",
35786             "description": ""
35787           },
35788           {
35789             "group": "Body",
35790             "type": "String",
35791             "allowedValues": [
35792               "\"account\"",
35793               "\"agent\"",
35794               "\"queue\""
35795             ],
35796             "optional": false,
35797             "field": "type",
35798             "description": ""
35799           },
35800           {
35801             "group": "Body",
35802             "type": "String",
35803             "optional": true,
35804             "field": "transferredAt",
35805             "description": ""
35806           }
35807         ]
35808       }
35809     },
35810     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35811     "version": "0.0.0",
35812     "filename": "server/api/whatsappTransferReport/index.js",
35813     "groupTitle": "Whatsapp_Transfer_Reports"
35814   },
35815   {
35816     "type": "delete",
35817     "url": "/api/whatsapp/reports/transfer/{id}",
35818     "title": "Deletes a Whatsapp Transfer Report",
35819     "examples": [
35820       {
35821         "title": "Example usage:",
35822         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
35823         "type": "json"
35824       }
35825     ],
35826     "name": "DeleteWhatsapp_Transfer_Reports",
35827     "group": "Whatsapp_Transfer_Reports",
35828     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35829     "version": "0.0.0",
35830     "filename": "server/api/whatsappTransferReport/index.js",
35831     "groupTitle": "Whatsapp_Transfer_Reports"
35832   },
35833   {
35834     "type": "get",
35835     "url": "/api/whatsapp/reports/transfer/describe",
35836     "title": "Gets table info about Whatsapp Transfer Reports",
35837     "examples": [
35838       {
35839         "title": "Example usage:",
35840         "content": "curl https://{domain}/api/whatsapp/reports/transfer/describe -v -u {name}:{password}",
35841         "type": "json"
35842       }
35843     ],
35844     "name": "DescribeWhatsapp_Transfer_Reports",
35845     "group": "Whatsapp_Transfer_Reports",
35846     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35847     "version": "0.0.0",
35848     "filename": "server/api/whatsappTransferReport/index.js",
35849     "groupTitle": "Whatsapp_Transfer_Reports"
35850   },
35851   {
35852     "type": "get",
35853     "url": "/api/whatsapp/reports/transfer",
35854     "title": "Gets a list of Whatsapp Transfer Reports",
35855     "examples": [
35856       {
35857         "title": "Example usage:",
35858         "content": "curl https://{domain}/api/whatsapp/reports/transfer -v -u {name}:{password}",
35859         "type": "json"
35860       }
35861     ],
35862     "name": "GetWhatsapp_Transfer_Reports",
35863     "group": "Whatsapp_Transfer_Reports",
35864     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35865     "version": "0.0.0",
35866     "filename": "server/api/whatsappTransferReport/index.js",
35867     "groupTitle": "Whatsapp_Transfer_Reports"
35868   },
35869   {
35870     "type": "get",
35871     "url": "/api/whatsapp/reports/transfer/{id}",
35872     "title": "Gets a single Whatsapp Transfer Report",
35873     "examples": [
35874       {
35875         "title": "Example usage:",
35876         "content": "curl https://{domain}/api/whatsapp/reports/transfer/{id} -v -u {name}:{password}",
35877         "type": "json"
35878       }
35879     ],
35880     "name": "ShowWhatsapp_Transfer_Reports",
35881     "group": "Whatsapp_Transfer_Reports",
35882     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35883     "version": "0.0.0",
35884     "filename": "server/api/whatsappTransferReport/index.js",
35885     "groupTitle": "Whatsapp_Transfer_Reports"
35886   },
35887   {
35888     "type": "put",
35889     "url": "/api/whatsapp/reports/transfer/{id}",
35890     "title": "Update an existing Whatsapp Transfer Report",
35891     "examples": [
35892       {
35893         "title": "Example usage:",
35894         "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",
35895         "type": "json"
35896       }
35897     ],
35898     "name": "updateWhatsapp_Transfer_Reports",
35899     "group": "Whatsapp_Transfer_Reports",
35900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35901     "version": "0.0.0",
35902     "filename": "server/api/whatsappTransferReport/index.js",
35903     "groupTitle": "Whatsapp_Transfer_Reports"
35904   },
35905   {
35906     "type": "post",
35907     "url": "/api/integrations/zendesk/accounts",
35908     "title": "Creates a new Zendesk Account",
35909     "examples": [
35910       {
35911         "title": "Example usage:",
35912         "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",
35913         "type": "json"
35914       }
35915     ],
35916     "name": "CreateZendesk_Accounts",
35917     "group": "Zendesk_Accounts",
35918     "parameter": {
35919       "fields": {
35920         "Body": [
35921           {
35922             "group": "Body",
35923             "type": "String",
35924             "optional": true,
35925             "field": "name",
35926             "description": ""
35927           },
35928           {
35929             "group": "Body",
35930             "type": "String",
35931             "optional": true,
35932             "field": "description",
35933             "description": ""
35934           },
35935           {
35936             "group": "Body",
35937             "type": "String",
35938             "optional": true,
35939             "field": "username",
35940             "description": ""
35941           },
35942           {
35943             "group": "Body",
35944             "type": "String",
35945             "optional": true,
35946             "field": "password",
35947             "description": ""
35948           },
35949           {
35950             "group": "Body",
35951             "type": "String",
35952             "optional": true,
35953             "field": "token",
35954             "description": ""
35955           },
35956           {
35957             "group": "Body",
35958             "type": "String",
35959             "optional": true,
35960             "field": "remoteUri",
35961             "description": ""
35962           },
35963           {
35964             "group": "Body",
35965             "type": "String",
35966             "allowedValues": [
35967               "\"password\"",
35968               "\"token\""
35969             ],
35970             "optional": true,
35971             "field": "authType",
35972             "description": ""
35973           },
35974           {
35975             "group": "Body",
35976             "type": "String",
35977             "optional": true,
35978             "field": "serverUrl",
35979             "description": ""
35980           },
35981           {
35982             "group": "Body",
35983             "type": "String",
35984             "allowedValues": [
35985               "\"integrationTab\"",
35986               "\"newTab\""
35987             ],
35988             "optional": true,
35989             "field": "type",
35990             "description": ""
35991           }
35992         ]
35993       }
35994     },
35995     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35996     "version": "0.0.0",
35997     "filename": "server/api/intZendeskAccount/index.js",
35998     "groupTitle": "Zendesk_Accounts"
35999   },
36000   {
36001     "type": "delete",
36002     "url": "/api/integrations/zendesk/accounts/{id}",
36003     "title": "Deletes a Zendesk Account",
36004     "examples": [
36005       {
36006         "title": "Example usage:",
36007         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
36008         "type": "json"
36009       }
36010     ],
36011     "name": "DeleteZendesk_Accounts",
36012     "group": "Zendesk_Accounts",
36013     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36014     "version": "0.0.0",
36015     "filename": "server/api/intZendeskAccount/index.js",
36016     "groupTitle": "Zendesk_Accounts"
36017   },
36018   {
36019     "type": "get",
36020     "url": "/api/integrations/zendesk/accounts",
36021     "title": "Gets a list of Zendesk Accounts",
36022     "examples": [
36023       {
36024         "title": "Example usage:",
36025         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
36026         "type": "json"
36027       }
36028     ],
36029     "name": "GetZendesk_Accounts",
36030     "group": "Zendesk_Accounts",
36031     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36032     "version": "0.0.0",
36033     "filename": "server/api/intZendeskAccount/index.js",
36034     "groupTitle": "Zendesk_Accounts"
36035   },
36036   {
36037     "type": "get",
36038     "url": "/api/integrations/zendesk/accounts/{id}",
36039     "title": "Gets a single Zendesk Account",
36040     "examples": [
36041       {
36042         "title": "Example usage:",
36043         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
36044         "type": "json"
36045       }
36046     ],
36047     "name": "ShowZendesk_Accounts",
36048     "group": "Zendesk_Accounts",
36049     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36050     "version": "0.0.0",
36051     "filename": "server/api/intZendeskAccount/index.js",
36052     "groupTitle": "Zendesk_Accounts"
36053   },
36054   {
36055     "type": "post",
36056     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36057     "title": "Creates new configuration",
36058     "examples": [
36059       {
36060         "title": "Example usage:",
36061         "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",
36062         "type": "json"
36063       }
36064     ],
36065     "name": "addConfiguration",
36066     "group": "Zendesk_Accounts",
36067     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36068     "version": "0.0.0",
36069     "filename": "server/api/intZendeskAccount/index.js",
36070     "groupTitle": "Zendesk_Accounts"
36071   },
36072   {
36073     "type": "get",
36074     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
36075     "title": "Gets account configurations",
36076     "examples": [
36077       {
36078         "title": "Example usage:",
36079         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36080         "type": "json"
36081       }
36082     ],
36083     "name": "getConfigurations",
36084     "group": "Zendesk_Accounts",
36085     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36086     "version": "0.0.0",
36087     "filename": "server/api/intZendeskAccount/index.js",
36088     "groupTitle": "Zendesk_Accounts"
36089   },
36090   {
36091     "type": "get",
36092     "url": "/api/integrations/zendesk/accounts/{id}/fields",
36093     "title": "Gets account fields",
36094     "examples": [
36095       {
36096         "title": "Example usage:",
36097         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
36098         "type": "json"
36099       }
36100     ],
36101     "name": "getFields",
36102     "group": "Zendesk_Accounts",
36103     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36104     "version": "0.0.0",
36105     "filename": "server/api/intZendeskAccount/index.js",
36106     "groupTitle": "Zendesk_Accounts"
36107   },
36108   {
36109     "type": "put",
36110     "url": "/api/integrations/zendesk/accounts/{id}",
36111     "title": "Update an existing Zendesk Account",
36112     "examples": [
36113       {
36114         "title": "Example usage:",
36115         "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",
36116         "type": "json"
36117       }
36118     ],
36119     "name": "updateZendesk_Accounts",
36120     "group": "Zendesk_Accounts",
36121     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36122     "version": "0.0.0",
36123     "filename": "server/api/intZendeskAccount/index.js",
36124     "groupTitle": "Zendesk_Accounts"
36125   },
36126   {
36127     "type": "post",
36128     "url": "/api/integrations/zendesk/configurations",
36129     "title": "Creates a new Zendesk Configuration",
36130     "examples": [
36131       {
36132         "title": "Example usage:",
36133         "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",
36134         "type": "json"
36135       }
36136     ],
36137     "name": "CreateZendesk_Configurations",
36138     "group": "Zendesk_Configurations",
36139     "parameter": {
36140       "fields": {
36141         "Body": [
36142           {
36143             "group": "Body",
36144             "type": "String",
36145             "optional": true,
36146             "field": "name",
36147             "description": ""
36148           },
36149           {
36150             "group": "Body",
36151             "type": "String",
36152             "optional": true,
36153             "field": "description",
36154             "description": ""
36155           }
36156         ]
36157       }
36158     },
36159     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36160     "version": "0.0.0",
36161     "filename": "server/api/intZendeskConfiguration/index.js",
36162     "groupTitle": "Zendesk_Configurations"
36163   },
36164   {
36165     "type": "delete",
36166     "url": "/api/integrations/zendesk/configurations/{id}",
36167     "title": "Deletes a Zendesk Configuration",
36168     "examples": [
36169       {
36170         "title": "Example usage:",
36171         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
36172         "type": "json"
36173       }
36174     ],
36175     "name": "DeleteZendesk_Configurations",
36176     "group": "Zendesk_Configurations",
36177     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36178     "version": "0.0.0",
36179     "filename": "server/api/intZendeskConfiguration/index.js",
36180     "groupTitle": "Zendesk_Configurations"
36181   },
36182   {
36183     "type": "get",
36184     "url": "/api/integrations/zendesk/configurations",
36185     "title": "Gets a list of Zendesk Configurations",
36186     "examples": [
36187       {
36188         "title": "Example usage:",
36189         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
36190         "type": "json"
36191       }
36192     ],
36193     "name": "GetZendesk_Configurations",
36194     "group": "Zendesk_Configurations",
36195     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36196     "version": "0.0.0",
36197     "filename": "server/api/intZendeskConfiguration/index.js",
36198     "groupTitle": "Zendesk_Configurations"
36199   },
36200   {
36201     "type": "get",
36202     "url": "/api/integrations/zendesk/configurations/{id}",
36203     "title": "Gets a single Zendesk Configuration",
36204     "examples": [
36205       {
36206         "title": "Example usage:",
36207         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
36208         "type": "json"
36209       }
36210     ],
36211     "name": "ShowZendesk_Configurations",
36212     "group": "Zendesk_Configurations",
36213     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36214     "version": "0.0.0",
36215     "filename": "server/api/intZendeskConfiguration/index.js",
36216     "groupTitle": "Zendesk_Configurations"
36217   },
36218   {
36219     "type": "get",
36220     "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
36221     "title": "Gets configurations descriptions",
36222     "examples": [
36223       {
36224         "title": "Example usage:",
36225         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36226         "type": "json"
36227       }
36228     ],
36229     "name": "getDescriptions",
36230     "group": "Zendesk_Configurations",
36231     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36232     "version": "0.0.0",
36233     "filename": "server/api/intZendeskConfiguration/index.js",
36234     "groupTitle": "Zendesk_Configurations"
36235   },
36236   {
36237     "type": "get",
36238     "url": "/api/integrations/zendesk/configurations/{id}/fields",
36239     "title": "Gets configurations fields",
36240     "examples": [
36241       {
36242         "title": "Example usage:",
36243         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
36244         "type": "json"
36245       }
36246     ],
36247     "name": "getFields",
36248     "group": "Zendesk_Configurations",
36249     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36250     "version": "0.0.0",
36251     "filename": "server/api/intZendeskConfiguration/index.js",
36252     "groupTitle": "Zendesk_Configurations"
36253   },
36254   {
36255     "type": "get",
36256     "url": "/api/integrations/zendesk/configurations/{id}/subjects",
36257     "title": "Gets configurations subjects",
36258     "examples": [
36259       {
36260         "title": "Example usage:",
36261         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36262         "type": "json"
36263       }
36264     ],
36265     "name": "getSubjects",
36266     "group": "Zendesk_Configurations",
36267     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36268     "version": "0.0.0",
36269     "filename": "server/api/intZendeskConfiguration/index.js",
36270     "groupTitle": "Zendesk_Configurations"
36271   },
36272   {
36273     "type": "get",
36274     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36275     "title": "Gets configurations tags",
36276     "examples": [
36277       {
36278         "title": "Example usage:",
36279         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
36280         "type": "json"
36281       }
36282     ],
36283     "name": "getTags",
36284     "group": "Zendesk_Configurations",
36285     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36286     "version": "0.0.0",
36287     "filename": "server/api/intZendeskConfiguration/index.js",
36288     "groupTitle": "Zendesk_Configurations"
36289   },
36290   {
36291     "type": "post",
36292     "url": "/api/integrations/zendesk/configurations/{id}/tags",
36293     "title": "Sets new tags",
36294     "examples": [
36295       {
36296         "title": "Example usage:",
36297         "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",
36298         "type": "json"
36299       }
36300     ],
36301     "name": "setTags",
36302     "group": "Zendesk_Configurations",
36303     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36304     "version": "0.0.0",
36305     "filename": "server/api/intZendeskConfiguration/index.js",
36306     "groupTitle": "Zendesk_Configurations"
36307   },
36308   {
36309     "type": "put",
36310     "url": "/api/integrations/zendesk/configurations/{id}",
36311     "title": "Update an existing Zendesk Configuration",
36312     "examples": [
36313       {
36314         "title": "Example usage:",
36315         "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",
36316         "type": "json"
36317       }
36318     ],
36319     "name": "updateZendesk_Configurations",
36320     "group": "Zendesk_Configurations",
36321     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36322     "version": "0.0.0",
36323     "filename": "server/api/intZendeskConfiguration/index.js",
36324     "groupTitle": "Zendesk_Configurations"
36325   },
36326   {
36327     "type": "post",
36328     "url": "/api/integrations/zendesk/fields",
36329     "title": "Creates a new Zendesk Field",
36330     "examples": [
36331       {
36332         "title": "Example usage:",
36333         "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",
36334         "type": "json"
36335       }
36336     ],
36337     "name": "CreateZendesk_Fields",
36338     "group": "Zendesk_Fields",
36339     "parameter": {
36340       "fields": {
36341         "Body": [
36342           {
36343             "group": "Body",
36344             "type": "String",
36345             "allowedValues": [
36346               "\"string\"",
36347               "\"variable\"",
36348               "\"customVariable\"",
36349               "\"keyValue\""
36350             ],
36351             "optional": true,
36352             "field": "type",
36353             "description": ""
36354           },
36355           {
36356             "group": "Body",
36357             "type": "String",
36358             "optional": true,
36359             "field": "content",
36360             "description": ""
36361           },
36362           {
36363             "group": "Body",
36364             "type": "String",
36365             "optional": true,
36366             "field": "key",
36367             "description": ""
36368           },
36369           {
36370             "group": "Body",
36371             "type": "String",
36372             "allowedValues": [
36373               "\"string\"",
36374               "\"variable\"",
36375               "\"customVariable\""
36376             ],
36377             "optional": true,
36378             "field": "keyType",
36379             "description": ""
36380           },
36381           {
36382             "group": "Body",
36383             "type": "String",
36384             "optional": true,
36385             "field": "keyContent",
36386             "description": ""
36387           },
36388           {
36389             "group": "Body",
36390             "type": "String",
36391             "optional": true,
36392             "field": "idField",
36393             "description": ""
36394           },
36395           {
36396             "group": "Body",
36397             "type": "String",
36398             "optional": true,
36399             "field": "nameField",
36400             "description": ""
36401           },
36402           {
36403             "group": "Body",
36404             "type": "Boolean",
36405             "optional": true,
36406             "field": "customField",
36407             "description": ""
36408           },
36409           {
36410             "group": "Body",
36411             "type": "String",
36412             "optional": true,
36413             "field": "variableName",
36414             "description": ""
36415           }
36416         ]
36417       }
36418     },
36419     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36420     "version": "0.0.0",
36421     "filename": "server/api/intZendeskField/index.js",
36422     "groupTitle": "Zendesk_Fields"
36423   },
36424   {
36425     "type": "delete",
36426     "url": "/api/integrations/zendesk/fields/{id}",
36427     "title": "Deletes a Zendesk Field",
36428     "examples": [
36429       {
36430         "title": "Example usage:",
36431         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
36432         "type": "json"
36433       }
36434     ],
36435     "name": "DeleteZendesk_Fields",
36436     "group": "Zendesk_Fields",
36437     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36438     "version": "0.0.0",
36439     "filename": "server/api/intZendeskField/index.js",
36440     "groupTitle": "Zendesk_Fields"
36441   },
36442   {
36443     "type": "get",
36444     "url": "/api/integrations/zendesk/fields",
36445     "title": "Gets a list of Zendesk Fields",
36446     "examples": [
36447       {
36448         "title": "Example usage:",
36449         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
36450         "type": "json"
36451       }
36452     ],
36453     "name": "GetZendesk_Fields",
36454     "group": "Zendesk_Fields",
36455     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36456     "version": "0.0.0",
36457     "filename": "server/api/intZendeskField/index.js",
36458     "groupTitle": "Zendesk_Fields"
36459   },
36460   {
36461     "type": "get",
36462     "url": "/api/integrations/zendesk/fields/{id}",
36463     "title": "Gets a single Zendesk Field",
36464     "examples": [
36465       {
36466         "title": "Example usage:",
36467         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
36468         "type": "json"
36469       }
36470     ],
36471     "name": "ShowZendesk_Fields",
36472     "group": "Zendesk_Fields",
36473     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36474     "version": "0.0.0",
36475     "filename": "server/api/intZendeskField/index.js",
36476     "groupTitle": "Zendesk_Fields"
36477   },
36478   {
36479     "type": "put",
36480     "url": "/api/integrations/zendesk/fields/{id}",
36481     "title": "Update an existing Zendesk Field",
36482     "examples": [
36483       {
36484         "title": "Example usage:",
36485         "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",
36486         "type": "json"
36487       }
36488     ],
36489     "name": "updateZendesk_Fields",
36490     "group": "Zendesk_Fields",
36491     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36492     "version": "0.0.0",
36493     "filename": "server/api/intZendeskField/index.js",
36494     "groupTitle": "Zendesk_Fields"
36495   },
36496   {
36497     "type": "post",
36498     "url": "/api/integrations/zoho/accounts",
36499     "title": "Creates a new Zoho Account",
36500     "examples": [
36501       {
36502         "title": "Example usage:",
36503         "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",
36504         "type": "json"
36505       }
36506     ],
36507     "name": "CreateZoho_Accounts",
36508     "group": "Zoho_Accounts",
36509     "parameter": {
36510       "fields": {
36511         "Body": [
36512           {
36513             "group": "Body",
36514             "type": "String",
36515             "optional": true,
36516             "field": "name",
36517             "description": ""
36518           },
36519           {
36520             "group": "Body",
36521             "type": "String",
36522             "optional": true,
36523             "field": "description",
36524             "description": ""
36525           },
36526           {
36527             "group": "Body",
36528             "type": "String",
36529             "optional": true,
36530             "field": "host",
36531             "description": ""
36532           },
36533           {
36534             "group": "Body",
36535             "type": "String",
36536             "optional": true,
36537             "field": "zone",
36538             "description": ""
36539           },
36540           {
36541             "group": "Body",
36542             "type": "String",
36543             "optional": true,
36544             "field": "clientId",
36545             "description": ""
36546           },
36547           {
36548             "group": "Body",
36549             "type": "String",
36550             "optional": true,
36551             "field": "clientSecret",
36552             "description": ""
36553           },
36554           {
36555             "group": "Body",
36556             "type": "String",
36557             "optional": true,
36558             "field": "serverUrl",
36559             "description": ""
36560           },
36561           {
36562             "group": "Body",
36563             "type": "String",
36564             "optional": true,
36565             "field": "code",
36566             "description": ""
36567           },
36568           {
36569             "group": "Body",
36570             "type": "String",
36571             "optional": true,
36572             "field": "refreshToken",
36573             "description": ""
36574           }
36575         ]
36576       }
36577     },
36578     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36579     "version": "0.0.0",
36580     "filename": "server/api/intZohoAccount/index.js",
36581     "groupTitle": "Zoho_Accounts"
36582   },
36583   {
36584     "type": "delete",
36585     "url": "/api/integrations/zoho/accounts/{id}",
36586     "title": "Deletes a Zoho Account",
36587     "examples": [
36588       {
36589         "title": "Example usage:",
36590         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
36591         "type": "json"
36592       }
36593     ],
36594     "name": "DeleteZoho_Accounts",
36595     "group": "Zoho_Accounts",
36596     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36597     "version": "0.0.0",
36598     "filename": "server/api/intZohoAccount/index.js",
36599     "groupTitle": "Zoho_Accounts"
36600   },
36601   {
36602     "type": "get",
36603     "url": "/api/integrations/zoho/accounts",
36604     "title": "Gets a list of Zoho Accounts",
36605     "examples": [
36606       {
36607         "title": "Example usage:",
36608         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
36609         "type": "json"
36610       }
36611     ],
36612     "name": "GetZoho_Accounts",
36613     "group": "Zoho_Accounts",
36614     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36615     "version": "0.0.0",
36616     "filename": "server/api/intZohoAccount/index.js",
36617     "groupTitle": "Zoho_Accounts"
36618   },
36619   {
36620     "type": "get",
36621     "url": "/api/integrations/zoho/accounts/{id}",
36622     "title": "Gets a single Zoho Account",
36623     "examples": [
36624       {
36625         "title": "Example usage:",
36626         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
36627         "type": "json"
36628       }
36629     ],
36630     "name": "ShowZoho_Accounts",
36631     "group": "Zoho_Accounts",
36632     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36633     "version": "0.0.0",
36634     "filename": "server/api/intZohoAccount/index.js",
36635     "groupTitle": "Zoho_Accounts"
36636   },
36637   {
36638     "type": "post",
36639     "url": "/api/integrations/zoho/accounts/{id}/configurations",
36640     "title": "Creates new configuration",
36641     "examples": [
36642       {
36643         "title": "Example usage:",
36644         "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",
36645         "type": "json"
36646       }
36647     ],
36648     "name": "addConfiguration",
36649     "group": "Zoho_Accounts",
36650     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36651     "version": "0.0.0",
36652     "filename": "server/api/intZohoAccount/index.js",
36653     "groupTitle": "Zoho_Accounts"
36654   },
36655   {
36656     "type": "get",
36657     "url": "/api/integrations/zoho/accounts/{id}/configurations",
36658     "title": "Gets account configurations",
36659     "examples": [
36660       {
36661         "title": "Example usage:",
36662         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
36663         "type": "json"
36664       }
36665     ],
36666     "name": "getConfigurations",
36667     "group": "Zoho_Accounts",
36668     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36669     "version": "0.0.0",
36670     "filename": "server/api/intZohoAccount/index.js",
36671     "groupTitle": "Zoho_Accounts"
36672   },
36673   {
36674     "type": "get",
36675     "url": "/api/integrations/zoho/accounts/{id}/fields",
36676     "title": "Gets account fields",
36677     "examples": [
36678       {
36679         "title": "Example usage:",
36680         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
36681         "type": "json"
36682       }
36683     ],
36684     "name": "getFields",
36685     "group": "Zoho_Accounts",
36686     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36687     "version": "0.0.0",
36688     "filename": "server/api/intZohoAccount/index.js",
36689     "groupTitle": "Zoho_Accounts"
36690   },
36691   {
36692     "type": "put",
36693     "url": "/api/integrations/zoho/accounts/{id}",
36694     "title": "Update an existing Zoho Account",
36695     "examples": [
36696       {
36697         "title": "Example usage:",
36698         "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",
36699         "type": "json"
36700       }
36701     ],
36702     "name": "updateZoho_Accounts",
36703     "group": "Zoho_Accounts",
36704     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36705     "version": "0.0.0",
36706     "filename": "server/api/intZohoAccount/index.js",
36707     "groupTitle": "Zoho_Accounts"
36708   },
36709   {
36710     "type": "post",
36711     "url": "/api/integrations/zoho/configurations",
36712     "title": "Creates a new Zoho Configuration",
36713     "examples": [
36714       {
36715         "title": "Example usage:",
36716         "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",
36717         "type": "json"
36718       }
36719     ],
36720     "name": "CreateZoho_Configurations",
36721     "group": "Zoho_Configurations",
36722     "parameter": {
36723       "fields": {
36724         "Body": [
36725           {
36726             "group": "Body",
36727             "type": "String",
36728             "optional": true,
36729             "field": "name",
36730             "description": ""
36731           },
36732           {
36733             "group": "Body",
36734             "type": "String",
36735             "allowedValues": [
36736               "\"lead\"",
36737               "\"contact\"",
36738               "\"nothing\""
36739             ],
36740             "optional": true,
36741             "field": "moduleCreate",
36742             "description": ""
36743           },
36744           {
36745             "group": "Body",
36746             "type": "String",
36747             "allowedValues": [
36748               "\"contact_lead\"",
36749               "\"contact\"",
36750               "\"lead\""
36751             ],
36752             "optional": true,
36753             "field": "moduleSearch",
36754             "description": ""
36755           },
36756           {
36757             "group": "Body",
36758             "type": "String",
36759             "optional": true,
36760             "field": "description",
36761             "description": ""
36762           }
36763         ]
36764       }
36765     },
36766     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36767     "version": "0.0.0",
36768     "filename": "server/api/intZohoConfiguration/index.js",
36769     "groupTitle": "Zoho_Configurations"
36770   },
36771   {
36772     "type": "delete",
36773     "url": "/api/integrations/zoho/configurations/{id}",
36774     "title": "Deletes a Zoho Configuration",
36775     "examples": [
36776       {
36777         "title": "Example usage:",
36778         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
36779         "type": "json"
36780       }
36781     ],
36782     "name": "DeleteZoho_Configurations",
36783     "group": "Zoho_Configurations",
36784     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36785     "version": "0.0.0",
36786     "filename": "server/api/intZohoConfiguration/index.js",
36787     "groupTitle": "Zoho_Configurations"
36788   },
36789   {
36790     "type": "get",
36791     "url": "/api/integrations/zoho/configurations",
36792     "title": "Gets a list of Zoho Configurations",
36793     "examples": [
36794       {
36795         "title": "Example usage:",
36796         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
36797         "type": "json"
36798       }
36799     ],
36800     "name": "GetZoho_Configurations",
36801     "group": "Zoho_Configurations",
36802     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
36803     "version": "0.0.0",
36804     "filename": "server/api/intZohoConfiguration/index.js",
36805     "groupTitle": "Zoho_Configurations"
36806   },
36807   {
36808     "type": "get",
36809     "url": "/api/integrations/zoho/configurations/{id}",
36810     "title": "Gets a single Zoho Configuration",
36811     "examples": [
36812       {
36813         "title": "Example usage:",
36814         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
36815         "type": "json"
36816       }
36817     ],
36818     "name": "ShowZoho_Configurations",
36819     "group": "Zoho_Configurations",
36820     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36821     "version": "0.0.0",
36822     "filename": "server/api/intZohoConfiguration/index.js",
36823     "groupTitle": "Zoho_Configurations"
36824   },
36825   {
36826     "type": "get",
36827     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
36828     "title": "Gets configurations descriptions",
36829     "examples": [
36830       {
36831         "title": "Example usage:",
36832         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
36833         "type": "json"
36834       }
36835     ],
36836     "name": "getDescriptions",
36837     "group": "Zoho_Configurations",
36838     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36839     "version": "0.0.0",
36840     "filename": "server/api/intZohoConfiguration/index.js",
36841     "groupTitle": "Zoho_Configurations"
36842   },
36843   {
36844     "type": "get",
36845     "url": "/api/integrations/zoho/configurations/{id}/fields",
36846     "title": "Gets configurations fields",
36847     "examples": [
36848       {
36849         "title": "Example usage:",
36850         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
36851         "type": "json"
36852       }
36853     ],
36854     "name": "getFields",
36855     "group": "Zoho_Configurations",
36856     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36857     "version": "0.0.0",
36858     "filename": "server/api/intZohoConfiguration/index.js",
36859     "groupTitle": "Zoho_Configurations"
36860   },
36861   {
36862     "type": "get",
36863     "url": "/api/integrations/zoho/configurations/{id}/subjects",
36864     "title": "Gets configurations subjects",
36865     "examples": [
36866       {
36867         "title": "Example usage:",
36868         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
36869         "type": "json"
36870       }
36871     ],
36872     "name": "getSubjects",
36873     "group": "Zoho_Configurations",
36874     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36875     "version": "0.0.0",
36876     "filename": "server/api/intZohoConfiguration/index.js",
36877     "groupTitle": "Zoho_Configurations"
36878   },
36879   {
36880     "type": "put",
36881     "url": "/api/integrations/zoho/configurations/{id}",
36882     "title": "Update an existing Zoho Configuration",
36883     "examples": [
36884       {
36885         "title": "Example usage:",
36886         "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",
36887         "type": "json"
36888       }
36889     ],
36890     "name": "updateZoho_Configurations",
36891     "group": "Zoho_Configurations",
36892     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36893     "version": "0.0.0",
36894     "filename": "server/api/intZohoConfiguration/index.js",
36895     "groupTitle": "Zoho_Configurations"
36896   },
36897   {
36898     "type": "post",
36899     "url": "/api/integrations/zoho/fields",
36900     "title": "Creates a new Zoho Field",
36901     "examples": [
36902       {
36903         "title": "Example usage:",
36904         "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",
36905         "type": "json"
36906       }
36907     ],
36908     "name": "CreateZoho_Fields",
36909     "group": "Zoho_Fields",
36910     "parameter": {
36911       "fields": {
36912         "Body": [
36913           {
36914             "group": "Body",
36915             "type": "String",
36916             "allowedValues": [
36917               "\"string\"",
36918               "\"variable\"",
36919               "\"customVariable\"",
36920               "\"keyValue\""
36921             ],
36922             "optional": true,
36923             "field": "type",
36924             "description": ""
36925           },
36926           {
36927             "group": "Body",
36928             "type": "String",
36929             "optional": true,
36930             "field": "content",
36931             "description": ""
36932           },
36933           {
36934             "group": "Body",
36935             "type": "String",
36936             "optional": true,
36937             "field": "key",
36938             "description": ""
36939           },
36940           {
36941             "group": "Body",
36942             "type": "String",
36943             "allowedValues": [
36944               "\"string\"",
36945               "\"variable\"",
36946               "\"customVariable\""
36947             ],
36948             "optional": true,
36949             "field": "keyType",
36950             "description": ""
36951           },
36952           {
36953             "group": "Body",
36954             "type": "String",
36955             "optional": true,
36956             "field": "keyContent",
36957             "description": ""
36958           },
36959           {
36960             "group": "Body",
36961             "type": "String",
36962             "optional": true,
36963             "field": "idField",
36964             "description": ""
36965           },
36966           {
36967             "group": "Body",
36968             "type": "String",
36969             "optional": true,
36970             "field": "nameField",
36971             "description": ""
36972           },
36973           {
36974             "group": "Body",
36975             "type": "Boolean",
36976             "optional": true,
36977             "field": "customField",
36978             "description": ""
36979           },
36980           {
36981             "group": "Body",
36982             "type": "String",
36983             "optional": true,
36984             "field": "variableName",
36985             "description": ""
36986           }
36987         ]
36988       }
36989     },
36990     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
36991     "version": "0.0.0",
36992     "filename": "server/api/intZohoField/index.js",
36993     "groupTitle": "Zoho_Fields"
36994   },
36995   {
36996     "type": "delete",
36997     "url": "/api/integrations/zoho/fields/{id}",
36998     "title": "Deletes a Zoho Field",
36999     "examples": [
37000       {
37001         "title": "Example usage:",
37002         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
37003         "type": "json"
37004       }
37005     ],
37006     "name": "DeleteZoho_Fields",
37007     "group": "Zoho_Fields",
37008     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37009     "version": "0.0.0",
37010     "filename": "server/api/intZohoField/index.js",
37011     "groupTitle": "Zoho_Fields"
37012   },
37013   {
37014     "type": "get",
37015     "url": "/api/integrations/zoho/fields",
37016     "title": "Gets a list of Zoho Fields",
37017     "examples": [
37018       {
37019         "title": "Example usage:",
37020         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
37021         "type": "json"
37022       }
37023     ],
37024     "name": "GetZoho_Fields",
37025     "group": "Zoho_Fields",
37026     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37027     "version": "0.0.0",
37028     "filename": "server/api/intZohoField/index.js",
37029     "groupTitle": "Zoho_Fields"
37030   },
37031   {
37032     "type": "get",
37033     "url": "/api/integrations/zoho/fields/{id}",
37034     "title": "Gets a single Zoho Field",
37035     "examples": [
37036       {
37037         "title": "Example usage:",
37038         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
37039         "type": "json"
37040       }
37041     ],
37042     "name": "ShowZoho_Fields",
37043     "group": "Zoho_Fields",
37044     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37045     "version": "0.0.0",
37046     "filename": "server/api/intZohoField/index.js",
37047     "groupTitle": "Zoho_Fields"
37048   },
37049   {
37050     "type": "put",
37051     "url": "/api/integrations/zoho/fields/{id}",
37052     "title": "Update an existing Zoho Field",
37053     "examples": [
37054       {
37055         "title": "Example usage:",
37056         "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",
37057         "type": "json"
37058       }
37059     ],
37060     "name": "updateZoho_Fields",
37061     "group": "Zoho_Fields",
37062     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37063     "version": "0.0.0",
37064     "filename": "server/api/intZohoField/index.js",
37065     "groupTitle": "Zoho_Fields"
37066   },
37067   {
37068     "type": "post",
37069     "url": "/api/cdr",
37070     "title": "Creates a new Cdr",
37071     "examples": [
37072       {
37073         "title": "Example usage:",
37074         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37075         "type": "json"
37076       }
37077     ],
37078     "name": "CreateCdrs",
37079     "group": "cdr",
37080     "parameter": {
37081       "fields": {
37082         "Body": [
37083           {
37084             "group": "Body",
37085             "type": "String",
37086             "optional": false,
37087             "field": "calldate",
37088             "description": ""
37089           },
37090           {
37091             "group": "Body",
37092             "type": "String",
37093             "optional": true,
37094             "field": "clid",
37095             "description": ""
37096           },
37097           {
37098             "group": "Body",
37099             "type": "String",
37100             "optional": true,
37101             "field": "src",
37102             "description": ""
37103           },
37104           {
37105             "group": "Body",
37106             "type": "String",
37107             "optional": true,
37108             "field": "dst",
37109             "description": ""
37110           },
37111           {
37112             "group": "Body",
37113             "type": "String",
37114             "optional": true,
37115             "field": "dcontext",
37116             "description": ""
37117           },
37118           {
37119             "group": "Body",
37120             "type": "String",
37121             "optional": true,
37122             "field": "channel",
37123             "description": ""
37124           },
37125           {
37126             "group": "Body",
37127             "type": "String",
37128             "optional": true,
37129             "field": "dstchannel",
37130             "description": ""
37131           },
37132           {
37133             "group": "Body",
37134             "type": "String",
37135             "optional": true,
37136             "field": "lastapp",
37137             "description": ""
37138           },
37139           {
37140             "group": "Body",
37141             "type": "String",
37142             "optional": true,
37143             "field": "lastdata",
37144             "description": ""
37145           },
37146           {
37147             "group": "Body",
37148             "type": "Integer",
37149             "optional": false,
37150             "field": "duration",
37151             "description": ""
37152           },
37153           {
37154             "group": "Body",
37155             "type": "Integer",
37156             "optional": false,
37157             "field": "billsec",
37158             "description": ""
37159           },
37160           {
37161             "group": "Body",
37162             "type": "String",
37163             "optional": true,
37164             "field": "disposition",
37165             "description": ""
37166           },
37167           {
37168             "group": "Body",
37169             "type": "Integer",
37170             "optional": false,
37171             "field": "amaflags",
37172             "description": ""
37173           },
37174           {
37175             "group": "Body",
37176             "type": "String",
37177             "optional": true,
37178             "field": "accountcode",
37179             "description": ""
37180           },
37181           {
37182             "group": "Body",
37183             "type": "String",
37184             "optional": true,
37185             "field": "userfield",
37186             "description": ""
37187           },
37188           {
37189             "group": "Body",
37190             "type": "String",
37191             "optional": true,
37192             "field": "uniqueid",
37193             "description": ""
37194           },
37195           {
37196             "group": "Body",
37197             "type": "String",
37198             "optional": true,
37199             "field": "linkedid",
37200             "description": ""
37201           },
37202           {
37203             "group": "Body",
37204             "type": "String",
37205             "optional": true,
37206             "field": "sequence",
37207             "description": ""
37208           },
37209           {
37210             "group": "Body",
37211             "type": "String",
37212             "optional": true,
37213             "field": "peeraccount",
37214             "description": ""
37215           },
37216           {
37217             "group": "Body",
37218             "type": "String",
37219             "optional": true,
37220             "field": "type",
37221             "description": ""
37222           },
37223           {
37224             "group": "Body",
37225             "type": "String",
37226             "optional": true,
37227             "field": "tag",
37228             "description": ""
37229           }
37230         ]
37231       }
37232     },
37233     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37234     "version": "0.0.0",
37235     "filename": "server/api/cdr/index.js",
37236     "groupTitle": "cdr"
37237   },
37238   {
37239     "type": "delete",
37240     "url": "/api/cdr/{id}",
37241     "title": "Deletes a Cdr",
37242     "examples": [
37243       {
37244         "title": "Example usage:",
37245         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
37246         "type": "json"
37247       }
37248     ],
37249     "name": "DeleteCdrs",
37250     "group": "cdr",
37251     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37252     "version": "0.0.0",
37253     "filename": "server/api/cdr/index.js",
37254     "groupTitle": "cdr"
37255   },
37256   {
37257     "type": "get",
37258     "url": "/api/cdr/describe",
37259     "title": "Gets table info about Cdrs",
37260     "examples": [
37261       {
37262         "title": "Example usage:",
37263         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
37264         "type": "json"
37265       }
37266     ],
37267     "name": "DescribeCdrs",
37268     "group": "cdr",
37269     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37270     "version": "0.0.0",
37271     "filename": "server/api/cdr/index.js",
37272     "groupTitle": "cdr"
37273   },
37274   {
37275     "type": "get",
37276     "url": "/api/cdr",
37277     "title": "Gets a list of Cdrs",
37278     "examples": [
37279       {
37280         "title": "Example usage:",
37281         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
37282         "type": "json"
37283       }
37284     ],
37285     "name": "GetCdrs",
37286     "group": "cdr",
37287     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37288     "version": "0.0.0",
37289     "filename": "server/api/cdr/index.js",
37290     "groupTitle": "cdr"
37291   },
37292   {
37293     "type": "get",
37294     "url": "/api/cdr/{id}",
37295     "title": "Gets a single Cdr",
37296     "examples": [
37297       {
37298         "title": "Example usage:",
37299         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
37300         "type": "json"
37301       }
37302     ],
37303     "name": "ShowCdrs",
37304     "group": "cdr",
37305     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37306     "version": "0.0.0",
37307     "filename": "server/api/cdr/index.js",
37308     "groupTitle": "cdr"
37309   },
37310   {
37311     "type": "put",
37312     "url": "/api/cdr/{id}",
37313     "title": "Update an existing Cdr",
37314     "examples": [
37315       {
37316         "title": "Example usage:",
37317         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37318         "type": "json"
37319       }
37320     ],
37321     "name": "updateCdrs",
37322     "group": "cdr",
37323     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37324     "version": "0.0.0",
37325     "filename": "server/api/cdr/index.js",
37326     "groupTitle": "cdr"
37327   },
37328   {
37329     "type": "post",
37330     "url": "/api/voiceQueuesLog",
37331     "title": "Creates a new VoiceQueuesLog",
37332     "examples": [
37333       {
37334         "title": "Example usage:",
37335         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
37336         "type": "json"
37337       }
37338     ],
37339     "name": "CreateVoiceQueuesLogs",
37340     "group": "voiceQueuesLog",
37341     "parameter": {
37342       "fields": {
37343         "Body": [
37344           {
37345             "group": "Body",
37346             "type": "String",
37347             "optional": true,
37348             "field": "time",
37349             "description": ""
37350           },
37351           {
37352             "group": "Body",
37353             "type": "String",
37354             "optional": false,
37355             "field": "callid",
37356             "description": ""
37357           },
37358           {
37359             "group": "Body",
37360             "type": "String",
37361             "optional": false,
37362             "field": "queuename",
37363             "description": ""
37364           },
37365           {
37366             "group": "Body",
37367             "type": "String",
37368             "optional": false,
37369             "field": "agent",
37370             "description": ""
37371           },
37372           {
37373             "group": "Body",
37374             "type": "String",
37375             "optional": false,
37376             "field": "event",
37377             "description": ""
37378           },
37379           {
37380             "group": "Body",
37381             "type": "String",
37382             "optional": false,
37383             "field": "data",
37384             "description": ""
37385           },
37386           {
37387             "group": "Body",
37388             "type": "String",
37389             "optional": false,
37390             "field": "data1",
37391             "description": ""
37392           },
37393           {
37394             "group": "Body",
37395             "type": "String",
37396             "optional": false,
37397             "field": "data2",
37398             "description": ""
37399           },
37400           {
37401             "group": "Body",
37402             "type": "String",
37403             "optional": false,
37404             "field": "data3",
37405             "description": ""
37406           },
37407           {
37408             "group": "Body",
37409             "type": "String",
37410             "optional": false,
37411             "field": "data4",
37412             "description": ""
37413           },
37414           {
37415             "group": "Body",
37416             "type": "String",
37417             "optional": false,
37418             "field": "data5",
37419             "description": ""
37420           },
37421           {
37422             "group": "Body",
37423             "type": "String",
37424             "optional": false,
37425             "field": "dtm",
37426             "description": ""
37427           }
37428         ]
37429       }
37430     },
37431     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37432     "version": "0.0.0",
37433     "filename": "server/api/voiceQueuesLog/index.js",
37434     "groupTitle": "voiceQueuesLog"
37435   },
37436   {
37437     "type": "delete",
37438     "url": "/api/voiceQueuesLog/{id}",
37439     "title": "Deletes a VoiceQueuesLog",
37440     "examples": [
37441       {
37442         "title": "Example usage:",
37443         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
37444         "type": "json"
37445       }
37446     ],
37447     "name": "DeleteVoiceQueuesLogs",
37448     "group": "voiceQueuesLog",
37449     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37450     "version": "0.0.0",
37451     "filename": "server/api/voiceQueuesLog/index.js",
37452     "groupTitle": "voiceQueuesLog"
37453   },
37454   {
37455     "type": "get",
37456     "url": "/api/voiceQueuesLog",
37457     "title": "Gets a list of VoiceQueuesLogs",
37458     "examples": [
37459       {
37460         "title": "Example usage:",
37461         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
37462         "type": "json"
37463       }
37464     ],
37465     "name": "GetVoiceQueuesLogs",
37466     "group": "voiceQueuesLog",
37467     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
37468     "version": "0.0.0",
37469     "filename": "server/api/voiceQueuesLog/index.js",
37470     "groupTitle": "voiceQueuesLog"
37471   },
37472   {
37473     "type": "get",
37474     "url": "/api/voiceQueuesLog/{id}",
37475     "title": "Gets a single VoiceQueuesLog",
37476     "examples": [
37477       {
37478         "title": "Example usage:",
37479         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
37480         "type": "json"
37481       }
37482     ],
37483     "name": "ShowVoiceQueuesLogs",
37484     "group": "voiceQueuesLog",
37485     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37486     "version": "0.0.0",
37487     "filename": "server/api/voiceQueuesLog/index.js",
37488     "groupTitle": "voiceQueuesLog"
37489   },
37490   {
37491     "type": "put",
37492     "url": "/api/voiceQueuesLog/{id}",
37493     "title": "Update an existing VoiceQueuesLog",
37494     "examples": [
37495       {
37496         "title": "Example usage:",
37497         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
37498         "type": "json"
37499       }
37500     ],
37501     "name": "updateVoiceQueuesLogs",
37502     "group": "voiceQueuesLog",
37503     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
37504     "version": "0.0.0",
37505     "filename": "server/api/voiceQueuesLog/index.js",
37506     "groupTitle": "voiceQueuesLog"
37507   }
37508 ]