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": "note",
2188             "description": ""
2189           },
2190           {
2191             "group": "Body",
2192             "type": "String",
2193             "optional": true,
2194             "field": "browserName",
2195             "description": ""
2196           },
2197           {
2198             "group": "Body",
2199             "type": "String",
2200             "optional": true,
2201             "field": "browserVersion",
2202             "description": ""
2203           },
2204           {
2205             "group": "Body",
2206             "type": "String",
2207             "optional": true,
2208             "field": "osName",
2209             "description": ""
2210           },
2211           {
2212             "group": "Body",
2213             "type": "String",
2214             "optional": true,
2215             "field": "osVersion",
2216             "description": ""
2217           },
2218           {
2219             "group": "Body",
2220             "type": "String",
2221             "optional": true,
2222             "field": "deviceModel",
2223             "description": ""
2224           },
2225           {
2226             "group": "Body",
2227             "type": "String",
2228             "optional": true,
2229             "field": "deviceVendor",
2230             "description": ""
2231           },
2232           {
2233             "group": "Body",
2234             "type": "String",
2235             "optional": true,
2236             "field": "deviceType",
2237             "description": ""
2238           },
2239           {
2240             "group": "Body",
2241             "type": "Text",
2242             "optional": true,
2243             "field": "referer",
2244             "description": ""
2245           },
2246           {
2247             "group": "Body",
2248             "type": "String",
2249             "optional": true,
2250             "field": "customerIp",
2251             "description": ""
2252           },
2253           {
2254             "group": "Body",
2255             "type": "Text",
2256             "optional": true,
2257             "field": "formData",
2258             "description": ""
2259           },
2260           {
2261             "group": "Body",
2262             "type": "String",
2263             "optional": true,
2264             "field": "read1stAt",
2265             "description": ""
2266           },
2267           {
2268             "group": "Body",
2269             "type": "String",
2270             "optional": true,
2271             "field": "lastMsgAt",
2272             "description": ""
2273           },
2274           {
2275             "group": "Body",
2276             "type": "String",
2277             "allowedValues": [
2278               "\"in\"",
2279               "\"out\""
2280             ],
2281             "optional": false,
2282             "field": "lastMsgDirection",
2283             "description": ""
2284           },
2285           {
2286             "group": "Body",
2287             "type": "String",
2288             "optional": true,
2289             "field": "closeReason",
2290             "description": ""
2291           },
2292           {
2293             "group": "Body",
2294             "type": "String",
2295             "optional": true,
2296             "field": "customerPort",
2297             "description": ""
2298           }
2299         ]
2300       }
2301     },
2302     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2303     "version": "0.0.0",
2304     "filename": "server/api/chatInteraction/index.js",
2305     "groupTitle": "Chat_Interactions"
2306   },
2307   {
2308     "type": "delete",
2309     "url": "/api/chat/interactions/{id}",
2310     "title": "Deletes a Interaction",
2311     "examples": [
2312       {
2313         "title": "Example usage:",
2314         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password} -X DELETE",
2315         "type": "json"
2316       }
2317     ],
2318     "name": "DeleteInteractions",
2319     "group": "Chat_Interactions",
2320     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2321     "version": "0.0.0",
2322     "filename": "server/api/chatInteraction/index.js",
2323     "groupTitle": "Chat_Interactions"
2324   },
2325   {
2326     "type": "get",
2327     "url": "/api/chat/interactions/describe",
2328     "title": "Gets table info about Interactions",
2329     "examples": [
2330       {
2331         "title": "Example usage:",
2332         "content": "curl https://{domain}/api/chat/interactions/describe -v -u {name}:{password}",
2333         "type": "json"
2334       }
2335     ],
2336     "name": "DescribeInteractions",
2337     "group": "Chat_Interactions",
2338     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2339     "version": "0.0.0",
2340     "filename": "server/api/chatInteraction/index.js",
2341     "groupTitle": "Chat_Interactions"
2342   },
2343   {
2344     "type": "get",
2345     "url": "/api/chat/interactions",
2346     "title": "Gets a list of Interactions",
2347     "examples": [
2348       {
2349         "title": "Example usage:",
2350         "content": "curl https://{domain}/api/chat/interactions -v -u {name}:{password}",
2351         "type": "json"
2352       }
2353     ],
2354     "name": "GetInteractions",
2355     "group": "Chat_Interactions",
2356     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2357     "version": "0.0.0",
2358     "filename": "server/api/chatInteraction/index.js",
2359     "groupTitle": "Chat_Interactions"
2360   },
2361   {
2362     "type": "delete",
2363     "url": "/api/chat/interactions/{id}/tags",
2364     "title": "Removes tags from interaction",
2365     "examples": [
2366       {
2367         "title": "Example usage:",
2368         "content": "curl https://{domain}/api/chat/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
2369         "type": "json"
2370       }
2371     ],
2372     "name": "RemoveTags",
2373     "group": "Chat_Interactions",
2374     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2375     "version": "0.0.0",
2376     "filename": "server/api/chatInteraction/index.js",
2377     "groupTitle": "Chat_Interactions"
2378   },
2379   {
2380     "type": "get",
2381     "url": "/api/chat/interactions/{id}",
2382     "title": "Gets a single Interaction",
2383     "examples": [
2384       {
2385         "title": "Example usage:",
2386         "content": "curl https://{domain}/api/chat/interactions/{id} -v -u {name}:{password}",
2387         "type": "json"
2388       }
2389     ],
2390     "name": "ShowInteractions",
2391     "group": "Chat_Interactions",
2392     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2393     "version": "0.0.0",
2394     "filename": "server/api/chatInteraction/index.js",
2395     "groupTitle": "Chat_Interactions"
2396   },
2397   {
2398     "type": "put",
2399     "url": "/api/chat/interactions/{id}/abandon",
2400     "title": "Abandon interaction",
2401     "examples": [
2402       {
2403         "title": "Example usage:",
2404         "content": "curl https://{domain}/api/chat/interactions/{id}/abandon -d '{\"channel\": \"chat\", \"...\": \"...\"}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
2405         "type": "json"
2406       }
2407     ],
2408     "name": "abandon",
2409     "group": "Chat_Interactions",
2410     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2411     "version": "0.0.0",
2412     "filename": "server/api/chatInteraction/index.js",
2413     "groupTitle": "Chat_Interactions"
2414   },
2415   {
2416     "type": "put",
2417     "url": "/api/chat/interactions/{id}/close",
2418     "title": "Close Interaction",
2419     "examples": [
2420       {
2421         "title": "Example usage:",
2422         "content": "curl https://{domain}/api/chat/interactions/{id}/close -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2423         "type": "json"
2424       }
2425     ],
2426     "name": "addMessage",
2427     "group": "Chat_Interactions",
2428     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2429     "version": "0.0.0",
2430     "filename": "server/api/chatInteraction/index.js",
2431     "groupTitle": "Chat_Interactions"
2432   },
2433   {
2434     "type": "post",
2435     "url": "/api/chat/interactions/{id}/messages",
2436     "title": "Creates new messages",
2437     "examples": [
2438       {
2439         "title": "Example usage:",
2440         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
2441         "type": "json"
2442       }
2443     ],
2444     "name": "addMessage",
2445     "group": "Chat_Interactions",
2446     "parameter": {
2447       "fields": {
2448         "Body": [
2449           {
2450             "group": "Body",
2451             "type": "Text",
2452             "optional": false,
2453             "field": "body",
2454             "description": ""
2455           },
2456           {
2457             "group": "Body",
2458             "type": "Boolean",
2459             "optional": true,
2460             "field": "read",
2461             "description": ""
2462           },
2463           {
2464             "group": "Body",
2465             "type": "Boolean",
2466             "optional": true,
2467             "field": "secret",
2468             "description": ""
2469           },
2470           {
2471             "group": "Body",
2472             "type": "String",
2473             "allowedValues": [
2474               "\"in\"",
2475               "\"out\""
2476             ],
2477             "optional": false,
2478             "field": "direction",
2479             "description": ""
2480           },
2481           {
2482             "group": "Body",
2483             "type": "String",
2484             "optional": true,
2485             "field": "readAt",
2486             "description": ""
2487           }
2488         ]
2489       }
2490     },
2491     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2492     "version": "0.0.0",
2493     "filename": "server/api/chatInteraction/index.js",
2494     "groupTitle": "Chat_Interactions"
2495   },
2496   {
2497     "type": "post",
2498     "url": "/api/chat/interactions/{id}/attachment_upload",
2499     "title": "Add attachment",
2500     "examples": [
2501       {
2502         "title": "Example usage:",
2503         "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",
2504         "type": "json"
2505       }
2506     ],
2507     "name": "attachmentUpload",
2508     "group": "Chat_Interactions",
2509     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2510     "version": "0.0.0",
2511     "filename": "server/api/chatInteraction/index.js",
2512     "groupTitle": "Chat_Interactions"
2513   },
2514   {
2515     "type": "put",
2516     "url": "/api/chat/interactions/{id}/custom_update",
2517     "title": "Update interaction",
2518     "examples": [
2519       {
2520         "title": "Example usage:",
2521         "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",
2522         "type": "json"
2523       }
2524     ],
2525     "name": "customUpdate",
2526     "group": "Chat_Interactions",
2527     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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>",
2528     "version": "0.0.0",
2529     "filename": "server/api/chatInteraction/index.js",
2530     "groupTitle": "Chat_Interactions"
2531   },
2532   {
2533     "type": "get",
2534     "url": "/api/chat/interactions/{id}/download",
2535     "title": "Gets interaction",
2536     "examples": [
2537       {
2538         "title": "Example usage:",
2539         "content": "curl https://{domain}/api/chat/interactions/{id}/download -v -u {name}:{password} -X GET",
2540         "type": "json"
2541       }
2542     ],
2543     "name": "download",
2544     "group": "Chat_Interactions",
2545     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2546     "version": "0.0.0",
2547     "filename": "server/api/chatInteraction/index.js",
2548     "groupTitle": "Chat_Interactions"
2549   },
2550   {
2551     "type": "get",
2552     "url": "/api/chat/interactions/{id}/messages",
2553     "title": "Gets interaction messages",
2554     "examples": [
2555       {
2556         "title": "Example usage:",
2557         "content": "curl https://{domain}/api/chat/interactions/{id}/messages -v -u {name}:{password} -X GET",
2558         "type": "json"
2559       }
2560     ],
2561     "name": "getMessages",
2562     "group": "Chat_Interactions",
2563     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2564     "version": "0.0.0",
2565     "filename": "server/api/chatInteraction/index.js",
2566     "groupTitle": "Chat_Interactions"
2567   },
2568   {
2569     "type": "get",
2570     "url": "/api/chat/interactions/{id}/my_messages",
2571     "title": "Gets interaction messages",
2572     "examples": [
2573       {
2574         "title": "Example usage:",
2575         "content": "curl https://{domain}/api/chat/interactions/{id}/my_messages -v -u {name}:{password} -X GET",
2576         "type": "json"
2577       }
2578     ],
2579     "name": "getMyMessages",
2580     "group": "Chat_Interactions",
2581     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2582     "version": "0.0.0",
2583     "filename": "server/api/chatInteraction/index.js",
2584     "groupTitle": "Chat_Interactions"
2585   },
2586   {
2587     "type": "put",
2588     "url": "/api/chat/interactions/{id}",
2589     "title": "Update an existing Interaction",
2590     "examples": [
2591       {
2592         "title": "Example usage:",
2593         "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",
2594         "type": "json"
2595       }
2596     ],
2597     "name": "updateInteractions",
2598     "group": "Chat_Interactions",
2599     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2600     "version": "0.0.0",
2601     "filename": "server/api/chatInteraction/index.js",
2602     "groupTitle": "Chat_Interactions"
2603   },
2604   {
2605     "type": "post",
2606     "url": "/api/chat/internal/messages",
2607     "title": "Creates a new Message",
2608     "examples": [
2609       {
2610         "title": "Example usage:",
2611         "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",
2612         "type": "json"
2613       }
2614     ],
2615     "name": "CreateMessages",
2616     "group": "Chat_Internal_Messages",
2617     "parameter": {
2618       "fields": {
2619         "Body": [
2620           {
2621             "group": "Body",
2622             "type": "Text",
2623             "optional": false,
2624             "field": "body",
2625             "description": ""
2626           },
2627           {
2628             "group": "Body",
2629             "type": "Boolean",
2630             "optional": true,
2631             "field": "read",
2632             "description": ""
2633           },
2634           {
2635             "group": "Body",
2636             "type": "Integer",
2637             "optional": true,
2638             "field": "ChatInternalMessageId",
2639             "description": ""
2640           }
2641         ]
2642       }
2643     },
2644     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2645     "version": "0.0.0",
2646     "filename": "server/api/chatInternalMessage/index.js",
2647     "groupTitle": "Chat_Internal_Messages"
2648   },
2649   {
2650     "type": "delete",
2651     "url": "/api/chat/internal/messages/{id}",
2652     "title": "Deletes a Message",
2653     "examples": [
2654       {
2655         "title": "Example usage:",
2656         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password} -X DELETE",
2657         "type": "json"
2658       }
2659     ],
2660     "name": "DeleteMessages",
2661     "group": "Chat_Internal_Messages",
2662     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2663     "version": "0.0.0",
2664     "filename": "server/api/chatInternalMessage/index.js",
2665     "groupTitle": "Chat_Internal_Messages"
2666   },
2667   {
2668     "type": "get",
2669     "url": "/api/chat/internal/messages/describe",
2670     "title": "Gets table info about Messages",
2671     "examples": [
2672       {
2673         "title": "Example usage:",
2674         "content": "curl https://{domain}/api/chat/internal/messages/describe -v -u {name}:{password}",
2675         "type": "json"
2676       }
2677     ],
2678     "name": "DescribeMessages",
2679     "group": "Chat_Internal_Messages",
2680     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2681     "version": "0.0.0",
2682     "filename": "server/api/chatInternalMessage/index.js",
2683     "groupTitle": "Chat_Internal_Messages"
2684   },
2685   {
2686     "type": "get",
2687     "url": "/api/chat/internal/messages",
2688     "title": "Gets a list of Messages",
2689     "examples": [
2690       {
2691         "title": "Example usage:",
2692         "content": "curl https://{domain}/api/chat/internal/messages -v -u {name}:{password}",
2693         "type": "json"
2694       }
2695     ],
2696     "name": "GetMessages",
2697     "group": "Chat_Internal_Messages",
2698     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2699     "version": "0.0.0",
2700     "filename": "server/api/chatInternalMessage/index.js",
2701     "groupTitle": "Chat_Internal_Messages"
2702   },
2703   {
2704     "type": "get",
2705     "url": "/api/chat/internal/messages/{id}",
2706     "title": "Gets a single Message",
2707     "examples": [
2708       {
2709         "title": "Example usage:",
2710         "content": "curl https://{domain}/api/chat/internal/messages/{id} -v -u {name}:{password}",
2711         "type": "json"
2712       }
2713     ],
2714     "name": "ShowMessages",
2715     "group": "Chat_Internal_Messages",
2716     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2717     "version": "0.0.0",
2718     "filename": "server/api/chatInternalMessage/index.js",
2719     "groupTitle": "Chat_Internal_Messages"
2720   },
2721   {
2722     "type": "put",
2723     "url": "/api/chat/internal/messages/{id}",
2724     "title": "Update an existing Message",
2725     "examples": [
2726       {
2727         "title": "Example usage:",
2728         "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",
2729         "type": "json"
2730       }
2731     ],
2732     "name": "updateMessages",
2733     "group": "Chat_Internal_Messages",
2734     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2735     "version": "0.0.0",
2736     "filename": "server/api/chatInternalMessage/index.js",
2737     "groupTitle": "Chat_Internal_Messages"
2738   },
2739   {
2740     "type": "post",
2741     "url": "/api/chat/messages",
2742     "title": "Creates a new Message",
2743     "examples": [
2744       {
2745         "title": "Example usage:",
2746         "content": "curl https://{domain}/api/chat/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
2747         "type": "json"
2748       }
2749     ],
2750     "name": "CreateMessages",
2751     "group": "Chat_Messages",
2752     "parameter": {
2753       "fields": {
2754         "Body": [
2755           {
2756             "group": "Body",
2757             "type": "Text",
2758             "optional": false,
2759             "field": "body",
2760             "description": ""
2761           },
2762           {
2763             "group": "Body",
2764             "type": "Boolean",
2765             "optional": true,
2766             "field": "read",
2767             "description": ""
2768           },
2769           {
2770             "group": "Body",
2771             "type": "Boolean",
2772             "optional": true,
2773             "field": "secret",
2774             "description": ""
2775           },
2776           {
2777             "group": "Body",
2778             "type": "String",
2779             "allowedValues": [
2780               "\"in\"",
2781               "\"out\""
2782             ],
2783             "optional": false,
2784             "field": "direction",
2785             "description": ""
2786           },
2787           {
2788             "group": "Body",
2789             "type": "String",
2790             "optional": true,
2791             "field": "readAt",
2792             "description": ""
2793           }
2794         ]
2795       }
2796     },
2797     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2798     "version": "0.0.0",
2799     "filename": "server/api/chatMessage/index.js",
2800     "groupTitle": "Chat_Messages"
2801   },
2802   {
2803     "type": "delete",
2804     "url": "/api/chat/messages/{id}",
2805     "title": "Deletes a Message",
2806     "examples": [
2807       {
2808         "title": "Example usage:",
2809         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password} -X DELETE",
2810         "type": "json"
2811       }
2812     ],
2813     "name": "DeleteMessages",
2814     "group": "Chat_Messages",
2815     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2816     "version": "0.0.0",
2817     "filename": "server/api/chatMessage/index.js",
2818     "groupTitle": "Chat_Messages"
2819   },
2820   {
2821     "type": "get",
2822     "url": "/api/chat/messages/describe",
2823     "title": "Gets table info about Messages",
2824     "examples": [
2825       {
2826         "title": "Example usage:",
2827         "content": "curl https://{domain}/api/chat/messages/describe -v -u {name}:{password}",
2828         "type": "json"
2829       }
2830     ],
2831     "name": "DescribeMessages",
2832     "group": "Chat_Messages",
2833     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2834     "version": "0.0.0",
2835     "filename": "server/api/chatMessage/index.js",
2836     "groupTitle": "Chat_Messages"
2837   },
2838   {
2839     "type": "get",
2840     "url": "/api/chat/messages",
2841     "title": "Gets a list of Messages",
2842     "examples": [
2843       {
2844         "title": "Example usage:",
2845         "content": "curl https://{domain}/api/chat/messages -v -u {name}:{password}",
2846         "type": "json"
2847       }
2848     ],
2849     "name": "GetMessages",
2850     "group": "Chat_Messages",
2851     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2852     "version": "0.0.0",
2853     "filename": "server/api/chatMessage/index.js",
2854     "groupTitle": "Chat_Messages"
2855   },
2856   {
2857     "type": "get",
2858     "url": "/api/chat/messages/{id}",
2859     "title": "Gets a single Message",
2860     "examples": [
2861       {
2862         "title": "Example usage:",
2863         "content": "curl https://{domain}/api/chat/messages/{id} -v -u {name}:{password}",
2864         "type": "json"
2865       }
2866     ],
2867     "name": "ShowMessages",
2868     "group": "Chat_Messages",
2869     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2870     "version": "0.0.0",
2871     "filename": "server/api/chatMessage/index.js",
2872     "groupTitle": "Chat_Messages"
2873   },
2874   {
2875     "type": "put",
2876     "url": "/api/chat/messages/{id}",
2877     "title": "Update an existing Message",
2878     "examples": [
2879       {
2880         "title": "Example usage:",
2881         "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",
2882         "type": "json"
2883       }
2884     ],
2885     "name": "updateMessages",
2886     "group": "Chat_Messages",
2887     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2888     "version": "0.0.0",
2889     "filename": "server/api/chatMessage/index.js",
2890     "groupTitle": "Chat_Messages"
2891   },
2892   {
2893     "type": "post",
2894     "url": "/api/chat/offline_messages",
2895     "title": "Creates a new OfflineMessage",
2896     "examples": [
2897       {
2898         "title": "Example usage:",
2899         "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",
2900         "type": "json"
2901       }
2902     ],
2903     "name": "CreateOfflineMessages",
2904     "group": "Chat_Offline_Messages",
2905     "parameter": {
2906       "fields": {
2907         "Body": [
2908           {
2909             "group": "Body",
2910             "type": "Text",
2911             "optional": false,
2912             "field": "body",
2913             "description": ""
2914           }
2915         ]
2916       }
2917     },
2918     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2919     "version": "0.0.0",
2920     "filename": "server/api/chatOfflineMessage/index.js",
2921     "groupTitle": "Chat_Offline_Messages"
2922   },
2923   {
2924     "type": "delete",
2925     "url": "/api/chat/offline_messages/{id}",
2926     "title": "Deletes a OfflineMessage",
2927     "examples": [
2928       {
2929         "title": "Example usage:",
2930         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password} -X DELETE",
2931         "type": "json"
2932       }
2933     ],
2934     "name": "DeleteOfflineMessages",
2935     "group": "Chat_Offline_Messages",
2936     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2937     "version": "0.0.0",
2938     "filename": "server/api/chatOfflineMessage/index.js",
2939     "groupTitle": "Chat_Offline_Messages"
2940   },
2941   {
2942     "type": "get",
2943     "url": "/api/chat/offline_messages/describe",
2944     "title": "Gets table info about OfflineMessages",
2945     "examples": [
2946       {
2947         "title": "Example usage:",
2948         "content": "curl https://{domain}/api/chat/offline_messages/describe -v -u {name}:{password}",
2949         "type": "json"
2950       }
2951     ],
2952     "name": "DescribeOfflineMessages",
2953     "group": "Chat_Offline_Messages",
2954     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2955     "version": "0.0.0",
2956     "filename": "server/api/chatOfflineMessage/index.js",
2957     "groupTitle": "Chat_Offline_Messages"
2958   },
2959   {
2960     "type": "get",
2961     "url": "/api/chat/offline_messages",
2962     "title": "Gets a list of OfflineMessages",
2963     "examples": [
2964       {
2965         "title": "Example usage:",
2966         "content": "curl https://{domain}/api/chat/offline_messages -v -u {name}:{password}",
2967         "type": "json"
2968       }
2969     ],
2970     "name": "GetOfflineMessages",
2971     "group": "Chat_Offline_Messages",
2972     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
2973     "version": "0.0.0",
2974     "filename": "server/api/chatOfflineMessage/index.js",
2975     "groupTitle": "Chat_Offline_Messages"
2976   },
2977   {
2978     "type": "get",
2979     "url": "/api/chat/offline_messages/{id}",
2980     "title": "Gets a single OfflineMessage",
2981     "examples": [
2982       {
2983         "title": "Example usage:",
2984         "content": "curl https://{domain}/api/chat/offline_messages/{id} -v -u {name}:{password}",
2985         "type": "json"
2986       }
2987     ],
2988     "name": "ShowOfflineMessages",
2989     "group": "Chat_Offline_Messages",
2990     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
2991     "version": "0.0.0",
2992     "filename": "server/api/chatOfflineMessage/index.js",
2993     "groupTitle": "Chat_Offline_Messages"
2994   },
2995   {
2996     "type": "put",
2997     "url": "/api/chat/offline_messages/{id}",
2998     "title": "Update an existing OfflineMessage",
2999     "examples": [
3000       {
3001         "title": "Example usage:",
3002         "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",
3003         "type": "json"
3004       }
3005     ],
3006     "name": "updateOfflineMessages",
3007     "group": "Chat_Offline_Messages",
3008     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3009     "version": "0.0.0",
3010     "filename": "server/api/chatOfflineMessage/index.js",
3011     "groupTitle": "Chat_Offline_Messages"
3012   },
3013   {
3014     "type": "post",
3015     "url": "/api/chat/proactive_actions",
3016     "title": "Creates a new Proactive Action",
3017     "examples": [
3018       {
3019         "title": "Example usage:",
3020         "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",
3021         "type": "json"
3022       }
3023     ],
3024     "name": "CreateProactive_Actions",
3025     "group": "Chat_Proactive_Actions",
3026     "parameter": {
3027       "fields": {
3028         "Body": [
3029           {
3030             "group": "Body",
3031             "type": "String",
3032             "optional": false,
3033             "field": "name",
3034             "description": ""
3035           },
3036           {
3037             "group": "Body",
3038             "type": "String",
3039             "allowedValues": [
3040               "\"mouseOver\"",
3041               "\"timeout\""
3042             ],
3043             "optional": true,
3044             "field": "type",
3045             "description": ""
3046           },
3047           {
3048             "group": "Body",
3049             "type": "String",
3050             "optional": true,
3051             "field": "selector",
3052             "description": ""
3053           },
3054           {
3055             "group": "Body",
3056             "type": "Integer",
3057             "optional": true,
3058             "field": "timeout",
3059             "description": ""
3060           }
3061         ]
3062       }
3063     },
3064     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3065     "version": "0.0.0",
3066     "filename": "server/api/chatProactiveAction/index.js",
3067     "groupTitle": "Chat_Proactive_Actions"
3068   },
3069   {
3070     "type": "delete",
3071     "url": "/api/chat/proactive_actions/{id}",
3072     "title": "Deletes a Proactive Action",
3073     "examples": [
3074       {
3075         "title": "Example usage:",
3076         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password} -X DELETE",
3077         "type": "json"
3078       }
3079     ],
3080     "name": "DeleteProactive_Actions",
3081     "group": "Chat_Proactive_Actions",
3082     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3083     "version": "0.0.0",
3084     "filename": "server/api/chatProactiveAction/index.js",
3085     "groupTitle": "Chat_Proactive_Actions"
3086   },
3087   {
3088     "type": "get",
3089     "url": "/api/chat/proactive_actions/{id}",
3090     "title": "Gets a single Proactive Action",
3091     "examples": [
3092       {
3093         "title": "Example usage:",
3094         "content": "curl https://{domain}/api/chat/proactive_actions/{id} -v -u {name}:{password}",
3095         "type": "json"
3096       }
3097     ],
3098     "name": "ShowProactive_Actions",
3099     "group": "Chat_Proactive_Actions",
3100     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3101     "version": "0.0.0",
3102     "filename": "server/api/chatProactiveAction/index.js",
3103     "groupTitle": "Chat_Proactive_Actions"
3104   },
3105   {
3106     "type": "put",
3107     "url": "/api/chat/proactive_actions/{id}",
3108     "title": "Update an existing Proactive Action",
3109     "examples": [
3110       {
3111         "title": "Example usage:",
3112         "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",
3113         "type": "json"
3114       }
3115     ],
3116     "name": "updateProactive_Actions",
3117     "group": "Chat_Proactive_Actions",
3118     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3119     "version": "0.0.0",
3120     "filename": "server/api/chatProactiveAction/index.js",
3121     "groupTitle": "Chat_Proactive_Actions"
3122   },
3123   {
3124     "type": "post",
3125     "url": "/api/chat/reports/queue",
3126     "title": "Creates a new Chat Queue Report",
3127     "examples": [
3128       {
3129         "title": "Example usage:",
3130         "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",
3131         "type": "json"
3132       }
3133     ],
3134     "name": "CreateChat_Queue_Reports",
3135     "group": "Chat_Queue_Reports",
3136     "parameter": {
3137       "fields": {
3138         "Body": [
3139           {
3140             "group": "Body",
3141             "type": "String",
3142             "optional": false,
3143             "field": "uniqueid",
3144             "description": ""
3145           },
3146           {
3147             "group": "Body",
3148             "type": "String",
3149             "optional": true,
3150             "field": "from",
3151             "description": ""
3152           },
3153           {
3154             "group": "Body",
3155             "type": "String",
3156             "optional": true,
3157             "field": "joinAt",
3158             "description": ""
3159           },
3160           {
3161             "group": "Body",
3162             "type": "String",
3163             "optional": true,
3164             "field": "leaveAt",
3165             "description": ""
3166           },
3167           {
3168             "group": "Body",
3169             "type": "String",
3170             "optional": true,
3171             "field": "acceptAt",
3172             "description": ""
3173           },
3174           {
3175             "group": "Body",
3176             "type": "String",
3177             "optional": true,
3178             "field": "exitAt",
3179             "description": ""
3180           },
3181           {
3182             "group": "Body",
3183             "type": "String",
3184             "optional": true,
3185             "field": "reason",
3186             "description": ""
3187           }
3188         ]
3189       }
3190     },
3191     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3192     "version": "0.0.0",
3193     "filename": "server/api/chatQueueReport/index.js",
3194     "groupTitle": "Chat_Queue_Reports"
3195   },
3196   {
3197     "type": "delete",
3198     "url": "/api/chat/reports/queue/{id}",
3199     "title": "Deletes a Chat Queue Report",
3200     "examples": [
3201       {
3202         "title": "Example usage:",
3203         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password} -X DELETE",
3204         "type": "json"
3205       }
3206     ],
3207     "name": "DeleteChat_Queue_Reports",
3208     "group": "Chat_Queue_Reports",
3209     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3210     "version": "0.0.0",
3211     "filename": "server/api/chatQueueReport/index.js",
3212     "groupTitle": "Chat_Queue_Reports"
3213   },
3214   {
3215     "type": "get",
3216     "url": "/api/chat/reports/queue/describe",
3217     "title": "Gets table info about Chat Queue Reports",
3218     "examples": [
3219       {
3220         "title": "Example usage:",
3221         "content": "curl https://{domain}/api/chat/reports/queue/describe -v -u {name}:{password}",
3222         "type": "json"
3223       }
3224     ],
3225     "name": "DescribeChat_Queue_Reports",
3226     "group": "Chat_Queue_Reports",
3227     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3228     "version": "0.0.0",
3229     "filename": "server/api/chatQueueReport/index.js",
3230     "groupTitle": "Chat_Queue_Reports"
3231   },
3232   {
3233     "type": "get",
3234     "url": "/api/chat/reports/queue",
3235     "title": "Gets a list of Chat Queue Reports",
3236     "examples": [
3237       {
3238         "title": "Example usage:",
3239         "content": "curl https://{domain}/api/chat/reports/queue -v -u {name}:{password}",
3240         "type": "json"
3241       }
3242     ],
3243     "name": "GetChat_Queue_Reports",
3244     "group": "Chat_Queue_Reports",
3245     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3246     "version": "0.0.0",
3247     "filename": "server/api/chatQueueReport/index.js",
3248     "groupTitle": "Chat_Queue_Reports"
3249   },
3250   {
3251     "type": "get",
3252     "url": "/api/chat/reports/queue/{id}",
3253     "title": "Gets a single Chat Queue Report",
3254     "examples": [
3255       {
3256         "title": "Example usage:",
3257         "content": "curl https://{domain}/api/chat/reports/queue/{id} -v -u {name}:{password}",
3258         "type": "json"
3259       }
3260     ],
3261     "name": "ShowChat_Queue_Reports",
3262     "group": "Chat_Queue_Reports",
3263     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3264     "version": "0.0.0",
3265     "filename": "server/api/chatQueueReport/index.js",
3266     "groupTitle": "Chat_Queue_Reports"
3267   },
3268   {
3269     "type": "put",
3270     "url": "/api/chat/reports/queue/{id}",
3271     "title": "Update an existing Chat Queue Report",
3272     "examples": [
3273       {
3274         "title": "Example usage:",
3275         "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",
3276         "type": "json"
3277       }
3278     ],
3279     "name": "updateChat_Queue_Reports",
3280     "group": "Chat_Queue_Reports",
3281     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3282     "version": "0.0.0",
3283     "filename": "server/api/chatQueueReport/index.js",
3284     "groupTitle": "Chat_Queue_Reports"
3285   },
3286   {
3287     "type": "post",
3288     "url": "/api/chat/queues/{id}/users",
3289     "title": "Add agents to a queue",
3290     "examples": [
3291       {
3292         "title": "Example usage:",
3293         "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",
3294         "type": "json"
3295       }
3296     ],
3297     "name": "AddAgents",
3298     "group": "Chat_Queues",
3299     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3300     "version": "0.0.0",
3301     "filename": "server/api/chatQueue/index.js",
3302     "groupTitle": "Chat_Queues"
3303   },
3304   {
3305     "type": "post",
3306     "url": "/api/chat/queues/{id}/teams",
3307     "title": "Add teams to a queue",
3308     "examples": [
3309       {
3310         "title": "Example usage:",
3311         "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",
3312         "type": "json"
3313       }
3314     ],
3315     "name": "AddTeams",
3316     "group": "Chat_Queues",
3317     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3318     "version": "0.0.0",
3319     "filename": "server/api/chatQueue/index.js",
3320     "groupTitle": "Chat_Queues"
3321   },
3322   {
3323     "type": "post",
3324     "url": "/api/chat/queues",
3325     "title": "Creates a new Queue",
3326     "examples": [
3327       {
3328         "title": "Example usage:",
3329         "content": "curl https://{domain}/api/chat/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3330         "type": "json"
3331       }
3332     ],
3333     "name": "CreateQueues",
3334     "group": "Chat_Queues",
3335     "parameter": {
3336       "fields": {
3337         "Body": [
3338           {
3339             "group": "Body",
3340             "type": "String",
3341             "optional": false,
3342             "field": "name",
3343             "description": ""
3344           },
3345           {
3346             "group": "Body",
3347             "type": "String",
3348             "optional": true,
3349             "field": "description",
3350             "description": ""
3351           },
3352           {
3353             "group": "Body",
3354             "type": "Integer",
3355             "optional": true,
3356             "field": "timeout",
3357             "description": ""
3358           },
3359           {
3360             "group": "Body",
3361             "type": "String",
3362             "allowedValues": [
3363               "\"rrmemory\"",
3364               "\"beepall\"",
3365               "\"roundrobin\""
3366             ],
3367             "optional": true,
3368             "field": "strategy",
3369             "description": ""
3370           }
3371         ]
3372       }
3373     },
3374     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3375     "version": "0.0.0",
3376     "filename": "server/api/chatQueue/index.js",
3377     "groupTitle": "Chat_Queues"
3378   },
3379   {
3380     "type": "delete",
3381     "url": "/api/chat/queues/{id}",
3382     "title": "Deletes a Queue",
3383     "examples": [
3384       {
3385         "title": "Example usage:",
3386         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password} -X DELETE",
3387         "type": "json"
3388       }
3389     ],
3390     "name": "DeleteQueues",
3391     "group": "Chat_Queues",
3392     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3393     "version": "0.0.0",
3394     "filename": "server/api/chatQueue/index.js",
3395     "groupTitle": "Chat_Queues"
3396   },
3397   {
3398     "type": "get",
3399     "url": "/api/chat/queues/describe",
3400     "title": "Gets table info about Queues",
3401     "examples": [
3402       {
3403         "title": "Example usage:",
3404         "content": "curl https://{domain}/api/chat/queues/describe -v -u {name}:{password}",
3405         "type": "json"
3406       }
3407     ],
3408     "name": "DescribeQueues",
3409     "group": "Chat_Queues",
3410     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3411     "version": "0.0.0",
3412     "filename": "server/api/chatQueue/index.js",
3413     "groupTitle": "Chat_Queues"
3414   },
3415   {
3416     "type": "get",
3417     "url": "/api/chat/queues/{id}/users",
3418     "title": "Gets queue agents",
3419     "examples": [
3420       {
3421         "title": "Example usage:",
3422         "content": "curl https://{domain}/api/chat/queues/{id}/users -v -u {name}:{password} -X POST",
3423         "type": "json"
3424       }
3425     ],
3426     "name": "GetAgents",
3427     "group": "Chat_Queues",
3428     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3429     "version": "0.0.0",
3430     "filename": "server/api/chatQueue/index.js",
3431     "groupTitle": "Chat_Queues"
3432   },
3433   {
3434     "type": "get",
3435     "url": "/api/chat/queues/{id}/members",
3436     "title": "GetMembers",
3437     "examples": [
3438       {
3439         "title": "Example usage:",
3440         "content": "curl https://{domain}/api/chat/queues/{id}/members  -v -u {name}:{password}",
3441         "type": "json"
3442       }
3443     ],
3444     "name": "GetMembers",
3445     "group": "Chat_Queues",
3446     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3447     "version": "0.0.0",
3448     "filename": "server/api/chatQueue/index.js",
3449     "groupTitle": "Chat_Queues"
3450   },
3451   {
3452     "type": "get",
3453     "url": "/api/chat/queues",
3454     "title": "Gets a list of Queues",
3455     "examples": [
3456       {
3457         "title": "Example usage:",
3458         "content": "curl https://{domain}/api/chat/queues -v -u {name}:{password}",
3459         "type": "json"
3460       }
3461     ],
3462     "name": "GetQueues",
3463     "group": "Chat_Queues",
3464     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3465     "version": "0.0.0",
3466     "filename": "server/api/chatQueue/index.js",
3467     "groupTitle": "Chat_Queues"
3468   },
3469   {
3470     "type": "get",
3471     "url": "/api/chat/queues/{id}/teams",
3472     "title": "Gets queues list",
3473     "examples": [
3474       {
3475         "title": "Example usage:",
3476         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password}",
3477         "type": "json"
3478       }
3479     ],
3480     "name": "GetTeams",
3481     "group": "Chat_Queues",
3482     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3483     "version": "0.0.0",
3484     "filename": "server/api/chatQueue/index.js",
3485     "groupTitle": "Chat_Queues"
3486   },
3487   {
3488     "type": "delete",
3489     "url": "/api/chat/queues/{id}/users",
3490     "title": "Removes agents from a queue",
3491     "examples": [
3492       {
3493         "title": "Example usage:",
3494         "content": "curl https://{domain}/api/chat/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
3495         "type": "json"
3496       }
3497     ],
3498     "name": "RemoveAgents",
3499     "group": "Chat_Queues",
3500     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3501     "version": "0.0.0",
3502     "filename": "server/api/chatQueue/index.js",
3503     "groupTitle": "Chat_Queues"
3504   },
3505   {
3506     "type": "get",
3507     "url": "/api/chat/queues/{id}",
3508     "title": "Gets a single Queue",
3509     "examples": [
3510       {
3511         "title": "Example usage:",
3512         "content": "curl https://{domain}/api/chat/queues/{id} -v -u {name}:{password}",
3513         "type": "json"
3514       }
3515     ],
3516     "name": "ShowQueues",
3517     "group": "Chat_Queues",
3518     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3519     "version": "0.0.0",
3520     "filename": "server/api/chatQueue/index.js",
3521     "groupTitle": "Chat_Queues"
3522   },
3523   {
3524     "type": "put",
3525     "url": "/api/chat/queues/{id}",
3526     "title": "Update an existing Queue",
3527     "examples": [
3528       {
3529         "title": "Example usage:",
3530         "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",
3531         "type": "json"
3532       }
3533     ],
3534     "name": "updateQueues",
3535     "group": "Chat_Queues",
3536     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3537     "version": "0.0.0",
3538     "filename": "server/api/chatQueue/index.js",
3539     "groupTitle": "Chat_Queues"
3540   },
3541   {
3542     "type": "post",
3543     "url": "/api/chat/reports/transfer",
3544     "title": "Creates a new Chat Transfer Report",
3545     "examples": [
3546       {
3547         "title": "Example usage:",
3548         "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",
3549         "type": "json"
3550       }
3551     ],
3552     "name": "CreateChat_Transfer_Reports",
3553     "group": "Chat_Transfer_Reports",
3554     "parameter": {
3555       "fields": {
3556         "Body": [
3557           {
3558             "group": "Body",
3559             "type": "String",
3560             "optional": false,
3561             "field": "uniqueid",
3562             "description": ""
3563           },
3564           {
3565             "group": "Body",
3566             "type": "String",
3567             "allowedValues": [
3568               "\"account\"",
3569               "\"agent\"",
3570               "\"queue\""
3571             ],
3572             "optional": false,
3573             "field": "type",
3574             "description": ""
3575           },
3576           {
3577             "group": "Body",
3578             "type": "String",
3579             "optional": false,
3580             "field": "transferredAt",
3581             "description": ""
3582           }
3583         ]
3584       }
3585     },
3586     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3587     "version": "0.0.0",
3588     "filename": "server/api/chatTransferReport/index.js",
3589     "groupTitle": "Chat_Transfer_Reports"
3590   },
3591   {
3592     "type": "delete",
3593     "url": "/api/chat/reports/transfer/{id}",
3594     "title": "Deletes a Chat Transfer Report",
3595     "examples": [
3596       {
3597         "title": "Example usage:",
3598         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
3599         "type": "json"
3600       }
3601     ],
3602     "name": "DeleteChat_Transfer_Reports",
3603     "group": "Chat_Transfer_Reports",
3604     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3605     "version": "0.0.0",
3606     "filename": "server/api/chatTransferReport/index.js",
3607     "groupTitle": "Chat_Transfer_Reports"
3608   },
3609   {
3610     "type": "get",
3611     "url": "/api/chat/reports/transfer/describe",
3612     "title": "Gets table info about Chat Transfer Reports",
3613     "examples": [
3614       {
3615         "title": "Example usage:",
3616         "content": "curl https://{domain}/api/chat/reports/transfer/describe -v -u {name}:{password}",
3617         "type": "json"
3618       }
3619     ],
3620     "name": "DescribeChat_Transfer_Reports",
3621     "group": "Chat_Transfer_Reports",
3622     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3623     "version": "0.0.0",
3624     "filename": "server/api/chatTransferReport/index.js",
3625     "groupTitle": "Chat_Transfer_Reports"
3626   },
3627   {
3628     "type": "get",
3629     "url": "/api/chat/reports/transfer",
3630     "title": "Gets a list of Chat Transfer Reports",
3631     "examples": [
3632       {
3633         "title": "Example usage:",
3634         "content": "curl https://{domain}/api/chat/reports/transfer -v -u {name}:{password}",
3635         "type": "json"
3636       }
3637     ],
3638     "name": "GetChat_Transfer_Reports",
3639     "group": "Chat_Transfer_Reports",
3640     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
3641     "version": "0.0.0",
3642     "filename": "server/api/chatTransferReport/index.js",
3643     "groupTitle": "Chat_Transfer_Reports"
3644   },
3645   {
3646     "type": "get",
3647     "url": "/api/chat/reports/transfer/{id}",
3648     "title": "Gets a single Chat Transfer Report",
3649     "examples": [
3650       {
3651         "title": "Example usage:",
3652         "content": "curl https://{domain}/api/chat/reports/transfer/{id} -v -u {name}:{password}",
3653         "type": "json"
3654       }
3655     ],
3656     "name": "ShowChat_Transfer_Reports",
3657     "group": "Chat_Transfer_Reports",
3658     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3659     "version": "0.0.0",
3660     "filename": "server/api/chatTransferReport/index.js",
3661     "groupTitle": "Chat_Transfer_Reports"
3662   },
3663   {
3664     "type": "put",
3665     "url": "/api/chat/reports/transfer/{id}",
3666     "title": "Update an existing Chat Transfer Report",
3667     "examples": [
3668       {
3669         "title": "Example usage:",
3670         "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",
3671         "type": "json"
3672       }
3673     ],
3674     "name": "updateChat_Transfer_Reports",
3675     "group": "Chat_Transfer_Reports",
3676     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3677     "version": "0.0.0",
3678     "filename": "server/api/chatTransferReport/index.js",
3679     "groupTitle": "Chat_Transfer_Reports"
3680   },
3681   {
3682     "type": "post",
3683     "url": "/api/chat/websites/{id}/users",
3684     "title": "Add agents to a website",
3685     "examples": [
3686       {
3687         "title": "Example usage:",
3688         "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",
3689         "type": "json"
3690       }
3691     ],
3692     "name": "AddAgents",
3693     "group": "Chat_Websites",
3694     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
3695     "version": "0.0.0",
3696     "filename": "server/api/chatWebsite/index.js",
3697     "groupTitle": "Chat_Websites"
3698   },
3699   {
3700     "type": "post",
3701     "url": "/api/chat/websites",
3702     "title": "Creates a new Website",
3703     "examples": [
3704       {
3705         "title": "Example usage:",
3706         "content": "curl https://{domain}/api/chat/websites -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
3707         "type": "json"
3708       }
3709     ],
3710     "name": "CreateWebsites",
3711     "group": "Chat_Websites",
3712     "parameter": {
3713       "fields": {
3714         "Body": [
3715           {
3716             "group": "Body",
3717             "type": "String",
3718             "optional": false,
3719             "field": "name",
3720             "description": ""
3721           },
3722           {
3723             "group": "Body",
3724             "type": "String",
3725             "optional": false,
3726             "field": "address",
3727             "description": ""
3728           },
3729           {
3730             "group": "Body",
3731             "type": "String",
3732             "optional": true,
3733             "field": "description",
3734             "description": ""
3735           },
3736           {
3737             "group": "Body",
3738             "type": "String",
3739             "optional": true,
3740             "field": "mapKey",
3741             "description": ""
3742           },
3743           {
3744             "group": "Body",
3745             "type": "String",
3746             "optional": true,
3747             "field": "mapKeyOffline",
3748             "description": ""
3749           },
3750           {
3751             "group": "Body",
3752             "type": "String",
3753             "optional": false,
3754             "field": "key",
3755             "description": ""
3756           },
3757           {
3758             "group": "Body",
3759             "type": "String",
3760             "optional": true,
3761             "field": "agentAlias",
3762             "description": ""
3763           },
3764           {
3765             "group": "Body",
3766             "type": "String",
3767             "optional": true,
3768             "field": "customerAlias",
3769             "description": ""
3770           },
3771           {
3772             "group": "Body",
3773             "type": "String",
3774             "optional": false,
3775             "field": "color",
3776             "description": ""
3777           },
3778           {
3779             "group": "Body",
3780             "type": "String",
3781             "optional": false,
3782             "field": "color_button",
3783             "description": ""
3784           },
3785           {
3786             "group": "Body",
3787             "type": "String",
3788             "optional": false,
3789             "field": "textColor",
3790             "description": ""
3791           },
3792           {
3793             "group": "Body",
3794             "type": "Integer",
3795             "optional": true,
3796             "field": "fontSize",
3797             "description": ""
3798           },
3799           {
3800             "group": "Body",
3801             "type": "String",
3802             "optional": true,
3803             "field": "remote",
3804             "description": ""
3805           },
3806           {
3807             "group": "Body",
3808             "type": "Boolean",
3809             "optional": true,
3810             "field": "animation",
3811             "description": ""
3812           },
3813           {
3814             "group": "Body",
3815             "type": "String",
3816             "allowedValues": [
3817               "\"rounded\"",
3818               "\"squared\""
3819             ],
3820             "optional": true,
3821             "field": "header_shape",
3822             "description": ""
3823           },
3824           {
3825             "group": "Body",
3826             "type": "String",
3827             "optional": true,
3828             "field": "header_online",
3829             "description": ""
3830           },
3831           {
3832             "group": "Body",
3833             "type": "String",
3834             "optional": true,
3835             "field": "start_chat_button",
3836             "description": ""
3837           },
3838           {
3839             "group": "Body",
3840             "type": "String",
3841             "optional": true,
3842             "field": "offline_chat_button",
3843             "description": ""
3844           },
3845           {
3846             "group": "Body",
3847             "type": "String",
3848             "optional": true,
3849             "field": "header_offline",
3850             "description": ""
3851           },
3852           {
3853             "group": "Body",
3854             "type": "Boolean",
3855             "optional": true,
3856             "field": "download_transcript",
3857             "description": ""
3858           },
3859           {
3860             "group": "Body",
3861             "type": "Integer",
3862             "optional": true,
3863             "field": "timeout",
3864             "description": ""
3865           },
3866           {
3867             "group": "Body",
3868             "type": "String",
3869             "optional": true,
3870             "field": "whiteLabel",
3871             "description": ""
3872           },
3873           {
3874             "group": "Body",
3875             "type": "Boolean",
3876             "optional": true,
3877             "field": "defaultWhiteLabel",
3878             "description": ""
3879           },
3880           {
3881             "group": "Body",
3882             "type": "Text",
3883             "optional": true,
3884             "field": "sitepic",
3885             "description": ""
3886           },
3887           {
3888             "group": "Body",
3889             "type": "String",
3890             "optional": true,
3891             "field": "closingQuestion",
3892             "description": ""
3893           },
3894           {
3895             "group": "Body",
3896             "type": "String",
3897             "optional": true,
3898             "field": "formSubmitSuccessMessage",
3899             "description": ""
3900           },
3901           {
3902             "group": "Body",
3903             "type": "String",
3904             "optional": true,
3905             "field": "formSubmitFailureMessage",
3906             "description": ""
3907           },
3908           {
3909             "group": "Body",
3910             "type": "String",
3911             "optional": true,
3912             "field": "noteTitle",
3913             "description": ""
3914           },
3915           {
3916             "group": "Body",
3917             "type": "String",
3918             "optional": true,
3919             "field": "placeholderMessage",
3920             "description": ""
3921           },
3922           {
3923             "group": "Body",
3924             "type": "String",
3925             "optional": true,
3926             "field": "closingMessage",
3927             "description": ""
3928           },
3929           {
3930             "group": "Body",
3931             "type": "String",
3932             "optional": true,
3933             "field": "closingMessageButton",
3934             "description": ""
3935           },
3936           {
3937             "group": "Body",
3938             "type": "String",
3939             "optional": true,
3940             "field": "skipMessageButton",
3941             "description": ""
3942           },
3943           {
3944             "group": "Body",
3945             "type": "Boolean",
3946             "optional": true,
3947             "field": "conditionAgreement",
3948             "description": ""
3949           },
3950           {
3951             "group": "Body",
3952             "type": "Boolean",
3953             "optional": true,
3954             "field": "enableRating",
3955             "description": ""
3956           },
3957           {
3958             "group": "Body",
3959             "type": "Boolean",
3960             "optional": true,
3961             "field": "enableFeedback",
3962             "description": ""
3963           },
3964           {
3965             "group": "Body",
3966             "type": "Boolean",
3967             "optional": true,
3968             "field": "enableSendButton",
3969             "description": ""
3970           },
3971           {
3972             "group": "Body",
3973             "type": "String",
3974             "optional": true,
3975             "field": "feedbackTitle",
3976             "description": ""
3977           },
3978           {
3979             "group": "Body",
3980             "type": "String",
3981             "allowedValues": [
3982               "\"star\"",
3983               "\"thumb\""
3984             ],
3985             "optional": true,
3986             "field": "ratingType",
3987             "description": ""
3988           },
3989           {
3990             "group": "Body",
3991             "type": "Integer",
3992             "optional": true,
3993             "field": "ratingStarsNumber",
3994             "description": ""
3995           },
3996           {
3997             "group": "Body",
3998             "type": "Text",
3999             "optional": true,
4000             "field": "onlineForm",
4001             "description": ""
4002           },
4003           {
4004             "group": "Body",
4005             "type": "Text",
4006             "optional": true,
4007             "field": "offlineForm",
4008             "description": ""
4009           },
4010           {
4011             "group": "Body",
4012             "type": "String",
4013             "optional": true,
4014             "field": "token",
4015             "description": ""
4016           },
4017           {
4018             "group": "Body",
4019             "type": "Boolean",
4020             "optional": true,
4021             "field": "autoclose",
4022             "description": ""
4023           },
4024           {
4025             "group": "Body",
4026             "type": "Boolean",
4027             "optional": true,
4028             "field": "enableCustomerWriting",
4029             "description": ""
4030           },
4031           {
4032             "group": "Body",
4033             "type": "Boolean",
4034             "optional": true,
4035             "field": "forwardTranscript",
4036             "description": ""
4037           },
4038           {
4039             "group": "Body",
4040             "type": "String",
4041             "optional": true,
4042             "field": "forwardTranscriptMessage",
4043             "description": ""
4044           },
4045           {
4046             "group": "Body",
4047             "type": "Boolean",
4048             "optional": true,
4049             "field": "forwardOffline",
4050             "description": ""
4051           },
4052           {
4053             "group": "Body",
4054             "type": "String",
4055             "optional": true,
4056             "field": "forwardOfflineAddress",
4057             "description": ""
4058           },
4059           {
4060             "group": "Body",
4061             "type": "String",
4062             "optional": true,
4063             "field": "waitingTitle",
4064             "description": ""
4065           },
4066           {
4067             "group": "Body",
4068             "type": "String",
4069             "optional": true,
4070             "field": "waitingMessage",
4071             "description": ""
4072           },
4073           {
4074             "group": "Body",
4075             "type": "String",
4076             "optional": true,
4077             "field": "offlineMessageSubject",
4078             "description": ""
4079           },
4080           {
4081             "group": "Body",
4082             "type": "String",
4083             "optional": true,
4084             "field": "offlineMessageBody",
4085             "description": ""
4086           },
4087           {
4088             "group": "Body",
4089             "type": "Boolean",
4090             "optional": true,
4091             "field": "enableUnmanagedNote",
4092             "description": ""
4093           },
4094           {
4095             "group": "Body",
4096             "type": "String",
4097             "optional": true,
4098             "field": "unmanagedMessage",
4099             "description": ""
4100           },
4101           {
4102             "group": "Body",
4103             "type": "String",
4104             "optional": true,
4105             "field": "skipUnmanaged",
4106             "description": ""
4107           },
4108           {
4109             "group": "Body",
4110             "type": "String",
4111             "optional": true,
4112             "field": "sendUnmanaged",
4113             "description": ""
4114           },
4115           {
4116             "group": "Body",
4117             "type": "Boolean",
4118             "optional": true,
4119             "field": "enableCustomerAttachment",
4120             "description": ""
4121           },
4122           {
4123             "group": "Body",
4124             "type": "Boolean",
4125             "optional": true,
4126             "field": "enableCustomerCheckmarks",
4127             "description": ""
4128           },
4129           {
4130             "group": "Body",
4131             "type": "Text",
4132             "optional": true,
4133             "field": "agentAvatar",
4134             "description": ""
4135           },
4136           {
4137             "group": "Body",
4138             "type": "Boolean",
4139             "optional": true,
4140             "field": "showAgentAvatar",
4141             "description": ""
4142           },
4143           {
4144             "group": "Body",
4145             "type": "String",
4146             "optional": true,
4147             "field": "timezone",
4148             "description": ""
4149           },
4150           {
4151             "group": "Body",
4152             "type": "Text",
4153             "optional": true,
4154             "field": "notificationTemplate",
4155             "description": ""
4156           },
4157           {
4158             "group": "Body",
4159             "type": "Boolean",
4160             "optional": true,
4161             "field": "notificationSound",
4162             "description": ""
4163           },
4164           {
4165             "group": "Body",
4166             "type": "Boolean",
4167             "optional": true,
4168             "field": "notificationShake",
4169             "description": ""
4170           },
4171           {
4172             "group": "Body",
4173             "type": "Boolean",
4174             "optional": true,
4175             "field": "hideWhenOffline",
4176             "description": ""
4177           },
4178           {
4179             "group": "Body",
4180             "type": "String",
4181             "optional": true,
4182             "field": "agentIdentifier",
4183             "description": ""
4184           },
4185           {
4186             "group": "Body",
4187             "type": "Integer",
4188             "optional": true,
4189             "field": "waitForTheAssignedAgent",
4190             "description": ""
4191           },
4192           {
4193             "group": "Body",
4194             "type": "String",
4195             "optional": true,
4196             "field": "alignment",
4197             "description": ""
4198           },
4199           {
4200             "group": "Body",
4201             "type": "Integer",
4202             "optional": true,
4203             "field": "verticalAlignment",
4204             "description": ""
4205           },
4206           {
4207             "group": "Body",
4208             "type": "String",
4209             "optional": true,
4210             "field": "messagesAlignment",
4211             "description": ""
4212           },
4213           {
4214             "group": "Body",
4215             "type": "String",
4216             "optional": true,
4217             "field": "defaultTitle",
4218             "description": ""
4219           },
4220           {
4221             "group": "Body",
4222             "type": "Text",
4223             "optional": true,
4224             "field": "customerAvatar",
4225             "description": ""
4226           },
4227           {
4228             "group": "Body",
4229             "type": "Boolean",
4230             "optional": true,
4231             "field": "showCustomerAvatar",
4232             "description": ""
4233           },
4234           {
4235             "group": "Body",
4236             "type": "Integer",
4237             "optional": true,
4238             "field": "messageFontSize",
4239             "description": ""
4240           },
4241           {
4242             "group": "Body",
4243             "type": "String",
4244             "optional": false,
4245             "field": "backgroundColor",
4246             "description": ""
4247           },
4248           {
4249             "group": "Body",
4250             "type": "Boolean",
4251             "optional": true,
4252             "field": "queueTransfer",
4253             "description": ""
4254           },
4255           {
4256             "group": "Body",
4257             "type": "Integer",
4258             "optional": true,
4259             "field": "queueTransferTimeout",
4260             "description": ""
4261           },
4262           {
4263             "group": "Body",
4264             "type": "Boolean",
4265             "optional": true,
4266             "field": "agentTransfer",
4267             "description": ""
4268           },
4269           {
4270             "group": "Body",
4271             "type": "Integer",
4272             "optional": true,
4273             "field": "agentTransferTimeout",
4274             "description": ""
4275           },
4276           {
4277             "group": "Body",
4278             "type": "String",
4279             "optional": true,
4280             "field": "systemAlias",
4281             "description": ""
4282           },
4283           {
4284             "group": "Body",
4285             "type": "Text",
4286             "optional": true,
4287             "field": "systemAvatar",
4288             "description": ""
4289           },
4290           {
4291             "group": "Body",
4292             "type": "Integer",
4293             "optional": true,
4294             "field": "mandatoryDispositionPauseId",
4295             "description": "<p>Status to put when mandatory disposition is enabled</p>"
4296           },
4297           {
4298             "group": "Body",
4299             "type": "Boolean",
4300             "optional": true,
4301             "field": "mandatoryDisposition",
4302             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
4303           }
4304         ]
4305       }
4306     },
4307     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4308     "version": "0.0.0",
4309     "filename": "server/api/chatWebsite/index.js",
4310     "groupTitle": "Chat_Websites"
4311   },
4312   {
4313     "type": "delete",
4314     "url": "/api/chat/websites/{id}",
4315     "title": "Deletes a Website",
4316     "examples": [
4317       {
4318         "title": "Example usage:",
4319         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password} -X DELETE",
4320         "type": "json"
4321       }
4322     ],
4323     "name": "DeleteWebsites",
4324     "group": "Chat_Websites",
4325     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4326     "version": "0.0.0",
4327     "filename": "server/api/chatWebsite/index.js",
4328     "groupTitle": "Chat_Websites"
4329   },
4330   {
4331     "type": "get",
4332     "url": "/api/chat/websites/describe",
4333     "title": "Gets table info about Websites",
4334     "examples": [
4335       {
4336         "title": "Example usage:",
4337         "content": "curl https://{domain}/api/chat/websites/describe -v -u {name}:{password}",
4338         "type": "json"
4339       }
4340     ],
4341     "name": "DescribeWebsites",
4342     "group": "Chat_Websites",
4343     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4344     "version": "0.0.0",
4345     "filename": "server/api/chatWebsite/index.js",
4346     "groupTitle": "Chat_Websites"
4347   },
4348   {
4349     "type": "get",
4350     "url": "/api/chat/websites/{id}/users",
4351     "title": "Gets agents from website",
4352     "examples": [
4353       {
4354         "title": "Example usage:",
4355         "content": "curl https://{domain}/api/chat/websites/{id}/users -v -u {name}:{password} -X GET",
4356         "type": "json"
4357       }
4358     ],
4359     "name": "GetAgents",
4360     "group": "Chat_Websites",
4361     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4362     "version": "0.0.0",
4363     "filename": "server/api/chatWebsite/index.js",
4364     "groupTitle": "Chat_Websites"
4365   },
4366   {
4367     "type": "get",
4368     "url": "/api/chat/websites",
4369     "title": "Gets a list of Websites",
4370     "examples": [
4371       {
4372         "title": "Example usage:",
4373         "content": "curl https://{domain}/api/chat/websites -v -u {name}:{password}",
4374         "type": "json"
4375       }
4376     ],
4377     "name": "GetWebsites",
4378     "group": "Chat_Websites",
4379     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
4380     "version": "0.0.0",
4381     "filename": "server/api/chatWebsite/index.js",
4382     "groupTitle": "Chat_Websites"
4383   },
4384   {
4385     "type": "delete",
4386     "url": "/api/chat/websites/{id}/users",
4387     "title": "Removes agents from a website",
4388     "examples": [
4389       {
4390         "title": "Example usage:",
4391         "content": "curl https://{domain}/api/chat/websites/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4392         "type": "json"
4393       }
4394     ],
4395     "name": "RemoveAgents",
4396     "group": "Chat_Websites",
4397     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4398     "version": "0.0.0",
4399     "filename": "server/api/chatWebsite/index.js",
4400     "groupTitle": "Chat_Websites"
4401   },
4402   {
4403     "type": "delete",
4404     "url": "/api/chat/websites/{id}/canned_answers",
4405     "title": "Removes canned answers from account",
4406     "examples": [
4407       {
4408         "title": "Example usage:",
4409         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4410         "type": "json"
4411       }
4412     ],
4413     "name": "RemoveAnswers",
4414     "group": "Chat_Websites",
4415     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4416     "version": "0.0.0",
4417     "filename": "server/api/chatWebsite/index.js",
4418     "groupTitle": "Chat_Websites"
4419   },
4420   {
4421     "type": "delete",
4422     "url": "/api/chat/websites/{id}/dispositions",
4423     "title": "Removes canned answers from account",
4424     "examples": [
4425       {
4426         "title": "Example usage:",
4427         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
4428         "type": "json"
4429       }
4430     ],
4431     "name": "RemoveDispositions",
4432     "group": "Chat_Websites",
4433     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4434     "version": "0.0.0",
4435     "filename": "server/api/chatWebsite/index.js",
4436     "groupTitle": "Chat_Websites"
4437   },
4438   {
4439     "type": "get",
4440     "url": "/api/chat/websites/{id}",
4441     "title": "Gets a single Website",
4442     "examples": [
4443       {
4444         "title": "Example usage:",
4445         "content": "curl https://{domain}/api/chat/websites/{id} -v -u {name}:{password}",
4446         "type": "json"
4447       }
4448     ],
4449     "name": "ShowWebsites",
4450     "group": "Chat_Websites",
4451     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4452     "version": "0.0.0",
4453     "filename": "server/api/chatWebsite/index.js",
4454     "groupTitle": "Chat_Websites"
4455   },
4456   {
4457     "type": "put",
4458     "url": "/api/chat/messages/{id}/accept",
4459     "title": "Accepts message",
4460     "examples": [
4461       {
4462         "title": "Example usage:",
4463         "content": "curl https://{domain}/api/chat/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
4464         "type": "json"
4465       }
4466     ],
4467     "name": "acceptMessage",
4468     "group": "Chat_Websites",
4469     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4470     "version": "0.0.0",
4471     "filename": "server/api/chatMessage/index.js",
4472     "groupTitle": "Chat_Websites"
4473   },
4474   {
4475     "type": "post",
4476     "url": "/api/chat/websites/{id}/canned_answers",
4477     "title": "Creates new canned answer",
4478     "examples": [
4479       {
4480         "title": "Example usage:",
4481         "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",
4482         "type": "json"
4483       }
4484     ],
4485     "name": "addAnswer",
4486     "group": "Chat_Websites",
4487     "parameter": {
4488       "fields": {
4489         "Body": [
4490           {
4491             "group": "Body",
4492             "type": "String",
4493             "optional": false,
4494             "field": "key",
4495             "description": ""
4496           },
4497           {
4498             "group": "Body",
4499             "type": "Text",
4500             "optional": false,
4501             "field": "value",
4502             "description": ""
4503           },
4504           {
4505             "group": "Body",
4506             "type": "String",
4507             "optional": true,
4508             "field": "description",
4509             "description": ""
4510           },
4511           {
4512             "group": "Body",
4513             "type": "Virtual",
4514             "optional": true,
4515             "field": "name",
4516             "description": ""
4517           }
4518         ]
4519       }
4520     },
4521     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4522     "version": "0.0.0",
4523     "filename": "server/api/chatWebsite/index.js",
4524     "groupTitle": "Chat_Websites"
4525   },
4526   {
4527     "type": "post",
4528     "url": "/api/chat/websites/{id}/applications",
4529     "title": "Creates new applications",
4530     "examples": [
4531       {
4532         "title": "Example usage:",
4533         "content": "curl https://{domain}/api/chat/websites/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4534         "type": "json"
4535       }
4536     ],
4537     "name": "addApplications",
4538     "group": "Chat_Websites",
4539     "parameter": {
4540       "fields": {
4541         "Body": [
4542           {
4543             "group": "Body",
4544             "type": "Integer",
4545             "optional": false,
4546             "field": "priority",
4547             "description": ""
4548           },
4549           {
4550             "group": "Body",
4551             "type": "String",
4552             "optional": false,
4553             "field": "app",
4554             "description": ""
4555           },
4556           {
4557             "group": "Body",
4558             "type": "Text",
4559             "optional": true,
4560             "field": "appdata",
4561             "description": ""
4562           },
4563           {
4564             "group": "Body",
4565             "type": "String",
4566             "optional": true,
4567             "field": "description",
4568             "description": ""
4569           },
4570           {
4571             "group": "Body",
4572             "type": "String",
4573             "optional": true,
4574             "field": "interval",
4575             "description": ""
4576           }
4577         ]
4578       }
4579     },
4580     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4581     "version": "0.0.0",
4582     "filename": "server/api/chatWebsite/index.js",
4583     "groupTitle": "Chat_Websites"
4584   },
4585   {
4586     "type": "post",
4587     "url": "/api/chat/websites/{id}/avatar",
4588     "title": "Add avatar",
4589     "examples": [
4590       {
4591         "title": "Example usage:",
4592         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4593         "type": "json"
4594       }
4595     ],
4596     "name": "addAvatar",
4597     "group": "Chat_Websites",
4598     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4599     "version": "0.0.0",
4600     "filename": "server/api/chatWebsite/index.js",
4601     "groupTitle": "Chat_Websites"
4602   },
4603   {
4604     "type": "post",
4605     "url": "/api/chat/websites/{id}/customer_avatar",
4606     "title": "Add customer avatar",
4607     "examples": [
4608       {
4609         "title": "Example usage:",
4610         "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",
4611         "type": "json"
4612       }
4613     ],
4614     "name": "addCustomerAvatar",
4615     "group": "Chat_Websites",
4616     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4617     "version": "0.0.0",
4618     "filename": "server/api/chatWebsite/index.js",
4619     "groupTitle": "Chat_Websites"
4620   },
4621   {
4622     "type": "post",
4623     "url": "/api/chat/websites/{id}/dispositions",
4624     "title": "Creates new disposition",
4625     "examples": [
4626       {
4627         "title": "Example usage:",
4628         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
4629         "type": "json"
4630       }
4631     ],
4632     "name": "addDisposition",
4633     "group": "Chat_Websites",
4634     "parameter": {
4635       "fields": {
4636         "Body": [
4637           {
4638             "group": "Body",
4639             "type": "String",
4640             "optional": false,
4641             "field": "name",
4642             "description": ""
4643           }
4644         ]
4645       }
4646     },
4647     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4648     "version": "0.0.0",
4649     "filename": "server/api/chatWebsite/index.js",
4650     "groupTitle": "Chat_Websites"
4651   },
4652   {
4653     "type": "post",
4654     "url": "/api/chat/accounts/{id}/interactions",
4655     "title": "Creates new interactions",
4656     "examples": [
4657       {
4658         "title": "Example usage:",
4659         "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",
4660         "type": "json"
4661       }
4662     ],
4663     "name": "addInteraction",
4664     "group": "Chat_Websites",
4665     "parameter": {
4666       "fields": {
4667         "Body": [
4668           {
4669             "group": "Body",
4670             "type": "Boolean",
4671             "optional": true,
4672             "field": "closed",
4673             "description": ""
4674           },
4675           {
4676             "group": "Body",
4677             "type": "Integer",
4678             "optional": true,
4679             "field": "ratingValue",
4680             "description": ""
4681           },
4682           {
4683             "group": "Body",
4684             "type": "String",
4685             "allowedValues": [
4686               "\"star\"",
4687               "\"thumb\""
4688             ],
4689             "optional": true,
4690             "field": "ratingType",
4691             "description": ""
4692           },
4693           {
4694             "group": "Body",
4695             "type": "Text",
4696             "optional": true,
4697             "field": "ratingMessage",
4698             "description": ""
4699           },
4700           {
4701             "group": "Body",
4702             "type": "Text",
4703             "optional": true,
4704             "field": "pathTranscript",
4705             "description": ""
4706           },
4707           {
4708             "group": "Body",
4709             "type": "String",
4710             "optional": true,
4711             "field": "mailTranscript",
4712             "description": ""
4713           },
4714           {
4715             "group": "Body",
4716             "type": "String",
4717             "optional": true,
4718             "field": "closedAt",
4719             "description": ""
4720           },
4721           {
4722             "group": "Body",
4723             "type": "String",
4724             "optional": true,
4725             "field": "disposition",
4726             "description": ""
4727           },
4728           {
4729             "group": "Body",
4730             "type": "String",
4731             "optional": true,
4732             "field": "note",
4733             "description": ""
4734           },
4735           {
4736             "group": "Body",
4737             "type": "String",
4738             "optional": true,
4739             "field": "browserName",
4740             "description": ""
4741           },
4742           {
4743             "group": "Body",
4744             "type": "String",
4745             "optional": true,
4746             "field": "browserVersion",
4747             "description": ""
4748           },
4749           {
4750             "group": "Body",
4751             "type": "String",
4752             "optional": true,
4753             "field": "osName",
4754             "description": ""
4755           },
4756           {
4757             "group": "Body",
4758             "type": "String",
4759             "optional": true,
4760             "field": "osVersion",
4761             "description": ""
4762           },
4763           {
4764             "group": "Body",
4765             "type": "String",
4766             "optional": true,
4767             "field": "deviceModel",
4768             "description": ""
4769           },
4770           {
4771             "group": "Body",
4772             "type": "String",
4773             "optional": true,
4774             "field": "deviceVendor",
4775             "description": ""
4776           },
4777           {
4778             "group": "Body",
4779             "type": "String",
4780             "optional": true,
4781             "field": "deviceType",
4782             "description": ""
4783           },
4784           {
4785             "group": "Body",
4786             "type": "Text",
4787             "optional": true,
4788             "field": "referer",
4789             "description": ""
4790           },
4791           {
4792             "group": "Body",
4793             "type": "String",
4794             "optional": true,
4795             "field": "customerIp",
4796             "description": ""
4797           },
4798           {
4799             "group": "Body",
4800             "type": "Text",
4801             "optional": true,
4802             "field": "formData",
4803             "description": ""
4804           },
4805           {
4806             "group": "Body",
4807             "type": "String",
4808             "optional": true,
4809             "field": "read1stAt",
4810             "description": ""
4811           },
4812           {
4813             "group": "Body",
4814             "type": "String",
4815             "optional": true,
4816             "field": "lastMsgAt",
4817             "description": ""
4818           },
4819           {
4820             "group": "Body",
4821             "type": "String",
4822             "allowedValues": [
4823               "\"in\"",
4824               "\"out\""
4825             ],
4826             "optional": false,
4827             "field": "lastMsgDirection",
4828             "description": ""
4829           },
4830           {
4831             "group": "Body",
4832             "type": "String",
4833             "optional": true,
4834             "field": "closeReason",
4835             "description": ""
4836           },
4837           {
4838             "group": "Body",
4839             "type": "String",
4840             "optional": true,
4841             "field": "customerPort",
4842             "description": ""
4843           }
4844         ]
4845       }
4846     },
4847     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4848     "version": "0.0.0",
4849     "filename": "server/api/chatWebsite/index.js",
4850     "groupTitle": "Chat_Websites"
4851   },
4852   {
4853     "type": "post",
4854     "url": "/api/chat/websites/{id}/logo",
4855     "title": "Add logo",
4856     "examples": [
4857       {
4858         "title": "Example usage:",
4859         "content": "curl https://{domain}/api/chat/websites/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
4860         "type": "json"
4861       }
4862     ],
4863     "name": "addLogo",
4864     "group": "Chat_Websites",
4865     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4866     "version": "0.0.0",
4867     "filename": "server/api/chatWebsite/index.js",
4868     "groupTitle": "Chat_Websites"
4869   },
4870   {
4871     "type": "post",
4872     "url": "/api/chat/websites/{id}/proactive_actions",
4873     "title": "Creates new Proactive Actions",
4874     "examples": [
4875       {
4876         "title": "Example usage:",
4877         "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",
4878         "type": "json"
4879       }
4880     ],
4881     "name": "addProactiveActions",
4882     "group": "Chat_Websites",
4883     "parameter": {
4884       "fields": {
4885         "Body": [
4886           {
4887             "group": "Body",
4888             "type": "String",
4889             "optional": false,
4890             "field": "name",
4891             "description": ""
4892           },
4893           {
4894             "group": "Body",
4895             "type": "String",
4896             "allowedValues": [
4897               "\"mouseOver\"",
4898               "\"timeout\""
4899             ],
4900             "optional": true,
4901             "field": "type",
4902             "description": ""
4903           },
4904           {
4905             "group": "Body",
4906             "type": "String",
4907             "optional": true,
4908             "field": "selector",
4909             "description": ""
4910           },
4911           {
4912             "group": "Body",
4913             "type": "Integer",
4914             "optional": true,
4915             "field": "timeout",
4916             "description": ""
4917           }
4918         ]
4919       }
4920     },
4921     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4922     "version": "0.0.0",
4923     "filename": "server/api/chatWebsite/index.js",
4924     "groupTitle": "Chat_Websites"
4925   },
4926   {
4927     "type": "post",
4928     "url": "/api/chat/websites/{id}/system_avatar",
4929     "title": "Add system avatar",
4930     "examples": [
4931       {
4932         "title": "Example usage:",
4933         "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",
4934         "type": "json"
4935       }
4936     ],
4937     "name": "addSystemAvatar",
4938     "group": "Chat_Websites",
4939     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4940     "version": "0.0.0",
4941     "filename": "server/api/chatWebsite/index.js",
4942     "groupTitle": "Chat_Websites"
4943   },
4944   {
4945     "type": "get",
4946     "url": "/api/chat/websites/{id}/canned_answers",
4947     "title": "Gets account canned answers",
4948     "examples": [
4949       {
4950         "title": "Example usage:",
4951         "content": "curl https://{domain}/api/chat/websites/{id}/canned_answers -v -u {name}:{password} -X GET",
4952         "type": "json"
4953       }
4954     ],
4955     "name": "getAnswers",
4956     "group": "Chat_Websites",
4957     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4958     "version": "0.0.0",
4959     "filename": "server/api/chatWebsite/index.js",
4960     "groupTitle": "Chat_Websites"
4961   },
4962   {
4963     "type": "get",
4964     "url": "/api/chat/websites/{id}/applications",
4965     "title": "Gets Website Applications",
4966     "examples": [
4967       {
4968         "title": "Example usage:",
4969         "content": "curl https://{domain}/api/chat/websites/{id}/applications -v -u {name}:{password} -X GET",
4970         "type": "json"
4971       }
4972     ],
4973     "name": "getApplications",
4974     "group": "Chat_Websites",
4975     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4976     "version": "0.0.0",
4977     "filename": "server/api/chatWebsite/index.js",
4978     "groupTitle": "Chat_Websites"
4979   },
4980   {
4981     "type": "get",
4982     "url": "/api/chat/websites/{id}/avatar",
4983     "title": "Get avatar",
4984     "examples": [
4985       {
4986         "title": "Example usage:",
4987         "content": "curl https://{domain}/api/chat/websites/{id}/avatar -v -u {name}:{password} -X GET",
4988         "type": "json"
4989       }
4990     ],
4991     "name": "getAvatar",
4992     "group": "Chat_Websites",
4993     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
4994     "version": "0.0.0",
4995     "filename": "server/api/chatWebsite/index.js",
4996     "groupTitle": "Chat_Websites"
4997   },
4998   {
4999     "type": "get",
5000     "url": "/api/chat/websites/{id}/customer_avatar",
5001     "title": "Get Customer Avatar",
5002     "examples": [
5003       {
5004         "title": "Example usage:",
5005         "content": "curl https://{domain}/api/chat/websites/{id}/customer_avatar -v -u {name}:{password} -X GET",
5006         "type": "json"
5007       }
5008     ],
5009     "name": "getCustomerAvatar",
5010     "group": "Chat_Websites",
5011     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5012     "version": "0.0.0",
5013     "filename": "server/api/chatWebsite/index.js",
5014     "groupTitle": "Chat_Websites"
5015   },
5016   {
5017     "type": "get",
5018     "url": "/api/chat/websites/{id}/dispositions",
5019     "title": "Gets account dispositions",
5020     "examples": [
5021       {
5022         "title": "Example usage:",
5023         "content": "curl https://{domain}/api/chat/websites/{id}/dispositions -v -u {name}:{password} -X GET",
5024         "type": "json"
5025       }
5026     ],
5027     "name": "getDispositions",
5028     "group": "Chat_Websites",
5029     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5030     "version": "0.0.0",
5031     "filename": "server/api/chatWebsite/index.js",
5032     "groupTitle": "Chat_Websites"
5033   },
5034   {
5035     "type": "get",
5036     "url": "/api/chat/websites/{id}/fields",
5037     "title": "Gets Website Fields",
5038     "examples": [
5039       {
5040         "title": "Example usage:",
5041         "content": "curl https://{domain}/api/chat/websites/{id}/fields -v -u {name}:{password} -X GET",
5042         "type": "json"
5043       }
5044     ],
5045     "name": "getFields",
5046     "group": "Chat_Websites",
5047     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5048     "version": "0.0.0",
5049     "filename": "server/api/chatWebsite/index.js",
5050     "groupTitle": "Chat_Websites"
5051   },
5052   {
5053     "type": "get",
5054     "url": "/api/chat/websites/{id}/interactions",
5055     "title": "Gets Website Interactions",
5056     "examples": [
5057       {
5058         "title": "Example usage:",
5059         "content": "curl https://{domain}/api/chat/websites/{id}/interactions -v -u {name}:{password} -X GET",
5060         "type": "json"
5061       }
5062     ],
5063     "name": "getInteraction",
5064     "group": "Chat_Websites",
5065     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5066     "version": "0.0.0",
5067     "filename": "server/api/chatWebsite/index.js",
5068     "groupTitle": "Chat_Websites"
5069   },
5070   {
5071     "type": "get",
5072     "url": "/api/chat/websites/{id}/logo",
5073     "title": "Get logo",
5074     "examples": [
5075       {
5076         "title": "Example usage:",
5077         "content": "curl https://{domain}/api/chat/websites/{id}/logo -v -u {name}:{password} -X GET",
5078         "type": "json"
5079       }
5080     ],
5081     "name": "getLogo",
5082     "group": "Chat_Websites",
5083     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5084     "version": "0.0.0",
5085     "filename": "server/api/chatWebsite/index.js",
5086     "groupTitle": "Chat_Websites"
5087   },
5088   {
5089     "type": "get",
5090     "url": "/api/chat/websites/{id}/offline_messages",
5091     "title": "Gets Website Offline Messages",
5092     "examples": [
5093       {
5094         "title": "Example usage:",
5095         "content": "curl https://{domain}/api/chat/websites/{id}/offline_messages -v -u {name}:{password} -X GET",
5096         "type": "json"
5097       }
5098     ],
5099     "name": "getOfflineMessages",
5100     "group": "Chat_Websites",
5101     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5102     "version": "0.0.0",
5103     "filename": "server/api/chatWebsite/index.js",
5104     "groupTitle": "Chat_Websites"
5105   },
5106   {
5107     "type": "get",
5108     "url": "/api/chat/websites/{id}/proactive_actions",
5109     "title": "Gets Website Proactive Actions",
5110     "examples": [
5111       {
5112         "title": "Example usage:",
5113         "content": "curl https://{domain}/api/chat/websites/{id}/proactive_actions -v -u {name}:{password} -X GET",
5114         "type": "json"
5115       }
5116     ],
5117     "name": "getProactiveActions",
5118     "group": "Chat_Websites",
5119     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5120     "version": "0.0.0",
5121     "filename": "server/api/chatWebsite/index.js",
5122     "groupTitle": "Chat_Websites"
5123   },
5124   {
5125     "type": "get",
5126     "url": "/api/chat/websites/{id}/snippet",
5127     "title": "Gets Website Snippet",
5128     "examples": [
5129       {
5130         "title": "Example usage:",
5131         "content": "curl https://{domain}/api/chat/websites/{id}/snippet -v -u {name}:{password} -X GET",
5132         "type": "json"
5133       }
5134     ],
5135     "name": "getSnippet",
5136     "group": "Chat_Websites",
5137     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5138     "version": "0.0.0",
5139     "filename": "server/api/chatWebsite/index.js",
5140     "groupTitle": "Chat_Websites"
5141   },
5142   {
5143     "type": "get",
5144     "url": "/api/chat/websites/{id}/system_avatar",
5145     "title": "Get System Avatar",
5146     "examples": [
5147       {
5148         "title": "Example usage:",
5149         "content": "curl https://{domain}/api/chat/websites/{id}/system_avatar -v -u {name}:{password} -X GET",
5150         "type": "json"
5151       }
5152     ],
5153     "name": "getSystemAvatar",
5154     "group": "Chat_Websites",
5155     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5156     "version": "0.0.0",
5157     "filename": "server/api/chatWebsite/index.js",
5158     "groupTitle": "Chat_Websites"
5159   },
5160   {
5161     "type": "post",
5162     "url": "/api/chat/websites/{id}/notify",
5163     "title": "Notify new message",
5164     "examples": [
5165       {
5166         "title": "Example usage:",
5167         "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",
5168         "type": "json"
5169       }
5170     ],
5171     "name": "notify",
5172     "group": "Chat_Websites",
5173     "description": "<p>Motion 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>",
5174     "version": "0.0.0",
5175     "filename": "server/api/chatWebsite/index.js",
5176     "groupTitle": "Chat_Websites"
5177   },
5178   {
5179     "type": "post",
5180     "url": "/api/chat/websites/{id}/offline",
5181     "title": "Offline message",
5182     "examples": [
5183       {
5184         "title": "Example usage:",
5185         "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",
5186         "type": "json"
5187       }
5188     ],
5189     "name": "offline",
5190     "group": "Chat_Websites",
5191     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5192     "version": "0.0.0",
5193     "filename": "server/api/chatWebsite/index.js",
5194     "groupTitle": "Chat_Websites"
5195   },
5196   {
5197     "type": "put",
5198     "url": "/api/chat/messages/{id}/reject",
5199     "title": "Rejects message",
5200     "examples": [
5201       {
5202         "title": "Example usage:",
5203         "content": "curl https://{domain}/api/chat/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
5204         "type": "json"
5205       }
5206     ],
5207     "name": "rejectMessage",
5208     "group": "Chat_Websites",
5209     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5210     "version": "0.0.0",
5211     "filename": "server/api/chatMessage/index.js",
5212     "groupTitle": "Chat_Websites"
5213   },
5214   {
5215     "type": "put",
5216     "url": "/api/chat/websites/{id}",
5217     "title": "Update an existing Website",
5218     "examples": [
5219       {
5220         "title": "Example usage:",
5221         "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",
5222         "type": "json"
5223       }
5224     ],
5225     "name": "updateWebsites",
5226     "group": "Chat_Websites",
5227     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5228     "version": "0.0.0",
5229     "filename": "server/api/chatWebsite/index.js",
5230     "groupTitle": "Chat_Websites"
5231   },
5232   {
5233     "type": "post",
5234     "url": "/api/cm/companies",
5235     "title": "Creates a new Company",
5236     "examples": [
5237       {
5238         "title": "Example usage:",
5239         "content": "curl https://{domain}/api/cm/companies -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
5240         "type": "json"
5241       }
5242     ],
5243     "name": "CreateCompanies",
5244     "group": "Cm_Companies",
5245     "parameter": {
5246       "fields": {
5247         "Body": [
5248           {
5249             "group": "Body",
5250             "type": "String",
5251             "optional": false,
5252             "field": "name",
5253             "description": ""
5254           },
5255           {
5256             "group": "Body",
5257             "type": "String",
5258             "optional": true,
5259             "field": "vat",
5260             "description": ""
5261           },
5262           {
5263             "group": "Body",
5264             "type": "String",
5265             "optional": true,
5266             "field": "companyId",
5267             "description": ""
5268           },
5269           {
5270             "group": "Body",
5271             "type": "String",
5272             "optional": true,
5273             "field": "website",
5274             "description": ""
5275           },
5276           {
5277             "group": "Body",
5278             "type": "String",
5279             "optional": true,
5280             "field": "phone",
5281             "description": ""
5282           },
5283           {
5284             "group": "Body",
5285             "type": "String",
5286             "optional": true,
5287             "field": "fax",
5288             "description": ""
5289           },
5290           {
5291             "group": "Body",
5292             "type": "String",
5293             "optional": true,
5294             "field": "type",
5295             "description": ""
5296           },
5297           {
5298             "group": "Body",
5299             "type": "String",
5300             "optional": true,
5301             "field": "street",
5302             "description": ""
5303           },
5304           {
5305             "group": "Body",
5306             "type": "String",
5307             "optional": true,
5308             "field": "postalCode",
5309             "description": ""
5310           },
5311           {
5312             "group": "Body",
5313             "type": "String",
5314             "optional": true,
5315             "field": "city",
5316             "description": ""
5317           },
5318           {
5319             "group": "Body",
5320             "type": "String",
5321             "optional": true,
5322             "field": "country",
5323             "description": ""
5324           },
5325           {
5326             "group": "Body",
5327             "type": "String",
5328             "optional": true,
5329             "field": "email",
5330             "description": ""
5331           },
5332           {
5333             "group": "Body",
5334             "type": "String",
5335             "optional": true,
5336             "field": "emailDomain",
5337             "description": ""
5338           },
5339           {
5340             "group": "Body",
5341             "type": "String",
5342             "optional": true,
5343             "field": "sStreet",
5344             "description": ""
5345           },
5346           {
5347             "group": "Body",
5348             "type": "String",
5349             "optional": true,
5350             "field": "sPostalCode",
5351             "description": ""
5352           },
5353           {
5354             "group": "Body",
5355             "type": "String",
5356             "optional": true,
5357             "field": "sCity",
5358             "description": ""
5359           },
5360           {
5361             "group": "Body",
5362             "type": "String",
5363             "optional": true,
5364             "field": "sCountry",
5365             "description": ""
5366           },
5367           {
5368             "group": "Body",
5369             "type": "String",
5370             "optional": true,
5371             "field": "description",
5372             "description": ""
5373           }
5374         ]
5375       }
5376     },
5377     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5378     "version": "0.0.0",
5379     "filename": "server/api/cmCompany/index.js",
5380     "groupTitle": "Cm_Companies"
5381   },
5382   {
5383     "type": "delete",
5384     "url": "/api/cm/companies/{id}",
5385     "title": "Deletes a Company",
5386     "examples": [
5387       {
5388         "title": "Example usage:",
5389         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password} -X DELETE",
5390         "type": "json"
5391       }
5392     ],
5393     "name": "DeleteCompanies",
5394     "group": "Cm_Companies",
5395     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5396     "version": "0.0.0",
5397     "filename": "server/api/cmCompany/index.js",
5398     "groupTitle": "Cm_Companies"
5399   },
5400   {
5401     "type": "get",
5402     "url": "/api/cm/companies/describe",
5403     "title": "Gets table info about Companies",
5404     "examples": [
5405       {
5406         "title": "Example usage:",
5407         "content": "curl https://{domain}/api/cm/companies/describe -v -u {name}:{password}",
5408         "type": "json"
5409       }
5410     ],
5411     "name": "DescribeCompanies",
5412     "group": "Cm_Companies",
5413     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5414     "version": "0.0.0",
5415     "filename": "server/api/cmCompany/index.js",
5416     "groupTitle": "Cm_Companies"
5417   },
5418   {
5419     "type": "get",
5420     "url": "/api/cm/companies",
5421     "title": "Gets a list of Companies",
5422     "examples": [
5423       {
5424         "title": "Example usage:",
5425         "content": "curl https://{domain}/api/cm/companies -v -u {name}:{password}",
5426         "type": "json"
5427       }
5428     ],
5429     "name": "GetCompanies",
5430     "group": "Cm_Companies",
5431     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5432     "version": "0.0.0",
5433     "filename": "server/api/cmCompany/index.js",
5434     "groupTitle": "Cm_Companies"
5435   },
5436   {
5437     "type": "get",
5438     "url": "/api/cm/companies/{id}",
5439     "title": "Gets a single Company",
5440     "examples": [
5441       {
5442         "title": "Example usage:",
5443         "content": "curl https://{domain}/api/cm/companies/{id} -v -u {name}:{password}",
5444         "type": "json"
5445       }
5446     ],
5447     "name": "ShowCompanies",
5448     "group": "Cm_Companies",
5449     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5450     "version": "0.0.0",
5451     "filename": "server/api/cmCompany/index.js",
5452     "groupTitle": "Cm_Companies"
5453   },
5454   {
5455     "type": "post",
5456     "url": "/api/cm/companies/{id}/contacts",
5457     "title": "Creates new contacts",
5458     "examples": [
5459       {
5460         "title": "Example usage:",
5461         "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",
5462         "type": "json"
5463       }
5464     ],
5465     "name": "addContacts",
5466     "group": "Cm_Companies",
5467     "parameter": {
5468       "fields": {
5469         "Body": [
5470           {
5471             "group": "Body",
5472             "type": "String",
5473             "optional": false,
5474             "field": "firstName",
5475             "description": ""
5476           },
5477           {
5478             "group": "Body",
5479             "type": "String",
5480             "optional": true,
5481             "field": "lastName",
5482             "description": ""
5483           },
5484           {
5485             "group": "Body",
5486             "type": "String",
5487             "optional": true,
5488             "field": "street",
5489             "description": ""
5490           },
5491           {
5492             "group": "Body",
5493             "type": "String",
5494             "optional": true,
5495             "field": "postalCode",
5496             "description": ""
5497           },
5498           {
5499             "group": "Body",
5500             "type": "String",
5501             "optional": true,
5502             "field": "city",
5503             "description": ""
5504           },
5505           {
5506             "group": "Body",
5507             "type": "String",
5508             "optional": true,
5509             "field": "country",
5510             "description": ""
5511           },
5512           {
5513             "group": "Body",
5514             "type": "String",
5515             "optional": true,
5516             "field": "dateOfBirth",
5517             "description": ""
5518           },
5519           {
5520             "group": "Body",
5521             "type": "Text",
5522             "optional": true,
5523             "field": "description",
5524             "description": ""
5525           },
5526           {
5527             "group": "Body",
5528             "type": "String",
5529             "optional": true,
5530             "field": "phone",
5531             "description": ""
5532           },
5533           {
5534             "group": "Body",
5535             "type": "String",
5536             "optional": true,
5537             "field": "mobile",
5538             "description": ""
5539           },
5540           {
5541             "group": "Body",
5542             "type": "String",
5543             "optional": true,
5544             "field": "fax",
5545             "description": ""
5546           },
5547           {
5548             "group": "Body",
5549             "type": "String",
5550             "optional": true,
5551             "field": "email",
5552             "description": ""
5553           },
5554           {
5555             "group": "Body",
5556             "type": "String",
5557             "optional": true,
5558             "field": "url",
5559             "description": ""
5560           },
5561           {
5562             "group": "Body",
5563             "type": "String",
5564             "optional": true,
5565             "field": "facebook",
5566             "description": ""
5567           },
5568           {
5569             "group": "Body",
5570             "type": "String",
5571             "optional": true,
5572             "field": "fb_data",
5573             "description": ""
5574           },
5575           {
5576             "group": "Body",
5577             "type": "String",
5578             "optional": true,
5579             "field": "twitter",
5580             "description": ""
5581           },
5582           {
5583             "group": "Body",
5584             "type": "String",
5585             "optional": true,
5586             "field": "skype",
5587             "description": ""
5588           },
5589           {
5590             "group": "Body",
5591             "type": "String",
5592             "optional": true,
5593             "field": "teams",
5594             "description": ""
5595           },
5596           {
5597             "group": "Body",
5598             "type": "String",
5599             "optional": true,
5600             "field": "viber",
5601             "description": ""
5602           },
5603           {
5604             "group": "Body",
5605             "type": "String",
5606             "optional": true,
5607             "field": "line",
5608             "description": ""
5609           },
5610           {
5611             "group": "Body",
5612             "type": "String",
5613             "optional": true,
5614             "field": "wechat",
5615             "description": ""
5616           },
5617           {
5618             "group": "Body",
5619             "type": "String",
5620             "optional": true,
5621             "field": "telegram",
5622             "description": ""
5623           },
5624           {
5625             "group": "Body",
5626             "type": "Integer",
5627             "optional": true,
5628             "field": "UserId",
5629             "description": ""
5630           },
5631           {
5632             "group": "Body",
5633             "type": "Integer",
5634             "optional": true,
5635             "field": "priority",
5636             "description": ""
5637           },
5638           {
5639             "group": "Body",
5640             "type": "String",
5641             "optional": true,
5642             "field": "scheduledat",
5643             "description": ""
5644           }
5645         ]
5646       }
5647     },
5648     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5649     "version": "0.0.0",
5650     "filename": "server/api/cmCompany/index.js",
5651     "groupTitle": "Cm_Companies"
5652   },
5653   {
5654     "type": "get",
5655     "url": "/api/cm/companies/{id}/contacts",
5656     "title": "Gets List Contacts",
5657     "examples": [
5658       {
5659         "title": "Example usage:",
5660         "content": "curl https://{domain}/api/fax/companies/{id}/contacts -v -u {name}:{password} -X GET",
5661         "type": "json"
5662       }
5663     ],
5664     "name": "getContacts",
5665     "group": "Cm_Companies",
5666     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5667     "version": "0.0.0",
5668     "filename": "server/api/cmCompany/index.js",
5669     "groupTitle": "Cm_Companies"
5670   },
5671   {
5672     "type": "put",
5673     "url": "/api/cm/companies/{id}",
5674     "title": "Update an existing Company",
5675     "examples": [
5676       {
5677         "title": "Example usage:",
5678         "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",
5679         "type": "json"
5680       }
5681     ],
5682     "name": "updateCompanies",
5683     "group": "Cm_Companies",
5684     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5685     "version": "0.0.0",
5686     "filename": "server/api/cmCompany/index.js",
5687     "groupTitle": "Cm_Companies"
5688   },
5689   {
5690     "type": "delete",
5691     "url": "/api/cm/contacts/{id}",
5692     "title": "Deletes a Contact",
5693     "examples": [
5694       {
5695         "title": "Example usage:",
5696         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X DELETE",
5697         "type": "json"
5698       }
5699     ],
5700     "name": "DeleteContacts",
5701     "group": "Cm_Contacts",
5702     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5703     "version": "0.0.0",
5704     "filename": "server/api/cmContact/index.js",
5705     "groupTitle": "Cm_Contacts"
5706   },
5707   {
5708     "type": "get",
5709     "url": "/api/cm/contacts/describe",
5710     "title": "Gets table info about Contacts",
5711     "examples": [
5712       {
5713         "title": "Example usage:",
5714         "content": "curl https://{domain}/api/cm/contacts/describe -v -u {name}:{password}",
5715         "type": "json"
5716       }
5717     ],
5718     "name": "DescribeContacts",
5719     "group": "Cm_Contacts",
5720     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5721     "version": "0.0.0",
5722     "filename": "server/api/cmContact/index.js",
5723     "groupTitle": "Cm_Contacts"
5724   },
5725   {
5726     "type": "get",
5727     "url": "/api/cm/contacts",
5728     "title": "Gets a list of Contacts",
5729     "examples": [
5730       {
5731         "title": "Example usage:",
5732         "content": "curl https://{domain}/api/cm/contacts -v -u {name}:{password}",
5733         "type": "json"
5734       }
5735     ],
5736     "name": "GetContacts",
5737     "group": "Cm_Contacts",
5738     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5739     "version": "0.0.0",
5740     "filename": "server/api/cmContact/index.js",
5741     "groupTitle": "Cm_Contacts"
5742   },
5743   {
5744     "type": "get",
5745     "url": "/api/cm/contacts/{id}/finals",
5746     "title": "Gets contact hopper finals",
5747     "examples": [
5748       {
5749         "title": "Example usage:",
5750         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_finals -v -u {name}:{password}  -X GET",
5751         "type": "json"
5752       }
5753     ],
5754     "name": "GetHopperFinals",
5755     "group": "Cm_Contacts",
5756     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5757     "version": "0.0.0",
5758     "filename": "server/api/cmContact/index.js",
5759     "groupTitle": "Cm_Contacts"
5760   },
5761   {
5762     "type": "get",
5763     "url": "/api/cm/contacts/{id}/hopper_histories",
5764     "title": "Gets contact hopper histories",
5765     "examples": [
5766       {
5767         "title": "Example usage:",
5768         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_histories -v -u {name}:{password} -X GET",
5769         "type": "json"
5770       }
5771     ],
5772     "name": "GetHopperHistories",
5773     "group": "Cm_Contacts",
5774     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5775     "version": "0.0.0",
5776     "filename": "server/api/cmContact/index.js",
5777     "groupTitle": "Cm_Contacts"
5778   },
5779   {
5780     "type": "get",
5781     "url": "/api/cm/contacts/{id}/hoppers",
5782     "title": "Gets contact hoppers",
5783     "examples": [
5784       {
5785         "title": "Example usage:",
5786         "content": "curl https://{domain}/api/cm/contacts/{id}/hoppers -v -u {name}:{password} -X GET",
5787         "type": "json"
5788       }
5789     ],
5790     "name": "GetHoppers",
5791     "group": "Cm_Contacts",
5792     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5793     "version": "0.0.0",
5794     "filename": "server/api/cmContact/index.js",
5795     "groupTitle": "Cm_Contacts"
5796   },
5797   {
5798     "type": "post",
5799     "url": "/api/cm/contacts/create_many",
5800     "title": "Create Contacts",
5801     "examples": [
5802       {
5803         "title": "Example usage:",
5804         "content": "curl https://{domain}/api/cm/contacts/create_many -d '[{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}]' -v -u {name}:{password} -X POST",
5805         "type": "json"
5806       }
5807     ],
5808     "name": "bulkCreate",
5809     "group": "Cm_Contacts",
5810     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5811     "version": "0.0.0",
5812     "filename": "server/api/cmContact/index.js",
5813     "groupTitle": "Cm_Contacts"
5814   },
5815   {
5816     "type": "post",
5817     "url": "/api/cm/contacts",
5818     "title": "Create Contact",
5819     "examples": [
5820       {
5821         "title": "Example usage:",
5822         "content": "curl https://{domain}/api/cm/contacts -d '{\"firstName\": \"John\", \"lastName\": \"doe\", \"...\": \"...\"}' -v -u {name}:{password} -X POST",
5823         "type": "json"
5824       }
5825     ],
5826     "name": "create",
5827     "group": "Cm_Contacts",
5828     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5829     "version": "0.0.0",
5830     "filename": "server/api/cmContact/index.js",
5831     "groupTitle": "Cm_Contacts"
5832   },
5833   {
5834     "type": "get",
5835     "url": "/api/cm/contacts/{id}/jscripty_sessions",
5836     "title": "Gets contact hopper blacks",
5837     "examples": [
5838       {
5839         "title": "Example usage:",
5840         "content": "curl https://{domain}/api/cm/contacts/{id}/hopper_black -v -u {name}:{password}  -X GET",
5841         "type": "json"
5842       }
5843     ],
5844     "name": "getJscriptySessions",
5845     "group": "Cm_Contacts",
5846     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5847     "version": "0.0.0",
5848     "filename": "server/api/cmContact/index.js",
5849     "groupTitle": "Cm_Contacts"
5850   },
5851   {
5852     "type": "get",
5853     "url": "/api/cm/contacts/{id}/tags",
5854     "title": "Gets configurations tags",
5855     "examples": [
5856       {
5857         "title": "Example usage:",
5858         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -v -u {name}:{password} -X GET",
5859         "type": "json"
5860       }
5861     ],
5862     "name": "getTags",
5863     "group": "Cm_Contacts",
5864     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5865     "version": "0.0.0",
5866     "filename": "server/api/cmContact/index.js",
5867     "groupTitle": "Cm_Contacts"
5868   },
5869   {
5870     "type": "post",
5871     "url": "/api/cm/contacts/merge",
5872     "title": "Merge Contact",
5873     "examples": [
5874       {
5875         "title": "Example usage:",
5876         "content": "curl https://{domain}/api/cm/contacts/merge -d '{\"from\": 1, \"to\": 2}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5877         "type": "json"
5878       }
5879     ],
5880     "name": "merge",
5881     "group": "Cm_Contacts",
5882     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5883     "version": "0.0.0",
5884     "filename": "server/api/cmContact/index.js",
5885     "groupTitle": "Cm_Contacts"
5886   },
5887   {
5888     "type": "post",
5889     "url": "/api/cm/contacts/{id}/tags",
5890     "title": "Sets new tags",
5891     "examples": [
5892       {
5893         "title": "Example usage:",
5894         "content": "curl https://{domain}/api/cm/contacts/{id}/tags -d '{\"ids\": [1,12]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
5895         "type": "json"
5896       }
5897     ],
5898     "name": "setTags",
5899     "group": "Cm_Contacts",
5900     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5901     "version": "0.0.0",
5902     "filename": "server/api/cmContact/index.js",
5903     "groupTitle": "Cm_Contacts"
5904   },
5905   {
5906     "type": "get",
5907     "url": "/api/cm/contacts/{id}",
5908     "title": "Gets a single Contact",
5909     "examples": [
5910       {
5911         "title": "Example usage:",
5912         "content": "curl https://{domain}/api/cm/contacts/{id} -v -u {name}:{password} -X GET",
5913         "type": "json"
5914       }
5915     ],
5916     "name": "show",
5917     "group": "Cm_Contacts",
5918     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5919     "version": "0.0.0",
5920     "filename": "server/api/cmContact/index.js",
5921     "groupTitle": "Cm_Contacts"
5922   },
5923   {
5924     "type": "put",
5925     "url": "/api/cm/contacts/{id}",
5926     "title": "Update a single Contact",
5927     "examples": [
5928       {
5929         "title": "Example usage:",
5930         "content": "curl https://{domain}/api/cm/contacts/{id} -d '{\"firstName\": \"John\", \"lastName\": \"Doe\"}' -v -u {name}:{password} -X PUT",
5931         "type": "json"
5932       }
5933     ],
5934     "name": "update",
5935     "group": "Cm_Contacts",
5936     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5937     "version": "0.0.0",
5938     "filename": "server/api/cmContact/index.js",
5939     "groupTitle": "Cm_Contacts"
5940   },
5941   {
5942     "type": "delete",
5943     "url": "/api/cm/custom_fields/{id}",
5944     "title": "Deletes a Custom Field",
5945     "examples": [
5946       {
5947         "title": "Example usage:",
5948         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password} -X DELETE",
5949         "type": "json"
5950       }
5951     ],
5952     "name": "DeleteCustom_Fields",
5953     "group": "Cm_Custom_Fields",
5954     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5955     "version": "0.0.0",
5956     "filename": "server/api/cmCustomField/index.js",
5957     "groupTitle": "Cm_Custom_Fields"
5958   },
5959   {
5960     "type": "get",
5961     "url": "/api/cm/custom_fields",
5962     "title": "Gets a list of Custom Fields",
5963     "examples": [
5964       {
5965         "title": "Example usage:",
5966         "content": "curl https://{domain}/api/cm/custom_fields -v -u {name}:{password}",
5967         "type": "json"
5968       }
5969     ],
5970     "name": "GetCustom_Fields",
5971     "group": "Cm_Custom_Fields",
5972     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
5973     "version": "0.0.0",
5974     "filename": "server/api/cmCustomField/index.js",
5975     "groupTitle": "Cm_Custom_Fields"
5976   },
5977   {
5978     "type": "get",
5979     "url": "/api/cm/custom_fields/{id}",
5980     "title": "Gets a single Custom Field",
5981     "examples": [
5982       {
5983         "title": "Example usage:",
5984         "content": "curl https://{domain}/api/cm/custom_fields/{id} -v -u {name}:{password}",
5985         "type": "json"
5986       }
5987     ],
5988     "name": "ShowCustom_Fields",
5989     "group": "Cm_Custom_Fields",
5990     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
5991     "version": "0.0.0",
5992     "filename": "server/api/cmCustomField/index.js",
5993     "groupTitle": "Cm_Custom_Fields"
5994   },
5995   {
5996     "type": "put",
5997     "url": "/api/cm/custom_fields/{id}",
5998     "title": "Update an existing Custom Field",
5999     "examples": [
6000       {
6001         "title": "Example usage:",
6002         "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",
6003         "type": "json"
6004       }
6005     ],
6006     "name": "updateCustom_Fields",
6007     "group": "Cm_Custom_Fields",
6008     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6009     "version": "0.0.0",
6010     "filename": "server/api/cmCustomField/index.js",
6011     "groupTitle": "Cm_Custom_Fields"
6012   },
6013   {
6014     "type": "post",
6015     "url": "/api/cm/hopper",
6016     "title": "Creates a new Hopper",
6017     "examples": [
6018       {
6019         "title": "Example usage:",
6020         "content": "curl https://{domain}/api/cm/hopper -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6021         "type": "json"
6022       }
6023     ],
6024     "name": "CreateHopper",
6025     "group": "Cm_Hopper",
6026     "parameter": {
6027       "fields": {
6028         "Body": [
6029           {
6030             "group": "Body",
6031             "type": "String",
6032             "optional": false,
6033             "field": "phone",
6034             "description": ""
6035           },
6036           {
6037             "group": "Body",
6038             "type": "Boolean",
6039             "optional": true,
6040             "field": "active",
6041             "description": ""
6042           },
6043           {
6044             "group": "Body",
6045             "type": "String",
6046             "optional": true,
6047             "field": "scheduledat",
6048             "description": ""
6049           },
6050           {
6051             "group": "Body",
6052             "type": "Integer",
6053             "optional": true,
6054             "field": "countbusyretry",
6055             "description": ""
6056           },
6057           {
6058             "group": "Body",
6059             "type": "Integer",
6060             "optional": true,
6061             "field": "countcongestionretry",
6062             "description": ""
6063           },
6064           {
6065             "group": "Body",
6066             "type": "Integer",
6067             "optional": true,
6068             "field": "countnoanswerretry",
6069             "description": ""
6070           },
6071           {
6072             "group": "Body",
6073             "type": "Boolean",
6074             "optional": true,
6075             "field": "callback",
6076             "description": ""
6077           },
6078           {
6079             "group": "Body",
6080             "type": "String",
6081             "optional": true,
6082             "field": "callbackuniqueid",
6083             "description": ""
6084           },
6085           {
6086             "group": "Body",
6087             "type": "String",
6088             "optional": true,
6089             "field": "callbackat",
6090             "description": ""
6091           },
6092           {
6093             "group": "Body",
6094             "type": "Integer",
6095             "optional": true,
6096             "field": "priority",
6097             "description": ""
6098           },
6099           {
6100             "group": "Body",
6101             "type": "Boolean",
6102             "optional": true,
6103             "field": "recallme",
6104             "description": ""
6105           },
6106           {
6107             "group": "Body",
6108             "type": "Integer",
6109             "optional": true,
6110             "field": "ContactId",
6111             "description": ""
6112           },
6113           {
6114             "group": "Body",
6115             "type": "Integer",
6116             "optional": true,
6117             "field": "ListId",
6118             "description": ""
6119           },
6120           {
6121             "group": "Body",
6122             "type": "Integer",
6123             "optional": true,
6124             "field": "UserId",
6125             "description": ""
6126           },
6127           {
6128             "group": "Body",
6129             "type": "Integer",
6130             "optional": true,
6131             "field": "VoiceQueueId",
6132             "description": ""
6133           },
6134           {
6135             "group": "Body",
6136             "type": "Integer",
6137             "optional": true,
6138             "field": "CampaignId",
6139             "description": ""
6140           }
6141         ]
6142       }
6143     },
6144     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6145     "version": "0.0.0",
6146     "filename": "server/api/cmHopper/index.js",
6147     "groupTitle": "Cm_Hopper"
6148   },
6149   {
6150     "type": "get",
6151     "url": "/api/cm/hopper/describe",
6152     "title": "Gets table info about Hopper",
6153     "examples": [
6154       {
6155         "title": "Example usage:",
6156         "content": "curl https://{domain}/api/cm/hopper/describe -v -u {name}:{password}",
6157         "type": "json"
6158       }
6159     ],
6160     "name": "DescribeHopper",
6161     "group": "Cm_Hopper",
6162     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6163     "version": "0.0.0",
6164     "filename": "server/api/cmHopper/index.js",
6165     "groupTitle": "Cm_Hopper"
6166   },
6167   {
6168     "type": "get",
6169     "url": "/api/cm/hopper",
6170     "title": "Gets a list of Hopper",
6171     "examples": [
6172       {
6173         "title": "Example usage:",
6174         "content": "curl https://{domain}/api/cm/hopper -v -u {name}:{password}",
6175         "type": "json"
6176       }
6177     ],
6178     "name": "GetHopper",
6179     "group": "Cm_Hopper",
6180     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6181     "version": "0.0.0",
6182     "filename": "server/api/cmHopper/index.js",
6183     "groupTitle": "Cm_Hopper"
6184   },
6185   {
6186     "type": "get",
6187     "url": "/api/cm/hopper/{id}",
6188     "title": "Gets a single Hopper",
6189     "examples": [
6190       {
6191         "title": "Example usage:",
6192         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password}",
6193         "type": "json"
6194       }
6195     ],
6196     "name": "ShowHopper",
6197     "group": "Cm_Hopper",
6198     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6199     "version": "0.0.0",
6200     "filename": "server/api/cmHopper/index.js",
6201     "groupTitle": "Cm_Hopper"
6202   },
6203   {
6204     "type": "delete",
6205     "url": "/api/cm/hopper_black/{id}",
6206     "title": "Deletes a Hopper Black",
6207     "examples": [
6208       {
6209         "title": "Example usage:",
6210         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password} -X DELETE",
6211         "type": "json"
6212       }
6213     ],
6214     "name": "DeleteHopper_Black",
6215     "group": "Cm_Hopper_Black",
6216     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6217     "version": "0.0.0",
6218     "filename": "server/api/cmHopperBlack/index.js",
6219     "groupTitle": "Cm_Hopper_Black"
6220   },
6221   {
6222     "type": "get",
6223     "url": "/api/cm/hopper_black/describe",
6224     "title": "Gets table info about Hopper Black",
6225     "examples": [
6226       {
6227         "title": "Example usage:",
6228         "content": "curl https://{domain}/api/cm/hopper_black/describe -v -u {name}:{password}",
6229         "type": "json"
6230       }
6231     ],
6232     "name": "DescribeHopper_Black",
6233     "group": "Cm_Hopper_Black",
6234     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6235     "version": "0.0.0",
6236     "filename": "server/api/cmHopperBlack/index.js",
6237     "groupTitle": "Cm_Hopper_Black"
6238   },
6239   {
6240     "type": "get",
6241     "url": "/api/cm/hopper_black",
6242     "title": "Gets a list of Hopper Black",
6243     "examples": [
6244       {
6245         "title": "Example usage:",
6246         "content": "curl https://{domain}/api/cm/hopper_black -v -u {name}:{password}",
6247         "type": "json"
6248       }
6249     ],
6250     "name": "GetHopper_Black",
6251     "group": "Cm_Hopper_Black",
6252     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6253     "version": "0.0.0",
6254     "filename": "server/api/cmHopperBlack/index.js",
6255     "groupTitle": "Cm_Hopper_Black"
6256   },
6257   {
6258     "type": "get",
6259     "url": "/api/cm/hopper_black/{id}",
6260     "title": "Gets a single Hopper Black",
6261     "examples": [
6262       {
6263         "title": "Example usage:",
6264         "content": "curl https://{domain}/api/cm/hopper_black/{id} -v -u {name}:{password}",
6265         "type": "json"
6266       }
6267     ],
6268     "name": "ShowHopper_Black",
6269     "group": "Cm_Hopper_Black",
6270     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6271     "version": "0.0.0",
6272     "filename": "server/api/cmHopperBlack/index.js",
6273     "groupTitle": "Cm_Hopper_Black"
6274   },
6275   {
6276     "type": "put",
6277     "url": "/api/cm/hopper_black/{id}",
6278     "title": "Update an existing Hopper Black",
6279     "examples": [
6280       {
6281         "title": "Example usage:",
6282         "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",
6283         "type": "json"
6284       }
6285     ],
6286     "name": "updateHopper_Black",
6287     "group": "Cm_Hopper_Black",
6288     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6289     "version": "0.0.0",
6290     "filename": "server/api/cmHopperBlack/index.js",
6291     "groupTitle": "Cm_Hopper_Black"
6292   },
6293   {
6294     "type": "post",
6295     "url": "/api/cm/hopper_final/checkContactHopper",
6296     "title": "Check if contact is in hopper",
6297     "examples": [
6298       {
6299         "title": "Example usage:",
6300         "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",
6301         "type": "json"
6302       }
6303     ],
6304     "name": "/checkContactHopper",
6305     "group": "Cm_Hopper_Final",
6306     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6307     "version": "0.0.0",
6308     "filename": "server/api/cmHopperFinal/index.js",
6309     "groupTitle": "Cm_Hopper_Final"
6310   },
6311   {
6312     "type": "get",
6313     "url": "/api/cm/hopper_final/describe",
6314     "title": "Gets table info about HopperFinal",
6315     "examples": [
6316       {
6317         "title": "Example usage:",
6318         "content": "curl https://{domain}/api/cm/hopper_final/describe -v -u {name}:{password}",
6319         "type": "json"
6320       }
6321     ],
6322     "name": "DescribeHopperFinal",
6323     "group": "Cm_Hopper_Final",
6324     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6325     "version": "0.0.0",
6326     "filename": "server/api/cmHopperFinal/index.js",
6327     "groupTitle": "Cm_Hopper_Final"
6328   },
6329   {
6330     "type": "get",
6331     "url": "/api/cm/hopper_final",
6332     "title": "Gets a list of HopperFinal",
6333     "examples": [
6334       {
6335         "title": "Example usage:",
6336         "content": "curl https://{domain}/api/cm/hopper_final -v -u {name}:{password}",
6337         "type": "json"
6338       }
6339     ],
6340     "name": "GetHopperFinal",
6341     "group": "Cm_Hopper_Final",
6342     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6343     "version": "0.0.0",
6344     "filename": "server/api/cmHopperFinal/index.js",
6345     "groupTitle": "Cm_Hopper_Final"
6346   },
6347   {
6348     "type": "get",
6349     "url": "/api/cm/hopper_final/{id}",
6350     "title": "Gets a single HopperFinal",
6351     "examples": [
6352       {
6353         "title": "Example usage:",
6354         "content": "curl https://{domain}/api/cm/hopper_final/{id} -v -u {name}:{password}",
6355         "type": "json"
6356       }
6357     ],
6358     "name": "ShowHopperFinal",
6359     "group": "Cm_Hopper_Final",
6360     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6361     "version": "0.0.0",
6362     "filename": "server/api/cmHopperFinal/index.js",
6363     "groupTitle": "Cm_Hopper_Final"
6364   },
6365   {
6366     "type": "get",
6367     "url": "/api/cm/hopper_final/campaign/countAttributes/{id}",
6368     "title": "Return number contacts for attributes",
6369     "examples": [
6370       {
6371         "title": "Example usage:",
6372         "content": "curl https://{domain}/api/hopper_final/campaign/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6373         "type": "json"
6374       }
6375     ],
6376     "name": "countContactsIvrCampaignHopperFinal",
6377     "group": "Cm_Hopper_Final",
6378     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6379     "version": "0.0.0",
6380     "filename": "server/api/cmHopperFinal/index.js",
6381     "groupTitle": "Cm_Hopper_Final"
6382   },
6383   {
6384     "type": "get",
6385     "url": "/api/cm/hopper_final/voice/queue/countAttributes/{id}",
6386     "title": "Return number contacts for attributes",
6387     "examples": [
6388       {
6389         "title": "Example usage:",
6390         "content": "curl https://{domain}/api/hopper_final/voice/queue/countAttributes/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X GET",
6391         "type": "json"
6392       }
6393     ],
6394     "name": "countContactsQueueCampaignHopperFinal",
6395     "group": "Cm_Hopper_Final",
6396     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6397     "version": "0.0.0",
6398     "filename": "server/api/cmHopperFinal/index.js",
6399     "groupTitle": "Cm_Hopper_Final"
6400   },
6401   {
6402     "type": "post",
6403     "url": "/api/cm/hopper_final/campaign/{id}",
6404     "title": "Move contacts in hopper",
6405     "examples": [
6406       {
6407         "title": "Example usage:",
6408         "content": "curl https://{domain}/api/hopper_final/campaign/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
6409         "type": "json"
6410       }
6411     ],
6412     "name": "moveContactsIvrCampaignHopperFinal",
6413     "group": "Cm_Hopper_Final",
6414     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6415     "version": "0.0.0",
6416     "filename": "server/api/cmHopperFinal/index.js",
6417     "groupTitle": "Cm_Hopper_Final"
6418   },
6419   {
6420     "type": "post",
6421     "url": "/api/cm/hopper_final/voice/queue/{id}",
6422     "title": "Move contacts in hopper",
6423     "examples": [
6424       {
6425         "title": "Example usage:",
6426         "content": "curl https://{domain}/api/hopper_final/voice/queue/moveContacts/{id} -d '{\"state\": \"state\"}' -H 'Content-Type: application/json' -v -u {name}:{password}",
6427         "type": "json"
6428       }
6429     ],
6430     "name": "moveContactsQueueCampaignHopperFinal",
6431     "group": "Cm_Hopper_Final",
6432     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6433     "version": "0.0.0",
6434     "filename": "server/api/cmHopperFinal/index.js",
6435     "groupTitle": "Cm_Hopper_Final"
6436   },
6437   {
6438     "type": "put",
6439     "url": "/api/cm/hopper_final/{id}",
6440     "title": "Update a single hopper final",
6441     "examples": [
6442       {
6443         "title": "Example usage:",
6444         "content": "curl https://{domain}/api/hopper_final/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6445         "type": "json"
6446       }
6447     ],
6448     "name": "update",
6449     "group": "Cm_Hopper_Final",
6450     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6451     "version": "0.0.0",
6452     "filename": "server/api/cmHopperFinal/index.js",
6453     "groupTitle": "Cm_Hopper_Final"
6454   },
6455   {
6456     "type": "post",
6457     "url": "/api/cm/hopper_history",
6458     "title": "Creates a new HopperHistory",
6459     "examples": [
6460       {
6461         "title": "Example usage:",
6462         "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",
6463         "type": "json"
6464       }
6465     ],
6466     "name": "CreateHopperHistory",
6467     "group": "Cm_Hopper_History",
6468     "parameter": {
6469       "fields": {
6470         "Body": [
6471           {
6472             "group": "Body",
6473             "type": "Integer",
6474             "optional": true,
6475             "field": "state",
6476             "description": ""
6477           },
6478           {
6479             "group": "Body",
6480             "type": "String",
6481             "optional": true,
6482             "field": "statedesc",
6483             "description": ""
6484           },
6485           {
6486             "group": "Body",
6487             "type": "String",
6488             "optional": true,
6489             "field": "scheduledat",
6490             "description": ""
6491           },
6492           {
6493             "group": "Body",
6494             "type": "Integer",
6495             "optional": true,
6496             "field": "countbusyretry",
6497             "description": ""
6498           },
6499           {
6500             "group": "Body",
6501             "type": "Integer",
6502             "optional": true,
6503             "field": "countcongestionretry",
6504             "description": ""
6505           },
6506           {
6507             "group": "Body",
6508             "type": "Integer",
6509             "optional": true,
6510             "field": "countnoanswerretry",
6511             "description": ""
6512           },
6513           {
6514             "group": "Body",
6515             "type": "Integer",
6516             "optional": true,
6517             "field": "countglobal",
6518             "description": ""
6519           },
6520           {
6521             "group": "Body",
6522             "type": "String",
6523             "optional": true,
6524             "field": "uniqueid",
6525             "description": ""
6526           },
6527           {
6528             "group": "Body",
6529             "type": "String",
6530             "optional": true,
6531             "field": "originatecalleridnum",
6532             "description": ""
6533           },
6534           {
6535             "group": "Body",
6536             "type": "String",
6537             "optional": true,
6538             "field": "originatecalleridname",
6539             "description": ""
6540           },
6541           {
6542             "group": "Body",
6543             "type": "String",
6544             "optional": true,
6545             "field": "calleridnum",
6546             "description": ""
6547           },
6548           {
6549             "group": "Body",
6550             "type": "String",
6551             "optional": true,
6552             "field": "calleridname",
6553             "description": ""
6554           },
6555           {
6556             "group": "Body",
6557             "type": "String",
6558             "optional": true,
6559             "field": "starttime",
6560             "description": ""
6561           },
6562           {
6563             "group": "Body",
6564             "type": "String",
6565             "optional": true,
6566             "field": "responsetime",
6567             "description": ""
6568           },
6569           {
6570             "group": "Body",
6571             "type": "String",
6572             "optional": true,
6573             "field": "answertime",
6574             "description": ""
6575           },
6576           {
6577             "group": "Body",
6578             "type": "String",
6579             "optional": true,
6580             "field": "droptime",
6581             "description": ""
6582           },
6583           {
6584             "group": "Body",
6585             "type": "String",
6586             "optional": true,
6587             "field": "endtime",
6588             "description": ""
6589           },
6590           {
6591             "group": "Body",
6592             "type": "Integer",
6593             "optional": true,
6594             "field": "ringtime",
6595             "description": ""
6596           },
6597           {
6598             "group": "Body",
6599             "type": "Integer",
6600             "optional": true,
6601             "field": "holdtime",
6602             "description": ""
6603           },
6604           {
6605             "group": "Body",
6606             "type": "Integer",
6607             "optional": true,
6608             "field": "talktime",
6609             "description": ""
6610           },
6611           {
6612             "group": "Body",
6613             "type": "Integer",
6614             "optional": true,
6615             "field": "followuptime",
6616             "description": ""
6617           },
6618           {
6619             "group": "Body",
6620             "type": "String",
6621             "optional": true,
6622             "field": "dropreason",
6623             "description": ""
6624           },
6625           {
6626             "group": "Body",
6627             "type": "String",
6628             "optional": true,
6629             "field": "campaign",
6630             "description": ""
6631           },
6632           {
6633             "group": "Body",
6634             "type": "String",
6635             "optional": true,
6636             "field": "campaigntype",
6637             "description": ""
6638           },
6639           {
6640             "group": "Body",
6641             "type": "String",
6642             "optional": true,
6643             "field": "membername",
6644             "description": ""
6645           },
6646           {
6647             "group": "Body",
6648             "type": "String",
6649             "optional": true,
6650             "field": "reason",
6651             "description": ""
6652           },
6653           {
6654             "group": "Body",
6655             "type": "Boolean",
6656             "optional": true,
6657             "field": "amd",
6658             "description": ""
6659           },
6660           {
6661             "group": "Body",
6662             "type": "Boolean",
6663             "optional": true,
6664             "field": "fax",
6665             "description": ""
6666           },
6667           {
6668             "group": "Body",
6669             "type": "Boolean",
6670             "optional": true,
6671             "field": "callback",
6672             "description": ""
6673           },
6674           {
6675             "group": "Body",
6676             "type": "String",
6677             "optional": true,
6678             "field": "callbackuniqueid",
6679             "description": ""
6680           },
6681           {
6682             "group": "Body",
6683             "type": "String",
6684             "optional": true,
6685             "field": "callbackat",
6686             "description": ""
6687           },
6688           {
6689             "group": "Body",
6690             "type": "Boolean",
6691             "optional": true,
6692             "field": "recallme",
6693             "description": ""
6694           },
6695           {
6696             "group": "Body",
6697             "type": "String",
6698             "optional": true,
6699             "field": "editedat",
6700             "description": ""
6701           },
6702           {
6703             "group": "Body",
6704             "type": "Boolean",
6705             "optional": true,
6706             "field": "edited",
6707             "description": ""
6708           }
6709         ]
6710       }
6711     },
6712     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6713     "version": "0.0.0",
6714     "filename": "server/api/cmHopperHistory/index.js",
6715     "groupTitle": "Cm_Hopper_History"
6716   },
6717   {
6718     "type": "get",
6719     "url": "/api/cm/hopper_history/describe",
6720     "title": "Gets table info about HopperHistory",
6721     "examples": [
6722       {
6723         "title": "Example usage:",
6724         "content": "curl https://{domain}/api/cm/hopper_history/describe -v -u {name}:{password}",
6725         "type": "json"
6726       }
6727     ],
6728     "name": "DescribeHopperHistory",
6729     "group": "Cm_Hopper_History",
6730     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6731     "version": "0.0.0",
6732     "filename": "server/api/cmHopperHistory/index.js",
6733     "groupTitle": "Cm_Hopper_History"
6734   },
6735   {
6736     "type": "get",
6737     "url": "/api/cm/hopper_history",
6738     "title": "Gets a list of HopperHistory",
6739     "examples": [
6740       {
6741         "title": "Example usage:",
6742         "content": "curl https://{domain}/api/cm/hopper_history -v -u {name}:{password}",
6743         "type": "json"
6744       }
6745     ],
6746     "name": "GetHopperHistory",
6747     "group": "Cm_Hopper_History",
6748     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6749     "version": "0.0.0",
6750     "filename": "server/api/cmHopperHistory/index.js",
6751     "groupTitle": "Cm_Hopper_History"
6752   },
6753   {
6754     "type": "get",
6755     "url": "/api/cm/hopper_history/{id}",
6756     "title": "Gets a single HopperHistory",
6757     "examples": [
6758       {
6759         "title": "Example usage:",
6760         "content": "curl https://{domain}/api/cm/hopper_history/{id} -v -u {name}:{password}",
6761         "type": "json"
6762       }
6763     ],
6764     "name": "ShowHopperHistory",
6765     "group": "Cm_Hopper_History",
6766     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6767     "version": "0.0.0",
6768     "filename": "server/api/cmHopperHistory/index.js",
6769     "groupTitle": "Cm_Hopper_History"
6770   },
6771   {
6772     "type": "put",
6773     "url": "/api/cm/hopper_history/{id}",
6774     "title": "Update a single hopper history",
6775     "examples": [
6776       {
6777         "title": "Example usage:",
6778         "content": "curl https://{domain}/api/hopper_history/{id} -d '{\"disposition\": \"OK\"}' -v -u {name}:{password} -X PUT",
6779         "type": "json"
6780       }
6781     ],
6782     "name": "update",
6783     "group": "Cm_Hopper_History",
6784     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6785     "version": "0.0.0",
6786     "filename": "server/api/cmHopperHistory/index.js",
6787     "groupTitle": "Cm_Hopper_History"
6788   },
6789   {
6790     "type": "delete",
6791     "url": "/api/cm/hopper/{id}",
6792     "title": "Delete Hopper",
6793     "examples": [
6794       {
6795         "title": "Example usage:",
6796         "content": "curl https://{domain}/api/cm/hopper/{id} -v -u {name}:{password} -X DELETE",
6797         "type": "json"
6798       }
6799     ],
6800     "name": "destroy",
6801     "group": "Cm_Hopper",
6802     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6803     "version": "0.0.0",
6804     "filename": "server/api/cmHopper/index.js",
6805     "groupTitle": "Cm_Hopper"
6806   },
6807   {
6808     "type": "get",
6809     "url": "/api/cm/hopper/opencontacts",
6810     "title": "Gets Open Contacts",
6811     "examples": [
6812       {
6813         "title": "Example usage:",
6814         "content": "curl https://{domain}/api/cm/hopper/opencontacts -v -u {name}:{password} -X GET",
6815         "type": "json"
6816       }
6817     ],
6818     "name": "getOpenContacts",
6819     "group": "Cm_Hopper",
6820     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6821     "version": "0.0.0",
6822     "filename": "server/api/cmHopper/index.js",
6823     "groupTitle": "Cm_Hopper"
6824   },
6825   {
6826     "type": "post",
6827     "url": "/api/cm/hopper/preview",
6828     "title": "Gets Preview Dialer Contacts",
6829     "examples": [
6830       {
6831         "title": "Example usage:",
6832         "content": "curl https://{domain}/api/cm/hopper/preview -d '{\"hopperIds\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X GET",
6833         "type": "json"
6834       }
6835     ],
6836     "name": "getPreview",
6837     "group": "Cm_Hopper",
6838     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6839     "version": "0.0.0",
6840     "filename": "server/api/cmHopper/index.js",
6841     "groupTitle": "Cm_Hopper"
6842   },
6843   {
6844     "type": "put",
6845     "url": "/api/cm/hopper/{id}",
6846     "title": "Update an existing Hopper",
6847     "examples": [
6848       {
6849         "title": "Example usage:",
6850         "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",
6851         "type": "json"
6852       }
6853     ],
6854     "name": "updateHopper",
6855     "group": "Cm_Hopper",
6856     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6857     "version": "0.0.0",
6858     "filename": "server/api/cmHopper/index.js",
6859     "groupTitle": "Cm_Hopper"
6860   },
6861   {
6862     "type": "post",
6863     "url": "/api/cm/lists",
6864     "title": "Creates a new List",
6865     "examples": [
6866       {
6867         "title": "Example usage:",
6868         "content": "curl https://{domain}/api/cm/lists -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
6869         "type": "json"
6870       }
6871     ],
6872     "name": "CreateLists",
6873     "group": "Cm_Lists",
6874     "parameter": {
6875       "fields": {
6876         "Body": [
6877           {
6878             "group": "Body",
6879             "type": "String",
6880             "optional": false,
6881             "field": "name",
6882             "description": ""
6883           },
6884           {
6885             "group": "Body",
6886             "type": "String",
6887             "optional": true,
6888             "field": "description",
6889             "description": ""
6890           },
6891           {
6892             "group": "Body",
6893             "type": "String",
6894             "optional": true,
6895             "field": "dialPrefix",
6896             "description": ""
6897           }
6898         ]
6899       }
6900     },
6901     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6902     "version": "0.0.0",
6903     "filename": "server/api/cmList/index.js",
6904     "groupTitle": "Cm_Lists"
6905   },
6906   {
6907     "type": "delete",
6908     "url": "/api/cm/lists/{id}",
6909     "title": "Deletes a List",
6910     "examples": [
6911       {
6912         "title": "Example usage:",
6913         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password} -X DELETE",
6914         "type": "json"
6915       }
6916     ],
6917     "name": "DeleteLists",
6918     "group": "Cm_Lists",
6919     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6920     "version": "0.0.0",
6921     "filename": "server/api/cmList/index.js",
6922     "groupTitle": "Cm_Lists"
6923   },
6924   {
6925     "type": "get",
6926     "url": "/api/cm/lists/describe",
6927     "title": "Gets table info about Lists",
6928     "examples": [
6929       {
6930         "title": "Example usage:",
6931         "content": "curl https://{domain}/api/cm/lists/describe -v -u {name}:{password}",
6932         "type": "json"
6933       }
6934     ],
6935     "name": "DescribeLists",
6936     "group": "Cm_Lists",
6937     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6938     "version": "0.0.0",
6939     "filename": "server/api/cmList/index.js",
6940     "groupTitle": "Cm_Lists"
6941   },
6942   {
6943     "type": "get",
6944     "url": "/api/cm/lists/{id}/users",
6945     "title": "Gets agents from list",
6946     "examples": [
6947       {
6948         "title": "Example usage:",
6949         "content": "curl https://{domain}/api/cm/lists/{id}/users -v -u {name}:{password} -X GET",
6950         "type": "json"
6951       }
6952     ],
6953     "name": "GetAgents",
6954     "group": "Cm_Lists",
6955     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6956     "version": "0.0.0",
6957     "filename": "server/api/cmList/index.js",
6958     "groupTitle": "Cm_Lists"
6959   },
6960   {
6961     "type": "get",
6962     "url": "/api/cm/lists",
6963     "title": "Gets a list of Lists",
6964     "examples": [
6965       {
6966         "title": "Example usage:",
6967         "content": "curl https://{domain}/api/cm/lists -v -u {name}:{password}",
6968         "type": "json"
6969       }
6970     ],
6971     "name": "GetLists",
6972     "group": "Cm_Lists",
6973     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
6974     "version": "0.0.0",
6975     "filename": "server/api/cmList/index.js",
6976     "groupTitle": "Cm_Lists"
6977   },
6978   {
6979     "type": "delete",
6980     "url": "/api/cm/lists/{id}/users",
6981     "title": "Removes agents from a list",
6982     "examples": [
6983       {
6984         "title": "Example usage:",
6985         "content": "curl https://{domain}/api/cm/lists/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
6986         "type": "json"
6987       }
6988     ],
6989     "name": "RemoveAgents",
6990     "group": "Cm_Lists",
6991     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
6992     "version": "0.0.0",
6993     "filename": "server/api/cmList/index.js",
6994     "groupTitle": "Cm_Lists"
6995   },
6996   {
6997     "type": "delete",
6998     "url": "/api/cm/lists/{id}/dispositions",
6999     "title": "Removes dispositions from account",
7000     "examples": [
7001       {
7002         "title": "Example usage:",
7003         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
7004         "type": "json"
7005       }
7006     ],
7007     "name": "RemoveDispositions",
7008     "group": "Cm_Lists",
7009     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7010     "version": "0.0.0",
7011     "filename": "server/api/cmList/index.js",
7012     "groupTitle": "Cm_Lists"
7013   },
7014   {
7015     "type": "get",
7016     "url": "/api/cm/lists/{id}",
7017     "title": "Gets a single List",
7018     "examples": [
7019       {
7020         "title": "Example usage:",
7021         "content": "curl https://{domain}/api/cm/lists/{id} -v -u {name}:{password}",
7022         "type": "json"
7023       }
7024     ],
7025     "name": "ShowLists",
7026     "group": "Cm_Lists",
7027     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7028     "version": "0.0.0",
7029     "filename": "server/api/cmList/index.js",
7030     "groupTitle": "Cm_Lists"
7031   },
7032   {
7033     "type": "post",
7034     "url": "/api/cm/lists/{id}/users",
7035     "title": "Adds agents to a list",
7036     "examples": [
7037       {
7038         "title": "Example usage:",
7039         "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",
7040         "type": "json"
7041       }
7042     ],
7043     "name": "addAgents",
7044     "group": "Cm_Lists",
7045     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7046     "version": "0.0.0",
7047     "filename": "server/api/cmList/index.js",
7048     "groupTitle": "Cm_Lists"
7049   },
7050   {
7051     "type": "post",
7052     "url": "/api/cm/lists/{id}/contacts",
7053     "title": "Creates new contacts",
7054     "examples": [
7055       {
7056         "title": "Example usage:",
7057         "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",
7058         "type": "json"
7059       }
7060     ],
7061     "name": "addContacts",
7062     "group": "Cm_Lists",
7063     "parameter": {
7064       "fields": {
7065         "Body": [
7066           {
7067             "group": "Body",
7068             "type": "String",
7069             "optional": false,
7070             "field": "firstName",
7071             "description": ""
7072           },
7073           {
7074             "group": "Body",
7075             "type": "String",
7076             "optional": true,
7077             "field": "lastName",
7078             "description": ""
7079           },
7080           {
7081             "group": "Body",
7082             "type": "String",
7083             "optional": true,
7084             "field": "street",
7085             "description": ""
7086           },
7087           {
7088             "group": "Body",
7089             "type": "String",
7090             "optional": true,
7091             "field": "postalCode",
7092             "description": ""
7093           },
7094           {
7095             "group": "Body",
7096             "type": "String",
7097             "optional": true,
7098             "field": "city",
7099             "description": ""
7100           },
7101           {
7102             "group": "Body",
7103             "type": "String",
7104             "optional": true,
7105             "field": "country",
7106             "description": ""
7107           },
7108           {
7109             "group": "Body",
7110             "type": "String",
7111             "optional": true,
7112             "field": "dateOfBirth",
7113             "description": ""
7114           },
7115           {
7116             "group": "Body",
7117             "type": "Text",
7118             "optional": true,
7119             "field": "description",
7120             "description": ""
7121           },
7122           {
7123             "group": "Body",
7124             "type": "String",
7125             "optional": true,
7126             "field": "phone",
7127             "description": ""
7128           },
7129           {
7130             "group": "Body",
7131             "type": "String",
7132             "optional": true,
7133             "field": "mobile",
7134             "description": ""
7135           },
7136           {
7137             "group": "Body",
7138             "type": "String",
7139             "optional": true,
7140             "field": "fax",
7141             "description": ""
7142           },
7143           {
7144             "group": "Body",
7145             "type": "String",
7146             "optional": true,
7147             "field": "email",
7148             "description": ""
7149           },
7150           {
7151             "group": "Body",
7152             "type": "String",
7153             "optional": true,
7154             "field": "url",
7155             "description": ""
7156           },
7157           {
7158             "group": "Body",
7159             "type": "String",
7160             "optional": true,
7161             "field": "facebook",
7162             "description": ""
7163           },
7164           {
7165             "group": "Body",
7166             "type": "String",
7167             "optional": true,
7168             "field": "fb_data",
7169             "description": ""
7170           },
7171           {
7172             "group": "Body",
7173             "type": "String",
7174             "optional": true,
7175             "field": "twitter",
7176             "description": ""
7177           },
7178           {
7179             "group": "Body",
7180             "type": "String",
7181             "optional": true,
7182             "field": "skype",
7183             "description": ""
7184           },
7185           {
7186             "group": "Body",
7187             "type": "String",
7188             "optional": true,
7189             "field": "teams",
7190             "description": ""
7191           },
7192           {
7193             "group": "Body",
7194             "type": "String",
7195             "optional": true,
7196             "field": "viber",
7197             "description": ""
7198           },
7199           {
7200             "group": "Body",
7201             "type": "String",
7202             "optional": true,
7203             "field": "line",
7204             "description": ""
7205           },
7206           {
7207             "group": "Body",
7208             "type": "String",
7209             "optional": true,
7210             "field": "wechat",
7211             "description": ""
7212           },
7213           {
7214             "group": "Body",
7215             "type": "String",
7216             "optional": true,
7217             "field": "telegram",
7218             "description": ""
7219           },
7220           {
7221             "group": "Body",
7222             "type": "Integer",
7223             "optional": true,
7224             "field": "UserId",
7225             "description": ""
7226           },
7227           {
7228             "group": "Body",
7229             "type": "Integer",
7230             "optional": true,
7231             "field": "priority",
7232             "description": ""
7233           },
7234           {
7235             "group": "Body",
7236             "type": "String",
7237             "optional": true,
7238             "field": "scheduledat",
7239             "description": ""
7240           }
7241         ]
7242       }
7243     },
7244     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7245     "version": "0.0.0",
7246     "filename": "server/api/cmList/index.js",
7247     "groupTitle": "Cm_Lists"
7248   },
7249   {
7250     "type": "post",
7251     "url": "/api/cm/lists/{id}/fields",
7252     "title": "Creates a new custom field",
7253     "examples": [
7254       {
7255         "title": "Example usage:",
7256         "content": "curl https://{domain}/api/cm/lists/{id}/fields -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7257         "type": "json"
7258       }
7259     ],
7260     "name": "addCustomField",
7261     "group": "Cm_Lists",
7262     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7263     "version": "0.0.0",
7264     "filename": "server/api/cmList/index.js",
7265     "groupTitle": "Cm_Lists"
7266   },
7267   {
7268     "type": "post",
7269     "url": "/api/cm/lists/{id}/dispositions",
7270     "title": "Creates new disposition",
7271     "examples": [
7272       {
7273         "title": "Example usage:",
7274         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7275         "type": "json"
7276       }
7277     ],
7278     "name": "addDisposition",
7279     "group": "Cm_Lists",
7280     "parameter": {
7281       "fields": {
7282         "Body": [
7283           {
7284             "group": "Body",
7285             "type": "String",
7286             "optional": false,
7287             "field": "name",
7288             "description": ""
7289           }
7290         ]
7291       }
7292     },
7293     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7294     "version": "0.0.0",
7295     "filename": "server/api/cmList/index.js",
7296     "groupTitle": "Cm_Lists"
7297   },
7298   {
7299     "type": "get",
7300     "url": "/api/cm/lists/{id}/contacts",
7301     "title": "Gets List Contacts",
7302     "examples": [
7303       {
7304         "title": "Example usage:",
7305         "content": "curl https://{domain}/api/cm/lists/{id}/contacts -v -u {name}:{password} -X GET",
7306         "type": "json"
7307       }
7308     ],
7309     "name": "getContacts",
7310     "group": "Cm_Lists",
7311     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7312     "version": "0.0.0",
7313     "filename": "server/api/cmList/index.js",
7314     "groupTitle": "Cm_Lists"
7315   },
7316   {
7317     "type": "get",
7318     "url": "/api/cm/lists/{id}/fields",
7319     "title": "Gets Custom Fields",
7320     "examples": [
7321       {
7322         "title": "Example usage:",
7323         "content": "curl https://{domain}/api/cm/lists/{id}/fields -v -u {name}:{password} -X GET",
7324         "type": "json"
7325       }
7326     ],
7327     "name": "getCustomFields",
7328     "group": "Cm_Lists",
7329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7330     "version": "0.0.0",
7331     "filename": "server/api/cmList/index.js",
7332     "groupTitle": "Cm_Lists"
7333   },
7334   {
7335     "type": "get",
7336     "url": "/api/cm/lists/{id}/dispositions",
7337     "title": "Gets list dispositions",
7338     "examples": [
7339       {
7340         "title": "Example usage:",
7341         "content": "curl https://{domain}/api/cm/lists/{id}/dispositions -v -u {name}:{password} -X GET",
7342         "type": "json"
7343       }
7344     ],
7345     "name": "getDispositions",
7346     "group": "Cm_Lists",
7347     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7348     "version": "0.0.0",
7349     "filename": "server/api/cmList/index.js",
7350     "groupTitle": "Cm_Lists"
7351   },
7352   {
7353     "type": "get",
7354     "url": "/api/cm/lists/{id}/contacts/csv",
7355     "title": "Gets CSV List Contacts",
7356     "examples": [
7357       {
7358         "title": "Example usage:",
7359         "content": "curl https://{domain}/api/cm/lists/{id}/contacts/csv -v -u {name}:{password} -X GET",
7360         "type": "json"
7361       }
7362     ],
7363     "name": "grunt",
7364     "group": "Cm_Lists",
7365     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7366     "version": "0.0.0",
7367     "filename": "server/api/cmList/index.js",
7368     "groupTitle": "Cm_Lists"
7369   },
7370   {
7371     "type": "put",
7372     "url": "/api/cm/lists/{id}",
7373     "title": "Update an existing List",
7374     "examples": [
7375       {
7376         "title": "Example usage:",
7377         "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",
7378         "type": "json"
7379       }
7380     ],
7381     "name": "updateLists",
7382     "group": "Cm_Lists",
7383     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7384     "version": "0.0.0",
7385     "filename": "server/api/cmList/index.js",
7386     "groupTitle": "Cm_Lists"
7387   },
7388   {
7389     "type": "post",
7390     "url": "/api/cm/contacts/upload/:id",
7391     "title": "Import new contacts by csv",
7392     "examples": [
7393       {
7394         "title": "Example usage:",
7395         "content": "curl https://{domain}/api/cm/contacts/upload/:id -v -u {name}:{password} -X POST",
7396         "type": "json"
7397       }
7398     ],
7399     "name": "import",
7400     "group": "Cm_contacts",
7401     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7402     "version": "0.0.0",
7403     "filename": "server/api/cmContact/index.js",
7404     "groupTitle": "Cm_contacts"
7405   },
7406   {
7407     "type": "post",
7408     "url": "/api/cm/contacts/upload",
7409     "title": "Upload csv",
7410     "examples": [
7411       {
7412         "title": "Example usage:",
7413         "content": "curl https://{domain}/api/cm/contacts/upload -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7414         "type": "json"
7415       }
7416     ],
7417     "name": "upload",
7418     "group": "Cm_contacts",
7419     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7420     "version": "0.0.0",
7421     "filename": "server/api/cmContact/index.js",
7422     "groupTitle": "Cm_contacts"
7423   },
7424   {
7425     "type": "post",
7426     "url": "/api/cm/contacts/csv",
7427     "title": "Create new contacts by csv",
7428     "examples": [
7429       {
7430         "title": "Example usage:",
7431         "content": "curl https://{domain}/api/cm/contacts/csv -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
7432         "type": "json"
7433       }
7434     ],
7435     "name": "uploadCsv",
7436     "group": "Cm_contacts",
7437     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7438     "version": "0.0.0",
7439     "filename": "server/api/cmContact/index.js",
7440     "groupTitle": "Cm_contacts"
7441   },
7442   {
7443     "type": "delete",
7444     "url": "/api/conditions/{id}",
7445     "title": "Deletes a Condition",
7446     "examples": [
7447       {
7448         "title": "Example usage:",
7449         "content": "curl https://{domain}/api/conditions/{id} -v -u {name}:{password} -X DELETE",
7450         "type": "json"
7451       }
7452     ],
7453     "name": "DeleteConditions",
7454     "group": "Conditions",
7455     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7456     "version": "0.0.0",
7457     "filename": "server/api/condition/index.js",
7458     "groupTitle": "Conditions"
7459   },
7460   {
7461     "type": "put",
7462     "url": "/api/conditions/{id}",
7463     "title": "Update an existing Condition",
7464     "examples": [
7465       {
7466         "title": "Example usage:",
7467         "content": "curl https://{domain}/api/conditions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7468         "type": "json"
7469       }
7470     ],
7471     "name": "updateConditions",
7472     "group": "Conditions",
7473     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7474     "version": "0.0.0",
7475     "filename": "server/api/condition/index.js",
7476     "groupTitle": "Conditions"
7477   },
7478   {
7479     "type": "post",
7480     "url": "/api/cm/custom_field",
7481     "title": "Create a new custom field",
7482     "examples": [
7483       {
7484         "title": "Example usage:",
7485         "content": "curl https://{domain}/api/cm/custom_field  -d '{\"name\": \"mycf\", \"type\": \"text\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7486         "type": "json"
7487       }
7488     ],
7489     "name": "CreateCustomField",
7490     "group": "Custom_Fields",
7491     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7492     "version": "0.0.0",
7493     "filename": "server/api/cmCustomField/index.js",
7494     "groupTitle": "Custom_Fields"
7495   },
7496   {
7497     "type": "post",
7498     "url": "/api/dashboards/items",
7499     "title": "Create dasboard item",
7500     "examples": [
7501       {
7502         "title": "Example usage:",
7503         "content": "curl https://{domain}/api/dashboards/items \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
7504         "type": "json"
7505       }
7506     ],
7507     "name": "Create",
7508     "group": "Dashboard_Items",
7509     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7510     "version": "0.0.0",
7511     "filename": "server/api/dashboardItem/index.js",
7512     "groupTitle": "Dashboard_Items"
7513   },
7514   {
7515     "type": "delete",
7516     "url": "/api/dashboards/items/{id}",
7517     "title": "Deletes a Dashboard Item",
7518     "examples": [
7519       {
7520         "title": "Example usage:",
7521         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X DELETE",
7522         "type": "json"
7523       }
7524     ],
7525     "name": "DeleteDashboard_Items",
7526     "group": "Dashboard_Items",
7527     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7528     "version": "0.0.0",
7529     "filename": "server/api/dashboardItem/index.js",
7530     "groupTitle": "Dashboard_Items"
7531   },
7532   {
7533     "type": "get",
7534     "url": "/api/dashboards/items/{id}",
7535     "title": "Gets a single Dashboard Item",
7536     "examples": [
7537       {
7538         "title": "Example usage:",
7539         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password}",
7540         "type": "json"
7541       }
7542     ],
7543     "name": "ShowDashboard_Items",
7544     "group": "Dashboard_Items",
7545     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7546     "version": "0.0.0",
7547     "filename": "server/api/dashboardItem/index.js",
7548     "groupTitle": "Dashboard_Items"
7549   },
7550   {
7551     "type": "put",
7552     "url": "/api/dashboards/items/{id}",
7553     "title": "Update an existing item",
7554     "examples": [
7555       {
7556         "title": "Example usage:",
7557         "content": "curl https://{domain}/api/dashboards/items/{id} -v -u {name}:{password} -X PUT",
7558         "type": "json"
7559       }
7560     ],
7561     "name": "Update",
7562     "group": "Dashboard_Items",
7563     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7564     "version": "0.0.0",
7565     "filename": "server/api/dashboardItem/index.js",
7566     "groupTitle": "Dashboard_Items"
7567   },
7568   {
7569     "type": "post",
7570     "url": "/api/dashboards/clone",
7571     "title": "Clone an existing Dashboard",
7572     "examples": [
7573       {
7574         "title": "Example usage:",
7575         "content": "curl https://{domain}/api/dashboards/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7576         "type": "json"
7577       }
7578     ],
7579     "name": "CloneDashboards",
7580     "group": "Dashboards",
7581     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7582     "version": "0.0.0",
7583     "filename": "server/api/dashboard/index.js",
7584     "groupTitle": "Dashboards"
7585   },
7586   {
7587     "type": "post",
7588     "url": "/api/dashboards",
7589     "title": "Creates a new Dashboard",
7590     "examples": [
7591       {
7592         "title": "Example usage:",
7593         "content": "curl https://{domain}/api/dashboards -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
7594         "type": "json"
7595       }
7596     ],
7597     "name": "CreateDashboards",
7598     "group": "Dashboards",
7599     "parameter": {
7600       "fields": {
7601         "Body": [
7602           {
7603             "group": "Body",
7604             "type": "String",
7605             "optional": false,
7606             "field": "name",
7607             "description": ""
7608           },
7609           {
7610             "group": "Body",
7611             "type": "String",
7612             "optional": true,
7613             "field": "description",
7614             "description": ""
7615           }
7616         ]
7617       }
7618     },
7619     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7620     "version": "0.0.0",
7621     "filename": "server/api/dashboard/index.js",
7622     "groupTitle": "Dashboards"
7623   },
7624   {
7625     "type": "delete",
7626     "url": "/api/dashboards/{id}",
7627     "title": "Deletes a Dashboard",
7628     "examples": [
7629       {
7630         "title": "Example usage:",
7631         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password} -X DELETE",
7632         "type": "json"
7633       }
7634     ],
7635     "name": "DeleteDashboards",
7636     "group": "Dashboards",
7637     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7638     "version": "0.0.0",
7639     "filename": "server/api/dashboard/index.js",
7640     "groupTitle": "Dashboards"
7641   },
7642   {
7643     "type": "get",
7644     "url": "/api/dashboards",
7645     "title": "Gets a list of Dashboards",
7646     "examples": [
7647       {
7648         "title": "Example usage:",
7649         "content": "curl https://{domain}/api/dashboards -v -u {name}:{password}",
7650         "type": "json"
7651       }
7652     ],
7653     "name": "GetDashboards",
7654     "group": "Dashboards",
7655     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7656     "version": "0.0.0",
7657     "filename": "server/api/dashboard/index.js",
7658     "groupTitle": "Dashboards"
7659   },
7660   {
7661     "type": "get",
7662     "url": "/api/dashboards/{id}",
7663     "title": "Gets a single Dashboard",
7664     "examples": [
7665       {
7666         "title": "Example usage:",
7667         "content": "curl https://{domain}/api/dashboards/{id} -v -u {name}:{password}",
7668         "type": "json"
7669       }
7670     ],
7671     "name": "ShowDashboards",
7672     "group": "Dashboards",
7673     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7674     "version": "0.0.0",
7675     "filename": "server/api/dashboard/index.js",
7676     "groupTitle": "Dashboards"
7677   },
7678   {
7679     "type": "post",
7680     "url": "/api/dashboards/{id}/items",
7681     "title": "Creates new item",
7682     "examples": [
7683       {
7684         "title": "Example usage:",
7685         "content": "curl https://{domain}/api/dashboards/{id}/items -d '{\"type\": \"counter\", \"...\": \"...\"}]' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
7686         "type": "json"
7687       }
7688     ],
7689     "name": "addItem",
7690     "group": "Dashboards",
7691     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7692     "version": "0.0.0",
7693     "filename": "server/api/dashboard/index.js",
7694     "groupTitle": "Dashboards"
7695   },
7696   {
7697     "type": "get",
7698     "url": "/api/dashboards/{id}/items",
7699     "title": "Gets items",
7700     "examples": [
7701       {
7702         "title": "Example usage:",
7703         "content": "curl https://{domain}/api/dashboards/{id}/items -v -u {name}:{password} -X GET",
7704         "type": "json"
7705       }
7706     ],
7707     "name": "getItems",
7708     "group": "Dashboards",
7709     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7710     "version": "0.0.0",
7711     "filename": "server/api/dashboard/index.js",
7712     "groupTitle": "Dashboards"
7713   },
7714   {
7715     "type": "put",
7716     "url": "/api/dashboards/{id}",
7717     "title": "Update an existing Dashboard",
7718     "examples": [
7719       {
7720         "title": "Example usage:",
7721         "content": "curl https://{domain}/api/dashboards/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
7722         "type": "json"
7723       }
7724     ],
7725     "name": "updateDashboards",
7726     "group": "Dashboards",
7727     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7728     "version": "0.0.0",
7729     "filename": "server/api/dashboard/index.js",
7730     "groupTitle": "Dashboards"
7731   },
7732   {
7733     "type": "post",
7734     "url": "/api/integrations/desk/accounts",
7735     "title": "Creates a new Desk Account",
7736     "examples": [
7737       {
7738         "title": "Example usage:",
7739         "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",
7740         "type": "json"
7741       }
7742     ],
7743     "name": "CreateDesk_Accounts",
7744     "group": "Desk_Accounts",
7745     "parameter": {
7746       "fields": {
7747         "Body": [
7748           {
7749             "group": "Body",
7750             "type": "String",
7751             "optional": true,
7752             "field": "name",
7753             "description": ""
7754           },
7755           {
7756             "group": "Body",
7757             "type": "String",
7758             "optional": true,
7759             "field": "description",
7760             "description": ""
7761           },
7762           {
7763             "group": "Body",
7764             "type": "String",
7765             "optional": true,
7766             "field": "username",
7767             "description": ""
7768           },
7769           {
7770             "group": "Body",
7771             "type": "String",
7772             "optional": true,
7773             "field": "remoteUri",
7774             "description": ""
7775           },
7776           {
7777             "group": "Body",
7778             "type": "String",
7779             "allowedValues": [
7780               "\"basic\""
7781             ],
7782             "optional": true,
7783             "field": "authType",
7784             "description": ""
7785           },
7786           {
7787             "group": "Body",
7788             "type": "String",
7789             "optional": true,
7790             "field": "password",
7791             "description": ""
7792           },
7793           {
7794             "group": "Body",
7795             "type": "String",
7796             "optional": true,
7797             "field": "consumerKey",
7798             "description": ""
7799           },
7800           {
7801             "group": "Body",
7802             "type": "String",
7803             "optional": true,
7804             "field": "consumerSecret",
7805             "description": ""
7806           },
7807           {
7808             "group": "Body",
7809             "type": "String",
7810             "optional": true,
7811             "field": "token",
7812             "description": ""
7813           },
7814           {
7815             "group": "Body",
7816             "type": "String",
7817             "optional": true,
7818             "field": "tokenSecret",
7819             "description": ""
7820           },
7821           {
7822             "group": "Body",
7823             "type": "String",
7824             "optional": true,
7825             "field": "serverUrl",
7826             "description": ""
7827           },
7828           {
7829             "group": "Body",
7830             "type": "String",
7831             "allowedValues": [
7832               "\"integrationTab\"",
7833               "\"newTab\""
7834             ],
7835             "optional": true,
7836             "field": "type",
7837             "description": ""
7838           }
7839         ]
7840       }
7841     },
7842     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7843     "version": "0.0.0",
7844     "filename": "server/api/intDeskAccount/index.js",
7845     "groupTitle": "Desk_Accounts"
7846   },
7847   {
7848     "type": "delete",
7849     "url": "/api/integrations/desk/accounts/{id}",
7850     "title": "Deletes a Desk Account",
7851     "examples": [
7852       {
7853         "title": "Example usage:",
7854         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password} -X DELETE",
7855         "type": "json"
7856       }
7857     ],
7858     "name": "DeleteDesk_Accounts",
7859     "group": "Desk_Accounts",
7860     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7861     "version": "0.0.0",
7862     "filename": "server/api/intDeskAccount/index.js",
7863     "groupTitle": "Desk_Accounts"
7864   },
7865   {
7866     "type": "get",
7867     "url": "/api/integrations/desk/accounts",
7868     "title": "Gets a list of Desk Accounts",
7869     "examples": [
7870       {
7871         "title": "Example usage:",
7872         "content": "curl https://{domain}/api/integrations/desk/accounts -v -u {name}:{password}",
7873         "type": "json"
7874       }
7875     ],
7876     "name": "GetDesk_Accounts",
7877     "group": "Desk_Accounts",
7878     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
7879     "version": "0.0.0",
7880     "filename": "server/api/intDeskAccount/index.js",
7881     "groupTitle": "Desk_Accounts"
7882   },
7883   {
7884     "type": "get",
7885     "url": "/api/integrations/desk/accounts/{id}",
7886     "title": "Gets a single Desk Account",
7887     "examples": [
7888       {
7889         "title": "Example usage:",
7890         "content": "curl https://{domain}/api/integrations/desk/accounts/{id} -v -u {name}:{password}",
7891         "type": "json"
7892       }
7893     ],
7894     "name": "ShowDesk_Accounts",
7895     "group": "Desk_Accounts",
7896     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7897     "version": "0.0.0",
7898     "filename": "server/api/intDeskAccount/index.js",
7899     "groupTitle": "Desk_Accounts"
7900   },
7901   {
7902     "type": "post",
7903     "url": "/api/integrations/desk/accounts/{id}/configurations",
7904     "title": "Creates new configuration",
7905     "examples": [
7906       {
7907         "title": "Example usage:",
7908         "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",
7909         "type": "json"
7910       }
7911     ],
7912     "name": "addConfiguration",
7913     "group": "Desk_Accounts",
7914     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7915     "version": "0.0.0",
7916     "filename": "server/api/intDeskAccount/index.js",
7917     "groupTitle": "Desk_Accounts"
7918   },
7919   {
7920     "type": "get",
7921     "url": "/api/integrations/desk/accounts/{id}/configurations",
7922     "title": "Gets account configurations",
7923     "examples": [
7924       {
7925         "title": "Example usage:",
7926         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
7927         "type": "json"
7928       }
7929     ],
7930     "name": "getConfigurations",
7931     "group": "Desk_Accounts",
7932     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7933     "version": "0.0.0",
7934     "filename": "server/api/intDeskAccount/index.js",
7935     "groupTitle": "Desk_Accounts"
7936   },
7937   {
7938     "type": "get",
7939     "url": "/api/integrations/desk/accounts/{id}/fields",
7940     "title": "Gets account fields",
7941     "examples": [
7942       {
7943         "title": "Example usage:",
7944         "content": "curl https://{domain}/api/integrations/desk/accounts/{id}/fields -v -u {name}:{password} -X GET",
7945         "type": "json"
7946       }
7947     ],
7948     "name": "getFields",
7949     "group": "Desk_Accounts",
7950     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7951     "version": "0.0.0",
7952     "filename": "server/api/intDeskAccount/index.js",
7953     "groupTitle": "Desk_Accounts"
7954   },
7955   {
7956     "type": "put",
7957     "url": "/api/integrations/desk/accounts/{id}",
7958     "title": "Update an existing Desk Account",
7959     "examples": [
7960       {
7961         "title": "Example usage:",
7962         "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",
7963         "type": "json"
7964       }
7965     ],
7966     "name": "updateDesk_Accounts",
7967     "group": "Desk_Accounts",
7968     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
7969     "version": "0.0.0",
7970     "filename": "server/api/intDeskAccount/index.js",
7971     "groupTitle": "Desk_Accounts"
7972   },
7973   {
7974     "type": "post",
7975     "url": "/api/integrations/desk/configurations",
7976     "title": "Creates a new Desk Configuration",
7977     "examples": [
7978       {
7979         "title": "Example usage:",
7980         "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",
7981         "type": "json"
7982       }
7983     ],
7984     "name": "CreateDesk_Configurations",
7985     "group": "Desk_Configurations",
7986     "parameter": {
7987       "fields": {
7988         "Body": [
7989           {
7990             "group": "Body",
7991             "type": "String",
7992             "optional": true,
7993             "field": "name",
7994             "description": ""
7995           },
7996           {
7997             "group": "Body",
7998             "type": "String",
7999             "optional": true,
8000             "field": "description",
8001             "description": ""
8002           }
8003         ]
8004       }
8005     },
8006     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8007     "version": "0.0.0",
8008     "filename": "server/api/intDeskConfiguration/index.js",
8009     "groupTitle": "Desk_Configurations"
8010   },
8011   {
8012     "type": "delete",
8013     "url": "/api/integrations/desk/configurations/{id}",
8014     "title": "Deletes a Desk Configuration",
8015     "examples": [
8016       {
8017         "title": "Example usage:",
8018         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password} -X DELETE",
8019         "type": "json"
8020       }
8021     ],
8022     "name": "DeleteDesk_Configurations",
8023     "group": "Desk_Configurations",
8024     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8025     "version": "0.0.0",
8026     "filename": "server/api/intDeskConfiguration/index.js",
8027     "groupTitle": "Desk_Configurations"
8028   },
8029   {
8030     "type": "get",
8031     "url": "/api/integrations/desk/configurations",
8032     "title": "Gets a list of Desk Configurations",
8033     "examples": [
8034       {
8035         "title": "Example usage:",
8036         "content": "curl https://{domain}/api/integrations/desk/configurations -v -u {name}:{password}",
8037         "type": "json"
8038       }
8039     ],
8040     "name": "GetDesk_Configurations",
8041     "group": "Desk_Configurations",
8042     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8043     "version": "0.0.0",
8044     "filename": "server/api/intDeskConfiguration/index.js",
8045     "groupTitle": "Desk_Configurations"
8046   },
8047   {
8048     "type": "get",
8049     "url": "/api/integrations/desk/configurations/{id}",
8050     "title": "Gets a single Desk Configuration",
8051     "examples": [
8052       {
8053         "title": "Example usage:",
8054         "content": "curl https://{domain}/api/integrations/desk/configurations/{id} -v -u {name}:{password}",
8055         "type": "json"
8056       }
8057     ],
8058     "name": "ShowDesk_Configurations",
8059     "group": "Desk_Configurations",
8060     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8061     "version": "0.0.0",
8062     "filename": "server/api/intDeskConfiguration/index.js",
8063     "groupTitle": "Desk_Configurations"
8064   },
8065   {
8066     "type": "get",
8067     "url": "/api/integrations/desk/configurations/{id}/descriptions",
8068     "title": "Gets configurations descriptions",
8069     "examples": [
8070       {
8071         "title": "Example usage:",
8072         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8073         "type": "json"
8074       }
8075     ],
8076     "name": "getDescriptions",
8077     "group": "Desk_Configurations",
8078     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8079     "version": "0.0.0",
8080     "filename": "server/api/intDeskConfiguration/index.js",
8081     "groupTitle": "Desk_Configurations"
8082   },
8083   {
8084     "type": "get",
8085     "url": "/api/integrations/desk/configurations/{id}/fields",
8086     "title": "Gets configurations fields",
8087     "examples": [
8088       {
8089         "title": "Example usage:",
8090         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/fields -v -u {name}:{password} -X GET",
8091         "type": "json"
8092       }
8093     ],
8094     "name": "getFields",
8095     "group": "Desk_Configurations",
8096     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8097     "version": "0.0.0",
8098     "filename": "server/api/intDeskConfiguration/index.js",
8099     "groupTitle": "Desk_Configurations"
8100   },
8101   {
8102     "type": "get",
8103     "url": "/api/integrations/desk/configurations/{id}/subjects",
8104     "title": "Gets configurations subjects",
8105     "examples": [
8106       {
8107         "title": "Example usage:",
8108         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8109         "type": "json"
8110       }
8111     ],
8112     "name": "getSubjects",
8113     "group": "Desk_Configurations",
8114     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8115     "version": "0.0.0",
8116     "filename": "server/api/intDeskConfiguration/index.js",
8117     "groupTitle": "Desk_Configurations"
8118   },
8119   {
8120     "type": "get",
8121     "url": "/api/integrations/desk/configurations/{id}/tags",
8122     "title": "Gets configurations tags",
8123     "examples": [
8124       {
8125         "title": "Example usage:",
8126         "content": "curl https://{domain}/api/integrations/desk/configurations/{id}/tags -v -u {name}:{password} -X GET",
8127         "type": "json"
8128       }
8129     ],
8130     "name": "getTags",
8131     "group": "Desk_Configurations",
8132     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8133     "version": "0.0.0",
8134     "filename": "server/api/intDeskConfiguration/index.js",
8135     "groupTitle": "Desk_Configurations"
8136   },
8137   {
8138     "type": "post",
8139     "url": "/api/integrations/desk/configurations/{id}/tags",
8140     "title": "Sets new tags",
8141     "examples": [
8142       {
8143         "title": "Example usage:",
8144         "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",
8145         "type": "json"
8146       }
8147     ],
8148     "name": "setTags",
8149     "group": "Desk_Configurations",
8150     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8151     "version": "0.0.0",
8152     "filename": "server/api/intDeskConfiguration/index.js",
8153     "groupTitle": "Desk_Configurations"
8154   },
8155   {
8156     "type": "put",
8157     "url": "/api/integrations/desk/configurations/{id}",
8158     "title": "Update an existing Desk Configuration",
8159     "examples": [
8160       {
8161         "title": "Example usage:",
8162         "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",
8163         "type": "json"
8164       }
8165     ],
8166     "name": "updateDesk_Configurations",
8167     "group": "Desk_Configurations",
8168     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8169     "version": "0.0.0",
8170     "filename": "server/api/intDeskConfiguration/index.js",
8171     "groupTitle": "Desk_Configurations"
8172   },
8173   {
8174     "type": "post",
8175     "url": "/api/integrations/desk/fields",
8176     "title": "Creates a new Desk Field",
8177     "examples": [
8178       {
8179         "title": "Example usage:",
8180         "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",
8181         "type": "json"
8182       }
8183     ],
8184     "name": "CreateDesk_Fields",
8185     "group": "Desk_Fields",
8186     "parameter": {
8187       "fields": {
8188         "Body": [
8189           {
8190             "group": "Body",
8191             "type": "String",
8192             "allowedValues": [
8193               "\"string\"",
8194               "\"variable\"",
8195               "\"customVariable\"",
8196               "\"keyValue\""
8197             ],
8198             "optional": true,
8199             "field": "type",
8200             "description": ""
8201           },
8202           {
8203             "group": "Body",
8204             "type": "String",
8205             "optional": true,
8206             "field": "content",
8207             "description": ""
8208           },
8209           {
8210             "group": "Body",
8211             "type": "String",
8212             "optional": true,
8213             "field": "key",
8214             "description": ""
8215           },
8216           {
8217             "group": "Body",
8218             "type": "String",
8219             "allowedValues": [
8220               "\"string\"",
8221               "\"variable\"",
8222               "\"customVariable\""
8223             ],
8224             "optional": true,
8225             "field": "keyType",
8226             "description": ""
8227           },
8228           {
8229             "group": "Body",
8230             "type": "String",
8231             "optional": true,
8232             "field": "keyContent",
8233             "description": ""
8234           },
8235           {
8236             "group": "Body",
8237             "type": "String",
8238             "optional": true,
8239             "field": "idField",
8240             "description": ""
8241           },
8242           {
8243             "group": "Body",
8244             "type": "String",
8245             "optional": true,
8246             "field": "nameField",
8247             "description": ""
8248           },
8249           {
8250             "group": "Body",
8251             "type": "Boolean",
8252             "optional": true,
8253             "field": "customField",
8254             "description": ""
8255           },
8256           {
8257             "group": "Body",
8258             "type": "String",
8259             "optional": true,
8260             "field": "variableName",
8261             "description": ""
8262           }
8263         ]
8264       }
8265     },
8266     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8267     "version": "0.0.0",
8268     "filename": "server/api/intDeskField/index.js",
8269     "groupTitle": "Desk_Fields"
8270   },
8271   {
8272     "type": "delete",
8273     "url": "/api/integrations/desk/fields/{id}",
8274     "title": "Deletes a Desk Field",
8275     "examples": [
8276       {
8277         "title": "Example usage:",
8278         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password} -X DELETE",
8279         "type": "json"
8280       }
8281     ],
8282     "name": "DeleteDesk_Fields",
8283     "group": "Desk_Fields",
8284     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8285     "version": "0.0.0",
8286     "filename": "server/api/intDeskField/index.js",
8287     "groupTitle": "Desk_Fields"
8288   },
8289   {
8290     "type": "get",
8291     "url": "/api/integrations/desk/fields",
8292     "title": "Gets a list of Desk Fields",
8293     "examples": [
8294       {
8295         "title": "Example usage:",
8296         "content": "curl https://{domain}/api/integrations/desk/fields -v -u {name}:{password}",
8297         "type": "json"
8298       }
8299     ],
8300     "name": "GetDesk_Fields",
8301     "group": "Desk_Fields",
8302     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8303     "version": "0.0.0",
8304     "filename": "server/api/intDeskField/index.js",
8305     "groupTitle": "Desk_Fields"
8306   },
8307   {
8308     "type": "get",
8309     "url": "/api/integrations/desk/fields/{id}",
8310     "title": "Gets a single Desk Field",
8311     "examples": [
8312       {
8313         "title": "Example usage:",
8314         "content": "curl https://{domain}/api/integrations/desk/fields/{id} -v -u {name}:{password}",
8315         "type": "json"
8316       }
8317     ],
8318     "name": "ShowDesk_Fields",
8319     "group": "Desk_Fields",
8320     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8321     "version": "0.0.0",
8322     "filename": "server/api/intDeskField/index.js",
8323     "groupTitle": "Desk_Fields"
8324   },
8325   {
8326     "type": "put",
8327     "url": "/api/integrations/desk/fields/{id}",
8328     "title": "Update an existing Desk Field",
8329     "examples": [
8330       {
8331         "title": "Example usage:",
8332         "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",
8333         "type": "json"
8334       }
8335     ],
8336     "name": "updateDesk_Fields",
8337     "group": "Desk_Fields",
8338     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8339     "version": "0.0.0",
8340     "filename": "server/api/intDeskField/index.js",
8341     "groupTitle": "Desk_Fields"
8342   },
8343   {
8344     "type": "post",
8345     "url": "/api/dispositions",
8346     "title": "Creates a new Disposition",
8347     "examples": [
8348       {
8349         "title": "Example usage:",
8350         "content": "curl https://{domain}/api/dispositions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
8351         "type": "json"
8352       }
8353     ],
8354     "name": "CreateDispositions",
8355     "group": "Dispositions",
8356     "parameter": {
8357       "fields": {
8358         "Body": [
8359           {
8360             "group": "Body",
8361             "type": "String",
8362             "optional": false,
8363             "field": "name",
8364             "description": ""
8365           }
8366         ]
8367       }
8368     },
8369     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8370     "version": "0.0.0",
8371     "filename": "server/api/disposition/index.js",
8372     "groupTitle": "Dispositions"
8373   },
8374   {
8375     "type": "delete",
8376     "url": "/api/dispositions/{id}",
8377     "title": "Deletes a Disposition",
8378     "examples": [
8379       {
8380         "title": "Example usage:",
8381         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password} -X DELETE",
8382         "type": "json"
8383       }
8384     ],
8385     "name": "DeleteDispositions",
8386     "group": "Dispositions",
8387     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8388     "version": "0.0.0",
8389     "filename": "server/api/disposition/index.js",
8390     "groupTitle": "Dispositions"
8391   },
8392   {
8393     "type": "get",
8394     "url": "/api/dispositions",
8395     "title": "Gets a list of Dispositions",
8396     "examples": [
8397       {
8398         "title": "Example usage:",
8399         "content": "curl https://{domain}/api/dispositions -v -u {name}:{password}",
8400         "type": "json"
8401       }
8402     ],
8403     "name": "GetDispositions",
8404     "group": "Dispositions",
8405     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8406     "version": "0.0.0",
8407     "filename": "server/api/disposition/index.js",
8408     "groupTitle": "Dispositions"
8409   },
8410   {
8411     "type": "get",
8412     "url": "/api/dispositions/{id}",
8413     "title": "Gets a single Disposition",
8414     "examples": [
8415       {
8416         "title": "Example usage:",
8417         "content": "curl https://{domain}/api/dispositions/{id} -v -u {name}:{password}",
8418         "type": "json"
8419       }
8420     ],
8421     "name": "ShowDispositions",
8422     "group": "Dispositions",
8423     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8424     "version": "0.0.0",
8425     "filename": "server/api/disposition/index.js",
8426     "groupTitle": "Dispositions"
8427   },
8428   {
8429     "type": "put",
8430     "url": "/api/dispositions/{id}",
8431     "title": "Update an existing Disposition",
8432     "examples": [
8433       {
8434         "title": "Example usage:",
8435         "content": "curl https://{domain}/api/dispositions/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
8436         "type": "json"
8437       }
8438     ],
8439     "name": "updateDispositions",
8440     "group": "Dispositions",
8441     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8442     "version": "0.0.0",
8443     "filename": "server/api/disposition/index.js",
8444     "groupTitle": "Dispositions"
8445   },
8446   {
8447     "type": "post",
8448     "url": "/api/integrations/dynamics365/accounts",
8449     "title": "Creates a new Dynamics365 Account",
8450     "examples": [
8451       {
8452         "title": "Example usage:",
8453         "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",
8454         "type": "json"
8455       }
8456     ],
8457     "name": "CreateDynamics365_Accounts",
8458     "group": "Dynamics365_Accounts",
8459     "parameter": {
8460       "fields": {
8461         "Body": [
8462           {
8463             "group": "Body",
8464             "type": "String",
8465             "optional": true,
8466             "field": "name",
8467             "description": ""
8468           },
8469           {
8470             "group": "Body",
8471             "type": "String",
8472             "optional": true,
8473             "field": "username",
8474             "description": ""
8475           },
8476           {
8477             "group": "Body",
8478             "type": "String",
8479             "optional": true,
8480             "field": "password",
8481             "description": ""
8482           },
8483           {
8484             "group": "Body",
8485             "type": "String",
8486             "optional": true,
8487             "field": "remoteUri",
8488             "description": ""
8489           },
8490           {
8491             "group": "Body",
8492             "type": "String",
8493             "optional": true,
8494             "field": "tenantId",
8495             "description": ""
8496           },
8497           {
8498             "group": "Body",
8499             "type": "String",
8500             "optional": true,
8501             "field": "clientId",
8502             "description": ""
8503           },
8504           {
8505             "group": "Body",
8506             "type": "String",
8507             "optional": true,
8508             "field": "clientSecret",
8509             "description": ""
8510           },
8511           {
8512             "group": "Body",
8513             "type": "String",
8514             "optional": true,
8515             "field": "serverUrl",
8516             "description": ""
8517           },
8518           {
8519             "group": "Body",
8520             "type": "String",
8521             "optional": true,
8522             "field": "description",
8523             "description": ""
8524           }
8525         ]
8526       }
8527     },
8528     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8529     "version": "0.0.0",
8530     "filename": "server/api/intDynamics365Account/index.js",
8531     "groupTitle": "Dynamics365_Accounts"
8532   },
8533   {
8534     "type": "delete",
8535     "url": "/api/integrations/dynamics365/accounts/{id}",
8536     "title": "Deletes a Dynamics365 Account",
8537     "examples": [
8538       {
8539         "title": "Example usage:",
8540         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password} -X DELETE",
8541         "type": "json"
8542       }
8543     ],
8544     "name": "DeleteDynamics365_Accounts",
8545     "group": "Dynamics365_Accounts",
8546     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8547     "version": "0.0.0",
8548     "filename": "server/api/intDynamics365Account/index.js",
8549     "groupTitle": "Dynamics365_Accounts"
8550   },
8551   {
8552     "type": "get",
8553     "url": "/api/integrations/dynamics365/accounts",
8554     "title": "Gets a list of Dynamics365 Accounts",
8555     "examples": [
8556       {
8557         "title": "Example usage:",
8558         "content": "curl https://{domain}/api/integrations/dynamics365/accounts -v -u {name}:{password}",
8559         "type": "json"
8560       }
8561     ],
8562     "name": "GetDynamics365_Accounts",
8563     "group": "Dynamics365_Accounts",
8564     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8565     "version": "0.0.0",
8566     "filename": "server/api/intDynamics365Account/index.js",
8567     "groupTitle": "Dynamics365_Accounts"
8568   },
8569   {
8570     "type": "get",
8571     "url": "/api/integrations/dynamics365/accounts/{id}",
8572     "title": "Gets a single Dynamics365 Account",
8573     "examples": [
8574       {
8575         "title": "Example usage:",
8576         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id} -v -u {name}:{password}",
8577         "type": "json"
8578       }
8579     ],
8580     "name": "ShowDynamics365_Accounts",
8581     "group": "Dynamics365_Accounts",
8582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8583     "version": "0.0.0",
8584     "filename": "server/api/intDynamics365Account/index.js",
8585     "groupTitle": "Dynamics365_Accounts"
8586   },
8587   {
8588     "type": "post",
8589     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8590     "title": "Creates new configuration",
8591     "examples": [
8592       {
8593         "title": "Example usage:",
8594         "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",
8595         "type": "json"
8596       }
8597     ],
8598     "name": "addConfiguration",
8599     "group": "Dynamics365_Accounts",
8600     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8601     "version": "0.0.0",
8602     "filename": "server/api/intDynamics365Account/index.js",
8603     "groupTitle": "Dynamics365_Accounts"
8604   },
8605   {
8606     "type": "get",
8607     "url": "/api/integrations/dynamics365/accounts/{id}/configurations",
8608     "title": "Gets account configurations",
8609     "examples": [
8610       {
8611         "title": "Example usage:",
8612         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/configurations -v -u {name}:{password} -X GET",
8613         "type": "json"
8614       }
8615     ],
8616     "name": "getConfigurations",
8617     "group": "Dynamics365_Accounts",
8618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8619     "version": "0.0.0",
8620     "filename": "server/api/intDynamics365Account/index.js",
8621     "groupTitle": "Dynamics365_Accounts"
8622   },
8623   {
8624     "type": "get",
8625     "url": "/api/integrations/dynamics365/accounts/{id}/fields",
8626     "title": "Gets account fields",
8627     "examples": [
8628       {
8629         "title": "Example usage:",
8630         "content": "curl https://{domain}/api/integrations/dynamics365/accounts/{id}/fields -v -u {name}:{password} -X GET",
8631         "type": "json"
8632       }
8633     ],
8634     "name": "getFields",
8635     "group": "Dynamics365_Accounts",
8636     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8637     "version": "0.0.0",
8638     "filename": "server/api/intDynamics365Account/index.js",
8639     "groupTitle": "Dynamics365_Accounts"
8640   },
8641   {
8642     "type": "put",
8643     "url": "/api/integrations/dynamics365/accounts/{id}",
8644     "title": "Update an existing Dynamics365 Account",
8645     "examples": [
8646       {
8647         "title": "Example usage:",
8648         "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",
8649         "type": "json"
8650       }
8651     ],
8652     "name": "updateDynamics365_Accounts",
8653     "group": "Dynamics365_Accounts",
8654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8655     "version": "0.0.0",
8656     "filename": "server/api/intDynamics365Account/index.js",
8657     "groupTitle": "Dynamics365_Accounts"
8658   },
8659   {
8660     "type": "post",
8661     "url": "/api/integrations/dynamics365/configurations",
8662     "title": "Creates a new Dynamics365 Configuration",
8663     "examples": [
8664       {
8665         "title": "Example usage:",
8666         "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",
8667         "type": "json"
8668       }
8669     ],
8670     "name": "CreateDynamics365_Configurations",
8671     "group": "Dynamics365_Configurations",
8672     "parameter": {
8673       "fields": {
8674         "Body": [
8675           {
8676             "group": "Body",
8677             "type": "String",
8678             "optional": true,
8679             "field": "name",
8680             "description": ""
8681           },
8682           {
8683             "group": "Body",
8684             "type": "String",
8685             "optional": true,
8686             "field": "description",
8687             "description": ""
8688           },
8689           {
8690             "group": "Body",
8691             "type": "String",
8692             "allowedValues": [
8693               "\"incident\"",
8694               "\"phonecall\""
8695             ],
8696             "optional": true,
8697             "field": "ticketType",
8698             "description": ""
8699           }
8700         ]
8701       }
8702     },
8703     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8704     "version": "0.0.0",
8705     "filename": "server/api/intDynamics365Configuration/index.js",
8706     "groupTitle": "Dynamics365_Configurations"
8707   },
8708   {
8709     "type": "delete",
8710     "url": "/api/integrations/dynamics365/configurations/{id}",
8711     "title": "Deletes a Dynamics365 Configuration",
8712     "examples": [
8713       {
8714         "title": "Example usage:",
8715         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password} -X DELETE",
8716         "type": "json"
8717       }
8718     ],
8719     "name": "DeleteDynamics365_Configurations",
8720     "group": "Dynamics365_Configurations",
8721     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8722     "version": "0.0.0",
8723     "filename": "server/api/intDynamics365Configuration/index.js",
8724     "groupTitle": "Dynamics365_Configurations"
8725   },
8726   {
8727     "type": "get",
8728     "url": "/api/integrations/dynamics365/configurations",
8729     "title": "Gets a list of Dynamics365 Configurations",
8730     "examples": [
8731       {
8732         "title": "Example usage:",
8733         "content": "curl https://{domain}/api/integrations/dynamics365/configurations -v -u {name}:{password}",
8734         "type": "json"
8735       }
8736     ],
8737     "name": "GetDynamics365_Configurations",
8738     "group": "Dynamics365_Configurations",
8739     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8740     "version": "0.0.0",
8741     "filename": "server/api/intDynamics365Configuration/index.js",
8742     "groupTitle": "Dynamics365_Configurations"
8743   },
8744   {
8745     "type": "get",
8746     "url": "/api/integrations/dynamics365/configurations/{id}",
8747     "title": "Gets a single Dynamics365 Configuration",
8748     "examples": [
8749       {
8750         "title": "Example usage:",
8751         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id} -v -u {name}:{password}",
8752         "type": "json"
8753       }
8754     ],
8755     "name": "ShowDynamics365_Configurations",
8756     "group": "Dynamics365_Configurations",
8757     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8758     "version": "0.0.0",
8759     "filename": "server/api/intDynamics365Configuration/index.js",
8760     "groupTitle": "Dynamics365_Configurations"
8761   },
8762   {
8763     "type": "get",
8764     "url": "/api/integrations/dynamics365/configurations/{id}/descriptions",
8765     "title": "Gets configurations descriptions",
8766     "examples": [
8767       {
8768         "title": "Example usage:",
8769         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
8770         "type": "json"
8771       }
8772     ],
8773     "name": "getDescriptions",
8774     "group": "Dynamics365_Configurations",
8775     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8776     "version": "0.0.0",
8777     "filename": "server/api/intDynamics365Configuration/index.js",
8778     "groupTitle": "Dynamics365_Configurations"
8779   },
8780   {
8781     "type": "get",
8782     "url": "/api/integrations/dynamics365/configurations/{id}/fields",
8783     "title": "Gets configurations fields",
8784     "examples": [
8785       {
8786         "title": "Example usage:",
8787         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
8788         "type": "json"
8789       }
8790     ],
8791     "name": "getFields",
8792     "group": "Dynamics365_Configurations",
8793     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8794     "version": "0.0.0",
8795     "filename": "server/api/intDynamics365Configuration/index.js",
8796     "groupTitle": "Dynamics365_Configurations"
8797   },
8798   {
8799     "type": "get",
8800     "url": "/api/integrations/zoho/configurations/{id}/subjects",
8801     "title": "Gets configurations subjects",
8802     "examples": [
8803       {
8804         "title": "Example usage:",
8805         "content": "curl https://{domain}/api/integrations/dynamics365/configurations/{id}/subjects -v -u {name}:{password} -X GET",
8806         "type": "json"
8807       }
8808     ],
8809     "name": "getSubjects",
8810     "group": "Dynamics365_Configurations",
8811     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8812     "version": "0.0.0",
8813     "filename": "server/api/intDynamics365Configuration/index.js",
8814     "groupTitle": "Dynamics365_Configurations"
8815   },
8816   {
8817     "type": "put",
8818     "url": "/api/integrations/dynamics365/configurations/{id}",
8819     "title": "Update an existing Dynamics365 Configuration",
8820     "examples": [
8821       {
8822         "title": "Example usage:",
8823         "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",
8824         "type": "json"
8825       }
8826     ],
8827     "name": "updateDynamics365_Configurations",
8828     "group": "Dynamics365_Configurations",
8829     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8830     "version": "0.0.0",
8831     "filename": "server/api/intDynamics365Configuration/index.js",
8832     "groupTitle": "Dynamics365_Configurations"
8833   },
8834   {
8835     "type": "post",
8836     "url": "/api/integrations/dynamics365/fields",
8837     "title": "Creates a new Dynamics365 Field",
8838     "examples": [
8839       {
8840         "title": "Example usage:",
8841         "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",
8842         "type": "json"
8843       }
8844     ],
8845     "name": "CreateDynamics365_Fields",
8846     "group": "Dynamics365_Fields",
8847     "parameter": {
8848       "fields": {
8849         "Body": [
8850           {
8851             "group": "Body",
8852             "type": "String",
8853             "allowedValues": [
8854               "\"string\"",
8855               "\"variable\"",
8856               "\"customVariable\"",
8857               "\"keyValue\""
8858             ],
8859             "optional": true,
8860             "field": "type",
8861             "description": ""
8862           },
8863           {
8864             "group": "Body",
8865             "type": "String",
8866             "optional": true,
8867             "field": "content",
8868             "description": ""
8869           },
8870           {
8871             "group": "Body",
8872             "type": "String",
8873             "optional": true,
8874             "field": "key",
8875             "description": ""
8876           },
8877           {
8878             "group": "Body",
8879             "type": "String",
8880             "allowedValues": [
8881               "\"string\"",
8882               "\"variable\"",
8883               "\"customVariable\""
8884             ],
8885             "optional": true,
8886             "field": "keyType",
8887             "description": ""
8888           },
8889           {
8890             "group": "Body",
8891             "type": "String",
8892             "optional": true,
8893             "field": "keyContent",
8894             "description": ""
8895           },
8896           {
8897             "group": "Body",
8898             "type": "String",
8899             "optional": true,
8900             "field": "idField",
8901             "description": ""
8902           },
8903           {
8904             "group": "Body",
8905             "type": "String",
8906             "optional": true,
8907             "field": "nameField",
8908             "description": ""
8909           },
8910           {
8911             "group": "Body",
8912             "type": "Boolean",
8913             "optional": true,
8914             "field": "customField",
8915             "description": ""
8916           },
8917           {
8918             "group": "Body",
8919             "type": "String",
8920             "optional": true,
8921             "field": "variableName",
8922             "description": ""
8923           }
8924         ]
8925       }
8926     },
8927     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8928     "version": "0.0.0",
8929     "filename": "server/api/intDynamics365Field/index.js",
8930     "groupTitle": "Dynamics365_Fields"
8931   },
8932   {
8933     "type": "delete",
8934     "url": "/api/integrations/dynamics365/fields/{id}",
8935     "title": "Deletes a Dynamics365 Field",
8936     "examples": [
8937       {
8938         "title": "Example usage:",
8939         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password} -X DELETE",
8940         "type": "json"
8941       }
8942     ],
8943     "name": "DeleteDynamics365_Fields",
8944     "group": "Dynamics365_Fields",
8945     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8946     "version": "0.0.0",
8947     "filename": "server/api/intDynamics365Field/index.js",
8948     "groupTitle": "Dynamics365_Fields"
8949   },
8950   {
8951     "type": "get",
8952     "url": "/api/integrations/dynamics365/fields",
8953     "title": "Gets a list of Dynamics365 Fields",
8954     "examples": [
8955       {
8956         "title": "Example usage:",
8957         "content": "curl https://{domain}/api/integrations/dynamics365/fields -v -u {name}:{password}",
8958         "type": "json"
8959       }
8960     ],
8961     "name": "GetDynamics365_Fields",
8962     "group": "Dynamics365_Fields",
8963     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
8964     "version": "0.0.0",
8965     "filename": "server/api/intDynamics365Field/index.js",
8966     "groupTitle": "Dynamics365_Fields"
8967   },
8968   {
8969     "type": "get",
8970     "url": "/api/integrations/dynamics365/fields/{id}",
8971     "title": "Gets a single Dynamics365 Field",
8972     "examples": [
8973       {
8974         "title": "Example usage:",
8975         "content": "curl https://{domain}/api/integrations/dynamics365/fields/{id} -v -u {name}:{password}",
8976         "type": "json"
8977       }
8978     ],
8979     "name": "ShowDynamics365_Fields",
8980     "group": "Dynamics365_Fields",
8981     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
8982     "version": "0.0.0",
8983     "filename": "server/api/intDynamics365Field/index.js",
8984     "groupTitle": "Dynamics365_Fields"
8985   },
8986   {
8987     "type": "put",
8988     "url": "/api/integrations/dynamics365/fields/{id}",
8989     "title": "Update an existing Dynamics365 Field",
8990     "examples": [
8991       {
8992         "title": "Example usage:",
8993         "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",
8994         "type": "json"
8995       }
8996     ],
8997     "name": "updateDynamics365_Fields",
8998     "group": "Dynamics365_Fields",
8999     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9000     "version": "0.0.0",
9001     "filename": "server/api/intDynamics365Field/index.js",
9002     "groupTitle": "Dynamics365_Fields"
9003   },
9004   {
9005     "type": "post",
9006     "url": "/api/fax/accounts/{id}/users",
9007     "title": "Add agents to a fax account",
9008     "examples": [
9009       {
9010         "title": "Example usage:",
9011         "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",
9012         "type": "json"
9013       }
9014     ],
9015     "name": "AddAgents",
9016     "group": "Fax_Accounts",
9017     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9018     "version": "0.0.0",
9019     "filename": "server/api/faxAccount/index.js",
9020     "groupTitle": "Fax_Accounts"
9021   },
9022   {
9023     "type": "post",
9024     "url": "/api/fax/accounts",
9025     "title": "Creates a new Account",
9026     "examples": [
9027       {
9028         "title": "Example usage:",
9029         "content": "curl https://{domain}/api/fax/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9030         "type": "json"
9031       }
9032     ],
9033     "name": "CreateAccounts",
9034     "group": "Fax_Accounts",
9035     "parameter": {
9036       "fields": {
9037         "Body": [
9038           {
9039             "group": "Body",
9040             "type": "String",
9041             "optional": false,
9042             "field": "name",
9043             "description": ""
9044           },
9045           {
9046             "group": "Body",
9047             "type": "String",
9048             "optional": true,
9049             "field": "description",
9050             "description": ""
9051           },
9052           {
9053             "group": "Body",
9054             "type": "String",
9055             "allowedValues": [
9056               "\"yes\"",
9057               "\"no\""
9058             ],
9059             "optional": true,
9060             "field": "ecm",
9061             "description": ""
9062           },
9063           {
9064             "group": "Body",
9065             "type": "String",
9066             "optional": true,
9067             "field": "headerinfo",
9068             "description": ""
9069           },
9070           {
9071             "group": "Body",
9072             "type": "String",
9073             "optional": true,
9074             "field": "localstationid",
9075             "description": ""
9076           },
9077           {
9078             "group": "Body",
9079             "type": "String",
9080             "allowedValues": [
9081               "\"2400\"",
9082               "\"4800\"",
9083               "\"7200\"",
9084               "\"9600\"",
9085               "\"12000\"",
9086               "\"14400\""
9087             ],
9088             "optional": true,
9089             "field": "minrate",
9090             "description": ""
9091           },
9092           {
9093             "group": "Body",
9094             "type": "String",
9095             "allowedValues": [
9096               "\"2400\"",
9097               "\"4800\"",
9098               "\"7200\"",
9099               "\"9600\"",
9100               "\"12000\"",
9101               "\"14400\""
9102             ],
9103             "optional": true,
9104             "field": "maxrate",
9105             "description": ""
9106           },
9107           {
9108             "group": "Body",
9109             "type": "String",
9110             "optional": true,
9111             "field": "modem",
9112             "description": ""
9113           },
9114           {
9115             "group": "Body",
9116             "type": "String",
9117             "optional": true,
9118             "field": "gateway",
9119             "description": ""
9120           },
9121           {
9122             "group": "Body",
9123             "type": "String",
9124             "optional": true,
9125             "field": "faxdetect",
9126             "description": ""
9127           },
9128           {
9129             "group": "Body",
9130             "type": "Integer",
9131             "optional": true,
9132             "field": "t38timeout",
9133             "description": ""
9134           },
9135           {
9136             "group": "Body",
9137             "type": "String",
9138             "allowedValues": [
9139               "\"SIP\"",
9140               "\"IAX\"",
9141               "\"DADHI\"",
9142               "\"KHOMP\""
9143             ],
9144             "optional": true,
9145             "field": "tech",
9146             "description": ""
9147           },
9148           {
9149             "group": "Body",
9150             "type": "String",
9151             "optional": false,
9152             "field": "key",
9153             "description": ""
9154           },
9155           {
9156             "group": "Body",
9157             "type": "Text",
9158             "optional": true,
9159             "field": "notificationTemplate",
9160             "description": ""
9161           },
9162           {
9163             "group": "Body",
9164             "type": "Boolean",
9165             "optional": true,
9166             "field": "notificationSound",
9167             "description": ""
9168           },
9169           {
9170             "group": "Body",
9171             "type": "Boolean",
9172             "optional": true,
9173             "field": "notificationShake",
9174             "description": ""
9175           },
9176           {
9177             "group": "Body",
9178             "type": "Integer",
9179             "optional": true,
9180             "field": "waitForTheAssignedAgent",
9181             "description": ""
9182           },
9183           {
9184             "group": "Body",
9185             "type": "Boolean",
9186             "optional": true,
9187             "field": "queueTransfer",
9188             "description": ""
9189           },
9190           {
9191             "group": "Body",
9192             "type": "Integer",
9193             "optional": true,
9194             "field": "queueTransferTimeout",
9195             "description": ""
9196           },
9197           {
9198             "group": "Body",
9199             "type": "Boolean",
9200             "optional": true,
9201             "field": "agentTransfer",
9202             "description": ""
9203           },
9204           {
9205             "group": "Body",
9206             "type": "Integer",
9207             "optional": true,
9208             "field": "agentTransferTimeout",
9209             "description": ""
9210           },
9211           {
9212             "group": "Body",
9213             "type": "Integer",
9214             "optional": true,
9215             "field": "mandatoryDispositionPauseId",
9216             "description": "<p>Status to put when mandatory disposition is enabled</p>"
9217           },
9218           {
9219             "group": "Body",
9220             "type": "Boolean",
9221             "optional": true,
9222             "field": "mandatoryDisposition",
9223             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
9224           }
9225         ]
9226       }
9227     },
9228     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9229     "version": "0.0.0",
9230     "filename": "server/api/faxAccount/index.js",
9231     "groupTitle": "Fax_Accounts"
9232   },
9233   {
9234     "type": "delete",
9235     "url": "/api/fax/accounts/{id}",
9236     "title": "Deletes a Account",
9237     "examples": [
9238       {
9239         "title": "Example usage:",
9240         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password} -X DELETE",
9241         "type": "json"
9242       }
9243     ],
9244     "name": "DeleteAccounts",
9245     "group": "Fax_Accounts",
9246     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9247     "version": "0.0.0",
9248     "filename": "server/api/faxAccount/index.js",
9249     "groupTitle": "Fax_Accounts"
9250   },
9251   {
9252     "type": "get",
9253     "url": "/api/fax/accounts/describe",
9254     "title": "Gets table info about Accounts",
9255     "examples": [
9256       {
9257         "title": "Example usage:",
9258         "content": "curl https://{domain}/api/fax/accounts/describe -v -u {name}:{password}",
9259         "type": "json"
9260       }
9261     ],
9262     "name": "DescribeAccounts",
9263     "group": "Fax_Accounts",
9264     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9265     "version": "0.0.0",
9266     "filename": "server/api/faxAccount/index.js",
9267     "groupTitle": "Fax_Accounts"
9268   },
9269   {
9270     "type": "get",
9271     "url": "/api/fax/accounts",
9272     "title": "Gets a list of Accounts",
9273     "examples": [
9274       {
9275         "title": "Example usage:",
9276         "content": "curl https://{domain}/api/fax/accounts -v -u {name}:{password}",
9277         "type": "json"
9278       }
9279     ],
9280     "name": "GetAccounts",
9281     "group": "Fax_Accounts",
9282     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9283     "version": "0.0.0",
9284     "filename": "server/api/faxAccount/index.js",
9285     "groupTitle": "Fax_Accounts"
9286   },
9287   {
9288     "type": "get",
9289     "url": "/api/fax/accounts/{id}/users",
9290     "title": "Gets agents from fax account",
9291     "examples": [
9292       {
9293         "title": "Example usage:",
9294         "content": "curl https://{domain}/api/fax/accounts/{id}/users -v -u {name}:{password} -X GET",
9295         "type": "json"
9296       }
9297     ],
9298     "name": "GetAgents",
9299     "group": "Fax_Accounts",
9300     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9301     "version": "0.0.0",
9302     "filename": "server/api/faxAccount/index.js",
9303     "groupTitle": "Fax_Accounts"
9304   },
9305   {
9306     "type": "delete",
9307     "url": "/api/fax/accounts/{id}/users",
9308     "title": "Removes agents from a fax account",
9309     "examples": [
9310       {
9311         "title": "Example usage:",
9312         "content": "curl https://{domain}/api/fax/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9313         "type": "json"
9314       }
9315     ],
9316     "name": "RemoveAgents",
9317     "group": "Fax_Accounts",
9318     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9319     "version": "0.0.0",
9320     "filename": "server/api/faxAccount/index.js",
9321     "groupTitle": "Fax_Accounts"
9322   },
9323   {
9324     "type": "delete",
9325     "url": "/api/fax/accounts/{id}/canned_answers",
9326     "title": "Removes canned answers from account",
9327     "examples": [
9328       {
9329         "title": "Example usage:",
9330         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9331         "type": "json"
9332       }
9333     ],
9334     "name": "RemoveAnswers",
9335     "group": "Fax_Accounts",
9336     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9337     "version": "0.0.0",
9338     "filename": "server/api/faxAccount/index.js",
9339     "groupTitle": "Fax_Accounts"
9340   },
9341   {
9342     "type": "delete",
9343     "url": "/api/fax/accounts/{id}/dispositions",
9344     "title": "Removes dispositions from account",
9345     "examples": [
9346       {
9347         "title": "Example usage:",
9348         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
9349         "type": "json"
9350       }
9351     ],
9352     "name": "RemoveDispositions",
9353     "group": "Fax_Accounts",
9354     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9355     "version": "0.0.0",
9356     "filename": "server/api/faxAccount/index.js",
9357     "groupTitle": "Fax_Accounts"
9358   },
9359   {
9360     "type": "get",
9361     "url": "/api/fax/accounts/{id}",
9362     "title": "Gets a single Account",
9363     "examples": [
9364       {
9365         "title": "Example usage:",
9366         "content": "curl https://{domain}/api/fax/accounts/{id} -v -u {name}:{password}",
9367         "type": "json"
9368       }
9369     ],
9370     "name": "ShowAccounts",
9371     "group": "Fax_Accounts",
9372     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9373     "version": "0.0.0",
9374     "filename": "server/api/faxAccount/index.js",
9375     "groupTitle": "Fax_Accounts"
9376   },
9377   {
9378     "type": "post",
9379     "url": "/api/fax/accounts/{id}/canned_answers",
9380     "title": "Creates new canned answer",
9381     "examples": [
9382       {
9383         "title": "Example usage:",
9384         "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",
9385         "type": "json"
9386       }
9387     ],
9388     "name": "addAnswer",
9389     "group": "Fax_Accounts",
9390     "parameter": {
9391       "fields": {
9392         "Body": [
9393           {
9394             "group": "Body",
9395             "type": "String",
9396             "optional": false,
9397             "field": "key",
9398             "description": ""
9399           },
9400           {
9401             "group": "Body",
9402             "type": "Text",
9403             "optional": false,
9404             "field": "value",
9405             "description": ""
9406           },
9407           {
9408             "group": "Body",
9409             "type": "String",
9410             "optional": true,
9411             "field": "description",
9412             "description": ""
9413           },
9414           {
9415             "group": "Body",
9416             "type": "Virtual",
9417             "optional": true,
9418             "field": "name",
9419             "description": ""
9420           }
9421         ]
9422       }
9423     },
9424     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9425     "version": "0.0.0",
9426     "filename": "server/api/faxAccount/index.js",
9427     "groupTitle": "Fax_Accounts"
9428   },
9429   {
9430     "type": "post",
9431     "url": "/api/fax/accounts/{id}/applications",
9432     "title": "Creates new applications",
9433     "examples": [
9434       {
9435         "title": "Example usage:",
9436         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9437         "type": "json"
9438       }
9439     ],
9440     "name": "addApplications",
9441     "group": "Fax_Accounts",
9442     "parameter": {
9443       "fields": {
9444         "Body": [
9445           {
9446             "group": "Body",
9447             "type": "Integer",
9448             "optional": false,
9449             "field": "priority",
9450             "description": ""
9451           },
9452           {
9453             "group": "Body",
9454             "type": "String",
9455             "optional": false,
9456             "field": "app",
9457             "description": ""
9458           },
9459           {
9460             "group": "Body",
9461             "type": "Text",
9462             "optional": true,
9463             "field": "appdata",
9464             "description": ""
9465           },
9466           {
9467             "group": "Body",
9468             "type": "String",
9469             "optional": true,
9470             "field": "description",
9471             "description": ""
9472           },
9473           {
9474             "group": "Body",
9475             "type": "String",
9476             "optional": true,
9477             "field": "interval",
9478             "description": ""
9479           }
9480         ]
9481       }
9482     },
9483     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9484     "version": "0.0.0",
9485     "filename": "server/api/faxAccount/index.js",
9486     "groupTitle": "Fax_Accounts"
9487   },
9488   {
9489     "type": "post",
9490     "url": "/api/fax/accounts/addaccountapplications",
9491     "title": "Creates new account and applications",
9492     "examples": [
9493       {
9494         "title": "Example usage:",
9495         "content": "curl https://{domain}/api/fax/accounts/addaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9496         "type": "json"
9497       }
9498     ],
9499     "name": "addApplications",
9500     "group": "Fax_Accounts",
9501     "parameter": {
9502       "fields": {
9503         "Body": [
9504           {
9505             "group": "Body",
9506             "type": "Integer",
9507             "optional": false,
9508             "field": "priority",
9509             "description": ""
9510           },
9511           {
9512             "group": "Body",
9513             "type": "String",
9514             "optional": false,
9515             "field": "app",
9516             "description": ""
9517           },
9518           {
9519             "group": "Body",
9520             "type": "Text",
9521             "optional": true,
9522             "field": "appdata",
9523             "description": ""
9524           },
9525           {
9526             "group": "Body",
9527             "type": "String",
9528             "optional": true,
9529             "field": "description",
9530             "description": ""
9531           },
9532           {
9533             "group": "Body",
9534             "type": "String",
9535             "optional": true,
9536             "field": "interval",
9537             "description": ""
9538           }
9539         ]
9540       }
9541     },
9542     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9543     "version": "0.0.0",
9544     "filename": "server/api/faxAccount/index.js",
9545     "groupTitle": "Fax_Accounts"
9546   },
9547   {
9548     "type": "post",
9549     "url": "/api/fax/accounts/{id}/dispositions",
9550     "title": "Creates new disposition",
9551     "examples": [
9552       {
9553         "title": "Example usage:",
9554         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9555         "type": "json"
9556       }
9557     ],
9558     "name": "addDisposition",
9559     "group": "Fax_Accounts",
9560     "parameter": {
9561       "fields": {
9562         "Body": [
9563           {
9564             "group": "Body",
9565             "type": "String",
9566             "optional": false,
9567             "field": "name",
9568             "description": ""
9569           }
9570         ]
9571       }
9572     },
9573     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9574     "version": "0.0.0",
9575     "filename": "server/api/faxAccount/index.js",
9576     "groupTitle": "Fax_Accounts"
9577   },
9578   {
9579     "type": "post",
9580     "url": "/api/fax/accounts/{id}/interactions",
9581     "title": "Creates new interactions",
9582     "examples": [
9583       {
9584         "title": "Example usage:",
9585         "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",
9586         "type": "json"
9587       }
9588     ],
9589     "name": "addInteraction",
9590     "group": "Fax_Accounts",
9591     "parameter": {
9592       "fields": {
9593         "Body": [
9594           {
9595             "group": "Body",
9596             "type": "Boolean",
9597             "optional": true,
9598             "field": "closed",
9599             "description": ""
9600           },
9601           {
9602             "group": "Body",
9603             "type": "String",
9604             "optional": true,
9605             "field": "closedAt",
9606             "description": ""
9607           },
9608           {
9609             "group": "Body",
9610             "type": "String",
9611             "optional": true,
9612             "field": "disposition",
9613             "description": ""
9614           },
9615           {
9616             "group": "Body",
9617             "type": "String",
9618             "optional": true,
9619             "field": "note",
9620             "description": ""
9621           },
9622           {
9623             "group": "Body",
9624             "type": "String",
9625             "optional": true,
9626             "field": "read1stAt",
9627             "description": ""
9628           },
9629           {
9630             "group": "Body",
9631             "type": "String",
9632             "optional": true,
9633             "field": "fax",
9634             "description": ""
9635           },
9636           {
9637             "group": "Body",
9638             "type": "String",
9639             "allowedValues": [
9640               "\"in\"",
9641               "\"out\""
9642             ],
9643             "optional": false,
9644             "field": "firstMsgDirection",
9645             "description": ""
9646           },
9647           {
9648             "group": "Body",
9649             "type": "String",
9650             "optional": true,
9651             "field": "lastMsgAt",
9652             "description": ""
9653           },
9654           {
9655             "group": "Body",
9656             "type": "String",
9657             "allowedValues": [
9658               "\"in\"",
9659               "\"out\""
9660             ],
9661             "optional": false,
9662             "field": "lastMsgDirection",
9663             "description": ""
9664           }
9665         ]
9666       }
9667     },
9668     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9669     "version": "0.0.0",
9670     "filename": "server/api/faxAccount/index.js",
9671     "groupTitle": "Fax_Accounts"
9672   },
9673   {
9674     "type": "get",
9675     "url": "/api/fax/accounts/{id}/canned_answers",
9676     "title": "Gets account canned answers",
9677     "examples": [
9678       {
9679         "title": "Example usage:",
9680         "content": "curl https://{domain}/api/fax/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
9681         "type": "json"
9682       }
9683     ],
9684     "name": "getAnswers",
9685     "group": "Fax_Accounts",
9686     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9687     "version": "0.0.0",
9688     "filename": "server/api/faxAccount/index.js",
9689     "groupTitle": "Fax_Accounts"
9690   },
9691   {
9692     "type": "get",
9693     "url": "/api/fax/accounts/{id}/applications",
9694     "title": "Gets account pplications",
9695     "examples": [
9696       {
9697         "title": "Example usage:",
9698         "content": "curl https://{domain}/api/fax/accounts/{id}/applications -v -u {name}:{password} -X GET",
9699         "type": "json"
9700       }
9701     ],
9702     "name": "getApplications",
9703     "group": "Fax_Accounts",
9704     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9705     "version": "0.0.0",
9706     "filename": "server/api/faxAccount/index.js",
9707     "groupTitle": "Fax_Accounts"
9708   },
9709   {
9710     "type": "get",
9711     "url": "/api/fax/accounts/{id}/dispositions",
9712     "title": "Gets account dispositions",
9713     "examples": [
9714       {
9715         "title": "Example usage:",
9716         "content": "curl https://{domain}/api/fax/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
9717         "type": "json"
9718       }
9719     ],
9720     "name": "getDispositions",
9721     "group": "Fax_Accounts",
9722     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9723     "version": "0.0.0",
9724     "filename": "server/api/faxAccount/index.js",
9725     "groupTitle": "Fax_Accounts"
9726   },
9727   {
9728     "type": "get",
9729     "url": "/api/fax/accounts/{id}/interactions",
9730     "title": "Gets account interactions",
9731     "examples": [
9732       {
9733         "title": "Example usage:",
9734         "content": "curl https://{domain}/api/fax/accounts/{id}/interactions -v -u {name}:{password} -X GET",
9735         "type": "json"
9736       }
9737     ],
9738     "name": "getInteraction",
9739     "group": "Fax_Accounts",
9740     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9741     "version": "0.0.0",
9742     "filename": "server/api/faxAccount/index.js",
9743     "groupTitle": "Fax_Accounts"
9744   },
9745   {
9746     "type": "get",
9747     "url": "/api/fax/accounts/{id}/messages",
9748     "title": "Gets account messages",
9749     "examples": [
9750       {
9751         "title": "Example usage:",
9752         "content": "curl https://{domain}/api/fax/accounts/{id}/messages -v -u {name}:{password} -X GET",
9753         "type": "json"
9754       }
9755     ],
9756     "name": "getMessages",
9757     "group": "Fax_Accounts",
9758     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9759     "version": "0.0.0",
9760     "filename": "server/api/faxAccount/index.js",
9761     "groupTitle": "Fax_Accounts"
9762   },
9763   {
9764     "type": "post",
9765     "url": "/api/fax/accounts/{id}/send",
9766     "title": "Send new fax",
9767     "examples": [
9768       {
9769         "title": "Example usage:",
9770         "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",
9771         "type": "json"
9772       }
9773     ],
9774     "name": "sendFax",
9775     "group": "Fax_Accounts",
9776     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9777     "version": "0.0.0",
9778     "filename": "server/api/faxAccount/index.js",
9779     "groupTitle": "Fax_Accounts"
9780   },
9781   {
9782     "type": "put",
9783     "url": "/api/fax/accounts/{id}",
9784     "title": "Update an existing Account",
9785     "examples": [
9786       {
9787         "title": "Example usage:",
9788         "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",
9789         "type": "json"
9790       }
9791     ],
9792     "name": "updateAccounts",
9793     "group": "Fax_Accounts",
9794     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9795     "version": "0.0.0",
9796     "filename": "server/api/faxAccount/index.js",
9797     "groupTitle": "Fax_Accounts"
9798   },
9799   {
9800     "type": "post",
9801     "url": "/api/fax/accounts/updateaccountapplications",
9802     "title": "Update account and applications",
9803     "examples": [
9804       {
9805         "title": "Example usage:",
9806         "content": "curl https://{domain}/api/fax/accounts/updateaccountapplications -d '[{\"name\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
9807         "type": "json"
9808       }
9809     ],
9810     "name": "updateApplications",
9811     "group": "Fax_Accounts",
9812     "parameter": {
9813       "fields": {
9814         "Body": [
9815           {
9816             "group": "Body",
9817             "type": "Integer",
9818             "optional": false,
9819             "field": "priority",
9820             "description": ""
9821           },
9822           {
9823             "group": "Body",
9824             "type": "String",
9825             "optional": false,
9826             "field": "app",
9827             "description": ""
9828           },
9829           {
9830             "group": "Body",
9831             "type": "Text",
9832             "optional": true,
9833             "field": "appdata",
9834             "description": ""
9835           },
9836           {
9837             "group": "Body",
9838             "type": "String",
9839             "optional": true,
9840             "field": "description",
9841             "description": ""
9842           },
9843           {
9844             "group": "Body",
9845             "type": "String",
9846             "optional": true,
9847             "field": "interval",
9848             "description": ""
9849           }
9850         ]
9851       }
9852     },
9853     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9854     "version": "0.0.0",
9855     "filename": "server/api/faxAccount/index.js",
9856     "groupTitle": "Fax_Accounts"
9857   },
9858   {
9859     "type": "post",
9860     "url": "/api/fax/applications",
9861     "title": "Creates a new Application",
9862     "examples": [
9863       {
9864         "title": "Example usage:",
9865         "content": "curl https://{domain}/api/fax/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
9866         "type": "json"
9867       }
9868     ],
9869     "name": "CreateApplications",
9870     "group": "Fax_Applications",
9871     "parameter": {
9872       "fields": {
9873         "Body": [
9874           {
9875             "group": "Body",
9876             "type": "Integer",
9877             "optional": false,
9878             "field": "priority",
9879             "description": ""
9880           },
9881           {
9882             "group": "Body",
9883             "type": "String",
9884             "optional": false,
9885             "field": "app",
9886             "description": ""
9887           },
9888           {
9889             "group": "Body",
9890             "type": "Text",
9891             "optional": true,
9892             "field": "appdata",
9893             "description": ""
9894           },
9895           {
9896             "group": "Body",
9897             "type": "String",
9898             "optional": true,
9899             "field": "description",
9900             "description": ""
9901           },
9902           {
9903             "group": "Body",
9904             "type": "String",
9905             "optional": true,
9906             "field": "interval",
9907             "description": ""
9908           }
9909         ]
9910       }
9911     },
9912     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9913     "version": "0.0.0",
9914     "filename": "server/api/faxApplication/index.js",
9915     "groupTitle": "Fax_Applications"
9916   },
9917   {
9918     "type": "delete",
9919     "url": "/api/fax/applications/{id}",
9920     "title": "Deletes a Application",
9921     "examples": [
9922       {
9923         "title": "Example usage:",
9924         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password} -X DELETE",
9925         "type": "json"
9926       }
9927     ],
9928     "name": "DeleteApplications",
9929     "group": "Fax_Applications",
9930     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9931     "version": "0.0.0",
9932     "filename": "server/api/faxApplication/index.js",
9933     "groupTitle": "Fax_Applications"
9934   },
9935   {
9936     "type": "get",
9937     "url": "/api/fax/applications",
9938     "title": "Gets a list of Applications",
9939     "examples": [
9940       {
9941         "title": "Example usage:",
9942         "content": "curl https://{domain}/api/fax/applications -v -u {name}:{password}",
9943         "type": "json"
9944       }
9945     ],
9946     "name": "GetApplications",
9947     "group": "Fax_Applications",
9948     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
9949     "version": "0.0.0",
9950     "filename": "server/api/faxApplication/index.js",
9951     "groupTitle": "Fax_Applications"
9952   },
9953   {
9954     "type": "get",
9955     "url": "/api/fax/applications/{id}",
9956     "title": "Gets a single Application",
9957     "examples": [
9958       {
9959         "title": "Example usage:",
9960         "content": "curl https://{domain}/api/fax/applications/{id} -v -u {name}:{password}",
9961         "type": "json"
9962       }
9963     ],
9964     "name": "ShowApplications",
9965     "group": "Fax_Applications",
9966     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9967     "version": "0.0.0",
9968     "filename": "server/api/faxApplication/index.js",
9969     "groupTitle": "Fax_Applications"
9970   },
9971   {
9972     "type": "put",
9973     "url": "/api/fax/applications/{id}",
9974     "title": "Update an existing Application",
9975     "examples": [
9976       {
9977         "title": "Example usage:",
9978         "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",
9979         "type": "json"
9980       }
9981     ],
9982     "name": "updateApplications",
9983     "group": "Fax_Applications",
9984     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
9985     "version": "0.0.0",
9986     "filename": "server/api/faxApplication/index.js",
9987     "groupTitle": "Fax_Applications"
9988   },
9989   {
9990     "type": "post",
9991     "url": "/api/fax/interactions/{id}/tags",
9992     "title": "Add tags to the interaction",
9993     "examples": [
9994       {
9995         "title": "Example usage:",
9996         "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",
9997         "type": "json"
9998       }
9999     ],
10000     "name": "AddTags",
10001     "group": "Fax_Interactions",
10002     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10003     "version": "0.0.0",
10004     "filename": "server/api/faxInteraction/index.js",
10005     "groupTitle": "Fax_Interactions"
10006   },
10007   {
10008     "type": "post",
10009     "url": "/api/fax/interactions",
10010     "title": "Creates a new Interaction",
10011     "examples": [
10012       {
10013         "title": "Example usage:",
10014         "content": "curl https://{domain}/api/fax/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10015         "type": "json"
10016       }
10017     ],
10018     "name": "CreateInteractions",
10019     "group": "Fax_Interactions",
10020     "parameter": {
10021       "fields": {
10022         "Body": [
10023           {
10024             "group": "Body",
10025             "type": "Boolean",
10026             "optional": true,
10027             "field": "closed",
10028             "description": ""
10029           },
10030           {
10031             "group": "Body",
10032             "type": "String",
10033             "optional": true,
10034             "field": "closedAt",
10035             "description": ""
10036           },
10037           {
10038             "group": "Body",
10039             "type": "String",
10040             "optional": true,
10041             "field": "disposition",
10042             "description": ""
10043           },
10044           {
10045             "group": "Body",
10046             "type": "String",
10047             "optional": true,
10048             "field": "note",
10049             "description": ""
10050           },
10051           {
10052             "group": "Body",
10053             "type": "String",
10054             "optional": true,
10055             "field": "read1stAt",
10056             "description": ""
10057           },
10058           {
10059             "group": "Body",
10060             "type": "String",
10061             "optional": true,
10062             "field": "fax",
10063             "description": ""
10064           },
10065           {
10066             "group": "Body",
10067             "type": "String",
10068             "allowedValues": [
10069               "\"in\"",
10070               "\"out\""
10071             ],
10072             "optional": false,
10073             "field": "firstMsgDirection",
10074             "description": ""
10075           },
10076           {
10077             "group": "Body",
10078             "type": "String",
10079             "optional": true,
10080             "field": "lastMsgAt",
10081             "description": ""
10082           },
10083           {
10084             "group": "Body",
10085             "type": "String",
10086             "allowedValues": [
10087               "\"in\"",
10088               "\"out\""
10089             ],
10090             "optional": false,
10091             "field": "lastMsgDirection",
10092             "description": ""
10093           }
10094         ]
10095       }
10096     },
10097     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10098     "version": "0.0.0",
10099     "filename": "server/api/faxInteraction/index.js",
10100     "groupTitle": "Fax_Interactions"
10101   },
10102   {
10103     "type": "delete",
10104     "url": "/api/fax/interactions/{id}",
10105     "title": "Deletes a Interaction",
10106     "examples": [
10107       {
10108         "title": "Example usage:",
10109         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password} -X DELETE",
10110         "type": "json"
10111       }
10112     ],
10113     "name": "DeleteInteractions",
10114     "group": "Fax_Interactions",
10115     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10116     "version": "0.0.0",
10117     "filename": "server/api/faxInteraction/index.js",
10118     "groupTitle": "Fax_Interactions"
10119   },
10120   {
10121     "type": "get",
10122     "url": "/api/fax/interactions/describe",
10123     "title": "Gets table info about Interactions",
10124     "examples": [
10125       {
10126         "title": "Example usage:",
10127         "content": "curl https://{domain}/api/fax/interactions/describe -v -u {name}:{password}",
10128         "type": "json"
10129       }
10130     ],
10131     "name": "DescribeInteractions",
10132     "group": "Fax_Interactions",
10133     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10134     "version": "0.0.0",
10135     "filename": "server/api/faxInteraction/index.js",
10136     "groupTitle": "Fax_Interactions"
10137   },
10138   {
10139     "type": "get",
10140     "url": "/api/fax/interactions",
10141     "title": "Gets a list of Interactions",
10142     "examples": [
10143       {
10144         "title": "Example usage:",
10145         "content": "curl https://{domain}/api/fax/interactions -v -u {name}:{password}",
10146         "type": "json"
10147       }
10148     ],
10149     "name": "GetInteractions",
10150     "group": "Fax_Interactions",
10151     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10152     "version": "0.0.0",
10153     "filename": "server/api/faxInteraction/index.js",
10154     "groupTitle": "Fax_Interactions"
10155   },
10156   {
10157     "type": "delete",
10158     "url": "/api/fax/interactions/{id}/tags",
10159     "title": "Removes tags from interaction",
10160     "examples": [
10161       {
10162         "title": "Example usage:",
10163         "content": "curl https://{domain}/api/fax/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10164         "type": "json"
10165       }
10166     ],
10167     "name": "RemoveTags",
10168     "group": "Fax_Interactions",
10169     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10170     "version": "0.0.0",
10171     "filename": "server/api/faxInteraction/index.js",
10172     "groupTitle": "Fax_Interactions"
10173   },
10174   {
10175     "type": "get",
10176     "url": "/api/fax/interactions/{id}",
10177     "title": "Gets a single Interaction",
10178     "examples": [
10179       {
10180         "title": "Example usage:",
10181         "content": "curl https://{domain}/api/fax/interactions/{id} -v -u {name}:{password}",
10182         "type": "json"
10183       }
10184     ],
10185     "name": "ShowInteractions",
10186     "group": "Fax_Interactions",
10187     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10188     "version": "0.0.0",
10189     "filename": "server/api/faxInteraction/index.js",
10190     "groupTitle": "Fax_Interactions"
10191   },
10192   {
10193     "type": "post",
10194     "url": "/api/fax/interactions/{id}/messages",
10195     "title": "Creates new messages",
10196     "examples": [
10197       {
10198         "title": "Example usage:",
10199         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
10200         "type": "json"
10201       }
10202     ],
10203     "name": "addMessage",
10204     "group": "Fax_Interactions",
10205     "parameter": {
10206       "fields": {
10207         "Body": [
10208           {
10209             "group": "Body",
10210             "type": "Text",
10211             "optional": false,
10212             "field": "body",
10213             "description": ""
10214           },
10215           {
10216             "group": "Body",
10217             "type": "Boolean",
10218             "optional": true,
10219             "field": "read",
10220             "description": ""
10221           },
10222           {
10223             "group": "Body",
10224             "type": "String",
10225             "allowedValues": [
10226               "\"in\"",
10227               "\"out\""
10228             ],
10229             "optional": false,
10230             "field": "direction",
10231             "description": ""
10232           },
10233           {
10234             "group": "Body",
10235             "type": "Text",
10236             "optional": true,
10237             "field": "failMessage",
10238             "description": ""
10239           },
10240           {
10241             "group": "Body",
10242             "type": "String",
10243             "optional": true,
10244             "field": "readAt",
10245             "description": ""
10246           }
10247         ]
10248       }
10249     },
10250     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10251     "version": "0.0.0",
10252     "filename": "server/api/faxInteraction/index.js",
10253     "groupTitle": "Fax_Interactions"
10254   },
10255   {
10256     "type": "get",
10257     "url": "/api/fax/interactions/{id}/download",
10258     "title": "Get interactions",
10259     "examples": [
10260       {
10261         "title": "Example usage:",
10262         "content": "curl https://{domain}/api/fax/interactions/{id}/download -v -u {name}:{password} -X GET",
10263         "type": "json"
10264       }
10265     ],
10266     "name": "download",
10267     "group": "Fax_Interactions",
10268     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10269     "version": "0.0.0",
10270     "filename": "server/api/faxInteraction/index.js",
10271     "groupTitle": "Fax_Interactions"
10272   },
10273   {
10274     "type": "get",
10275     "url": "/api/fax/interactions/{id}/messages",
10276     "title": "Gets interaction messages",
10277     "examples": [
10278       {
10279         "title": "Example usage:",
10280         "content": "curl https://{domain}/api/fax/interactions/{id}/messages -v -u {name}:{password} -X GET",
10281         "type": "json"
10282       }
10283     ],
10284     "name": "getMessages",
10285     "group": "Fax_Interactions",
10286     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10287     "version": "0.0.0",
10288     "filename": "server/api/faxInteraction/index.js",
10289     "groupTitle": "Fax_Interactions"
10290   },
10291   {
10292     "type": "put",
10293     "url": "/api/fax/interactions/{id}",
10294     "title": "Update an existing Interaction",
10295     "examples": [
10296       {
10297         "title": "Example usage:",
10298         "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",
10299         "type": "json"
10300       }
10301     ],
10302     "name": "updateInteractions",
10303     "group": "Fax_Interactions",
10304     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10305     "version": "0.0.0",
10306     "filename": "server/api/faxInteraction/index.js",
10307     "groupTitle": "Fax_Interactions"
10308   },
10309   {
10310     "type": "get",
10311     "url": "/api/fax/messages/{id}/download",
10312     "title": "Get message",
10313     "examples": [
10314       {
10315         "title": "Example usage:",
10316         "content": "curl https://{domain}/api/fax/messages/{id}/download -v -u {name}:{password} -X GET",
10317         "type": "json"
10318       }
10319     ],
10320     "name": "download",
10321     "group": "Fax_Message",
10322     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10323     "version": "0.0.0",
10324     "filename": "server/api/faxMessage/index.js",
10325     "groupTitle": "Fax_Message"
10326   },
10327   {
10328     "type": "delete",
10329     "url": "/api/fax/messages/{id}",
10330     "title": "Deletes a Message",
10331     "examples": [
10332       {
10333         "title": "Example usage:",
10334         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password} -X DELETE",
10335         "type": "json"
10336       }
10337     ],
10338     "name": "DeleteMessages",
10339     "group": "Fax_Messages",
10340     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10341     "version": "0.0.0",
10342     "filename": "server/api/faxMessage/index.js",
10343     "groupTitle": "Fax_Messages"
10344   },
10345   {
10346     "type": "get",
10347     "url": "/api/fax/messages/describe",
10348     "title": "Gets table info about Messages",
10349     "examples": [
10350       {
10351         "title": "Example usage:",
10352         "content": "curl https://{domain}/api/fax/messages/describe -v -u {name}:{password}",
10353         "type": "json"
10354       }
10355     ],
10356     "name": "DescribeMessages",
10357     "group": "Fax_Messages",
10358     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10359     "version": "0.0.0",
10360     "filename": "server/api/faxMessage/index.js",
10361     "groupTitle": "Fax_Messages"
10362   },
10363   {
10364     "type": "get",
10365     "url": "/api/fax/messages",
10366     "title": "Gets a list of Messages",
10367     "examples": [
10368       {
10369         "title": "Example usage:",
10370         "content": "curl https://{domain}/api/fax/messages -v -u {name}:{password}",
10371         "type": "json"
10372       }
10373     ],
10374     "name": "GetMessages",
10375     "group": "Fax_Messages",
10376     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10377     "version": "0.0.0",
10378     "filename": "server/api/faxMessage/index.js",
10379     "groupTitle": "Fax_Messages"
10380   },
10381   {
10382     "type": "get",
10383     "url": "/api/fax/messages/{id}",
10384     "title": "Gets a single Message",
10385     "examples": [
10386       {
10387         "title": "Example usage:",
10388         "content": "curl https://{domain}/api/fax/messages/{id} -v -u {name}:{password}",
10389         "type": "json"
10390       }
10391     ],
10392     "name": "ShowMessages",
10393     "group": "Fax_Messages",
10394     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10395     "version": "0.0.0",
10396     "filename": "server/api/faxMessage/index.js",
10397     "groupTitle": "Fax_Messages"
10398   },
10399   {
10400     "type": "put",
10401     "url": "/api/fax/messages/{id}/accept",
10402     "title": "Accepts message",
10403     "examples": [
10404       {
10405         "title": "Example usage:",
10406         "content": "curl https://{domain}/api/fax/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10407         "type": "json"
10408       }
10409     ],
10410     "name": "acceptMessage",
10411     "group": "Fax_Messages",
10412     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10413     "version": "0.0.0",
10414     "filename": "server/api/faxMessage/index.js",
10415     "groupTitle": "Fax_Messages"
10416   },
10417   {
10418     "type": "put",
10419     "url": "/api/fax/messages/{id}/reject",
10420     "title": "Rejects message",
10421     "examples": [
10422       {
10423         "title": "Example usage:",
10424         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10425         "type": "json"
10426       }
10427     ],
10428     "name": "rejectMessage",
10429     "group": "Fax_Messages",
10430     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10431     "version": "0.0.0",
10432     "filename": "server/api/faxMessage/index.js",
10433     "groupTitle": "Fax_Messages"
10434   },
10435   {
10436     "type": "post",
10437     "url": "/api/fax/messages",
10438     "title": "Create message and send Fax",
10439     "examples": [
10440       {
10441         "title": "Example usage:",
10442         "content": "curl https://{domain}/api/fax/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
10443         "type": "json"
10444       }
10445     ],
10446     "name": "rejectMessage",
10447     "group": "Fax_Messages",
10448     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10449     "version": "0.0.0",
10450     "filename": "server/api/faxMessage/index.js",
10451     "groupTitle": "Fax_Messages"
10452   },
10453   {
10454     "type": "put",
10455     "url": "/api/fax/messages/{id}",
10456     "title": "Update an existing Message",
10457     "examples": [
10458       {
10459         "title": "Example usage:",
10460         "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",
10461         "type": "json"
10462       }
10463     ],
10464     "name": "updateMessages",
10465     "group": "Fax_Messages",
10466     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10467     "version": "0.0.0",
10468     "filename": "server/api/faxMessage/index.js",
10469     "groupTitle": "Fax_Messages"
10470   },
10471   {
10472     "type": "post",
10473     "url": "/api/fax/reports/queue",
10474     "title": "Creates a new Fax Queue Report",
10475     "examples": [
10476       {
10477         "title": "Example usage:",
10478         "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",
10479         "type": "json"
10480       }
10481     ],
10482     "name": "CreateFax_Queue_Reports",
10483     "group": "Fax_Queue_Reports",
10484     "parameter": {
10485       "fields": {
10486         "Body": [
10487           {
10488             "group": "Body",
10489             "type": "String",
10490             "optional": false,
10491             "field": "uniqueid",
10492             "description": ""
10493           },
10494           {
10495             "group": "Body",
10496             "type": "String",
10497             "optional": true,
10498             "field": "from",
10499             "description": ""
10500           },
10501           {
10502             "group": "Body",
10503             "type": "String",
10504             "optional": true,
10505             "field": "joinAt",
10506             "description": ""
10507           },
10508           {
10509             "group": "Body",
10510             "type": "String",
10511             "optional": true,
10512             "field": "leaveAt",
10513             "description": ""
10514           },
10515           {
10516             "group": "Body",
10517             "type": "String",
10518             "optional": true,
10519             "field": "acceptAt",
10520             "description": ""
10521           },
10522           {
10523             "group": "Body",
10524             "type": "String",
10525             "optional": true,
10526             "field": "exitAt",
10527             "description": ""
10528           },
10529           {
10530             "group": "Body",
10531             "type": "String",
10532             "optional": true,
10533             "field": "reason",
10534             "description": ""
10535           }
10536         ]
10537       }
10538     },
10539     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10540     "version": "0.0.0",
10541     "filename": "server/api/faxQueueReport/index.js",
10542     "groupTitle": "Fax_Queue_Reports"
10543   },
10544   {
10545     "type": "delete",
10546     "url": "/api/fax/reports/queue/{id}",
10547     "title": "Deletes a Fax Queue Report",
10548     "examples": [
10549       {
10550         "title": "Example usage:",
10551         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password} -X DELETE",
10552         "type": "json"
10553       }
10554     ],
10555     "name": "DeleteFax_Queue_Reports",
10556     "group": "Fax_Queue_Reports",
10557     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10558     "version": "0.0.0",
10559     "filename": "server/api/faxQueueReport/index.js",
10560     "groupTitle": "Fax_Queue_Reports"
10561   },
10562   {
10563     "type": "get",
10564     "url": "/api/fax/reports/queue/describe",
10565     "title": "Gets table info about Fax Queue Reports",
10566     "examples": [
10567       {
10568         "title": "Example usage:",
10569         "content": "curl https://{domain}/api/fax/reports/queue/describe -v -u {name}:{password}",
10570         "type": "json"
10571       }
10572     ],
10573     "name": "DescribeFax_Queue_Reports",
10574     "group": "Fax_Queue_Reports",
10575     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10576     "version": "0.0.0",
10577     "filename": "server/api/faxQueueReport/index.js",
10578     "groupTitle": "Fax_Queue_Reports"
10579   },
10580   {
10581     "type": "get",
10582     "url": "/api/fax/reports/queue",
10583     "title": "Gets a list of Fax Queue Reports",
10584     "examples": [
10585       {
10586         "title": "Example usage:",
10587         "content": "curl https://{domain}/api/fax/reports/queue -v -u {name}:{password}",
10588         "type": "json"
10589       }
10590     ],
10591     "name": "GetFax_Queue_Reports",
10592     "group": "Fax_Queue_Reports",
10593     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10594     "version": "0.0.0",
10595     "filename": "server/api/faxQueueReport/index.js",
10596     "groupTitle": "Fax_Queue_Reports"
10597   },
10598   {
10599     "type": "get",
10600     "url": "/api/fax/reports/queue/{id}",
10601     "title": "Gets a single Fax Queue Report",
10602     "examples": [
10603       {
10604         "title": "Example usage:",
10605         "content": "curl https://{domain}/api/fax/reports/queue/{id} -v -u {name}:{password}",
10606         "type": "json"
10607       }
10608     ],
10609     "name": "ShowFax_Queue_Reports",
10610     "group": "Fax_Queue_Reports",
10611     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10612     "version": "0.0.0",
10613     "filename": "server/api/faxQueueReport/index.js",
10614     "groupTitle": "Fax_Queue_Reports"
10615   },
10616   {
10617     "type": "put",
10618     "url": "/api/fax/reports/queue/{id}",
10619     "title": "Update an existing Fax Queue Report",
10620     "examples": [
10621       {
10622         "title": "Example usage:",
10623         "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",
10624         "type": "json"
10625       }
10626     ],
10627     "name": "updateFax_Queue_Reports",
10628     "group": "Fax_Queue_Reports",
10629     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10630     "version": "0.0.0",
10631     "filename": "server/api/faxQueueReport/index.js",
10632     "groupTitle": "Fax_Queue_Reports"
10633   },
10634   {
10635     "type": "post",
10636     "url": "/api/fax/queues/{id}/users",
10637     "title": "Add agents to a queue",
10638     "examples": [
10639       {
10640         "title": "Example usage:",
10641         "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",
10642         "type": "json"
10643       }
10644     ],
10645     "name": "AddAgents",
10646     "group": "Fax_Queues",
10647     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10648     "version": "0.0.0",
10649     "filename": "server/api/faxQueue/index.js",
10650     "groupTitle": "Fax_Queues"
10651   },
10652   {
10653     "type": "post",
10654     "url": "/api/fax/queues/{id}/teams",
10655     "title": "Add teams to a queue",
10656     "examples": [
10657       {
10658         "title": "Example usage:",
10659         "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",
10660         "type": "json"
10661       }
10662     ],
10663     "name": "AddTeams",
10664     "group": "Fax_Queues",
10665     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10666     "version": "0.0.0",
10667     "filename": "server/api/faxQueue/index.js",
10668     "groupTitle": "Fax_Queues"
10669   },
10670   {
10671     "type": "post",
10672     "url": "/api/fax/queues",
10673     "title": "Creates a new Queue",
10674     "examples": [
10675       {
10676         "title": "Example usage:",
10677         "content": "curl https://{domain}/api/fax/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
10678         "type": "json"
10679       }
10680     ],
10681     "name": "CreateQueues",
10682     "group": "Fax_Queues",
10683     "parameter": {
10684       "fields": {
10685         "Body": [
10686           {
10687             "group": "Body",
10688             "type": "String",
10689             "optional": false,
10690             "field": "name",
10691             "description": ""
10692           },
10693           {
10694             "group": "Body",
10695             "type": "String",
10696             "optional": true,
10697             "field": "description",
10698             "description": ""
10699           },
10700           {
10701             "group": "Body",
10702             "type": "Integer",
10703             "optional": false,
10704             "field": "timeout",
10705             "description": ""
10706           },
10707           {
10708             "group": "Body",
10709             "type": "String",
10710             "allowedValues": [
10711               "\"rrmemory\"",
10712               "\"beepall\"",
10713               "\"roundrobin\""
10714             ],
10715             "optional": false,
10716             "field": "strategy",
10717             "description": ""
10718           },
10719           {
10720             "group": "Body",
10721             "type": "Integer",
10722             "optional": true,
10723             "field": "lastAgent",
10724             "description": ""
10725           }
10726         ]
10727       }
10728     },
10729     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10730     "version": "0.0.0",
10731     "filename": "server/api/faxQueue/index.js",
10732     "groupTitle": "Fax_Queues"
10733   },
10734   {
10735     "type": "delete",
10736     "url": "/api/fax/queues/{id}",
10737     "title": "Deletes a Queue",
10738     "examples": [
10739       {
10740         "title": "Example usage:",
10741         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password} -X DELETE",
10742         "type": "json"
10743       }
10744     ],
10745     "name": "DeleteQueues",
10746     "group": "Fax_Queues",
10747     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10748     "version": "0.0.0",
10749     "filename": "server/api/faxQueue/index.js",
10750     "groupTitle": "Fax_Queues"
10751   },
10752   {
10753     "type": "get",
10754     "url": "/api/fax/queues/describe",
10755     "title": "Gets table info about Queues",
10756     "examples": [
10757       {
10758         "title": "Example usage:",
10759         "content": "curl https://{domain}/api/fax/queues/describe -v -u {name}:{password}",
10760         "type": "json"
10761       }
10762     ],
10763     "name": "DescribeQueues",
10764     "group": "Fax_Queues",
10765     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10766     "version": "0.0.0",
10767     "filename": "server/api/faxQueue/index.js",
10768     "groupTitle": "Fax_Queues"
10769   },
10770   {
10771     "type": "get",
10772     "url": "/api/fax/queues/{id}/users",
10773     "title": "Gets queue agents",
10774     "examples": [
10775       {
10776         "title": "Example usage:",
10777         "content": "curl https://{domain}/api/fax/queues/{id}/users -v -u {name}:{password} -X POST",
10778         "type": "json"
10779       }
10780     ],
10781     "name": "GetAgents",
10782     "group": "Fax_Queues",
10783     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10784     "version": "0.0.0",
10785     "filename": "server/api/faxQueue/index.js",
10786     "groupTitle": "Fax_Queues"
10787   },
10788   {
10789     "type": "get",
10790     "url": "/api/fax/queues/{id}/members",
10791     "title": "GetMembers",
10792     "examples": [
10793       {
10794         "title": "Example usage:",
10795         "content": "curl https://{domain}/api/fax/queues/{id}/members  -v -u {name}:{password}",
10796         "type": "json"
10797       }
10798     ],
10799     "name": "GetMembers",
10800     "group": "Fax_Queues",
10801     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10802     "version": "0.0.0",
10803     "filename": "server/api/faxQueue/index.js",
10804     "groupTitle": "Fax_Queues"
10805   },
10806   {
10807     "type": "get",
10808     "url": "/api/fax/queues",
10809     "title": "Gets a list of Queues",
10810     "examples": [
10811       {
10812         "title": "Example usage:",
10813         "content": "curl https://{domain}/api/fax/queues -v -u {name}:{password}",
10814         "type": "json"
10815       }
10816     ],
10817     "name": "GetQueues",
10818     "group": "Fax_Queues",
10819     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10820     "version": "0.0.0",
10821     "filename": "server/api/faxQueue/index.js",
10822     "groupTitle": "Fax_Queues"
10823   },
10824   {
10825     "type": "get",
10826     "url": "/api/fax/queues/{id}/teams",
10827     "title": "Gets queues list",
10828     "examples": [
10829       {
10830         "title": "Example usage:",
10831         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password}",
10832         "type": "json"
10833       }
10834     ],
10835     "name": "GetTeams",
10836     "group": "Fax_Queues",
10837     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10838     "version": "0.0.0",
10839     "filename": "server/api/faxQueue/index.js",
10840     "groupTitle": "Fax_Queues"
10841   },
10842   {
10843     "type": "delete",
10844     "url": "/api/fax/queues/{id}/users",
10845     "title": "Removes agents from a queue",
10846     "examples": [
10847       {
10848         "title": "Example usage:",
10849         "content": "curl https://{domain}/api/fax/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
10850         "type": "json"
10851       }
10852     ],
10853     "name": "RemoveAgents",
10854     "group": "Fax_Queues",
10855     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10856     "version": "0.0.0",
10857     "filename": "server/api/faxQueue/index.js",
10858     "groupTitle": "Fax_Queues"
10859   },
10860   {
10861     "type": "get",
10862     "url": "/api/fax/queues/{id}",
10863     "title": "Gets a single Queue",
10864     "examples": [
10865       {
10866         "title": "Example usage:",
10867         "content": "curl https://{domain}/api/fax/queues/{id} -v -u {name}:{password}",
10868         "type": "json"
10869       }
10870     ],
10871     "name": "ShowQueues",
10872     "group": "Fax_Queues",
10873     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10874     "version": "0.0.0",
10875     "filename": "server/api/faxQueue/index.js",
10876     "groupTitle": "Fax_Queues"
10877   },
10878   {
10879     "type": "put",
10880     "url": "/api/fax/queues/{id}",
10881     "title": "Update an existing Queue",
10882     "examples": [
10883       {
10884         "title": "Example usage:",
10885         "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",
10886         "type": "json"
10887       }
10888     ],
10889     "name": "updateQueues",
10890     "group": "Fax_Queues",
10891     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10892     "version": "0.0.0",
10893     "filename": "server/api/faxQueue/index.js",
10894     "groupTitle": "Fax_Queues"
10895   },
10896   {
10897     "type": "post",
10898     "url": "/api/fax/reports/transfer",
10899     "title": "Creates a new Fax Transfer Report",
10900     "examples": [
10901       {
10902         "title": "Example usage:",
10903         "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",
10904         "type": "json"
10905       }
10906     ],
10907     "name": "CreateFax_Transfer_Reports",
10908     "group": "Fax_Transfer_Reports",
10909     "parameter": {
10910       "fields": {
10911         "Body": [
10912           {
10913             "group": "Body",
10914             "type": "String",
10915             "optional": false,
10916             "field": "uniqueid",
10917             "description": ""
10918           },
10919           {
10920             "group": "Body",
10921             "type": "String",
10922             "allowedValues": [
10923               "\"account\"",
10924               "\"agent\"",
10925               "\"queue\""
10926             ],
10927             "optional": false,
10928             "field": "type",
10929             "description": ""
10930           },
10931           {
10932             "group": "Body",
10933             "type": "String",
10934             "optional": false,
10935             "field": "transferredAt",
10936             "description": ""
10937           }
10938         ]
10939       }
10940     },
10941     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10942     "version": "0.0.0",
10943     "filename": "server/api/faxTransferReport/index.js",
10944     "groupTitle": "Fax_Transfer_Reports"
10945   },
10946   {
10947     "type": "delete",
10948     "url": "/api/fax/reports/transfer/{id}",
10949     "title": "Deletes a Fax Transfer Report",
10950     "examples": [
10951       {
10952         "title": "Example usage:",
10953         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
10954         "type": "json"
10955       }
10956     ],
10957     "name": "DeleteFax_Transfer_Reports",
10958     "group": "Fax_Transfer_Reports",
10959     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10960     "version": "0.0.0",
10961     "filename": "server/api/faxTransferReport/index.js",
10962     "groupTitle": "Fax_Transfer_Reports"
10963   },
10964   {
10965     "type": "get",
10966     "url": "/api/fax/reports/transfer/describe",
10967     "title": "Gets table info about Fax Transfer Reports",
10968     "examples": [
10969       {
10970         "title": "Example usage:",
10971         "content": "curl https://{domain}/api/fax/reports/transfer/describe -v -u {name}:{password}",
10972         "type": "json"
10973       }
10974     ],
10975     "name": "DescribeFax_Transfer_Reports",
10976     "group": "Fax_Transfer_Reports",
10977     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
10978     "version": "0.0.0",
10979     "filename": "server/api/faxTransferReport/index.js",
10980     "groupTitle": "Fax_Transfer_Reports"
10981   },
10982   {
10983     "type": "get",
10984     "url": "/api/fax/reports/transfer",
10985     "title": "Gets a list of Fax Transfer Reports",
10986     "examples": [
10987       {
10988         "title": "Example usage:",
10989         "content": "curl https://{domain}/api/fax/reports/transfer -v -u {name}:{password}",
10990         "type": "json"
10991       }
10992     ],
10993     "name": "GetFax_Transfer_Reports",
10994     "group": "Fax_Transfer_Reports",
10995     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
10996     "version": "0.0.0",
10997     "filename": "server/api/faxTransferReport/index.js",
10998     "groupTitle": "Fax_Transfer_Reports"
10999   },
11000   {
11001     "type": "get",
11002     "url": "/api/fax/reports/transfer/{id}",
11003     "title": "Gets a single Fax Transfer Report",
11004     "examples": [
11005       {
11006         "title": "Example usage:",
11007         "content": "curl https://{domain}/api/fax/reports/transfer/{id} -v -u {name}:{password}",
11008         "type": "json"
11009       }
11010     ],
11011     "name": "ShowFax_Transfer_Reports",
11012     "group": "Fax_Transfer_Reports",
11013     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11014     "version": "0.0.0",
11015     "filename": "server/api/faxTransferReport/index.js",
11016     "groupTitle": "Fax_Transfer_Reports"
11017   },
11018   {
11019     "type": "put",
11020     "url": "/api/fax/reports/transfer/{id}",
11021     "title": "Update an existing Fax Transfer Report",
11022     "examples": [
11023       {
11024         "title": "Example usage:",
11025         "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",
11026         "type": "json"
11027       }
11028     ],
11029     "name": "updateFax_Transfer_Reports",
11030     "group": "Fax_Transfer_Reports",
11031     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11032     "version": "0.0.0",
11033     "filename": "server/api/faxTransferReport/index.js",
11034     "groupTitle": "Fax_Transfer_Reports"
11035   },
11036   {
11037     "type": "post",
11038     "url": "/api/integrations/freshdesk/accounts",
11039     "title": "Creates a new Freshdesk Account",
11040     "examples": [
11041       {
11042         "title": "Example usage:",
11043         "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",
11044         "type": "json"
11045       }
11046     ],
11047     "name": "CreateFreshdesk_Accounts",
11048     "group": "Freshdesk_Accounts",
11049     "parameter": {
11050       "fields": {
11051         "Body": [
11052           {
11053             "group": "Body",
11054             "type": "String",
11055             "optional": true,
11056             "field": "name",
11057             "description": ""
11058           },
11059           {
11060             "group": "Body",
11061             "type": "String",
11062             "optional": true,
11063             "field": "description",
11064             "description": ""
11065           },
11066           {
11067             "group": "Body",
11068             "type": "String",
11069             "optional": true,
11070             "field": "username",
11071             "description": ""
11072           },
11073           {
11074             "group": "Body",
11075             "type": "String",
11076             "optional": true,
11077             "field": "apiKey",
11078             "description": ""
11079           },
11080           {
11081             "group": "Body",
11082             "type": "String",
11083             "optional": true,
11084             "field": "remoteUri",
11085             "description": ""
11086           },
11087           {
11088             "group": "Body",
11089             "type": "String",
11090             "optional": true,
11091             "field": "serverUrl",
11092             "description": ""
11093           }
11094         ]
11095       }
11096     },
11097     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11098     "version": "0.0.0",
11099     "filename": "server/api/intFreshdeskAccount/index.js",
11100     "groupTitle": "Freshdesk_Accounts"
11101   },
11102   {
11103     "type": "delete",
11104     "url": "/api/integrations/freshdesk/accounts/{id}",
11105     "title": "Deletes a Freshdesk Account",
11106     "examples": [
11107       {
11108         "title": "Example usage:",
11109         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password} -X DELETE",
11110         "type": "json"
11111       }
11112     ],
11113     "name": "DeleteFreshdesk_Accounts",
11114     "group": "Freshdesk_Accounts",
11115     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11116     "version": "0.0.0",
11117     "filename": "server/api/intFreshdeskAccount/index.js",
11118     "groupTitle": "Freshdesk_Accounts"
11119   },
11120   {
11121     "type": "get",
11122     "url": "/api/integrations/freshdesk/accounts",
11123     "title": "Gets a list of Freshdesk Accounts",
11124     "examples": [
11125       {
11126         "title": "Example usage:",
11127         "content": "curl https://{domain}/api/integrations/freshdesk/accounts -v -u {name}:{password}",
11128         "type": "json"
11129       }
11130     ],
11131     "name": "GetFreshdesk_Accounts",
11132     "group": "Freshdesk_Accounts",
11133     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11134     "version": "0.0.0",
11135     "filename": "server/api/intFreshdeskAccount/index.js",
11136     "groupTitle": "Freshdesk_Accounts"
11137   },
11138   {
11139     "type": "get",
11140     "url": "/api/integrations/freshdesk/accounts/{id}",
11141     "title": "Gets a single Freshdesk Account",
11142     "examples": [
11143       {
11144         "title": "Example usage:",
11145         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id} -v -u {name}:{password}",
11146         "type": "json"
11147       }
11148     ],
11149     "name": "ShowFreshdesk_Accounts",
11150     "group": "Freshdesk_Accounts",
11151     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11152     "version": "0.0.0",
11153     "filename": "server/api/intFreshdeskAccount/index.js",
11154     "groupTitle": "Freshdesk_Accounts"
11155   },
11156   {
11157     "type": "post",
11158     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11159     "title": "Creates new configuration",
11160     "examples": [
11161       {
11162         "title": "Example usage:",
11163         "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",
11164         "type": "json"
11165       }
11166     ],
11167     "name": "addConfiguration",
11168     "group": "Freshdesk_Accounts",
11169     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11170     "version": "0.0.0",
11171     "filename": "server/api/intFreshdeskAccount/index.js",
11172     "groupTitle": "Freshdesk_Accounts"
11173   },
11174   {
11175     "type": "get",
11176     "url": "/api/integrations/freshdesk/accounts/{id}/configurations",
11177     "title": "Gets account configurations",
11178     "examples": [
11179       {
11180         "title": "Example usage:",
11181         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11182         "type": "json"
11183       }
11184     ],
11185     "name": "getConfigurations",
11186     "group": "Freshdesk_Accounts",
11187     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11188     "version": "0.0.0",
11189     "filename": "server/api/intFreshdeskAccount/index.js",
11190     "groupTitle": "Freshdesk_Accounts"
11191   },
11192   {
11193     "type": "get",
11194     "url": "/api/integrations/freshdesk/accounts/{id}/fields",
11195     "title": "Gets account fields",
11196     "examples": [
11197       {
11198         "title": "Example usage:",
11199         "content": "curl https://{domain}/api/integrations/freshdesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
11200         "type": "json"
11201       }
11202     ],
11203     "name": "getFields",
11204     "group": "Freshdesk_Accounts",
11205     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11206     "version": "0.0.0",
11207     "filename": "server/api/intFreshdeskAccount/index.js",
11208     "groupTitle": "Freshdesk_Accounts"
11209   },
11210   {
11211     "type": "put",
11212     "url": "/api/integrations/freshdesk/accounts/{id}",
11213     "title": "Update an existing Freshdesk Account",
11214     "examples": [
11215       {
11216         "title": "Example usage:",
11217         "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",
11218         "type": "json"
11219       }
11220     ],
11221     "name": "updateFreshdesk_Accounts",
11222     "group": "Freshdesk_Accounts",
11223     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11224     "version": "0.0.0",
11225     "filename": "server/api/intFreshdeskAccount/index.js",
11226     "groupTitle": "Freshdesk_Accounts"
11227   },
11228   {
11229     "type": "post",
11230     "url": "/api/integrations/freshdesk/configurations",
11231     "title": "Creates a new Freshdesk Configuration",
11232     "examples": [
11233       {
11234         "title": "Example usage:",
11235         "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",
11236         "type": "json"
11237       }
11238     ],
11239     "name": "CreateFreshdesk_Configurations",
11240     "group": "Freshdesk_Configurations",
11241     "parameter": {
11242       "fields": {
11243         "Body": [
11244           {
11245             "group": "Body",
11246             "type": "String",
11247             "optional": true,
11248             "field": "name",
11249             "description": ""
11250           },
11251           {
11252             "group": "Body",
11253             "type": "String",
11254             "optional": true,
11255             "field": "description",
11256             "description": ""
11257           }
11258         ]
11259       }
11260     },
11261     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11262     "version": "0.0.0",
11263     "filename": "server/api/intFreshdeskConfiguration/index.js",
11264     "groupTitle": "Freshdesk_Configurations"
11265   },
11266   {
11267     "type": "delete",
11268     "url": "/api/integrations/freshdesk/configurations/{id}",
11269     "title": "Deletes a Freshdesk Configuration",
11270     "examples": [
11271       {
11272         "title": "Example usage:",
11273         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password} -X DELETE",
11274         "type": "json"
11275       }
11276     ],
11277     "name": "DeleteFreshdesk_Configurations",
11278     "group": "Freshdesk_Configurations",
11279     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11280     "version": "0.0.0",
11281     "filename": "server/api/intFreshdeskConfiguration/index.js",
11282     "groupTitle": "Freshdesk_Configurations"
11283   },
11284   {
11285     "type": "get",
11286     "url": "/api/integrations/freshdesk/configurations",
11287     "title": "Gets a list of Freshdesk Configurations",
11288     "examples": [
11289       {
11290         "title": "Example usage:",
11291         "content": "curl https://{domain}/api/integrations/freshdesk/configurations -v -u {name}:{password}",
11292         "type": "json"
11293       }
11294     ],
11295     "name": "GetFreshdesk_Configurations",
11296     "group": "Freshdesk_Configurations",
11297     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11298     "version": "0.0.0",
11299     "filename": "server/api/intFreshdeskConfiguration/index.js",
11300     "groupTitle": "Freshdesk_Configurations"
11301   },
11302   {
11303     "type": "get",
11304     "url": "/api/integrations/freshdesk/configurations/{id}",
11305     "title": "Gets a single Freshdesk Configuration",
11306     "examples": [
11307       {
11308         "title": "Example usage:",
11309         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id} -v -u {name}:{password}",
11310         "type": "json"
11311       }
11312     ],
11313     "name": "ShowFreshdesk_Configurations",
11314     "group": "Freshdesk_Configurations",
11315     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11316     "version": "0.0.0",
11317     "filename": "server/api/intFreshdeskConfiguration/index.js",
11318     "groupTitle": "Freshdesk_Configurations"
11319   },
11320   {
11321     "type": "get",
11322     "url": "/api/integrations/freshdesk/configurations/{id}/descriptions",
11323     "title": "Gets configurations descriptions",
11324     "examples": [
11325       {
11326         "title": "Example usage:",
11327         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11328         "type": "json"
11329       }
11330     ],
11331     "name": "getDescriptions",
11332     "group": "Freshdesk_Configurations",
11333     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11334     "version": "0.0.0",
11335     "filename": "server/api/intFreshdeskConfiguration/index.js",
11336     "groupTitle": "Freshdesk_Configurations"
11337   },
11338   {
11339     "type": "get",
11340     "url": "/api/integrations/freshdesk/configurations/{id}/fields",
11341     "title": "Gets configurations fields",
11342     "examples": [
11343       {
11344         "title": "Example usage:",
11345         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
11346         "type": "json"
11347       }
11348     ],
11349     "name": "getFields",
11350     "group": "Freshdesk_Configurations",
11351     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11352     "version": "0.0.0",
11353     "filename": "server/api/intFreshdeskConfiguration/index.js",
11354     "groupTitle": "Freshdesk_Configurations"
11355   },
11356   {
11357     "type": "get",
11358     "url": "/api/integrations/freshdesk/configurations/{id}/subjects",
11359     "title": "Gets configurations subjects",
11360     "examples": [
11361       {
11362         "title": "Example usage:",
11363         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11364         "type": "json"
11365       }
11366     ],
11367     "name": "getSubjects",
11368     "group": "Freshdesk_Configurations",
11369     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11370     "version": "0.0.0",
11371     "filename": "server/api/intFreshdeskConfiguration/index.js",
11372     "groupTitle": "Freshdesk_Configurations"
11373   },
11374   {
11375     "type": "get",
11376     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11377     "title": "Gets configurations tags",
11378     "examples": [
11379       {
11380         "title": "Example usage:",
11381         "content": "curl https://{domain}/api/integrations/freshdesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
11382         "type": "json"
11383       }
11384     ],
11385     "name": "getTags",
11386     "group": "Freshdesk_Configurations",
11387     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11388     "version": "0.0.0",
11389     "filename": "server/api/intFreshdeskConfiguration/index.js",
11390     "groupTitle": "Freshdesk_Configurations"
11391   },
11392   {
11393     "type": "post",
11394     "url": "/api/integrations/freshdesk/configurations/{id}/tags",
11395     "title": "Sets new tags",
11396     "examples": [
11397       {
11398         "title": "Example usage:",
11399         "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",
11400         "type": "json"
11401       }
11402     ],
11403     "name": "setTags",
11404     "group": "Freshdesk_Configurations",
11405     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11406     "version": "0.0.0",
11407     "filename": "server/api/intFreshdeskConfiguration/index.js",
11408     "groupTitle": "Freshdesk_Configurations"
11409   },
11410   {
11411     "type": "put",
11412     "url": "/api/integrations/freshdesk/configurations/{id}",
11413     "title": "Update an existing Freshdesk Configuration",
11414     "examples": [
11415       {
11416         "title": "Example usage:",
11417         "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",
11418         "type": "json"
11419       }
11420     ],
11421     "name": "updateFreshdesk_Configurations",
11422     "group": "Freshdesk_Configurations",
11423     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11424     "version": "0.0.0",
11425     "filename": "server/api/intFreshdeskConfiguration/index.js",
11426     "groupTitle": "Freshdesk_Configurations"
11427   },
11428   {
11429     "type": "post",
11430     "url": "/api/integrations/freshdesk/fields",
11431     "title": "Creates a new Freshdesk Field",
11432     "examples": [
11433       {
11434         "title": "Example usage:",
11435         "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",
11436         "type": "json"
11437       }
11438     ],
11439     "name": "CreateFreshdesk_Fields",
11440     "group": "Freshdesk_Fields",
11441     "parameter": {
11442       "fields": {
11443         "Body": [
11444           {
11445             "group": "Body",
11446             "type": "String",
11447             "allowedValues": [
11448               "\"string\"",
11449               "\"variable\"",
11450               "\"customVariable\"",
11451               "\"keyValue\""
11452             ],
11453             "optional": true,
11454             "field": "type",
11455             "description": ""
11456           },
11457           {
11458             "group": "Body",
11459             "type": "String",
11460             "optional": true,
11461             "field": "content",
11462             "description": ""
11463           },
11464           {
11465             "group": "Body",
11466             "type": "String",
11467             "optional": true,
11468             "field": "key",
11469             "description": ""
11470           },
11471           {
11472             "group": "Body",
11473             "type": "String",
11474             "allowedValues": [
11475               "\"string\"",
11476               "\"variable\"",
11477               "\"customVariable\""
11478             ],
11479             "optional": true,
11480             "field": "keyType",
11481             "description": ""
11482           },
11483           {
11484             "group": "Body",
11485             "type": "String",
11486             "optional": true,
11487             "field": "keyContent",
11488             "description": ""
11489           },
11490           {
11491             "group": "Body",
11492             "type": "String",
11493             "optional": true,
11494             "field": "idField",
11495             "description": ""
11496           },
11497           {
11498             "group": "Body",
11499             "type": "String",
11500             "optional": true,
11501             "field": "nameField",
11502             "description": ""
11503           },
11504           {
11505             "group": "Body",
11506             "type": "Boolean",
11507             "optional": true,
11508             "field": "customField",
11509             "description": ""
11510           },
11511           {
11512             "group": "Body",
11513             "type": "String",
11514             "optional": true,
11515             "field": "variableName",
11516             "description": ""
11517           }
11518         ]
11519       }
11520     },
11521     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11522     "version": "0.0.0",
11523     "filename": "server/api/intFreshdeskField/index.js",
11524     "groupTitle": "Freshdesk_Fields"
11525   },
11526   {
11527     "type": "delete",
11528     "url": "/api/integrations/freshdesk/fields/{id}",
11529     "title": "Deletes a Freshdesk Field",
11530     "examples": [
11531       {
11532         "title": "Example usage:",
11533         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password} -X DELETE",
11534         "type": "json"
11535       }
11536     ],
11537     "name": "DeleteFreshdesk_Fields",
11538     "group": "Freshdesk_Fields",
11539     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11540     "version": "0.0.0",
11541     "filename": "server/api/intFreshdeskField/index.js",
11542     "groupTitle": "Freshdesk_Fields"
11543   },
11544   {
11545     "type": "get",
11546     "url": "/api/integrations/freshdesk/fields",
11547     "title": "Gets a list of Freshdesk Fields",
11548     "examples": [
11549       {
11550         "title": "Example usage:",
11551         "content": "curl https://{domain}/api/integrations/freshdesk/fields -v -u {name}:{password}",
11552         "type": "json"
11553       }
11554     ],
11555     "name": "GetFreshdesk_Fields",
11556     "group": "Freshdesk_Fields",
11557     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11558     "version": "0.0.0",
11559     "filename": "server/api/intFreshdeskField/index.js",
11560     "groupTitle": "Freshdesk_Fields"
11561   },
11562   {
11563     "type": "get",
11564     "url": "/api/integrations/freshdesk/fields/{id}",
11565     "title": "Gets a single Freshdesk Field",
11566     "examples": [
11567       {
11568         "title": "Example usage:",
11569         "content": "curl https://{domain}/api/integrations/freshdesk/fields/{id} -v -u {name}:{password}",
11570         "type": "json"
11571       }
11572     ],
11573     "name": "ShowFreshdesk_Fields",
11574     "group": "Freshdesk_Fields",
11575     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11576     "version": "0.0.0",
11577     "filename": "server/api/intFreshdeskField/index.js",
11578     "groupTitle": "Freshdesk_Fields"
11579   },
11580   {
11581     "type": "put",
11582     "url": "/api/integrations/freshdesk/fields/{id}",
11583     "title": "Update an existing Freshdesk Field",
11584     "examples": [
11585       {
11586         "title": "Example usage:",
11587         "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",
11588         "type": "json"
11589       }
11590     ],
11591     "name": "updateFreshdesk_Fields",
11592     "group": "Freshdesk_Fields",
11593     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11594     "version": "0.0.0",
11595     "filename": "server/api/intFreshdeskField/index.js",
11596     "groupTitle": "Freshdesk_Fields"
11597   },
11598   {
11599     "type": "post",
11600     "url": "/api/integrations/freshsales/accounts",
11601     "title": "Creates a new Freshsales Account",
11602     "examples": [
11603       {
11604         "title": "Example usage:",
11605         "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",
11606         "type": "json"
11607       }
11608     ],
11609     "name": "CreateFreshsales_Accounts",
11610     "group": "Freshsales_Accounts",
11611     "parameter": {
11612       "fields": {
11613         "Body": [
11614           {
11615             "group": "Body",
11616             "type": "String",
11617             "optional": true,
11618             "field": "name",
11619             "description": ""
11620           },
11621           {
11622             "group": "Body",
11623             "type": "String",
11624             "optional": true,
11625             "field": "description",
11626             "description": ""
11627           },
11628           {
11629             "group": "Body",
11630             "type": "String",
11631             "optional": true,
11632             "field": "username",
11633             "description": ""
11634           },
11635           {
11636             "group": "Body",
11637             "type": "String",
11638             "optional": true,
11639             "field": "apiKey",
11640             "description": ""
11641           },
11642           {
11643             "group": "Body",
11644             "type": "String",
11645             "optional": true,
11646             "field": "remoteUri",
11647             "description": ""
11648           },
11649           {
11650             "group": "Body",
11651             "type": "String",
11652             "optional": true,
11653             "field": "serverUrl",
11654             "description": ""
11655           }
11656         ]
11657       }
11658     },
11659     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11660     "version": "0.0.0",
11661     "filename": "server/api/intFreshsalesAccount/index.js",
11662     "groupTitle": "Freshsales_Accounts"
11663   },
11664   {
11665     "type": "delete",
11666     "url": "/api/integrations/freshsales/accounts/{id}",
11667     "title": "Deletes a Freshsales Account",
11668     "examples": [
11669       {
11670         "title": "Example usage:",
11671         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password} -X DELETE",
11672         "type": "json"
11673       }
11674     ],
11675     "name": "DeleteFreshsales_Accounts",
11676     "group": "Freshsales_Accounts",
11677     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11678     "version": "0.0.0",
11679     "filename": "server/api/intFreshsalesAccount/index.js",
11680     "groupTitle": "Freshsales_Accounts"
11681   },
11682   {
11683     "type": "get",
11684     "url": "/api/integrations/freshsales/accounts",
11685     "title": "Gets a list of Freshsales Accounts",
11686     "examples": [
11687       {
11688         "title": "Example usage:",
11689         "content": "curl https://{domain}/api/integrations/freshsales/accounts -v -u {name}:{password}",
11690         "type": "json"
11691       }
11692     ],
11693     "name": "GetFreshsales_Accounts",
11694     "group": "Freshsales_Accounts",
11695     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11696     "version": "0.0.0",
11697     "filename": "server/api/intFreshsalesAccount/index.js",
11698     "groupTitle": "Freshsales_Accounts"
11699   },
11700   {
11701     "type": "get",
11702     "url": "/api/integrations/freshsales/accounts/{id}",
11703     "title": "Gets a single Freshsales Account",
11704     "examples": [
11705       {
11706         "title": "Example usage:",
11707         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id} -v -u {name}:{password}",
11708         "type": "json"
11709       }
11710     ],
11711     "name": "ShowFreshsales_Accounts",
11712     "group": "Freshsales_Accounts",
11713     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11714     "version": "0.0.0",
11715     "filename": "server/api/intFreshsalesAccount/index.js",
11716     "groupTitle": "Freshsales_Accounts"
11717   },
11718   {
11719     "type": "post",
11720     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
11721     "title": "Creates new configuration",
11722     "examples": [
11723       {
11724         "title": "Example usage:",
11725         "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",
11726         "type": "json"
11727       }
11728     ],
11729     "name": "addConfiguration",
11730     "group": "Freshsales_Accounts",
11731     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11732     "version": "0.0.0",
11733     "filename": "server/api/intFreshsalesAccount/index.js",
11734     "groupTitle": "Freshsales_Accounts"
11735   },
11736   {
11737     "type": "get",
11738     "url": "/api/integrations/freshsales/accounts/{id}/configurations",
11739     "title": "Gets account configurations",
11740     "examples": [
11741       {
11742         "title": "Example usage:",
11743         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/configurations -v -u {name}:{password} -X GET",
11744         "type": "json"
11745       }
11746     ],
11747     "name": "getConfigurations",
11748     "group": "Freshsales_Accounts",
11749     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11750     "version": "0.0.0",
11751     "filename": "server/api/intFreshsalesAccount/index.js",
11752     "groupTitle": "Freshsales_Accounts"
11753   },
11754   {
11755     "type": "get",
11756     "url": "/api/integrations/freshsales/accounts/{id}/fields",
11757     "title": "Gets account fields",
11758     "examples": [
11759       {
11760         "title": "Example usage:",
11761         "content": "curl https://{domain}/api/integrations/freshsales/accounts/{id}/fields -v -u {name}:{password} -X GET",
11762         "type": "json"
11763       }
11764     ],
11765     "name": "getFields",
11766     "group": "Freshsales_Accounts",
11767     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11768     "version": "0.0.0",
11769     "filename": "server/api/intFreshsalesAccount/index.js",
11770     "groupTitle": "Freshsales_Accounts"
11771   },
11772   {
11773     "type": "put",
11774     "url": "/api/integrations/freshsales/accounts/{id}",
11775     "title": "Update an existing Freshsales Account",
11776     "examples": [
11777       {
11778         "title": "Example usage:",
11779         "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",
11780         "type": "json"
11781       }
11782     ],
11783     "name": "updateFreshsales_Accounts",
11784     "group": "Freshsales_Accounts",
11785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11786     "version": "0.0.0",
11787     "filename": "server/api/intFreshsalesAccount/index.js",
11788     "groupTitle": "Freshsales_Accounts"
11789   },
11790   {
11791     "type": "post",
11792     "url": "/api/integrations/freshsales/configurations",
11793     "title": "Creates a new Freshsales Configuration",
11794     "examples": [
11795       {
11796         "title": "Example usage:",
11797         "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",
11798         "type": "json"
11799       }
11800     ],
11801     "name": "CreateFreshsales_Configurations",
11802     "group": "Freshsales_Configurations",
11803     "parameter": {
11804       "fields": {
11805         "Body": [
11806           {
11807             "group": "Body",
11808             "type": "String",
11809             "optional": true,
11810             "field": "name",
11811             "description": ""
11812           },
11813           {
11814             "group": "Body",
11815             "type": "String",
11816             "optional": true,
11817             "field": "description",
11818             "description": ""
11819           }
11820         ]
11821       }
11822     },
11823     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11824     "version": "0.0.0",
11825     "filename": "server/api/intFreshsalesConfiguration/index.js",
11826     "groupTitle": "Freshsales_Configurations"
11827   },
11828   {
11829     "type": "delete",
11830     "url": "/api/integrations/freshsales/configurations/{id}",
11831     "title": "Deletes a Freshsales Configuration",
11832     "examples": [
11833       {
11834         "title": "Example usage:",
11835         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password} -X DELETE",
11836         "type": "json"
11837       }
11838     ],
11839     "name": "DeleteFreshsales_Configurations",
11840     "group": "Freshsales_Configurations",
11841     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11842     "version": "0.0.0",
11843     "filename": "server/api/intFreshsalesConfiguration/index.js",
11844     "groupTitle": "Freshsales_Configurations"
11845   },
11846   {
11847     "type": "get",
11848     "url": "/api/integrations/freshsales/configurations",
11849     "title": "Gets a list of Freshsales Configurations",
11850     "examples": [
11851       {
11852         "title": "Example usage:",
11853         "content": "curl https://{domain}/api/integrations/freshsales/configurations -v -u {name}:{password}",
11854         "type": "json"
11855       }
11856     ],
11857     "name": "GetFreshsales_Configurations",
11858     "group": "Freshsales_Configurations",
11859     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
11860     "version": "0.0.0",
11861     "filename": "server/api/intFreshsalesConfiguration/index.js",
11862     "groupTitle": "Freshsales_Configurations"
11863   },
11864   {
11865     "type": "get",
11866     "url": "/api/integrations/freshsales/configurations/{id}",
11867     "title": "Gets a single Freshsales Configuration",
11868     "examples": [
11869       {
11870         "title": "Example usage:",
11871         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id} -v -u {name}:{password}",
11872         "type": "json"
11873       }
11874     ],
11875     "name": "ShowFreshsales_Configurations",
11876     "group": "Freshsales_Configurations",
11877     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11878     "version": "0.0.0",
11879     "filename": "server/api/intFreshsalesConfiguration/index.js",
11880     "groupTitle": "Freshsales_Configurations"
11881   },
11882   {
11883     "type": "get",
11884     "url": "/api/integrations/freshsales/configurations/{id}/descriptions",
11885     "title": "Gets configurations descriptions",
11886     "examples": [
11887       {
11888         "title": "Example usage:",
11889         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
11890         "type": "json"
11891       }
11892     ],
11893     "name": "getDescriptions",
11894     "group": "Freshsales_Configurations",
11895     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11896     "version": "0.0.0",
11897     "filename": "server/api/intFreshsalesConfiguration/index.js",
11898     "groupTitle": "Freshsales_Configurations"
11899   },
11900   {
11901     "type": "get",
11902     "url": "/api/integrations/freshsales/configurations/{id}/fields",
11903     "title": "Gets configurations fields",
11904     "examples": [
11905       {
11906         "title": "Example usage:",
11907         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/fields -v -u {name}:{password} -X GET",
11908         "type": "json"
11909       }
11910     ],
11911     "name": "getFields",
11912     "group": "Freshsales_Configurations",
11913     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11914     "version": "0.0.0",
11915     "filename": "server/api/intFreshsalesConfiguration/index.js",
11916     "groupTitle": "Freshsales_Configurations"
11917   },
11918   {
11919     "type": "get",
11920     "url": "/api/integrations/freshsales/configurations/{id}/subjects",
11921     "title": "Gets configurations subjects",
11922     "examples": [
11923       {
11924         "title": "Example usage:",
11925         "content": "curl https://{domain}/api/integrations/freshsales/configurations/{id}/subjects -v -u {name}:{password} -X GET",
11926         "type": "json"
11927       }
11928     ],
11929     "name": "getSubjects",
11930     "group": "Freshsales_Configurations",
11931     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11932     "version": "0.0.0",
11933     "filename": "server/api/intFreshsalesConfiguration/index.js",
11934     "groupTitle": "Freshsales_Configurations"
11935   },
11936   {
11937     "type": "put",
11938     "url": "/api/integrations/freshsales/configurations/{id}",
11939     "title": "Update an existing Freshsales Configuration",
11940     "examples": [
11941       {
11942         "title": "Example usage:",
11943         "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",
11944         "type": "json"
11945       }
11946     ],
11947     "name": "updateFreshsales_Configurations",
11948     "group": "Freshsales_Configurations",
11949     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
11950     "version": "0.0.0",
11951     "filename": "server/api/intFreshsalesConfiguration/index.js",
11952     "groupTitle": "Freshsales_Configurations"
11953   },
11954   {
11955     "type": "post",
11956     "url": "/api/integrations/freshsales/fields",
11957     "title": "Creates a new Freshsales Field",
11958     "examples": [
11959       {
11960         "title": "Example usage:",
11961         "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",
11962         "type": "json"
11963       }
11964     ],
11965     "name": "CreateFreshsales_Fields",
11966     "group": "Freshsales_Fields",
11967     "parameter": {
11968       "fields": {
11969         "Body": [
11970           {
11971             "group": "Body",
11972             "type": "String",
11973             "allowedValues": [
11974               "\"string\"",
11975               "\"variable\"",
11976               "\"customVariable\"",
11977               "\"keyValue\""
11978             ],
11979             "optional": true,
11980             "field": "type",
11981             "description": ""
11982           },
11983           {
11984             "group": "Body",
11985             "type": "String",
11986             "optional": true,
11987             "field": "content",
11988             "description": ""
11989           },
11990           {
11991             "group": "Body",
11992             "type": "String",
11993             "optional": true,
11994             "field": "key",
11995             "description": ""
11996           },
11997           {
11998             "group": "Body",
11999             "type": "String",
12000             "allowedValues": [
12001               "\"string\"",
12002               "\"variable\"",
12003               "\"customVariable\""
12004             ],
12005             "optional": true,
12006             "field": "keyType",
12007             "description": ""
12008           },
12009           {
12010             "group": "Body",
12011             "type": "String",
12012             "optional": true,
12013             "field": "keyContent",
12014             "description": ""
12015           },
12016           {
12017             "group": "Body",
12018             "type": "String",
12019             "optional": true,
12020             "field": "idField",
12021             "description": ""
12022           },
12023           {
12024             "group": "Body",
12025             "type": "String",
12026             "optional": true,
12027             "field": "nameField",
12028             "description": ""
12029           },
12030           {
12031             "group": "Body",
12032             "type": "Boolean",
12033             "optional": true,
12034             "field": "customField",
12035             "description": ""
12036           },
12037           {
12038             "group": "Body",
12039             "type": "String",
12040             "optional": true,
12041             "field": "variableName",
12042             "description": ""
12043           }
12044         ]
12045       }
12046     },
12047     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12048     "version": "0.0.0",
12049     "filename": "server/api/intFreshsalesField/index.js",
12050     "groupTitle": "Freshsales_Fields"
12051   },
12052   {
12053     "type": "delete",
12054     "url": "/api/integrations/freshsales/fields/{id}",
12055     "title": "Deletes a Freshsales Field",
12056     "examples": [
12057       {
12058         "title": "Example usage:",
12059         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password} -X DELETE",
12060         "type": "json"
12061       }
12062     ],
12063     "name": "DeleteFreshsales_Fields",
12064     "group": "Freshsales_Fields",
12065     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12066     "version": "0.0.0",
12067     "filename": "server/api/intFreshsalesField/index.js",
12068     "groupTitle": "Freshsales_Fields"
12069   },
12070   {
12071     "type": "get",
12072     "url": "/api/integrations/freshsales/fields",
12073     "title": "Gets a list of Freshsales Fields",
12074     "examples": [
12075       {
12076         "title": "Example usage:",
12077         "content": "curl https://{domain}/api/integrations/freshsales/fields -v -u {name}:{password}",
12078         "type": "json"
12079       }
12080     ],
12081     "name": "GetFreshsales_Fields",
12082     "group": "Freshsales_Fields",
12083     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12084     "version": "0.0.0",
12085     "filename": "server/api/intFreshsalesField/index.js",
12086     "groupTitle": "Freshsales_Fields"
12087   },
12088   {
12089     "type": "get",
12090     "url": "/api/integrations/freshsales/fields/{id}",
12091     "title": "Gets a single Freshsales Field",
12092     "examples": [
12093       {
12094         "title": "Example usage:",
12095         "content": "curl https://{domain}/api/integrations/freshsales/fields/{id} -v -u {name}:{password}",
12096         "type": "json"
12097       }
12098     ],
12099     "name": "ShowFreshsales_Fields",
12100     "group": "Freshsales_Fields",
12101     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12102     "version": "0.0.0",
12103     "filename": "server/api/intFreshsalesField/index.js",
12104     "groupTitle": "Freshsales_Fields"
12105   },
12106   {
12107     "type": "put",
12108     "url": "/api/integrations/freshsales/fields/{id}",
12109     "title": "Update an existing Freshsales Field",
12110     "examples": [
12111       {
12112         "title": "Example usage:",
12113         "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",
12114         "type": "json"
12115       }
12116     ],
12117     "name": "updateFreshsales_Fields",
12118     "group": "Freshsales_Fields",
12119     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12120     "version": "0.0.0",
12121     "filename": "server/api/intFreshsalesField/index.js",
12122     "groupTitle": "Freshsales_Fields"
12123   },
12124   {
12125     "type": "post",
12126     "url": "/api/campaigns/{id}/blacklists",
12127     "title": "Add blacklists to an IVR campaign",
12128     "examples": [
12129       {
12130         "title": "Example usage:",
12131         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12132         "type": "json"
12133       }
12134     ],
12135     "name": "AddBlackLists",
12136     "group": "IVR_Campaigns",
12137     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12138     "version": "0.0.0",
12139     "filename": "server/api/campaign/index.js",
12140     "groupTitle": "IVR_Campaigns"
12141   },
12142   {
12143     "type": "post",
12144     "url": "/api/campaigns/{id}/lists",
12145     "title": "Add lists to an IVR campaign",
12146     "examples": [
12147       {
12148         "title": "Example usage:",
12149         "content": "curl https://{domain}/api/campaigns/{id}/lists -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
12150         "type": "json"
12151       }
12152     ],
12153     "name": "AddLists",
12154     "group": "IVR_Campaigns",
12155     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12156     "version": "0.0.0",
12157     "filename": "server/api/campaign/index.js",
12158     "groupTitle": "IVR_Campaigns"
12159   },
12160   {
12161     "type": "post",
12162     "url": "/api/campaigns/clone",
12163     "title": "Clone an existing IVR Campaign",
12164     "examples": [
12165       {
12166         "title": "Example usage:",
12167         "content": "curl https://{domain}/api/campaigns/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12168         "type": "json"
12169       }
12170     ],
12171     "name": "CloneIVR_Campaigns",
12172     "group": "IVR_Campaigns",
12173     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12174     "version": "0.0.0",
12175     "filename": "server/api/campaign/index.js",
12176     "groupTitle": "IVR_Campaigns"
12177   },
12178   {
12179     "type": "post",
12180     "url": "/api/campaigns",
12181     "title": "Creates a new IVR Campaign",
12182     "examples": [
12183       {
12184         "title": "Example usage:",
12185         "content": "curl https://{domain}/api/campaigns -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12186         "type": "json"
12187       }
12188     ],
12189     "name": "CreateIVR_Campaigns",
12190     "group": "IVR_Campaigns",
12191     "parameter": {
12192       "fields": {
12193         "Body": [
12194           {
12195             "group": "Body",
12196             "type": "String",
12197             "optional": false,
12198             "field": "name",
12199             "description": ""
12200           },
12201           {
12202             "group": "Body",
12203             "type": "String",
12204             "allowedValues": [
12205               "\"ivr\""
12206             ],
12207             "optional": false,
12208             "field": "type",
12209             "description": ""
12210           },
12211           {
12212             "group": "Body",
12213             "type": "String",
12214             "optional": true,
12215             "field": "description",
12216             "description": ""
12217           },
12218           {
12219             "group": "Body",
12220             "type": "Boolean",
12221             "optional": true,
12222             "field": "active",
12223             "description": "<p>Active/Disactive Campaign</p>"
12224           },
12225           {
12226             "group": "Body",
12227             "type": "Integer",
12228             "optional": true,
12229             "field": "limitCalls",
12230             "description": "<p>Max 200 calls.</p>"
12231           },
12232           {
12233             "group": "Body",
12234             "type": "String",
12235             "optional": true,
12236             "field": "dialOriginateCallerIdName",
12237             "description": ""
12238           },
12239           {
12240             "group": "Body",
12241             "type": "String",
12242             "optional": true,
12243             "field": "dialOriginateCallerIdNumber",
12244             "description": ""
12245           },
12246           {
12247             "group": "Body",
12248             "type": "Integer",
12249             "optional": true,
12250             "field": "dialOriginateTimeout",
12251             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
12252           },
12253           {
12254             "group": "Body",
12255             "type": "Integer",
12256             "optional": true,
12257             "field": "dialCongestionMaxRetry",
12258             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
12259           },
12260           {
12261             "group": "Body",
12262             "type": "Integer",
12263             "optional": true,
12264             "field": "dialCongestionRetryFrequency",
12265             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
12266           },
12267           {
12268             "group": "Body",
12269             "type": "Integer",
12270             "optional": true,
12271             "field": "dialBusyMaxRetry",
12272             "description": "<p>#Busy Retry (min:1, max:999)</p>"
12273           },
12274           {
12275             "group": "Body",
12276             "type": "Integer",
12277             "optional": true,
12278             "field": "dialBusyRetryFrequency",
12279             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
12280           },
12281           {
12282             "group": "Body",
12283             "type": "Integer",
12284             "optional": true,
12285             "field": "dialNoAnswerMaxRetry",
12286             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
12287           },
12288           {
12289             "group": "Body",
12290             "type": "Integer",
12291             "optional": true,
12292             "field": "dialNoAnswerRetryFrequency",
12293             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
12294           },
12295           {
12296             "group": "Body",
12297             "type": "Integer",
12298             "optional": true,
12299             "field": "dialGlobalMaxRetry",
12300             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
12301           },
12302           {
12303             "group": "Body",
12304             "type": "String",
12305             "optional": true,
12306             "field": "dialTimezone",
12307             "description": ""
12308           },
12309           {
12310             "group": "Body",
12311             "type": "String",
12312             "optional": true,
12313             "field": "dialGlobalInterval",
12314             "description": ""
12315           },
12316           {
12317             "group": "Body",
12318             "type": "String",
12319             "allowedValues": [
12320               "\"always\"",
12321               "\"never\"",
12322               "\"onlyIfOpen\""
12323             ],
12324             "optional": true,
12325             "field": "dialCheckDuplicateType",
12326             "description": ""
12327           },
12328           {
12329             "group": "Body",
12330             "type": "Boolean",
12331             "optional": true,
12332             "field": "dialAMDActive",
12333             "description": "<p>Active/Disactive AMD</p>"
12334           },
12335           {
12336             "group": "Body",
12337             "type": "Integer",
12338             "optional": true,
12339             "field": "dialAMDInitialSilence",
12340             "description": "<p>#AMD Initial Silence</p>"
12341           },
12342           {
12343             "group": "Body",
12344             "type": "Integer",
12345             "optional": true,
12346             "field": "dialAMDGreeting",
12347             "description": "<p>#AMD Greeting</p>"
12348           },
12349           {
12350             "group": "Body",
12351             "type": "Integer",
12352             "optional": true,
12353             "field": "dialAMDAfterGreetingSilence",
12354             "description": "<p>#AMD After Greeting Silence</p>"
12355           },
12356           {
12357             "group": "Body",
12358             "type": "Integer",
12359             "optional": true,
12360             "field": "dialAMDTotalAnalysisTime",
12361             "description": "<p>#AMD Total Analysis Time</p>"
12362           },
12363           {
12364             "group": "Body",
12365             "type": "Integer",
12366             "optional": true,
12367             "field": "dialAMDMinWordLength",
12368             "description": "<p>#AMD Min Word Length</p>"
12369           },
12370           {
12371             "group": "Body",
12372             "type": "Integer",
12373             "optional": true,
12374             "field": "dialAMDBetweenWordsSilence",
12375             "description": "<p>#AMD Between Words Silence</p>"
12376           },
12377           {
12378             "group": "Body",
12379             "type": "Integer",
12380             "optional": true,
12381             "field": "dialAMDMaximumNumberOfWords",
12382             "description": "<p>#AMD Maximum Number Of Words</p>"
12383           },
12384           {
12385             "group": "Body",
12386             "type": "Integer",
12387             "optional": true,
12388             "field": "dialAMDSilenceThreshold",
12389             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
12390           },
12391           {
12392             "group": "Body",
12393             "type": "Integer",
12394             "optional": true,
12395             "field": "dialAMDMaximumWordLength",
12396             "description": "<p>#AMD Maximum Word Length</p>"
12397           },
12398           {
12399             "group": "Body",
12400             "type": "String",
12401             "allowedValues": [
12402               "\"DESC\"",
12403               "\"ASC\""
12404             ],
12405             "optional": true,
12406             "field": "dialOrderByScheduledAt",
12407             "description": ""
12408           },
12409           {
12410             "group": "Body",
12411             "type": "String",
12412             "optional": true,
12413             "field": "dialPrefix",
12414             "description": ""
12415           },
12416           {
12417             "group": "Body",
12418             "type": "Integer",
12419             "optional": true,
12420             "field": "dialRandomLastDigitCallerIdNumber",
12421             "description": "<p>Random Last Digit (min:1, max:15)</p>"
12422           },
12423           {
12424             "group": "Body",
12425             "type": "Integer",
12426             "optional": true,
12427             "field": "dialCutDigit",
12428             "description": "<p>Cut Digit (min:1, max:15)</p>"
12429           }
12430         ]
12431       }
12432     },
12433     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12434     "version": "0.0.0",
12435     "filename": "server/api/campaign/index.js",
12436     "groupTitle": "IVR_Campaigns"
12437   },
12438   {
12439     "type": "delete",
12440     "url": "/api/campaigns/{id}",
12441     "title": "Deletes a IVR Campaign",
12442     "examples": [
12443       {
12444         "title": "Example usage:",
12445         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password} -X DELETE",
12446         "type": "json"
12447       }
12448     ],
12449     "name": "DeleteIVR_Campaigns",
12450     "group": "IVR_Campaigns",
12451     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12452     "version": "0.0.0",
12453     "filename": "server/api/campaign/index.js",
12454     "groupTitle": "IVR_Campaigns"
12455   },
12456   {
12457     "type": "get",
12458     "url": "/api/campaigns/{id}/blacklists",
12459     "title": "Get IVR campaign blacklists",
12460     "examples": [
12461       {
12462         "title": "Example usage:",
12463         "content": "curl https://{domain}/api/campaigns/{id}/blacklists -v -u {name}:{password} -X GET",
12464         "type": "json"
12465       }
12466     ],
12467     "name": "GetBlackLists",
12468     "group": "IVR_Campaigns",
12469     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12470     "version": "0.0.0",
12471     "filename": "server/api/campaign/index.js",
12472     "groupTitle": "IVR_Campaigns"
12473   },
12474   {
12475     "type": "get",
12476     "url": "/api/campaigns/{id}/finals",
12477     "title": "Gets IVR campaign hopper finals",
12478     "examples": [
12479       {
12480         "title": "Example usage:",
12481         "content": "curl https://{domain}/api/campaigns/{id}/hopper_finals -v -u {name}:{password}  -X GET",
12482         "type": "json"
12483       }
12484     ],
12485     "name": "GetHopperFinals",
12486     "group": "IVR_Campaigns",
12487     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12488     "version": "0.0.0",
12489     "filename": "server/api/campaign/index.js",
12490     "groupTitle": "IVR_Campaigns"
12491   },
12492   {
12493     "type": "get",
12494     "url": "/api/campaigns/{id}/hopper_histories",
12495     "title": "Gets IVR campaign hopper histories",
12496     "examples": [
12497       {
12498         "title": "Example usage:",
12499         "content": "curl https://{domain}/api/campaigns/{id}/hopper_histories -v -u {name}:{password} -X GET",
12500         "type": "json"
12501       }
12502     ],
12503     "name": "GetHopperHistories",
12504     "group": "IVR_Campaigns",
12505     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12506     "version": "0.0.0",
12507     "filename": "server/api/campaign/index.js",
12508     "groupTitle": "IVR_Campaigns"
12509   },
12510   {
12511     "type": "get",
12512     "url": "/api/campaigns/{id}/hoppers",
12513     "title": "Gets IVR campaign hoppers",
12514     "examples": [
12515       {
12516         "title": "Example usage:",
12517         "content": "curl https://{domain}/api/campaigns/{id}/hoppers -v -u {name}:{password} -X GET",
12518         "type": "json"
12519       }
12520     ],
12521     "name": "GetHoppers",
12522     "group": "IVR_Campaigns",
12523     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12524     "version": "0.0.0",
12525     "filename": "server/api/campaign/index.js",
12526     "groupTitle": "IVR_Campaigns"
12527   },
12528   {
12529     "type": "get",
12530     "url": "/api/campaigns",
12531     "title": "Gets a list of IVR Campaigns",
12532     "examples": [
12533       {
12534         "title": "Example usage:",
12535         "content": "curl https://{domain}/api/campaigns -v -u {name}:{password}",
12536         "type": "json"
12537       }
12538     ],
12539     "name": "GetIVR_Campaigns",
12540     "group": "IVR_Campaigns",
12541     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
12542     "version": "0.0.0",
12543     "filename": "server/api/campaign/index.js",
12544     "groupTitle": "IVR_Campaigns"
12545   },
12546   {
12547     "type": "get",
12548     "url": "/api/campaigns/{id}/lists",
12549     "title": "Get IVR campaign lists",
12550     "examples": [
12551       {
12552         "title": "Example usage:",
12553         "content": "curl https://{domain}/api/campaigns/{id}/lists -v -u {name}:{password} -X GET",
12554         "type": "json"
12555       }
12556     ],
12557     "name": "GetLists",
12558     "group": "IVR_Campaigns",
12559     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12560     "version": "0.0.0",
12561     "filename": "server/api/campaign/index.js",
12562     "groupTitle": "IVR_Campaigns"
12563   },
12564   {
12565     "type": "delete",
12566     "url": "/api/campaigns/{id}/blacklists",
12567     "title": "Remove blacklists from an IVR Campaign",
12568     "examples": [
12569       {
12570         "title": "Example usage:",
12571         "content": "curl https://{domain}/api/campaigns/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
12572         "type": "json"
12573       }
12574     ],
12575     "name": "RemoveBlackLists",
12576     "group": "IVR_Campaigns",
12577     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12578     "version": "0.0.0",
12579     "filename": "server/api/campaign/index.js",
12580     "groupTitle": "IVR_Campaigns"
12581   },
12582   {
12583     "type": "delete",
12584     "url": "/api/campaigns/{id}/lists",
12585     "title": "Remove lists from an IVR Campaign",
12586     "examples": [
12587       {
12588         "title": "Example usage:",
12589         "content": "curl https://{domain}/api/campaigns/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
12590         "type": "json"
12591       }
12592     ],
12593     "name": "RemoveLists",
12594     "group": "IVR_Campaigns",
12595     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12596     "version": "0.0.0",
12597     "filename": "server/api/campaign/index.js",
12598     "groupTitle": "IVR_Campaigns"
12599   },
12600   {
12601     "type": "get",
12602     "url": "/api/campaigns/{id}",
12603     "title": "Gets a single IVR Campaign",
12604     "examples": [
12605       {
12606         "title": "Example usage:",
12607         "content": "curl https://{domain}/api/campaigns/{id} -v -u {name}:{password}",
12608         "type": "json"
12609       }
12610     ],
12611     "name": "ShowIVR_Campaigns",
12612     "group": "IVR_Campaigns",
12613     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12614     "version": "0.0.0",
12615     "filename": "server/api/campaign/index.js",
12616     "groupTitle": "IVR_Campaigns"
12617   },
12618   {
12619     "type": "get",
12620     "url": "/api/campaigns/{id}/blacks",
12621     "title": "Gets IVR campaign hopper blacks",
12622     "examples": [
12623       {
12624         "title": "Example usage:",
12625         "content": "curl https://{domain}/api/campaigns/{id}/hopper_black -v -u {name}:{password}  -X GET",
12626         "type": "json"
12627       }
12628     ],
12629     "name": "getHopperBlacks",
12630     "group": "IVR_Campaigns",
12631     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12632     "version": "0.0.0",
12633     "filename": "server/api/campaign/index.js",
12634     "groupTitle": "IVR_Campaigns"
12635   },
12636   {
12637     "type": "put",
12638     "url": "/api/campaigns/{id}",
12639     "title": "Update an existing IVR Campaign",
12640     "examples": [
12641       {
12642         "title": "Example usage:",
12643         "content": "curl https://{domain}/api/campaigns/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
12644         "type": "json"
12645       }
12646     ],
12647     "name": "updateIVR_Campaigns",
12648     "group": "IVR_Campaigns",
12649     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
12650     "version": "0.0.0",
12651     "filename": "server/api/campaign/index.js",
12652     "groupTitle": "IVR_Campaigns"
12653   },
12654   {
12655     "type": "post",
12656     "url": "/api/integrations/reports",
12657     "title": "Creates a new Integration Report",
12658     "examples": [
12659       {
12660         "title": "Example usage:",
12661         "content": "curl https://{domain}/api/integrations/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
12662         "type": "json"
12663       }
12664     ],
12665     "name": "CreateIntegration_Reports",
12666     "group": "Integration_Reports",
12667     "parameter": {
12668       "fields": {
12669         "Body": [
12670           {
12671             "group": "Body",
12672             "type": "String",
12673             "optional": true,
12674             "field": "integration",
12675             "description": ""
12676           },
12677           {
12678             "group": "Body",
12679             "type": "String",
12680             "optional": true,
12681             "field": "eventChannel",
12682             "description": ""
12683           },
12684           {
12685             "group": "Body",
12686             "type": "String",
12687             "optional": true,
12688             "field": "exitStatus",
12689             "description": ""
12690           },
12691           {
12692             "group": "Body",
12693             "type": "String",
12694             "optional": true,
12695             "field": "ticketId",
12696             "description": ""
12697           },
12698           {
12699             "group": "Body",
12700             "type": "Integer",
12701             "optional": true,
12702             "field": "integrationId",
12703             "description": ""
12704           },
12705           {
12706             "group": "Body",
12707             "type": "String",
12708             "optional": true,
12709             "field": "contacts",
12710             "description": ""
12711           },
12712           {
12713             "group": "Body",
12714             "type": "String",
12715             "optional": true,
12716             "field": "uniqueid",
12717             "description": ""
12718           },
12719           {
12720             "group": "Body",
12721             "type": "String",
12722             "optional": true,
12723             "field": "calleridnum",
12724             "description": ""
12725           },
12726           {
12727             "group": "Body",
12728             "type": "String",
12729             "optional": true,
12730             "field": "calleridname",
12731             "description": ""
12732           },
12733           {
12734             "group": "Body",
12735             "type": "String",
12736             "optional": true,
12737             "field": "queue",
12738             "description": ""
12739           },
12740           {
12741             "group": "Body",
12742             "type": "String",
12743             "optional": true,
12744             "field": "interface",
12745             "description": ""
12746           },
12747           {
12748             "group": "Body",
12749             "type": "String",
12750             "optional": true,
12751             "field": "membername",
12752             "description": ""
12753           },
12754           {
12755             "group": "Body",
12756             "type": "String",
12757             "optional": true,
12758             "field": "agentcalledAt",
12759             "description": ""
12760           },
12761           {
12762             "group": "Body",
12763             "type": "String",
12764             "optional": true,
12765             "field": "agentconnectAt",
12766             "description": ""
12767           },
12768           {
12769             "group": "Body",
12770             "type": "Integer",
12771             "optional": true,
12772             "field": "holdtime",
12773             "description": ""
12774           },
12775           {
12776             "group": "Body",
12777             "type": "Boolean",
12778             "optional": true,
12779             "field": "agentcomplete",
12780             "description": ""
12781           },
12782           {
12783             "group": "Body",
12784             "type": "String",
12785             "optional": true,
12786             "field": "agentcompleteAt",
12787             "description": ""
12788           },
12789           {
12790             "group": "Body",
12791             "type": "Integer",
12792             "optional": true,
12793             "field": "talktime",
12794             "description": ""
12795           },
12796           {
12797             "group": "Body",
12798             "type": "Boolean",
12799             "optional": true,
12800             "field": "agentacw",
12801             "description": ""
12802           },
12803           {
12804             "group": "Body",
12805             "type": "Integer",
12806             "optional": true,
12807             "field": "acwtime",
12808             "description": ""
12809           },
12810           {
12811             "group": "Body",
12812             "type": "String",
12813             "optional": true,
12814             "field": "reason",
12815             "description": ""
12816           },
12817           {
12818             "group": "Body",
12819             "type": "Boolean",
12820             "optional": true,
12821             "field": "agentringnoanswer",
12822             "description": ""
12823           },
12824           {
12825             "group": "Body",
12826             "type": "String",
12827             "optional": true,
12828             "field": "agentringnoanswerAt",
12829             "description": ""
12830           },
12831           {
12832             "group": "Body",
12833             "type": "Boolean",
12834             "optional": true,
12835             "field": "agentdump",
12836             "description": ""
12837           },
12838           {
12839             "group": "Body",
12840             "type": "String",
12841             "optional": true,
12842             "field": "agentdumpAt",
12843             "description": ""
12844           },
12845           {
12846             "group": "Body",
12847             "type": "String",
12848             "optional": true,
12849             "field": "lastevent",
12850             "description": ""
12851           },
12852           {
12853             "group": "Body",
12854             "type": "String",
12855             "optional": true,
12856             "field": "channel",
12857             "description": ""
12858           },
12859           {
12860             "group": "Body",
12861             "type": "Integer",
12862             "optional": true,
12863             "field": "channelstate",
12864             "description": ""
12865           },
12866           {
12867             "group": "Body",
12868             "type": "String",
12869             "optional": true,
12870             "field": "channelstatedesc",
12871             "description": ""
12872           },
12873           {
12874             "group": "Body",
12875             "type": "String",
12876             "optional": true,
12877             "field": "connectedlinenum",
12878             "description": ""
12879           },
12880           {
12881             "group": "Body",
12882             "type": "String",
12883             "optional": true,
12884             "field": "connectedlinename",
12885             "description": ""
12886           },
12887           {
12888             "group": "Body",
12889             "type": "String",
12890             "optional": true,
12891             "field": "language",
12892             "description": ""
12893           },
12894           {
12895             "group": "Body",
12896             "type": "String",
12897             "optional": true,
12898             "field": "accountcode",
12899             "description": ""
12900           },
12901           {
12902             "group": "Body",
12903             "type": "String",
12904             "optional": true,
12905             "field": "context",
12906             "description": ""
12907           },
12908           {
12909             "group": "Body",
12910             "type": "String",
12911             "optional": true,
12912             "field": "exten",
12913             "description": ""
12914           },
12915           {
12916             "group": "Body",
12917             "type": "String",
12918             "optional": true,
12919             "field": "priority",
12920             "description": ""
12921           },
12922           {
12923             "group": "Body",
12924             "type": "String",
12925             "optional": true,
12926             "field": "destchannel",
12927             "description": ""
12928           },
12929           {
12930             "group": "Body",
12931             "type": "Integer",
12932             "optional": true,
12933             "field": "destchannelstate",
12934             "description": ""
12935           },
12936           {
12937             "group": "Body",
12938             "type": "String",
12939             "optional": true,
12940             "field": "destchannelstatedesc",
12941             "description": ""
12942           },
12943           {
12944             "group": "Body",
12945             "type": "String",
12946             "optional": true,
12947             "field": "destcalleridnum",
12948             "description": ""
12949           },
12950           {
12951             "group": "Body",
12952             "type": "String",
12953             "optional": true,
12954             "field": "destcalleridname",
12955             "description": ""
12956           },
12957           {
12958             "group": "Body",
12959             "type": "String",
12960             "optional": true,
12961             "field": "destconnectedlinenum",
12962             "description": ""
12963           },
12964           {
12965             "group": "Body",
12966             "type": "String",
12967             "optional": true,
12968             "field": "destconnectedlinename",
12969             "description": ""
12970           },
12971           {
12972             "group": "Body",
12973             "type": "String",
12974             "optional": true,
12975             "field": "destlanguage",
12976             "description": ""
12977           },
12978           {
12979             "group": "Body",
12980             "type": "String",
12981             "optional": true,
12982             "field": "destaccountcode",
12983             "description": ""
12984           },
12985           {
12986             "group": "Body",
12987             "type": "String",
12988             "optional": true,
12989             "field": "destcontext",
12990             "description": ""
12991           },
12992           {
12993             "group": "Body",
12994             "type": "String",
12995             "optional": true,
12996             "field": "destexten",
12997             "description": ""
12998           },
12999           {
13000             "group": "Body",
13001             "type": "String",
13002             "optional": true,
13003             "field": "destpriority",
13004             "description": ""
13005           },
13006           {
13007             "group": "Body",
13008             "type": "String",
13009             "optional": true,
13010             "field": "destuniqueid",
13011             "description": ""
13012           },
13013           {
13014             "group": "Body",
13015             "type": "String",
13016             "optional": true,
13017             "field": "messageId",
13018             "description": ""
13019           },
13020           {
13021             "group": "Body",
13022             "type": "String",
13023             "optional": true,
13024             "field": "inReplyTo",
13025             "description": ""
13026           },
13027           {
13028             "group": "Body",
13029             "type": "String",
13030             "optional": true,
13031             "field": "subject",
13032             "description": ""
13033           },
13034           {
13035             "group": "Body",
13036             "type": "String",
13037             "optional": true,
13038             "field": "from",
13039             "description": ""
13040           },
13041           {
13042             "group": "Body",
13043             "type": "String",
13044             "optional": true,
13045             "field": "to",
13046             "description": ""
13047           },
13048           {
13049             "group": "Body",
13050             "type": "String",
13051             "optional": true,
13052             "field": "cc",
13053             "description": ""
13054           },
13055           {
13056             "group": "Body",
13057             "type": "Text",
13058             "optional": true,
13059             "field": "attachment",
13060             "description": ""
13061           },
13062           {
13063             "group": "Body",
13064             "type": "Text",
13065             "optional": true,
13066             "field": "html",
13067             "description": ""
13068           },
13069           {
13070             "group": "Body",
13071             "type": "Text",
13072             "optional": true,
13073             "field": "text",
13074             "description": ""
13075           },
13076           {
13077             "group": "Body",
13078             "type": "String",
13079             "allowedValues": [
13080               "\"SENT\"",
13081               "\"SENDING\"",
13082               "\"RECEIVED\"",
13083               "\"FAILED\""
13084             ],
13085             "optional": true,
13086             "field": "status",
13087             "description": ""
13088           },
13089           {
13090             "group": "Body",
13091             "type": "String",
13092             "optional": true,
13093             "field": "url",
13094             "description": ""
13095           },
13096           {
13097             "group": "Body",
13098             "type": "String",
13099             "optional": true,
13100             "field": "app",
13101             "description": ""
13102           },
13103           {
13104             "group": "Body",
13105             "type": "String",
13106             "optional": true,
13107             "field": "appdata",
13108             "description": ""
13109           },
13110           {
13111             "group": "Body",
13112             "type": "Integer",
13113             "optional": true,
13114             "field": "projectId",
13115             "description": ""
13116           }
13117         ]
13118       }
13119     },
13120     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13121     "version": "0.0.0",
13122     "filename": "server/api/integrationReport/index.js",
13123     "groupTitle": "Integration_Reports"
13124   },
13125   {
13126     "type": "delete",
13127     "url": "/api/integrations/reports/{id}",
13128     "title": "Deletes a Integration Report",
13129     "examples": [
13130       {
13131         "title": "Example usage:",
13132         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password} -X DELETE",
13133         "type": "json"
13134       }
13135     ],
13136     "name": "DeleteIntegration_Reports",
13137     "group": "Integration_Reports",
13138     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13139     "version": "0.0.0",
13140     "filename": "server/api/integrationReport/index.js",
13141     "groupTitle": "Integration_Reports"
13142   },
13143   {
13144     "type": "get",
13145     "url": "/api/integrations/reports/describe",
13146     "title": "Gets table info about Integration Reports",
13147     "examples": [
13148       {
13149         "title": "Example usage:",
13150         "content": "curl https://{domain}/api/integrations/reports/describe -v -u {name}:{password}",
13151         "type": "json"
13152       }
13153     ],
13154     "name": "DescribeIntegration_Reports",
13155     "group": "Integration_Reports",
13156     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13157     "version": "0.0.0",
13158     "filename": "server/api/integrationReport/index.js",
13159     "groupTitle": "Integration_Reports"
13160   },
13161   {
13162     "type": "get",
13163     "url": "/api/integrations/reports",
13164     "title": "Gets a list of Integration Reports",
13165     "examples": [
13166       {
13167         "title": "Example usage:",
13168         "content": "curl https://{domain}/api/integrations/reports -v -u {name}:{password}",
13169         "type": "json"
13170       }
13171     ],
13172     "name": "GetIntegration_Reports",
13173     "group": "Integration_Reports",
13174     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13175     "version": "0.0.0",
13176     "filename": "server/api/integrationReport/index.js",
13177     "groupTitle": "Integration_Reports"
13178   },
13179   {
13180     "type": "get",
13181     "url": "/api/integrations/reports/{id}",
13182     "title": "Gets a single Integration Report",
13183     "examples": [
13184       {
13185         "title": "Example usage:",
13186         "content": "curl https://{domain}/api/integrations/reports/{id} -v -u {name}:{password}",
13187         "type": "json"
13188       }
13189     ],
13190     "name": "ShowIntegration_Reports",
13191     "group": "Integration_Reports",
13192     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13193     "version": "0.0.0",
13194     "filename": "server/api/integrationReport/index.js",
13195     "groupTitle": "Integration_Reports"
13196   },
13197   {
13198     "type": "put",
13199     "url": "/api/integrations/reports/{id}",
13200     "title": "Update an existing Integration Report",
13201     "examples": [
13202       {
13203         "title": "Example usage:",
13204         "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",
13205         "type": "json"
13206       }
13207     ],
13208     "name": "updateIntegration_Reports",
13209     "group": "Integration_Reports",
13210     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13211     "version": "0.0.0",
13212     "filename": "server/api/integrationReport/index.js",
13213     "groupTitle": "Integration_Reports"
13214   },
13215   {
13216     "type": "post",
13217     "url": "/api/intervals",
13218     "title": "Creates a new Interval",
13219     "examples": [
13220       {
13221         "title": "Example usage:",
13222         "content": "curl https://{domain}/api/intervals -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
13223         "type": "json"
13224       }
13225     ],
13226     "name": "CreateIntervals",
13227     "group": "Intervals",
13228     "parameter": {
13229       "fields": {
13230         "Body": [
13231           {
13232             "group": "Body",
13233             "type": "String",
13234             "optional": true,
13235             "field": "name",
13236             "description": ""
13237           },
13238           {
13239             "group": "Body",
13240             "type": "String",
13241             "optional": true,
13242             "field": "description",
13243             "description": ""
13244           },
13245           {
13246             "group": "Body",
13247             "type": "String",
13248             "optional": true,
13249             "field": "interval",
13250             "description": ""
13251           }
13252         ]
13253       }
13254     },
13255     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13256     "version": "0.0.0",
13257     "filename": "server/api/interval/index.js",
13258     "groupTitle": "Intervals"
13259   },
13260   {
13261     "type": "delete",
13262     "url": "/api/intervals/{id}",
13263     "title": "Deletes a Interval",
13264     "examples": [
13265       {
13266         "title": "Example usage:",
13267         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password} -X DELETE",
13268         "type": "json"
13269       }
13270     ],
13271     "name": "DeleteIntervals",
13272     "group": "Intervals",
13273     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13274     "version": "0.0.0",
13275     "filename": "server/api/interval/index.js",
13276     "groupTitle": "Intervals"
13277   },
13278   {
13279     "type": "get",
13280     "url": "/api/intervals",
13281     "title": "Gets a list of Intervals",
13282     "examples": [
13283       {
13284         "title": "Example usage:",
13285         "content": "curl https://{domain}/api/intervals -v -u {name}:{password}",
13286         "type": "json"
13287       }
13288     ],
13289     "name": "GetIntervals",
13290     "group": "Intervals",
13291     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13292     "version": "0.0.0",
13293     "filename": "server/api/interval/index.js",
13294     "groupTitle": "Intervals"
13295   },
13296   {
13297     "type": "get",
13298     "url": "/api/intervals/{id}",
13299     "title": "Gets a single Interval",
13300     "examples": [
13301       {
13302         "title": "Example usage:",
13303         "content": "curl https://{domain}/api/intervals/{id} -v -u {name}:{password}",
13304         "type": "json"
13305       }
13306     ],
13307     "name": "ShowIntervals",
13308     "group": "Intervals",
13309     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13310     "version": "0.0.0",
13311     "filename": "server/api/interval/index.js",
13312     "groupTitle": "Intervals"
13313   },
13314   {
13315     "type": "post",
13316     "url": "/api/intervals/{id}/sub_intervals",
13317     "title": "Creates a new sub interval",
13318     "examples": [
13319       {
13320         "title": "Example usage:",
13321         "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",
13322         "type": "json"
13323       }
13324     ],
13325     "name": "addInterval",
13326     "group": "Intervals",
13327     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13328     "version": "0.0.0",
13329     "filename": "server/api/interval/index.js",
13330     "groupTitle": "Intervals"
13331   },
13332   {
13333     "type": "post",
13334     "url": "/api/intervals/{id}/sub_intervals/create_many",
13335     "title": "Create new sub intervals set",
13336     "examples": [
13337       {
13338         "title": "Example usage:",
13339         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
13340         "type": "json"
13341       }
13342     ],
13343     "name": "addIntervals",
13344     "group": "Intervals",
13345     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13346     "version": "0.0.0",
13347     "filename": "server/api/interval/index.js",
13348     "groupTitle": "Intervals"
13349   },
13350   {
13351     "type": "get",
13352     "url": "/api/intervals/{id}/sub_intervals",
13353     "title": "Get sub intervals set",
13354     "examples": [
13355       {
13356         "title": "Example usage:",
13357         "content": "curl https://{domain}/api/intervals/{id}/sub_intervals -v -u {name}:{password} -X GET",
13358         "type": "json"
13359       }
13360     ],
13361     "name": "getIntervals",
13362     "group": "Intervals",
13363     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13364     "version": "0.0.0",
13365     "filename": "server/api/interval/index.js",
13366     "groupTitle": "Intervals"
13367   },
13368   {
13369     "type": "put",
13370     "url": "/api/intervals/{id}",
13371     "title": "Update an existing Interval",
13372     "examples": [
13373       {
13374         "title": "Example usage:",
13375         "content": "curl https://{domain}/api/intervals/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
13376         "type": "json"
13377       }
13378     ],
13379     "name": "updateIntervals",
13380     "group": "Intervals",
13381     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13382     "version": "0.0.0",
13383     "filename": "server/api/interval/index.js",
13384     "groupTitle": "Intervals"
13385   },
13386   {
13387     "type": "post",
13388     "url": "/api/jira",
13389     "title": "Creates a new issue",
13390     "examples": [
13391       {
13392         "title": "Example usage:",
13393         "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}",
13394         "type": "json"
13395       }
13396     ],
13397     "name": "Creates_Issue",
13398     "group": "Issue",
13399     "parameter": {
13400       "fields": {
13401         "Body": [
13402           {
13403             "group": "Body",
13404             "type": "String",
13405             "allowedValues": [
13406               "\"Bug\""
13407             ],
13408             "optional": true,
13409             "field": "issuetype",
13410             "description": ""
13411           },
13412           {
13413             "group": "Body",
13414             "type": "String",
13415             "optional": false,
13416             "field": "summary",
13417             "description": ""
13418           },
13419           {
13420             "group": "Body",
13421             "type": "String",
13422             "optional": false,
13423             "field": "description",
13424             "description": ""
13425           }
13426         ]
13427       }
13428     },
13429     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13430     "version": "0.0.0",
13431     "filename": "server/api/jira/index.js",
13432     "groupTitle": "Issue"
13433   },
13434   {
13435     "type": "post",
13436     "url": "/api/jscripty/answers/reports",
13437     "title": "Creates a new Report",
13438     "examples": [
13439       {
13440         "title": "Example usage:",
13441         "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",
13442         "type": "json"
13443       }
13444     ],
13445     "name": "CreateReports",
13446     "group": "JscriptyAnswerReport",
13447     "parameter": {
13448       "fields": {
13449         "Body": [
13450           {
13451             "group": "Body",
13452             "type": "String",
13453             "optional": true,
13454             "field": "question",
13455             "description": ""
13456           },
13457           {
13458             "group": "Body",
13459             "type": "Text",
13460             "optional": true,
13461             "field": "answer",
13462             "description": ""
13463           },
13464           {
13465             "group": "Body",
13466             "type": "String",
13467             "optional": true,
13468             "field": "membername",
13469             "description": ""
13470           },
13471           {
13472             "group": "Body",
13473             "type": "String",
13474             "optional": true,
13475             "field": "projectname",
13476             "description": ""
13477           },
13478           {
13479             "group": "Body",
13480             "type": "String",
13481             "optional": true,
13482             "field": "queue",
13483             "description": ""
13484           },
13485           {
13486             "group": "Body",
13487             "type": "String",
13488             "optional": true,
13489             "field": "uniqueid",
13490             "description": ""
13491           },
13492           {
13493             "group": "Body",
13494             "type": "String",
13495             "optional": true,
13496             "field": "calleridname",
13497             "description": ""
13498           },
13499           {
13500             "group": "Body",
13501             "type": "String",
13502             "optional": true,
13503             "field": "calleridnum",
13504             "description": ""
13505           },
13506           {
13507             "group": "Body",
13508             "type": "String",
13509             "optional": true,
13510             "field": "questionId",
13511             "description": ""
13512           }
13513         ]
13514       }
13515     },
13516     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13517     "version": "0.0.0",
13518     "filename": "server/api/jscriptyAnswerReport/index.js",
13519     "groupTitle": "JscriptyAnswerReport"
13520   },
13521   {
13522     "type": "delete",
13523     "url": "/api/jscripty/answers/reports/{id}",
13524     "title": "Deletes a Report",
13525     "examples": [
13526       {
13527         "title": "Example usage:",
13528         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password} -X DELETE",
13529         "type": "json"
13530       }
13531     ],
13532     "name": "DeleteReports",
13533     "group": "JscriptyAnswerReport",
13534     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13535     "version": "0.0.0",
13536     "filename": "server/api/jscriptyAnswerReport/index.js",
13537     "groupTitle": "JscriptyAnswerReport"
13538   },
13539   {
13540     "type": "get",
13541     "url": "/api/jscripty/answers/reports/describe",
13542     "title": "Gets table info about Reports",
13543     "examples": [
13544       {
13545         "title": "Example usage:",
13546         "content": "curl https://{domain}/api/jscripty/answers/reports/describe -v -u {name}:{password}",
13547         "type": "json"
13548       }
13549     ],
13550     "name": "DescribeReports",
13551     "group": "JscriptyAnswerReport",
13552     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13553     "version": "0.0.0",
13554     "filename": "server/api/jscriptyAnswerReport/index.js",
13555     "groupTitle": "JscriptyAnswerReport"
13556   },
13557   {
13558     "type": "get",
13559     "url": "/api/jscripty/answers/reports",
13560     "title": "Gets a list of Reports",
13561     "examples": [
13562       {
13563         "title": "Example usage:",
13564         "content": "curl https://{domain}/api/jscripty/answers/reports -v -u {name}:{password}",
13565         "type": "json"
13566       }
13567     ],
13568     "name": "GetReports",
13569     "group": "JscriptyAnswerReport",
13570     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13571     "version": "0.0.0",
13572     "filename": "server/api/jscriptyAnswerReport/index.js",
13573     "groupTitle": "JscriptyAnswerReport"
13574   },
13575   {
13576     "type": "get",
13577     "url": "/api/jscripty/answers/reports/{id}",
13578     "title": "Gets a single Report",
13579     "examples": [
13580       {
13581         "title": "Example usage:",
13582         "content": "curl https://{domain}/api/jscripty/answers/reports/{id} -v -u {name}:{password}",
13583         "type": "json"
13584       }
13585     ],
13586     "name": "ShowReports",
13587     "group": "JscriptyAnswerReport",
13588     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13589     "version": "0.0.0",
13590     "filename": "server/api/jscriptyAnswerReport/index.js",
13591     "groupTitle": "JscriptyAnswerReport"
13592   },
13593   {
13594     "type": "put",
13595     "url": "/api/jscripty/answers/reports/{id}",
13596     "title": "Update an existing Report",
13597     "examples": [
13598       {
13599         "title": "Example usage:",
13600         "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",
13601         "type": "json"
13602       }
13603     ],
13604     "name": "updateReports",
13605     "group": "JscriptyAnswerReport",
13606     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13607     "version": "0.0.0",
13608     "filename": "server/api/jscriptyAnswerReport/index.js",
13609     "groupTitle": "JscriptyAnswerReport"
13610   },
13611   {
13612     "type": "post",
13613     "url": "/api/jscripty/questions/reports",
13614     "title": "Creates a new Report",
13615     "examples": [
13616       {
13617         "title": "Example usage:",
13618         "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",
13619         "type": "json"
13620       }
13621     ],
13622     "name": "CreateReports",
13623     "group": "JscriptyQuestionReport",
13624     "parameter": {
13625       "fields": {
13626         "Body": [
13627           {
13628             "group": "Body",
13629             "type": "String",
13630             "optional": true,
13631             "field": "question",
13632             "description": ""
13633           },
13634           {
13635             "group": "Body",
13636             "type": "Text",
13637             "optional": true,
13638             "field": "answer",
13639             "description": ""
13640           },
13641           {
13642             "group": "Body",
13643             "type": "String",
13644             "optional": true,
13645             "field": "membername",
13646             "description": ""
13647           },
13648           {
13649             "group": "Body",
13650             "type": "String",
13651             "optional": true,
13652             "field": "projectname",
13653             "description": ""
13654           },
13655           {
13656             "group": "Body",
13657             "type": "String",
13658             "optional": true,
13659             "field": "queue",
13660             "description": ""
13661           },
13662           {
13663             "group": "Body",
13664             "type": "String",
13665             "optional": true,
13666             "field": "uniqueid",
13667             "description": ""
13668           },
13669           {
13670             "group": "Body",
13671             "type": "String",
13672             "optional": true,
13673             "field": "calleridname",
13674             "description": ""
13675           },
13676           {
13677             "group": "Body",
13678             "type": "String",
13679             "optional": true,
13680             "field": "calleridnum",
13681             "description": ""
13682           },
13683           {
13684             "group": "Body",
13685             "type": "String",
13686             "optional": true,
13687             "field": "questionId",
13688             "description": ""
13689           }
13690         ]
13691       }
13692     },
13693     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13694     "version": "0.0.0",
13695     "filename": "server/api/jscriptyQuestionReport/index.js",
13696     "groupTitle": "JscriptyQuestionReport"
13697   },
13698   {
13699     "type": "delete",
13700     "url": "/api/jscripty/questions/reports/{id}",
13701     "title": "Deletes a Report",
13702     "examples": [
13703       {
13704         "title": "Example usage:",
13705         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password} -X DELETE",
13706         "type": "json"
13707       }
13708     ],
13709     "name": "DeleteReports",
13710     "group": "JscriptyQuestionReport",
13711     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13712     "version": "0.0.0",
13713     "filename": "server/api/jscriptyQuestionReport/index.js",
13714     "groupTitle": "JscriptyQuestionReport"
13715   },
13716   {
13717     "type": "get",
13718     "url": "/api/jscripty/questions/reports/describe",
13719     "title": "Gets table info about Reports",
13720     "examples": [
13721       {
13722         "title": "Example usage:",
13723         "content": "curl https://{domain}/api/jscripty/questions/reports/describe -v -u {name}:{password}",
13724         "type": "json"
13725       }
13726     ],
13727     "name": "DescribeReports",
13728     "group": "JscriptyQuestionReport",
13729     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13730     "version": "0.0.0",
13731     "filename": "server/api/jscriptyQuestionReport/index.js",
13732     "groupTitle": "JscriptyQuestionReport"
13733   },
13734   {
13735     "type": "get",
13736     "url": "/api/jscripty/questions/reports",
13737     "title": "Gets a list of Reports",
13738     "examples": [
13739       {
13740         "title": "Example usage:",
13741         "content": "curl https://{domain}/api/jscripty/questions/reports -v -u {name}:{password}",
13742         "type": "json"
13743       }
13744     ],
13745     "name": "GetReports",
13746     "group": "JscriptyQuestionReport",
13747     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13748     "version": "0.0.0",
13749     "filename": "server/api/jscriptyQuestionReport/index.js",
13750     "groupTitle": "JscriptyQuestionReport"
13751   },
13752   {
13753     "type": "get",
13754     "url": "/api/jscripty/questions/reports/{id}",
13755     "title": "Gets a single Report",
13756     "examples": [
13757       {
13758         "title": "Example usage:",
13759         "content": "curl https://{domain}/api/jscripty/questions/reports/{id} -v -u {name}:{password}",
13760         "type": "json"
13761       }
13762     ],
13763     "name": "ShowReports",
13764     "group": "JscriptyQuestionReport",
13765     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13766     "version": "0.0.0",
13767     "filename": "server/api/jscriptyQuestionReport/index.js",
13768     "groupTitle": "JscriptyQuestionReport"
13769   },
13770   {
13771     "type": "put",
13772     "url": "/api/jscripty/questions/reports/{id}",
13773     "title": "Update an existing Report",
13774     "examples": [
13775       {
13776         "title": "Example usage:",
13777         "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",
13778         "type": "json"
13779       }
13780     ],
13781     "name": "updateReports",
13782     "group": "JscriptyQuestionReport",
13783     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13784     "version": "0.0.0",
13785     "filename": "server/api/jscriptyQuestionReport/index.js",
13786     "groupTitle": "JscriptyQuestionReport"
13787   },
13788   {
13789     "type": "post",
13790     "url": "/api/jscripty/sessions/reports",
13791     "title": "Creates a new Report",
13792     "examples": [
13793       {
13794         "title": "Example usage:",
13795         "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",
13796         "type": "json"
13797       }
13798     ],
13799     "name": "CreateReports",
13800     "group": "JscriptySessionReport",
13801     "parameter": {
13802       "fields": {
13803         "Body": [
13804           {
13805             "group": "Body",
13806             "type": "String",
13807             "optional": true,
13808             "field": "starttime",
13809             "description": ""
13810           },
13811           {
13812             "group": "Body",
13813             "type": "String",
13814             "optional": true,
13815             "field": "endtime",
13816             "description": ""
13817           },
13818           {
13819             "group": "Body",
13820             "type": "String",
13821             "optional": true,
13822             "field": "membername",
13823             "description": ""
13824           },
13825           {
13826             "group": "Body",
13827             "type": "String",
13828             "optional": true,
13829             "field": "projectname",
13830             "description": ""
13831           },
13832           {
13833             "group": "Body",
13834             "type": "String",
13835             "optional": true,
13836             "field": "queue",
13837             "description": ""
13838           },
13839           {
13840             "group": "Body",
13841             "type": "String",
13842             "optional": true,
13843             "field": "uniqueid",
13844             "description": ""
13845           },
13846           {
13847             "group": "Body",
13848             "type": "String",
13849             "optional": true,
13850             "field": "calleridname",
13851             "description": ""
13852           },
13853           {
13854             "group": "Body",
13855             "type": "String",
13856             "optional": true,
13857             "field": "calleridnum",
13858             "description": ""
13859           },
13860           {
13861             "group": "Body",
13862             "type": "Boolean",
13863             "optional": true,
13864             "field": "completed",
13865             "description": ""
13866           }
13867         ]
13868       }
13869     },
13870     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13871     "version": "0.0.0",
13872     "filename": "server/api/jscriptySessionReport/index.js",
13873     "groupTitle": "JscriptySessionReport"
13874   },
13875   {
13876     "type": "delete",
13877     "url": "/api/jscripty/sessions/reports/{id}",
13878     "title": "Deletes a Report",
13879     "examples": [
13880       {
13881         "title": "Example usage:",
13882         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password} -X DELETE",
13883         "type": "json"
13884       }
13885     ],
13886     "name": "DeleteReports",
13887     "group": "JscriptySessionReport",
13888     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13889     "version": "0.0.0",
13890     "filename": "server/api/jscriptySessionReport/index.js",
13891     "groupTitle": "JscriptySessionReport"
13892   },
13893   {
13894     "type": "get",
13895     "url": "/api/jscripty/sessions/reports/describe",
13896     "title": "Gets table info about Reports",
13897     "examples": [
13898       {
13899         "title": "Example usage:",
13900         "content": "curl https://{domain}/api/jscripty/sessions/reports/describe -v -u {name}:{password}",
13901         "type": "json"
13902       }
13903     ],
13904     "name": "DescribeReports",
13905     "group": "JscriptySessionReport",
13906     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13907     "version": "0.0.0",
13908     "filename": "server/api/jscriptySessionReport/index.js",
13909     "groupTitle": "JscriptySessionReport"
13910   },
13911   {
13912     "type": "get",
13913     "url": "/api/jscripty/sessions/reports",
13914     "title": "Gets a list of Reports",
13915     "examples": [
13916       {
13917         "title": "Example usage:",
13918         "content": "curl https://{domain}/api/jscripty/sessions/reports -v -u {name}:{password}",
13919         "type": "json"
13920       }
13921     ],
13922     "name": "GetReports",
13923     "group": "JscriptySessionReport",
13924     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
13925     "version": "0.0.0",
13926     "filename": "server/api/jscriptySessionReport/index.js",
13927     "groupTitle": "JscriptySessionReport"
13928   },
13929   {
13930     "type": "get",
13931     "url": "/api/jscripty/sessions/reports/{id}",
13932     "title": "Gets a single Report",
13933     "examples": [
13934       {
13935         "title": "Example usage:",
13936         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id} -v -u {name}:{password}",
13937         "type": "json"
13938       }
13939     ],
13940     "name": "ShowReports",
13941     "group": "JscriptySessionReport",
13942     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13943     "version": "0.0.0",
13944     "filename": "server/api/jscriptySessionReport/index.js",
13945     "groupTitle": "JscriptySessionReport"
13946   },
13947   {
13948     "type": "get",
13949     "url": "/api/jscripty/sessions/reports/{id}/questions",
13950     "title": "Gets Jscripty Session questions",
13951     "examples": [
13952       {
13953         "title": "Example usage:",
13954         "content": "curl https://{domain}/api/jscripty/sessions/reports/{id}/questions -v -u {name}:{password}  -X GET",
13955         "type": "json"
13956       }
13957     ],
13958     "name": "getQuestions",
13959     "group": "JscriptySessionReport",
13960     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13961     "version": "0.0.0",
13962     "filename": "server/api/jscriptySessionReport/index.js",
13963     "groupTitle": "JscriptySessionReport"
13964   },
13965   {
13966     "type": "put",
13967     "url": "/api/jscripty/sessions/reports/{id}",
13968     "title": "Update an existing Report",
13969     "examples": [
13970       {
13971         "title": "Example usage:",
13972         "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",
13973         "type": "json"
13974       }
13975     ],
13976     "name": "updateReports",
13977     "group": "JscriptySessionReport",
13978     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13979     "version": "0.0.0",
13980     "filename": "server/api/jscriptySessionReport/index.js",
13981     "groupTitle": "JscriptySessionReport"
13982   },
13983   {
13984     "type": "post",
13985     "url": "/api/jscripty/projects/clone",
13986     "title": "Clone an existing Project",
13987     "examples": [
13988       {
13989         "title": "Example usage:",
13990         "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",
13991         "type": "json"
13992       }
13993     ],
13994     "name": "CloneProjects",
13995     "group": "Jscripty_Projects",
13996     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
13997     "version": "0.0.0",
13998     "filename": "server/api/jscriptyProject/index.js",
13999     "groupTitle": "Jscripty_Projects"
14000   },
14001   {
14002     "type": "post",
14003     "url": "/api/jscripty/projects",
14004     "title": "Creates a new Project",
14005     "examples": [
14006       {
14007         "title": "Example usage:",
14008         "content": "curl https://{domain}/api/jscripty/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
14009         "type": "json"
14010       }
14011     ],
14012     "name": "CreateProjects",
14013     "group": "Jscripty_Projects",
14014     "parameter": {
14015       "fields": {
14016         "Body": [
14017           {
14018             "group": "Body",
14019             "type": "String",
14020             "optional": true,
14021             "field": "name",
14022             "description": ""
14023           },
14024           {
14025             "group": "Body",
14026             "type": "String",
14027             "optional": true,
14028             "field": "description",
14029             "description": ""
14030           },
14031           {
14032             "group": "Body",
14033             "type": "Text",
14034             "optional": true,
14035             "field": "formData",
14036             "description": ""
14037           },
14038           {
14039             "group": "Body",
14040             "type": "Boolean",
14041             "optional": true,
14042             "field": "enableUncompleteSave",
14043             "description": ""
14044           },
14045           {
14046             "group": "Body",
14047             "type": "Boolean",
14048             "optional": true,
14049             "field": "sendUnpauseOnSubmit",
14050             "description": ""
14051           }
14052         ]
14053       }
14054     },
14055     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14056     "version": "0.0.0",
14057     "filename": "server/api/jscriptyProject/index.js",
14058     "groupTitle": "Jscripty_Projects"
14059   },
14060   {
14061     "type": "delete",
14062     "url": "/api/jscripty/projects/{id}",
14063     "title": "Deletes a Project",
14064     "examples": [
14065       {
14066         "title": "Example usage:",
14067         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password} -X DELETE",
14068         "type": "json"
14069       }
14070     ],
14071     "name": "DeleteProjects",
14072     "group": "Jscripty_Projects",
14073     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14074     "version": "0.0.0",
14075     "filename": "server/api/jscriptyProject/index.js",
14076     "groupTitle": "Jscripty_Projects"
14077   },
14078   {
14079     "type": "get",
14080     "url": "/api/jscripty/projects",
14081     "title": "Gets a list of Projects",
14082     "examples": [
14083       {
14084         "title": "Example usage:",
14085         "content": "curl https://{domain}/api/jscripty/projects -v -u {name}:{password}",
14086         "type": "json"
14087       }
14088     ],
14089     "name": "GetProjects",
14090     "group": "Jscripty_Projects",
14091     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14092     "version": "0.0.0",
14093     "filename": "server/api/jscriptyProject/index.js",
14094     "groupTitle": "Jscripty_Projects"
14095   },
14096   {
14097     "type": "get",
14098     "url": "/api/jscripty/projects/{id}",
14099     "title": "Gets a single Project",
14100     "examples": [
14101       {
14102         "title": "Example usage:",
14103         "content": "curl https://{domain}/api/jscripty/projects/{id} -v -u {name}:{password}",
14104         "type": "json"
14105       }
14106     ],
14107     "name": "ShowProjects",
14108     "group": "Jscripty_Projects",
14109     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14110     "version": "0.0.0",
14111     "filename": "server/api/jscriptyProject/index.js",
14112     "groupTitle": "Jscripty_Projects"
14113   },
14114   {
14115     "type": "get",
14116     "url": "/api/jscripty/projects/{id}/answers",
14117     "title": "Gets jscripty project answers",
14118     "examples": [
14119       {
14120         "title": "Example usage:",
14121         "content": "curl https://{domain}/api/jscripty/projects/{id}/answers -v -u {name}:{password}  -X GET",
14122         "type": "json"
14123       }
14124     ],
14125     "name": "getAnswers",
14126     "group": "Jscripty_Projects",
14127     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14128     "version": "0.0.0",
14129     "filename": "server/api/jscriptyProject/index.js",
14130     "groupTitle": "Jscripty_Projects"
14131   },
14132   {
14133     "type": "get",
14134     "url": "/api/jscripty/projects/{id}/sessions",
14135     "title": "Gets jscripty project sessions",
14136     "examples": [
14137       {
14138         "title": "Example usage:",
14139         "content": "curl https://{domain}/api/jscripty/projects/{id}/sessions -v -u {name}:{password}  -X GET",
14140         "type": "json"
14141       }
14142     ],
14143     "name": "getSessions",
14144     "group": "Jscripty_Projects",
14145     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14146     "version": "0.0.0",
14147     "filename": "server/api/jscriptyProject/index.js",
14148     "groupTitle": "Jscripty_Projects"
14149   },
14150   {
14151     "type": "get",
14152     "url": "/api/jscripty/projects/{id}/summary",
14153     "title": "Gets jscripty project summary",
14154     "examples": [
14155       {
14156         "title": "Example usage:",
14157         "content": "curl https://{domain}/api/jscripty/projects/{id}/summary -v -u {name}:{password}  -X GET",
14158         "type": "json"
14159       }
14160     ],
14161     "name": "getSummary",
14162     "group": "Jscripty_Projects",
14163     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14164     "version": "0.0.0",
14165     "filename": "server/api/jscriptyProject/index.js",
14166     "groupTitle": "Jscripty_Projects"
14167   },
14168   {
14169     "type": "put",
14170     "url": "/api/jscripty/projects/{id}",
14171     "title": "Update an existing Project",
14172     "examples": [
14173       {
14174         "title": "Example usage:",
14175         "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",
14176         "type": "json"
14177       }
14178     ],
14179     "name": "updateProjects",
14180     "group": "Jscripty_Projects",
14181     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14182     "version": "0.0.0",
14183     "filename": "server/api/jscriptyProject/index.js",
14184     "groupTitle": "Jscripty_Projects"
14185   },
14186   {
14187     "type": "get",
14188     "url": "/api/license",
14189     "title": "Gets License Info",
14190     "examples": [
14191       {
14192         "title": "Example usage:",
14193         "content": "curl https://{domain}/api/license -v -u {name}:{password} -X GET",
14194         "type": "json"
14195       }
14196     ],
14197     "name": "index",
14198     "group": "License",
14199     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14200     "version": "0.0.0",
14201     "filename": "server/api/license/index.js",
14202     "groupTitle": "License"
14203   },
14204   {
14205     "type": "put",
14206     "url": "/api/license/{id}",
14207     "title": "Update License Info",
14208     "examples": [
14209       {
14210         "title": "Example usage:",
14211         "content": "curl https://{domain}/api/license/{id} -v -u {name}:{password} -X PUT",
14212         "type": "json"
14213       }
14214     ],
14215     "name": "update",
14216     "group": "License",
14217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14218     "version": "0.0.0",
14219     "filename": "server/api/license/index.js",
14220     "groupTitle": "License"
14221   },
14222   {
14223     "type": "post",
14224     "url": "/api/mail/accounts/{id}/users",
14225     "title": "Add agents to a mail account",
14226     "examples": [
14227       {
14228         "title": "Example usage:",
14229         "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",
14230         "type": "json"
14231       }
14232     ],
14233     "name": "AddAgents",
14234     "group": "Mail_Accounts",
14235     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14236     "version": "0.0.0",
14237     "filename": "server/api/mailAccount/index.js",
14238     "groupTitle": "Mail_Accounts"
14239   },
14240   {
14241     "type": "post",
14242     "url": "/api/mail/accounts/{id}/in_servers",
14243     "title": "Creates a new IMAP server",
14244     "examples": [
14245       {
14246         "title": "Example usage:",
14247         "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",
14248         "type": "json"
14249       }
14250     ],
14251     "name": "AddImap",
14252     "group": "Mail_Accounts",
14253     "parameter": {
14254       "fields": {
14255         "Body": [
14256           {
14257             "group": "Body",
14258             "type": "String",
14259             "optional": true,
14260             "field": "description",
14261             "description": ""
14262           },
14263           {
14264             "group": "Body",
14265             "type": "String",
14266             "optional": true,
14267             "field": "host",
14268             "description": ""
14269           },
14270           {
14271             "group": "Body",
14272             "type": "Boolean",
14273             "optional": true,
14274             "field": "authentication",
14275             "description": ""
14276           },
14277           {
14278             "group": "Body",
14279             "type": "String",
14280             "optional": true,
14281             "field": "user",
14282             "description": ""
14283           },
14284           {
14285             "group": "Body",
14286             "type": "String",
14287             "optional": true,
14288             "field": "password",
14289             "description": ""
14290           },
14291           {
14292             "group": "Body",
14293             "type": "Integer",
14294             "optional": true,
14295             "field": "port",
14296             "description": ""
14297           },
14298           {
14299             "group": "Body",
14300             "type": "Boolean",
14301             "optional": true,
14302             "field": "tls",
14303             "description": ""
14304           },
14305           {
14306             "group": "Body",
14307             "type": "String",
14308             "optional": true,
14309             "field": "mailbox",
14310             "description": ""
14311           },
14312           {
14313             "group": "Body",
14314             "type": "Integer",
14315             "optional": true,
14316             "field": "connTimeout",
14317             "description": ""
14318           },
14319           {
14320             "group": "Body",
14321             "type": "Integer",
14322             "optional": true,
14323             "field": "authTimeout",
14324             "description": ""
14325           },
14326           {
14327             "group": "Body",
14328             "type": "String",
14329             "optional": true,
14330             "field": "service",
14331             "description": ""
14332           }
14333         ]
14334       }
14335     },
14336     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14337     "version": "0.0.0",
14338     "filename": "server/api/mailAccount/index.js",
14339     "groupTitle": "Mail_Accounts"
14340   },
14341   {
14342     "type": "post",
14343     "url": "/api/mail/accounts/{id}/out_servers",
14344     "title": "Creates a new SMTP server",
14345     "examples": [
14346       {
14347         "title": "Example usage:",
14348         "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",
14349         "type": "json"
14350       }
14351     ],
14352     "name": "AddSmtp",
14353     "group": "Mail_Accounts",
14354     "parameter": {
14355       "fields": {
14356         "Body": [
14357           {
14358             "group": "Body",
14359             "type": "String",
14360             "optional": true,
14361             "field": "description",
14362             "description": ""
14363           },
14364           {
14365             "group": "Body",
14366             "type": "String",
14367             "optional": true,
14368             "field": "host",
14369             "description": ""
14370           },
14371           {
14372             "group": "Body",
14373             "type": "String",
14374             "optional": true,
14375             "field": "user",
14376             "description": ""
14377           },
14378           {
14379             "group": "Body",
14380             "type": "String",
14381             "optional": true,
14382             "field": "pass",
14383             "description": ""
14384           },
14385           {
14386             "group": "Body",
14387             "type": "Integer",
14388             "optional": true,
14389             "field": "port",
14390             "description": ""
14391           },
14392           {
14393             "group": "Body",
14394             "type": "Boolean",
14395             "optional": true,
14396             "field": "secure",
14397             "description": ""
14398           },
14399           {
14400             "group": "Body",
14401             "type": "String",
14402             "optional": true,
14403             "field": "service",
14404             "description": ""
14405           },
14406           {
14407             "group": "Body",
14408             "type": "Boolean",
14409             "optional": true,
14410             "field": "authentication",
14411             "description": ""
14412           }
14413         ]
14414       }
14415     },
14416     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14417     "version": "0.0.0",
14418     "filename": "server/api/mailAccount/index.js",
14419     "groupTitle": "Mail_Accounts"
14420   },
14421   {
14422     "type": "delete",
14423     "url": "/api/mail/accounts/{id}",
14424     "title": "Deletes a mail account",
14425     "examples": [
14426       {
14427         "title": "Example usage:",
14428         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password} -X DELETE",
14429         "type": "json"
14430       }
14431     ],
14432     "name": "DeleteMailAccounts",
14433     "group": "Mail_Accounts",
14434     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14435     "version": "0.0.0",
14436     "filename": "server/api/mailAccount/index.js",
14437     "groupTitle": "Mail_Accounts"
14438   },
14439   {
14440     "type": "get",
14441     "url": "/api/mail/accounts/describe",
14442     "title": "Gets table info about Accounts",
14443     "examples": [
14444       {
14445         "title": "Example usage:",
14446         "content": "curl https://{domain}/api/mail/accounts/describe -v -u {name}:{password}",
14447         "type": "json"
14448       }
14449     ],
14450     "name": "DescribeAccounts",
14451     "group": "Mail_Accounts",
14452     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14453     "version": "0.0.0",
14454     "filename": "server/api/mailAccount/index.js",
14455     "groupTitle": "Mail_Accounts"
14456   },
14457   {
14458     "type": "get",
14459     "url": "/api/mail/accounts",
14460     "title": "Gets a list of Accounts",
14461     "examples": [
14462       {
14463         "title": "Example usage:",
14464         "content": "curl https://{domain}/api/mail/accounts -v -u {name}:{password}",
14465         "type": "json"
14466       }
14467     ],
14468     "name": "GetAccounts",
14469     "group": "Mail_Accounts",
14470     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
14471     "version": "0.0.0",
14472     "filename": "server/api/mailAccount/index.js",
14473     "groupTitle": "Mail_Accounts"
14474   },
14475   {
14476     "type": "get",
14477     "url": "/api/mail/accounts/{id}/users",
14478     "title": "Gets agents from mail account",
14479     "examples": [
14480       {
14481         "title": "Example usage:",
14482         "content": "curl https://{domain}/api/mail/accounts/{id}/users -v -u {name}:{password} -X GET",
14483         "type": "json"
14484       }
14485     ],
14486     "name": "GetAgents",
14487     "group": "Mail_Accounts",
14488     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14489     "version": "0.0.0",
14490     "filename": "server/api/mailAccount/index.js",
14491     "groupTitle": "Mail_Accounts"
14492   },
14493   {
14494     "type": "get",
14495     "url": "/api/mail/accounts/{id}/in_servers",
14496     "title": "Gets account IMAP server",
14497     "examples": [
14498       {
14499         "title": "Example usage:",
14500         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X GET",
14501         "type": "json"
14502       }
14503     ],
14504     "name": "GetImap",
14505     "group": "Mail_Accounts",
14506     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14507     "version": "0.0.0",
14508     "filename": "server/api/mailAccount/index.js",
14509     "groupTitle": "Mail_Accounts"
14510   },
14511   {
14512     "type": "get",
14513     "url": "/api/mail/accounts/{id}/out_servers",
14514     "title": "Gets account SMTP server",
14515     "examples": [
14516       {
14517         "title": "Example usage:",
14518         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X GET",
14519         "type": "json"
14520       }
14521     ],
14522     "name": "GetSmtp",
14523     "group": "Mail_Accounts",
14524     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14525     "version": "0.0.0",
14526     "filename": "server/api/mailAccount/index.js",
14527     "groupTitle": "Mail_Accounts"
14528   },
14529   {
14530     "type": "delete",
14531     "url": "/api/mail/accounts/{id}/users",
14532     "title": "Removes agents from a mail account",
14533     "examples": [
14534       {
14535         "title": "Example usage:",
14536         "content": "curl https://{domain}/api/mail/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14537         "type": "json"
14538       }
14539     ],
14540     "name": "RemoveAgents",
14541     "group": "Mail_Accounts",
14542     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14543     "version": "0.0.0",
14544     "filename": "server/api/mailAccount/index.js",
14545     "groupTitle": "Mail_Accounts"
14546   },
14547   {
14548     "type": "delete",
14549     "url": "/api/mail/accounts/{id}/canned_answers",
14550     "title": "Removes canned answers from account",
14551     "examples": [
14552       {
14553         "title": "Example usage:",
14554         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14555         "type": "json"
14556       }
14557     ],
14558     "name": "RemoveAnswers",
14559     "group": "Mail_Accounts",
14560     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14561     "version": "0.0.0",
14562     "filename": "server/api/mailAccount/index.js",
14563     "groupTitle": "Mail_Accounts"
14564   },
14565   {
14566     "type": "delete",
14567     "url": "/api/mail/accounts/{id}/dispositions",
14568     "title": "Removes dispositions from account",
14569     "examples": [
14570       {
14571         "title": "Example usage:",
14572         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
14573         "type": "json"
14574       }
14575     ],
14576     "name": "RemoveDispositions",
14577     "group": "Mail_Accounts",
14578     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14579     "version": "0.0.0",
14580     "filename": "server/api/mailAccount/index.js",
14581     "groupTitle": "Mail_Accounts"
14582   },
14583   {
14584     "type": "delete",
14585     "url": "/api/mail/accounts/{id}/in_servers",
14586     "title": "Removes IMAP server from an account",
14587     "examples": [
14588       {
14589         "title": "Example usage:",
14590         "content": "curl https://{domain}/api/mail/accounts/{id}/in_servers -v -u {name}:{password} -X DELETE",
14591         "type": "json"
14592       }
14593     ],
14594     "name": "RemoveImmap",
14595     "group": "Mail_Accounts",
14596     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14597     "version": "0.0.0",
14598     "filename": "server/api/mailAccount/index.js",
14599     "groupTitle": "Mail_Accounts"
14600   },
14601   {
14602     "type": "delete",
14603     "url": "/api/mail/accounts/{id}/out_servers",
14604     "title": "Removes SMTP server from an account",
14605     "examples": [
14606       {
14607         "title": "Example usage:",
14608         "content": "curl https://{domain}/api/mail/accounts/{id}/out_servers -v -u {name}:{password} -X DELETE",
14609         "type": "json"
14610       }
14611     ],
14612     "name": "RemoveSmtp",
14613     "group": "Mail_Accounts",
14614     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14615     "version": "0.0.0",
14616     "filename": "server/api/mailAccount/index.js",
14617     "groupTitle": "Mail_Accounts"
14618   },
14619   {
14620     "type": "get",
14621     "url": "/api/mail/accounts/{id}",
14622     "title": "Gets a single Account",
14623     "examples": [
14624       {
14625         "title": "Example usage:",
14626         "content": "curl https://{domain}/api/mail/accounts/{id} -v -u {name}:{password}",
14627         "type": "json"
14628       }
14629     ],
14630     "name": "ShowAccounts",
14631     "group": "Mail_Accounts",
14632     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14633     "version": "0.0.0",
14634     "filename": "server/api/mailAccount/index.js",
14635     "groupTitle": "Mail_Accounts"
14636   },
14637   {
14638     "type": "post",
14639     "url": "/api/mail/accounts/{id}/canned_answers",
14640     "title": "Creates new canned answer",
14641     "examples": [
14642       {
14643         "title": "Example usage:",
14644         "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",
14645         "type": "json"
14646       }
14647     ],
14648     "name": "addAnswer",
14649     "group": "Mail_Accounts",
14650     "parameter": {
14651       "fields": {
14652         "Body": [
14653           {
14654             "group": "Body",
14655             "type": "String",
14656             "optional": false,
14657             "field": "key",
14658             "description": ""
14659           },
14660           {
14661             "group": "Body",
14662             "type": "Text",
14663             "optional": false,
14664             "field": "value",
14665             "description": ""
14666           },
14667           {
14668             "group": "Body",
14669             "type": "String",
14670             "optional": true,
14671             "field": "description",
14672             "description": ""
14673           },
14674           {
14675             "group": "Body",
14676             "type": "Virtual",
14677             "optional": true,
14678             "field": "name",
14679             "description": ""
14680           }
14681         ]
14682       }
14683     },
14684     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14685     "version": "0.0.0",
14686     "filename": "server/api/mailAccount/index.js",
14687     "groupTitle": "Mail_Accounts"
14688   },
14689   {
14690     "type": "post",
14691     "url": "/api/mail/accounts/{id}/applications",
14692     "title": "Creates new applications",
14693     "examples": [
14694       {
14695         "title": "Example usage:",
14696         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14697         "type": "json"
14698       }
14699     ],
14700     "name": "addApplications",
14701     "group": "Mail_Accounts",
14702     "parameter": {
14703       "fields": {
14704         "Body": [
14705           {
14706             "group": "Body",
14707             "type": "Integer",
14708             "optional": false,
14709             "field": "priority",
14710             "description": ""
14711           },
14712           {
14713             "group": "Body",
14714             "type": "String",
14715             "optional": false,
14716             "field": "app",
14717             "description": ""
14718           },
14719           {
14720             "group": "Body",
14721             "type": "Text",
14722             "optional": true,
14723             "field": "appdata",
14724             "description": ""
14725           },
14726           {
14727             "group": "Body",
14728             "type": "String",
14729             "optional": true,
14730             "field": "description",
14731             "description": ""
14732           },
14733           {
14734             "group": "Body",
14735             "type": "String",
14736             "optional": true,
14737             "field": "interval",
14738             "description": ""
14739           }
14740         ]
14741       }
14742     },
14743     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14744     "version": "0.0.0",
14745     "filename": "server/api/mailAccount/index.js",
14746     "groupTitle": "Mail_Accounts"
14747   },
14748   {
14749     "type": "post",
14750     "url": "/api/mail/accounts/{id}/dispositions",
14751     "title": "Creates new disposition",
14752     "examples": [
14753       {
14754         "title": "Example usage:",
14755         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14756         "type": "json"
14757       }
14758     ],
14759     "name": "addDisposition",
14760     "group": "Mail_Accounts",
14761     "parameter": {
14762       "fields": {
14763         "Body": [
14764           {
14765             "group": "Body",
14766             "type": "String",
14767             "optional": false,
14768             "field": "name",
14769             "description": ""
14770           }
14771         ]
14772       }
14773     },
14774     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14775     "version": "0.0.0",
14776     "filename": "server/api/mailAccount/index.js",
14777     "groupTitle": "Mail_Accounts"
14778   },
14779   {
14780     "type": "post",
14781     "url": "/api/mail/accounts/{id}/interactions",
14782     "title": "Creates new interactions",
14783     "examples": [
14784       {
14785         "title": "Example usage:",
14786         "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",
14787         "type": "json"
14788       }
14789     ],
14790     "name": "addInteraction",
14791     "group": "Mail_Accounts",
14792     "parameter": {
14793       "fields": {
14794         "Body": [
14795           {
14796             "group": "Body",
14797             "type": "Boolean",
14798             "optional": true,
14799             "field": "closed",
14800             "description": ""
14801           },
14802           {
14803             "group": "Body",
14804             "type": "String",
14805             "optional": true,
14806             "field": "closedAt",
14807             "description": ""
14808           },
14809           {
14810             "group": "Body",
14811             "type": "String",
14812             "optional": true,
14813             "field": "disposition",
14814             "description": ""
14815           },
14816           {
14817             "group": "Body",
14818             "type": "String",
14819             "optional": true,
14820             "field": "note",
14821             "description": ""
14822           },
14823           {
14824             "group": "Body",
14825             "type": "String",
14826             "optional": true,
14827             "field": "inReplyTo",
14828             "description": ""
14829           },
14830           {
14831             "group": "Body",
14832             "type": "String",
14833             "optional": true,
14834             "field": "to",
14835             "description": ""
14836           },
14837           {
14838             "group": "Body",
14839             "type": "Text",
14840             "optional": true,
14841             "field": "cc",
14842             "description": ""
14843           },
14844           {
14845             "group": "Body",
14846             "type": "Text",
14847             "optional": true,
14848             "field": "subject",
14849             "description": ""
14850           },
14851           {
14852             "group": "Body",
14853             "type": "Boolean",
14854             "optional": true,
14855             "field": "attach",
14856             "description": ""
14857           },
14858           {
14859             "group": "Body",
14860             "type": "String",
14861             "optional": true,
14862             "field": "read1stAt",
14863             "description": ""
14864           },
14865           {
14866             "group": "Body",
14867             "type": "String",
14868             "optional": true,
14869             "field": "substatus",
14870             "description": ""
14871           },
14872           {
14873             "group": "Body",
14874             "type": "String",
14875             "optional": true,
14876             "field": "substatusAt",
14877             "description": ""
14878           },
14879           {
14880             "group": "Body",
14881             "type": "String",
14882             "allowedValues": [
14883               "\"in\"",
14884               "\"out\""
14885             ],
14886             "optional": false,
14887             "field": "firstMsgDirection",
14888             "description": ""
14889           },
14890           {
14891             "group": "Body",
14892             "type": "String",
14893             "optional": true,
14894             "field": "lastMsgAt",
14895             "description": ""
14896           },
14897           {
14898             "group": "Body",
14899             "type": "String",
14900             "allowedValues": [
14901               "\"in\"",
14902               "\"out\""
14903             ],
14904             "optional": false,
14905             "field": "lastMsgDirection",
14906             "description": ""
14907           },
14908           {
14909             "group": "Body",
14910             "type": "Text",
14911             "optional": true,
14912             "field": "lastMsgBody",
14913             "description": ""
14914           },
14915           {
14916             "group": "Body",
14917             "type": "Text",
14918             "optional": true,
14919             "field": "lastMsgText",
14920             "description": ""
14921           }
14922         ]
14923       }
14924     },
14925     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14926     "version": "0.0.0",
14927     "filename": "server/api/mailAccount/index.js",
14928     "groupTitle": "Mail_Accounts"
14929   },
14930   {
14931     "type": "post",
14932     "url": "/api/mail/accounts",
14933     "title": "Create a mail account",
14934     "examples": [
14935       {
14936         "title": "Example usage:",
14937         "content": "curl https://{domain}/api/mail/accounts \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
14938         "type": "json"
14939       }
14940     ],
14941     "name": "create",
14942     "group": "Mail_Accounts",
14943     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14944     "version": "0.0.0",
14945     "filename": "server/api/mailAccount/index.js",
14946     "groupTitle": "Mail_Accounts"
14947   },
14948   {
14949     "type": "get",
14950     "url": "/api/mail/accounts/{id}/canned_answers",
14951     "title": "Gets account canned answers",
14952     "examples": [
14953       {
14954         "title": "Example usage:",
14955         "content": "curl https://{domain}/api/mail/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
14956         "type": "json"
14957       }
14958     ],
14959     "name": "getAnswers",
14960     "group": "Mail_Accounts",
14961     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14962     "version": "0.0.0",
14963     "filename": "server/api/mailAccount/index.js",
14964     "groupTitle": "Mail_Accounts"
14965   },
14966   {
14967     "type": "get",
14968     "url": "/api/mail/accounts/{id}/applications",
14969     "title": "Gets account applications",
14970     "examples": [
14971       {
14972         "title": "Example usage:",
14973         "content": "curl https://{domain}/api/mail/accounts/{id}/applications -v -u {name}:{password} -X GET",
14974         "type": "json"
14975       }
14976     ],
14977     "name": "getApplications",
14978     "group": "Mail_Accounts",
14979     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14980     "version": "0.0.0",
14981     "filename": "server/api/mailAccount/index.js",
14982     "groupTitle": "Mail_Accounts"
14983   },
14984   {
14985     "type": "get",
14986     "url": "/api/mail/accounts/{id}/dispositions",
14987     "title": "Gets account dispositions",
14988     "examples": [
14989       {
14990         "title": "Example usage:",
14991         "content": "curl https://{domain}/api/mail/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
14992         "type": "json"
14993       }
14994     ],
14995     "name": "getDispositions",
14996     "group": "Mail_Accounts",
14997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
14998     "version": "0.0.0",
14999     "filename": "server/api/mailAccount/index.js",
15000     "groupTitle": "Mail_Accounts"
15001   },
15002   {
15003     "type": "get",
15004     "url": "/api/mail/accounts/{id}/interactions",
15005     "title": "Gets account interactions",
15006     "examples": [
15007       {
15008         "title": "Example usage:",
15009         "content": "curl https://{domain}/api/mail/accounts/{id}/interactions -v -u {name}:{password} -X GET",
15010         "type": "json"
15011       }
15012     ],
15013     "name": "getInteraction",
15014     "group": "Mail_Accounts",
15015     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15016     "version": "0.0.0",
15017     "filename": "server/api/mailAccount/index.js",
15018     "groupTitle": "Mail_Accounts"
15019   },
15020   {
15021     "type": "get",
15022     "url": "/api/mail/accounts/{id}/messages",
15023     "title": "Gets account messages",
15024     "examples": [
15025       {
15026         "title": "Example usage:",
15027         "content": "curl https://{domain}/api/mail/accounts/{id}/messages -v -u {name}:{password} -X GET",
15028         "type": "json"
15029       }
15030     ],
15031     "name": "getMessages",
15032     "group": "Mail_Accounts",
15033     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15034     "version": "0.0.0",
15035     "filename": "server/api/mailAccount/index.js",
15036     "groupTitle": "Mail_Accounts"
15037   },
15038   {
15039     "type": "post",
15040     "url": "/api/mail/accounts/{id}/send",
15041     "title": "Send new mail",
15042     "examples": [
15043       {
15044         "title": "Example usage:",
15045         "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",
15046         "type": "json"
15047       }
15048     ],
15049     "name": "sendMail",
15050     "group": "Mail_Accounts",
15051     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15052     "version": "0.0.0",
15053     "filename": "server/api/mailAccount/index.js",
15054     "groupTitle": "Mail_Accounts"
15055   },
15056   {
15057     "type": "put",
15058     "url": "/api/mail/accounts/{id}",
15059     "title": "Update an existing Account",
15060     "examples": [
15061       {
15062         "title": "Example usage:",
15063         "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",
15064         "type": "json"
15065       }
15066     ],
15067     "name": "updateAccounts",
15068     "group": "Mail_Accounts",
15069     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15070     "version": "0.0.0",
15071     "filename": "server/api/mailAccount/index.js",
15072     "groupTitle": "Mail_Accounts"
15073   },
15074   {
15075     "type": "get",
15076     "url": "/api/mail/accounts/{id}/verify",
15077     "title": "Verify mail account",
15078     "examples": [
15079       {
15080         "title": "Example usage:",
15081         "content": "curl https://{domain}/api/mail/accounts/{id}/verify -v -u {name}:{password} -X GET",
15082         "type": "json"
15083       }
15084     ],
15085     "name": "verifySmtp",
15086     "group": "Mail_Accounts",
15087     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15088     "version": "0.0.0",
15089     "filename": "server/api/mailAccount/index.js",
15090     "groupTitle": "Mail_Accounts"
15091   },
15092   {
15093     "type": "delete",
15094     "url": "/api/mail/applications/{id}",
15095     "title": "Deletes a Application",
15096     "examples": [
15097       {
15098         "title": "Example usage:",
15099         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password} -X DELETE",
15100         "type": "json"
15101       }
15102     ],
15103     "name": "DeleteApplications",
15104     "group": "Mail_Applications",
15105     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15106     "version": "0.0.0",
15107     "filename": "server/api/mailApplication/index.js",
15108     "groupTitle": "Mail_Applications"
15109   },
15110   {
15111     "type": "get",
15112     "url": "/api/mail/applications/{id}",
15113     "title": "Gets a single Application",
15114     "examples": [
15115       {
15116         "title": "Example usage:",
15117         "content": "curl https://{domain}/api/mail/applications/{id} -v -u {name}:{password}",
15118         "type": "json"
15119       }
15120     ],
15121     "name": "ShowApplications",
15122     "group": "Mail_Applications",
15123     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15124     "version": "0.0.0",
15125     "filename": "server/api/mailApplication/index.js",
15126     "groupTitle": "Mail_Applications"
15127   },
15128   {
15129     "type": "put",
15130     "url": "/api/mail/applications/{id}",
15131     "title": "Update an existing Application",
15132     "examples": [
15133       {
15134         "title": "Example usage:",
15135         "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",
15136         "type": "json"
15137       }
15138     ],
15139     "name": "updateApplications",
15140     "group": "Mail_Applications",
15141     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15142     "version": "0.0.0",
15143     "filename": "server/api/mailApplication/index.js",
15144     "groupTitle": "Mail_Applications"
15145   },
15146   {
15147     "type": "post",
15148     "url": "/api/mail/interactions/{id}/tags",
15149     "title": "Add tags to the interaction",
15150     "examples": [
15151       {
15152         "title": "Example usage:",
15153         "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",
15154         "type": "json"
15155       }
15156     ],
15157     "name": "AddTags",
15158     "group": "Mail_Interactions",
15159     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15160     "version": "0.0.0",
15161     "filename": "server/api/mailInteraction/index.js",
15162     "groupTitle": "Mail_Interactions"
15163   },
15164   {
15165     "type": "post",
15166     "url": "/api/mail/interactions",
15167     "title": "Creates a new Interaction",
15168     "examples": [
15169       {
15170         "title": "Example usage:",
15171         "content": "curl https://{domain}/api/mail/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15172         "type": "json"
15173       }
15174     ],
15175     "name": "CreateInteractions",
15176     "group": "Mail_Interactions",
15177     "parameter": {
15178       "fields": {
15179         "Body": [
15180           {
15181             "group": "Body",
15182             "type": "Boolean",
15183             "optional": true,
15184             "field": "closed",
15185             "description": ""
15186           },
15187           {
15188             "group": "Body",
15189             "type": "String",
15190             "optional": true,
15191             "field": "closedAt",
15192             "description": ""
15193           },
15194           {
15195             "group": "Body",
15196             "type": "String",
15197             "optional": true,
15198             "field": "disposition",
15199             "description": ""
15200           },
15201           {
15202             "group": "Body",
15203             "type": "String",
15204             "optional": true,
15205             "field": "note",
15206             "description": ""
15207           },
15208           {
15209             "group": "Body",
15210             "type": "String",
15211             "optional": true,
15212             "field": "inReplyTo",
15213             "description": ""
15214           },
15215           {
15216             "group": "Body",
15217             "type": "String",
15218             "optional": true,
15219             "field": "to",
15220             "description": ""
15221           },
15222           {
15223             "group": "Body",
15224             "type": "Text",
15225             "optional": true,
15226             "field": "cc",
15227             "description": ""
15228           },
15229           {
15230             "group": "Body",
15231             "type": "Text",
15232             "optional": true,
15233             "field": "subject",
15234             "description": ""
15235           },
15236           {
15237             "group": "Body",
15238             "type": "Boolean",
15239             "optional": true,
15240             "field": "attach",
15241             "description": ""
15242           },
15243           {
15244             "group": "Body",
15245             "type": "String",
15246             "optional": true,
15247             "field": "read1stAt",
15248             "description": ""
15249           },
15250           {
15251             "group": "Body",
15252             "type": "String",
15253             "optional": true,
15254             "field": "substatus",
15255             "description": ""
15256           },
15257           {
15258             "group": "Body",
15259             "type": "String",
15260             "optional": true,
15261             "field": "substatusAt",
15262             "description": ""
15263           },
15264           {
15265             "group": "Body",
15266             "type": "String",
15267             "allowedValues": [
15268               "\"in\"",
15269               "\"out\""
15270             ],
15271             "optional": false,
15272             "field": "firstMsgDirection",
15273             "description": ""
15274           },
15275           {
15276             "group": "Body",
15277             "type": "String",
15278             "optional": true,
15279             "field": "lastMsgAt",
15280             "description": ""
15281           },
15282           {
15283             "group": "Body",
15284             "type": "String",
15285             "allowedValues": [
15286               "\"in\"",
15287               "\"out\""
15288             ],
15289             "optional": false,
15290             "field": "lastMsgDirection",
15291             "description": ""
15292           },
15293           {
15294             "group": "Body",
15295             "type": "Text",
15296             "optional": true,
15297             "field": "lastMsgBody",
15298             "description": ""
15299           },
15300           {
15301             "group": "Body",
15302             "type": "Text",
15303             "optional": true,
15304             "field": "lastMsgText",
15305             "description": ""
15306           }
15307         ]
15308       }
15309     },
15310     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15311     "version": "0.0.0",
15312     "filename": "server/api/mailInteraction/index.js",
15313     "groupTitle": "Mail_Interactions"
15314   },
15315   {
15316     "type": "delete",
15317     "url": "/api/mail/interactions/{id}",
15318     "title": "Deletes a Interaction",
15319     "examples": [
15320       {
15321         "title": "Example usage:",
15322         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password} -X DELETE",
15323         "type": "json"
15324       }
15325     ],
15326     "name": "DeleteInteractions",
15327     "group": "Mail_Interactions",
15328     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15329     "version": "0.0.0",
15330     "filename": "server/api/mailInteraction/index.js",
15331     "groupTitle": "Mail_Interactions"
15332   },
15333   {
15334     "type": "get",
15335     "url": "/api/mail/interactions/describe",
15336     "title": "Gets table info about Interactions",
15337     "examples": [
15338       {
15339         "title": "Example usage:",
15340         "content": "curl https://{domain}/api/mail/interactions/describe -v -u {name}:{password}",
15341         "type": "json"
15342       }
15343     ],
15344     "name": "DescribeInteractions",
15345     "group": "Mail_Interactions",
15346     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15347     "version": "0.0.0",
15348     "filename": "server/api/mailInteraction/index.js",
15349     "groupTitle": "Mail_Interactions"
15350   },
15351   {
15352     "type": "get",
15353     "url": "/api/mail/interactions",
15354     "title": "Gets a list of Interactions",
15355     "examples": [
15356       {
15357         "title": "Example usage:",
15358         "content": "curl https://{domain}/api/mail/interactions -v -u {name}:{password}",
15359         "type": "json"
15360       }
15361     ],
15362     "name": "GetInteractions",
15363     "group": "Mail_Interactions",
15364     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15365     "version": "0.0.0",
15366     "filename": "server/api/mailInteraction/index.js",
15367     "groupTitle": "Mail_Interactions"
15368   },
15369   {
15370     "type": "delete",
15371     "url": "/api/mail/interactions/{id}/tags",
15372     "title": "Removes tags from interaction",
15373     "examples": [
15374       {
15375         "title": "Example usage:",
15376         "content": "curl https://{domain}/api/mail/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
15377         "type": "json"
15378       }
15379     ],
15380     "name": "RemoveTags",
15381     "group": "Mail_Interactions",
15382     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15383     "version": "0.0.0",
15384     "filename": "server/api/mailInteraction/index.js",
15385     "groupTitle": "Mail_Interactions"
15386   },
15387   {
15388     "type": "get",
15389     "url": "/api/mail/interactions/{id}",
15390     "title": "Gets a single Interaction",
15391     "examples": [
15392       {
15393         "title": "Example usage:",
15394         "content": "curl https://{domain}/api/mail/interactions/{id} -v -u {name}:{password}",
15395         "type": "json"
15396       }
15397     ],
15398     "name": "ShowInteractions",
15399     "group": "Mail_Interactions",
15400     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15401     "version": "0.0.0",
15402     "filename": "server/api/mailInteraction/index.js",
15403     "groupTitle": "Mail_Interactions"
15404   },
15405   {
15406     "type": "post",
15407     "url": "/api/mail/interactions/{id}/messages",
15408     "title": "Creates new message",
15409     "examples": [
15410       {
15411         "title": "Example usage:",
15412         "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",
15413         "type": "json"
15414       }
15415     ],
15416     "name": "addMessage",
15417     "group": "Mail_Interactions",
15418     "parameter": {
15419       "fields": {
15420         "Body": [
15421           {
15422             "group": "Body",
15423             "type": "Text",
15424             "optional": false,
15425             "field": "body",
15426             "description": ""
15427           },
15428           {
15429             "group": "Body",
15430             "type": "Text",
15431             "optional": true,
15432             "field": "plainBody",
15433             "description": ""
15434           },
15435           {
15436             "group": "Body",
15437             "type": "Boolean",
15438             "optional": true,
15439             "field": "read",
15440             "description": ""
15441           },
15442           {
15443             "group": "Body",
15444             "type": "String",
15445             "allowedValues": [
15446               "\"in\"",
15447               "\"out\""
15448             ],
15449             "optional": false,
15450             "field": "direction",
15451             "description": ""
15452           },
15453           {
15454             "group": "Body",
15455             "type": "String",
15456             "optional": true,
15457             "field": "messageId",
15458             "description": ""
15459           },
15460           {
15461             "group": "Body",
15462             "type": "String",
15463             "optional": true,
15464             "field": "from",
15465             "description": ""
15466           },
15467           {
15468             "group": "Body",
15469             "type": "Text",
15470             "optional": true,
15471             "field": "to",
15472             "description": ""
15473           },
15474           {
15475             "group": "Body",
15476             "type": "Text",
15477             "optional": true,
15478             "field": "cc",
15479             "description": ""
15480           },
15481           {
15482             "group": "Body",
15483             "type": "Text",
15484             "optional": true,
15485             "field": "bcc",
15486             "description": ""
15487           },
15488           {
15489             "group": "Body",
15490             "type": "Text",
15491             "optional": true,
15492             "field": "subject",
15493             "description": ""
15494           },
15495           {
15496             "group": "Body",
15497             "type": "String",
15498             "optional": true,
15499             "field": "sentAt",
15500             "description": ""
15501           },
15502           {
15503             "group": "Body",
15504             "type": "Integer",
15505             "optional": true,
15506             "field": "attach",
15507             "description": ""
15508           },
15509           {
15510             "group": "Body",
15511             "type": "Boolean",
15512             "optional": true,
15513             "field": "secret",
15514             "description": ""
15515           },
15516           {
15517             "group": "Body",
15518             "type": "String",
15519             "optional": true,
15520             "field": "readAt",
15521             "description": ""
15522           },
15523           {
15524             "group": "Body",
15525             "type": "Text",
15526             "optional": true,
15527             "field": "originTo",
15528             "description": ""
15529           },
15530           {
15531             "group": "Body",
15532             "type": "Text",
15533             "optional": true,
15534             "field": "originCc",
15535             "description": ""
15536           }
15537         ]
15538       }
15539     },
15540     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15541     "version": "0.0.0",
15542     "filename": "server/api/mailInteraction/index.js",
15543     "groupTitle": "Mail_Interactions"
15544   },
15545   {
15546     "type": "get",
15547     "url": "/api/mail/interactions/{id}/download",
15548     "title": "Gets interaction",
15549     "examples": [
15550       {
15551         "title": "Example usage:",
15552         "content": "curl https://{domain}/api/mail/interactions/{id}/download -v -u {name}:{password} -X GET",
15553         "type": "json"
15554       }
15555     ],
15556     "name": "download",
15557     "group": "Mail_Interactions",
15558     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15559     "version": "0.0.0",
15560     "filename": "server/api/mailInteraction/index.js",
15561     "groupTitle": "Mail_Interactions"
15562   },
15563   {
15564     "type": "get",
15565     "url": "/api/mail/interactions/{id}/messages",
15566     "title": "Gets interaction messages",
15567     "examples": [
15568       {
15569         "title": "Example usage:",
15570         "content": "curl https://{domain}/api/mail/interactions/{id}/messages -v -u {name}:{password} -X GET",
15571         "type": "json"
15572       }
15573     ],
15574     "name": "getMessages",
15575     "group": "Mail_Interactions",
15576     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15577     "version": "0.0.0",
15578     "filename": "server/api/mailInteraction/index.js",
15579     "groupTitle": "Mail_Interactions"
15580   },
15581   {
15582     "type": "put",
15583     "url": "/api/mail/interactions/{id}",
15584     "title": "Update an existing Interaction",
15585     "examples": [
15586       {
15587         "title": "Example usage:",
15588         "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",
15589         "type": "json"
15590       }
15591     ],
15592     "name": "updateInteractions",
15593     "group": "Mail_Interactions",
15594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15595     "version": "0.0.0",
15596     "filename": "server/api/mailInteraction/index.js",
15597     "groupTitle": "Mail_Interactions"
15598   },
15599   {
15600     "type": "delete",
15601     "url": "/api/mail/messages/{id}",
15602     "title": "Deletes a Message",
15603     "examples": [
15604       {
15605         "title": "Example usage:",
15606         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password} -X DELETE",
15607         "type": "json"
15608       }
15609     ],
15610     "name": "DeleteMessages",
15611     "group": "Mail_Messages",
15612     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15613     "version": "0.0.0",
15614     "filename": "server/api/mailMessage/index.js",
15615     "groupTitle": "Mail_Messages"
15616   },
15617   {
15618     "type": "get",
15619     "url": "/api/mail/messages/describe",
15620     "title": "Gets table info about Messages",
15621     "examples": [
15622       {
15623         "title": "Example usage:",
15624         "content": "curl https://{domain}/api/mail/messages/describe -v -u {name}:{password}",
15625         "type": "json"
15626       }
15627     ],
15628     "name": "DescribeMessages",
15629     "group": "Mail_Messages",
15630     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15631     "version": "0.0.0",
15632     "filename": "server/api/mailMessage/index.js",
15633     "groupTitle": "Mail_Messages"
15634   },
15635   {
15636     "type": "get",
15637     "url": "/api/mail/messages",
15638     "title": "Gets a list of Messages",
15639     "examples": [
15640       {
15641         "title": "Example usage:",
15642         "content": "curl https://{domain}/api/mail/messages -v -u {name}:{password}",
15643         "type": "json"
15644       }
15645     ],
15646     "name": "GetMessages",
15647     "group": "Mail_Messages",
15648     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15649     "version": "0.0.0",
15650     "filename": "server/api/mailMessage/index.js",
15651     "groupTitle": "Mail_Messages"
15652   },
15653   {
15654     "type": "get",
15655     "url": "/api/mail/messages/{id}",
15656     "title": "Gets a single Message",
15657     "examples": [
15658       {
15659         "title": "Example usage:",
15660         "content": "curl https://{domain}/api/mail/messages/{id} -v -u {name}:{password}",
15661         "type": "json"
15662       }
15663     ],
15664     "name": "ShowMessages",
15665     "group": "Mail_Messages",
15666     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15667     "version": "0.0.0",
15668     "filename": "server/api/mailMessage/index.js",
15669     "groupTitle": "Mail_Messages"
15670   },
15671   {
15672     "type": "put",
15673     "url": "/api/mail/messages/{id}/accept",
15674     "title": "Accepts message",
15675     "examples": [
15676       {
15677         "title": "Example usage:",
15678         "content": "curl https://{domain}/api/mail/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
15679         "type": "json"
15680       }
15681     ],
15682     "name": "acceptMessage",
15683     "group": "Mail_Messages",
15684     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15685     "version": "0.0.0",
15686     "filename": "server/api/mailMessage/index.js",
15687     "groupTitle": "Mail_Messages"
15688   },
15689   {
15690     "type": "post",
15691     "url": "/api/mail/messages",
15692     "title": "Create a message",
15693     "examples": [
15694       {
15695         "title": "Example usage:",
15696         "content": "curl https://{domain}/api/mail/messages \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
15697         "type": "json"
15698       }
15699     ],
15700     "name": "createMessage",
15701     "group": "Mail_Messages",
15702     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15703     "version": "0.0.0",
15704     "filename": "server/api/mailMessage/index.js",
15705     "groupTitle": "Mail_Messages"
15706   },
15707   {
15708     "type": "get",
15709     "url": "/api/mail/messages/{id}/download",
15710     "title": "Gets message",
15711     "examples": [
15712       {
15713         "title": "Example usage:",
15714         "content": "curl https://{domain}/api/mail/messages/{id}/download -v -u {name}:{password} -X GET",
15715         "type": "json"
15716       }
15717     ],
15718     "name": "download",
15719     "group": "Mail_Messages",
15720     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15721     "version": "0.0.0",
15722     "filename": "server/api/mailMessage/index.js",
15723     "groupTitle": "Mail_Messages"
15724   },
15725   {
15726     "type": "put",
15727     "url": "/api/mail/messages/{id}/reject",
15728     "title": "Rejects message",
15729     "examples": [
15730       {
15731         "title": "Example usage:",
15732         "content": "curl https://{domain}/api/mail/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
15733         "type": "json"
15734       }
15735     ],
15736     "name": "rejectMessage",
15737     "group": "Mail_Messages",
15738     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15739     "version": "0.0.0",
15740     "filename": "server/api/mailMessage/index.js",
15741     "groupTitle": "Mail_Messages"
15742   },
15743   {
15744     "type": "put",
15745     "url": "/api/mail/messages/{id}",
15746     "title": "Update an existing Message",
15747     "examples": [
15748       {
15749         "title": "Example usage:",
15750         "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",
15751         "type": "json"
15752       }
15753     ],
15754     "name": "updateMessages",
15755     "group": "Mail_Messages",
15756     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15757     "version": "0.0.0",
15758     "filename": "server/api/mailMessage/index.js",
15759     "groupTitle": "Mail_Messages"
15760   },
15761   {
15762     "type": "post",
15763     "url": "/api/mail/reports/queue",
15764     "title": "Creates a new Mail Queue Report",
15765     "examples": [
15766       {
15767         "title": "Example usage:",
15768         "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",
15769         "type": "json"
15770       }
15771     ],
15772     "name": "CreateMail_Queue_Reports",
15773     "group": "Mail_Queue_Reports",
15774     "parameter": {
15775       "fields": {
15776         "Body": [
15777           {
15778             "group": "Body",
15779             "type": "String",
15780             "optional": false,
15781             "field": "uniqueid",
15782             "description": ""
15783           },
15784           {
15785             "group": "Body",
15786             "type": "String",
15787             "optional": true,
15788             "field": "from",
15789             "description": ""
15790           },
15791           {
15792             "group": "Body",
15793             "type": "String",
15794             "optional": true,
15795             "field": "joinAt",
15796             "description": ""
15797           },
15798           {
15799             "group": "Body",
15800             "type": "String",
15801             "optional": true,
15802             "field": "leaveAt",
15803             "description": ""
15804           },
15805           {
15806             "group": "Body",
15807             "type": "String",
15808             "optional": true,
15809             "field": "acceptAt",
15810             "description": ""
15811           },
15812           {
15813             "group": "Body",
15814             "type": "String",
15815             "optional": true,
15816             "field": "exitAt",
15817             "description": ""
15818           },
15819           {
15820             "group": "Body",
15821             "type": "String",
15822             "optional": true,
15823             "field": "reason",
15824             "description": ""
15825           }
15826         ]
15827       }
15828     },
15829     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15830     "version": "0.0.0",
15831     "filename": "server/api/mailQueueReport/index.js",
15832     "groupTitle": "Mail_Queue_Reports"
15833   },
15834   {
15835     "type": "delete",
15836     "url": "/api/mail/reports/queue/{id}",
15837     "title": "Deletes a Mail Queue Report",
15838     "examples": [
15839       {
15840         "title": "Example usage:",
15841         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password} -X DELETE",
15842         "type": "json"
15843       }
15844     ],
15845     "name": "DeleteMail_Queue_Reports",
15846     "group": "Mail_Queue_Reports",
15847     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15848     "version": "0.0.0",
15849     "filename": "server/api/mailQueueReport/index.js",
15850     "groupTitle": "Mail_Queue_Reports"
15851   },
15852   {
15853     "type": "get",
15854     "url": "/api/mail/reports/queue/describe",
15855     "title": "Gets table info about Mail Queue Reports",
15856     "examples": [
15857       {
15858         "title": "Example usage:",
15859         "content": "curl https://{domain}/api/mail/reports/queue/describe -v -u {name}:{password}",
15860         "type": "json"
15861       }
15862     ],
15863     "name": "DescribeMail_Queue_Reports",
15864     "group": "Mail_Queue_Reports",
15865     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15866     "version": "0.0.0",
15867     "filename": "server/api/mailQueueReport/index.js",
15868     "groupTitle": "Mail_Queue_Reports"
15869   },
15870   {
15871     "type": "get",
15872     "url": "/api/mail/reports/queue",
15873     "title": "Gets a list of Mail Queue Reports",
15874     "examples": [
15875       {
15876         "title": "Example usage:",
15877         "content": "curl https://{domain}/api/mail/reports/queue -v -u {name}:{password}",
15878         "type": "json"
15879       }
15880     ],
15881     "name": "GetMail_Queue_Reports",
15882     "group": "Mail_Queue_Reports",
15883     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
15884     "version": "0.0.0",
15885     "filename": "server/api/mailQueueReport/index.js",
15886     "groupTitle": "Mail_Queue_Reports"
15887   },
15888   {
15889     "type": "get",
15890     "url": "/api/mail/reports/queue/{id}",
15891     "title": "Gets a single Mail Queue Report",
15892     "examples": [
15893       {
15894         "title": "Example usage:",
15895         "content": "curl https://{domain}/api/mail/reports/queue/{id} -v -u {name}:{password}",
15896         "type": "json"
15897       }
15898     ],
15899     "name": "ShowMail_Queue_Reports",
15900     "group": "Mail_Queue_Reports",
15901     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15902     "version": "0.0.0",
15903     "filename": "server/api/mailQueueReport/index.js",
15904     "groupTitle": "Mail_Queue_Reports"
15905   },
15906   {
15907     "type": "put",
15908     "url": "/api/mail/reports/queue/{id}",
15909     "title": "Update an existing Mail Queue Report",
15910     "examples": [
15911       {
15912         "title": "Example usage:",
15913         "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",
15914         "type": "json"
15915       }
15916     ],
15917     "name": "updateMail_Queue_Reports",
15918     "group": "Mail_Queue_Reports",
15919     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15920     "version": "0.0.0",
15921     "filename": "server/api/mailQueueReport/index.js",
15922     "groupTitle": "Mail_Queue_Reports"
15923   },
15924   {
15925     "type": "post",
15926     "url": "/api/mail/queues/{id}/users",
15927     "title": "Add agents to a queue",
15928     "examples": [
15929       {
15930         "title": "Example usage:",
15931         "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",
15932         "type": "json"
15933       }
15934     ],
15935     "name": "AddAgents",
15936     "group": "Mail_Queues",
15937     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15938     "version": "0.0.0",
15939     "filename": "server/api/mailQueue/index.js",
15940     "groupTitle": "Mail_Queues"
15941   },
15942   {
15943     "type": "post",
15944     "url": "/api/mail/queues/{id}/teams",
15945     "title": "Add teams to a queue",
15946     "examples": [
15947       {
15948         "title": "Example usage:",
15949         "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",
15950         "type": "json"
15951       }
15952     ],
15953     "name": "AddTeams",
15954     "group": "Mail_Queues",
15955     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
15956     "version": "0.0.0",
15957     "filename": "server/api/mailQueue/index.js",
15958     "groupTitle": "Mail_Queues"
15959   },
15960   {
15961     "type": "post",
15962     "url": "/api/mail/queues",
15963     "title": "Creates a new Queue",
15964     "examples": [
15965       {
15966         "title": "Example usage:",
15967         "content": "curl https://{domain}/api/mail/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
15968         "type": "json"
15969       }
15970     ],
15971     "name": "CreateQueues",
15972     "group": "Mail_Queues",
15973     "parameter": {
15974       "fields": {
15975         "Body": [
15976           {
15977             "group": "Body",
15978             "type": "String",
15979             "optional": true,
15980             "field": "name",
15981             "description": ""
15982           },
15983           {
15984             "group": "Body",
15985             "type": "String",
15986             "optional": true,
15987             "field": "description",
15988             "description": ""
15989           },
15990           {
15991             "group": "Body",
15992             "type": "Integer",
15993             "optional": true,
15994             "field": "timeout",
15995             "description": ""
15996           },
15997           {
15998             "group": "Body",
15999             "type": "String",
16000             "allowedValues": [
16001               "\"rrmemory\"",
16002               "\"beepall\"",
16003               "\"roundrobin\""
16004             ],
16005             "optional": true,
16006             "field": "strategy",
16007             "description": ""
16008           }
16009         ]
16010       }
16011     },
16012     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16013     "version": "0.0.0",
16014     "filename": "server/api/mailQueue/index.js",
16015     "groupTitle": "Mail_Queues"
16016   },
16017   {
16018     "type": "delete",
16019     "url": "/api/mail/queues/{id}",
16020     "title": "Deletes a Queue",
16021     "examples": [
16022       {
16023         "title": "Example usage:",
16024         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password} -X DELETE",
16025         "type": "json"
16026       }
16027     ],
16028     "name": "DeleteQueues",
16029     "group": "Mail_Queues",
16030     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16031     "version": "0.0.0",
16032     "filename": "server/api/mailQueue/index.js",
16033     "groupTitle": "Mail_Queues"
16034   },
16035   {
16036     "type": "get",
16037     "url": "/api/mail/queues/describe",
16038     "title": "Gets table info about Queues",
16039     "examples": [
16040       {
16041         "title": "Example usage:",
16042         "content": "curl https://{domain}/api/mail/queues/describe -v -u {name}:{password}",
16043         "type": "json"
16044       }
16045     ],
16046     "name": "DescribeQueues",
16047     "group": "Mail_Queues",
16048     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16049     "version": "0.0.0",
16050     "filename": "server/api/mailQueue/index.js",
16051     "groupTitle": "Mail_Queues"
16052   },
16053   {
16054     "type": "get",
16055     "url": "/api/mail/queues/{id}/users",
16056     "title": "Gets queue agents",
16057     "examples": [
16058       {
16059         "title": "Example usage:",
16060         "content": "curl https://{domain}/api/mail/queues/{id}/users -v -u {name}:{password} -X POST",
16061         "type": "json"
16062       }
16063     ],
16064     "name": "GetAgents",
16065     "group": "Mail_Queues",
16066     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16067     "version": "0.0.0",
16068     "filename": "server/api/mailQueue/index.js",
16069     "groupTitle": "Mail_Queues"
16070   },
16071   {
16072     "type": "get",
16073     "url": "/api/mail/queues/{id}/members",
16074     "title": "GetMembers",
16075     "examples": [
16076       {
16077         "title": "Example usage:",
16078         "content": "curl https://{domain}/api/mail/queues/{id}/members  -v -u {name}:{password}",
16079         "type": "json"
16080       }
16081     ],
16082     "name": "GetMembers",
16083     "group": "Mail_Queues",
16084     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16085     "version": "0.0.0",
16086     "filename": "server/api/mailQueue/index.js",
16087     "groupTitle": "Mail_Queues"
16088   },
16089   {
16090     "type": "get",
16091     "url": "/api/mail/queues",
16092     "title": "Gets a list of Queues",
16093     "examples": [
16094       {
16095         "title": "Example usage:",
16096         "content": "curl https://{domain}/api/mail/queues -v -u {name}:{password}",
16097         "type": "json"
16098       }
16099     ],
16100     "name": "GetQueues",
16101     "group": "Mail_Queues",
16102     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16103     "version": "0.0.0",
16104     "filename": "server/api/mailQueue/index.js",
16105     "groupTitle": "Mail_Queues"
16106   },
16107   {
16108     "type": "get",
16109     "url": "/api/mail/queues/{id}/teams",
16110     "title": "Gets queues list",
16111     "examples": [
16112       {
16113         "title": "Example usage:",
16114         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password}",
16115         "type": "json"
16116       }
16117     ],
16118     "name": "GetTeams",
16119     "group": "Mail_Queues",
16120     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16121     "version": "0.0.0",
16122     "filename": "server/api/mailQueue/index.js",
16123     "groupTitle": "Mail_Queues"
16124   },
16125   {
16126     "type": "delete",
16127     "url": "/api/mail/queues/{id}/users",
16128     "title": "Removes agents from a queue",
16129     "examples": [
16130       {
16131         "title": "Example usage:",
16132         "content": "curl https://{domain}/api/mail/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16133         "type": "json"
16134       }
16135     ],
16136     "name": "RemoveAgents",
16137     "group": "Mail_Queues",
16138     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16139     "version": "0.0.0",
16140     "filename": "server/api/mailQueue/index.js",
16141     "groupTitle": "Mail_Queues"
16142   },
16143   {
16144     "type": "get",
16145     "url": "/api/mail/queues/{id}",
16146     "title": "Gets a single Queue",
16147     "examples": [
16148       {
16149         "title": "Example usage:",
16150         "content": "curl https://{domain}/api/mail/queues/{id} -v -u {name}:{password}",
16151         "type": "json"
16152       }
16153     ],
16154     "name": "ShowQueues",
16155     "group": "Mail_Queues",
16156     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16157     "version": "0.0.0",
16158     "filename": "server/api/mailQueue/index.js",
16159     "groupTitle": "Mail_Queues"
16160   },
16161   {
16162     "type": "put",
16163     "url": "/api/mail/queues/{id}",
16164     "title": "Update an existing Queue",
16165     "examples": [
16166       {
16167         "title": "Example usage:",
16168         "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",
16169         "type": "json"
16170       }
16171     ],
16172     "name": "updateQueues",
16173     "group": "Mail_Queues",
16174     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16175     "version": "0.0.0",
16176     "filename": "server/api/mailQueue/index.js",
16177     "groupTitle": "Mail_Queues"
16178   },
16179   {
16180     "type": "post",
16181     "url": "/api/mail/out_servers",
16182     "title": "Creates a new SMTP",
16183     "examples": [
16184       {
16185         "title": "Example usage:",
16186         "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",
16187         "type": "json"
16188       }
16189     ],
16190     "name": "CreateSMTPs",
16191     "group": "Mail_SMTP",
16192     "parameter": {
16193       "fields": {
16194         "Body": [
16195           {
16196             "group": "Body",
16197             "type": "String",
16198             "optional": true,
16199             "field": "description",
16200             "description": ""
16201           },
16202           {
16203             "group": "Body",
16204             "type": "String",
16205             "optional": true,
16206             "field": "host",
16207             "description": ""
16208           },
16209           {
16210             "group": "Body",
16211             "type": "String",
16212             "optional": true,
16213             "field": "user",
16214             "description": ""
16215           },
16216           {
16217             "group": "Body",
16218             "type": "String",
16219             "optional": true,
16220             "field": "pass",
16221             "description": ""
16222           },
16223           {
16224             "group": "Body",
16225             "type": "Integer",
16226             "optional": true,
16227             "field": "port",
16228             "description": ""
16229           },
16230           {
16231             "group": "Body",
16232             "type": "Boolean",
16233             "optional": true,
16234             "field": "secure",
16235             "description": ""
16236           },
16237           {
16238             "group": "Body",
16239             "type": "String",
16240             "optional": true,
16241             "field": "service",
16242             "description": ""
16243           },
16244           {
16245             "group": "Body",
16246             "type": "Boolean",
16247             "optional": true,
16248             "field": "authentication",
16249             "description": ""
16250           }
16251         ]
16252       }
16253     },
16254     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16255     "version": "0.0.0",
16256     "filename": "server/api/mailServerOut/index.js",
16257     "groupTitle": "Mail_SMTP"
16258   },
16259   {
16260     "type": "delete",
16261     "url": "/api/mail/out_servers/{id}",
16262     "title": "Deletes a SMTP",
16263     "examples": [
16264       {
16265         "title": "Example usage:",
16266         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password} -X DELETE",
16267         "type": "json"
16268       }
16269     ],
16270     "name": "DeleteSMTPs",
16271     "group": "Mail_SMTP",
16272     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16273     "version": "0.0.0",
16274     "filename": "server/api/mailServerOut/index.js",
16275     "groupTitle": "Mail_SMTP"
16276   },
16277   {
16278     "type": "get",
16279     "url": "/api/mail/out_servers",
16280     "title": "Gets a list of SMTPs",
16281     "examples": [
16282       {
16283         "title": "Example usage:",
16284         "content": "curl https://{domain}/api/mail/out_servers -v -u {name}:{password}",
16285         "type": "json"
16286       }
16287     ],
16288     "name": "GetSMTPs",
16289     "group": "Mail_SMTP",
16290     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16291     "version": "0.0.0",
16292     "filename": "server/api/mailServerOut/index.js",
16293     "groupTitle": "Mail_SMTP"
16294   },
16295   {
16296     "type": "get",
16297     "url": "/api/mail/out_servers/{id}",
16298     "title": "Gets a single SMTP",
16299     "examples": [
16300       {
16301         "title": "Example usage:",
16302         "content": "curl https://{domain}/api/mail/out_servers/{id} -v -u {name}:{password}",
16303         "type": "json"
16304       }
16305     ],
16306     "name": "ShowSMTPs",
16307     "group": "Mail_SMTP",
16308     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16309     "version": "0.0.0",
16310     "filename": "server/api/mailServerOut/index.js",
16311     "groupTitle": "Mail_SMTP"
16312   },
16313   {
16314     "type": "put",
16315     "url": "/api/mail/out_servers/{id}",
16316     "title": "Update an existing SMTP",
16317     "examples": [
16318       {
16319         "title": "Example usage:",
16320         "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",
16321         "type": "json"
16322       }
16323     ],
16324     "name": "updateSMTPs",
16325     "group": "Mail_SMTP",
16326     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16327     "version": "0.0.0",
16328     "filename": "server/api/mailServerOut/index.js",
16329     "groupTitle": "Mail_SMTP"
16330   },
16331   {
16332     "type": "post",
16333     "url": "/api/mail/substatuses",
16334     "title": "Creates a new Queue",
16335     "examples": [
16336       {
16337         "title": "Example usage:",
16338         "content": "curl https://{domain}/api/mail/substatuses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16339         "type": "json"
16340       }
16341     ],
16342     "name": "CreateSubstatuses",
16343     "group": "Mail_Substatuses",
16344     "parameter": {
16345       "fields": {
16346         "Body": [
16347           {
16348             "group": "Body",
16349             "type": "String",
16350             "optional": false,
16351             "field": "name",
16352             "description": ""
16353           },
16354           {
16355             "group": "Body",
16356             "type": "String",
16357             "optional": true,
16358             "field": "description",
16359             "description": ""
16360           }
16361         ]
16362       }
16363     },
16364     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16365     "version": "0.0.0",
16366     "filename": "server/api/mailSubstatus/index.js",
16367     "groupTitle": "Mail_Substatuses"
16368   },
16369   {
16370     "type": "delete",
16371     "url": "/api/mail/substatuses/{id}",
16372     "title": "Deletes a Queue",
16373     "examples": [
16374       {
16375         "title": "Example usage:",
16376         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password} -X DELETE",
16377         "type": "json"
16378       }
16379     ],
16380     "name": "DeleteSubstatuses",
16381     "group": "Mail_Substatuses",
16382     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16383     "version": "0.0.0",
16384     "filename": "server/api/mailSubstatus/index.js",
16385     "groupTitle": "Mail_Substatuses"
16386   },
16387   {
16388     "type": "get",
16389     "url": "/api/mail/substatuses/describe",
16390     "title": "Gets table info about Substatuses",
16391     "examples": [
16392       {
16393         "title": "Example usage:",
16394         "content": "curl https://{domain}/api/mail/substatuses/describe -v -u {name}:{password}",
16395         "type": "json"
16396       }
16397     ],
16398     "name": "DescribeSubstatuses",
16399     "group": "Mail_Substatuses",
16400     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16401     "version": "0.0.0",
16402     "filename": "server/api/mailSubstatus/index.js",
16403     "groupTitle": "Mail_Substatuses"
16404   },
16405   {
16406     "type": "get",
16407     "url": "/api/mail/substatuses",
16408     "title": "Gets a list of Substatuses",
16409     "examples": [
16410       {
16411         "title": "Example usage:",
16412         "content": "curl https://{domain}/api/mail/substatuses -v -u {name}:{password}",
16413         "type": "json"
16414       }
16415     ],
16416     "name": "GetSubstatuses",
16417     "group": "Mail_Substatuses",
16418     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16419     "version": "0.0.0",
16420     "filename": "server/api/mailSubstatus/index.js",
16421     "groupTitle": "Mail_Substatuses"
16422   },
16423   {
16424     "type": "get",
16425     "url": "/api/mail/substatuses/{id}",
16426     "title": "Gets a single Queue",
16427     "examples": [
16428       {
16429         "title": "Example usage:",
16430         "content": "curl https://{domain}/api/mail/substatuses/{id} -v -u {name}:{password}",
16431         "type": "json"
16432       }
16433     ],
16434     "name": "ShowSubstatuses",
16435     "group": "Mail_Substatuses",
16436     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16437     "version": "0.0.0",
16438     "filename": "server/api/mailSubstatus/index.js",
16439     "groupTitle": "Mail_Substatuses"
16440   },
16441   {
16442     "type": "put",
16443     "url": "/api/mail/substatuses/{id}",
16444     "title": "Update an existing Queue",
16445     "examples": [
16446       {
16447         "title": "Example usage:",
16448         "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",
16449         "type": "json"
16450       }
16451     ],
16452     "name": "updateSubstatuses",
16453     "group": "Mail_Substatuses",
16454     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16455     "version": "0.0.0",
16456     "filename": "server/api/mailSubstatus/index.js",
16457     "groupTitle": "Mail_Substatuses"
16458   },
16459   {
16460     "type": "post",
16461     "url": "/api/mail/reports/transfer",
16462     "title": "Creates a new Mail Transfer Report",
16463     "examples": [
16464       {
16465         "title": "Example usage:",
16466         "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",
16467         "type": "json"
16468       }
16469     ],
16470     "name": "CreateMail_Transfer_Reports",
16471     "group": "Mail_Transfer_Reports",
16472     "parameter": {
16473       "fields": {
16474         "Body": [
16475           {
16476             "group": "Body",
16477             "type": "String",
16478             "optional": false,
16479             "field": "uniqueid",
16480             "description": ""
16481           },
16482           {
16483             "group": "Body",
16484             "type": "String",
16485             "allowedValues": [
16486               "\"account\"",
16487               "\"agent\"",
16488               "\"queue\""
16489             ],
16490             "optional": false,
16491             "field": "type",
16492             "description": ""
16493           },
16494           {
16495             "group": "Body",
16496             "type": "String",
16497             "optional": false,
16498             "field": "transferredAt",
16499             "description": ""
16500           }
16501         ]
16502       }
16503     },
16504     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16505     "version": "0.0.0",
16506     "filename": "server/api/mailTransferReport/index.js",
16507     "groupTitle": "Mail_Transfer_Reports"
16508   },
16509   {
16510     "type": "delete",
16511     "url": "/api/mail/reports/transfer/{id}",
16512     "title": "Deletes a Mail Transfer Report",
16513     "examples": [
16514       {
16515         "title": "Example usage:",
16516         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
16517         "type": "json"
16518       }
16519     ],
16520     "name": "DeleteMail_Transfer_Reports",
16521     "group": "Mail_Transfer_Reports",
16522     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16523     "version": "0.0.0",
16524     "filename": "server/api/mailTransferReport/index.js",
16525     "groupTitle": "Mail_Transfer_Reports"
16526   },
16527   {
16528     "type": "get",
16529     "url": "/api/mail/reports/transfer/describe",
16530     "title": "Gets table info about Mail Transfer Reports",
16531     "examples": [
16532       {
16533         "title": "Example usage:",
16534         "content": "curl https://{domain}/api/mail/reports/transfer/describe -v -u {name}:{password}",
16535         "type": "json"
16536       }
16537     ],
16538     "name": "DescribeMail_Transfer_Reports",
16539     "group": "Mail_Transfer_Reports",
16540     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16541     "version": "0.0.0",
16542     "filename": "server/api/mailTransferReport/index.js",
16543     "groupTitle": "Mail_Transfer_Reports"
16544   },
16545   {
16546     "type": "get",
16547     "url": "/api/mail/reports/transfer",
16548     "title": "Gets a list of Mail Transfer Reports",
16549     "examples": [
16550       {
16551         "title": "Example usage:",
16552         "content": "curl https://{domain}/api/mail/reports/transfer -v -u {name}:{password}",
16553         "type": "json"
16554       }
16555     ],
16556     "name": "GetMail_Transfer_Reports",
16557     "group": "Mail_Transfer_Reports",
16558     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16559     "version": "0.0.0",
16560     "filename": "server/api/mailTransferReport/index.js",
16561     "groupTitle": "Mail_Transfer_Reports"
16562   },
16563   {
16564     "type": "get",
16565     "url": "/api/mail/reports/transfer/{id}",
16566     "title": "Gets a single Mail Transfer Report",
16567     "examples": [
16568       {
16569         "title": "Example usage:",
16570         "content": "curl https://{domain}/api/mail/reports/transfer/{id} -v -u {name}:{password}",
16571         "type": "json"
16572       }
16573     ],
16574     "name": "ShowMail_Transfer_Reports",
16575     "group": "Mail_Transfer_Reports",
16576     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16577     "version": "0.0.0",
16578     "filename": "server/api/mailTransferReport/index.js",
16579     "groupTitle": "Mail_Transfer_Reports"
16580   },
16581   {
16582     "type": "put",
16583     "url": "/api/mail/reports/transfer/{id}",
16584     "title": "Update an existing Mail Transfer Report",
16585     "examples": [
16586       {
16587         "title": "Example usage:",
16588         "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",
16589         "type": "json"
16590       }
16591     ],
16592     "name": "updateMail_Transfer_Reports",
16593     "group": "Mail_Transfer_Reports",
16594     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16595     "version": "0.0.0",
16596     "filename": "server/api/mailTransferReport/index.js",
16597     "groupTitle": "Mail_Transfer_Reports"
16598   },
16599   {
16600     "type": "get",
16601     "url": "/api/members/reports/describe",
16602     "title": "Gets table info about Member Reports",
16603     "examples": [
16604       {
16605         "title": "Example usage:",
16606         "content": "curl https://{domain}/api/members/reports/describe -v -u {name}:{password}",
16607         "type": "json"
16608       }
16609     ],
16610     "name": "DescribeMember_Reports",
16611     "group": "Member_Reports",
16612     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16613     "version": "0.0.0",
16614     "filename": "server/api/memberReport/index.js",
16615     "groupTitle": "Member_Reports"
16616   },
16617   {
16618     "type": "get",
16619     "url": "/api/members/reports",
16620     "title": "Gets a list of Member Reports",
16621     "examples": [
16622       {
16623         "title": "Example usage:",
16624         "content": "curl https://{domain}/api/members/reports -v -u {name}:{password}",
16625         "type": "json"
16626       }
16627     ],
16628     "name": "GetMember_Reports",
16629     "group": "Member_Reports",
16630     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16631     "version": "0.0.0",
16632     "filename": "server/api/memberReport/index.js",
16633     "groupTitle": "Member_Reports"
16634   },
16635   {
16636     "type": "get",
16637     "url": "/api/members/reports/{id}",
16638     "title": "Gets a single Member Report",
16639     "examples": [
16640       {
16641         "title": "Example usage:",
16642         "content": "curl https://{domain}/api/members/reports/{id} -v -u {name}:{password}",
16643         "type": "json"
16644       }
16645     ],
16646     "name": "ShowMember_Reports",
16647     "group": "Member_Reports",
16648     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16649     "version": "0.0.0",
16650     "filename": "server/api/memberReport/index.js",
16651     "groupTitle": "Member_Reports"
16652   },
16653   {
16654     "type": "get",
16655     "url": "/api/migrations",
16656     "title": "Gets a list of Migrations",
16657     "examples": [
16658       {
16659         "title": "Example usage:",
16660         "content": "curl https://{domain}/api/migrations -v -u {name}:{password}",
16661         "type": "json"
16662       }
16663     ],
16664     "name": "GetMigrations",
16665     "group": "Migrations",
16666     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16667     "version": "0.0.0",
16668     "filename": "server/api/migration/index.js",
16669     "groupTitle": "Migrations"
16670   },
16671   {
16672     "type": "post",
16673     "url": "/api/voice/networks",
16674     "title": "Create a new network",
16675     "examples": [
16676       {
16677         "title": "Example usage:",
16678         "content": "curl https://{domain}/api/voice/networks -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
16679         "type": "json"
16680       }
16681     ],
16682     "name": "Create",
16683     "group": "Networks",
16684     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16685     "version": "0.0.0",
16686     "filename": "server/api/network/index.js",
16687     "groupTitle": "Networks"
16688   },
16689   {
16690     "type": "delete",
16691     "url": "/api/voice/networks/{id}",
16692     "title": "Deletes a network",
16693     "examples": [
16694       {
16695         "title": "Example usage:",
16696         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X DELETE",
16697         "type": "json"
16698       }
16699     ],
16700     "name": "Delete",
16701     "group": "Networks",
16702     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16703     "version": "0.0.0",
16704     "filename": "server/api/network/index.js",
16705     "groupTitle": "Networks"
16706   },
16707   {
16708     "type": "get",
16709     "url": "/api/networks",
16710     "title": "Gets a list of Networks",
16711     "examples": [
16712       {
16713         "title": "Example usage:",
16714         "content": "curl https://{domain}/api/networks -v -u {name}:{password}",
16715         "type": "json"
16716       }
16717     ],
16718     "name": "GetNetworks",
16719     "group": "Networks",
16720     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16721     "version": "0.0.0",
16722     "filename": "server/api/network/index.js",
16723     "groupTitle": "Networks"
16724   },
16725   {
16726     "type": "get",
16727     "url": "/api/networks/{id}",
16728     "title": "Gets a single Network",
16729     "examples": [
16730       {
16731         "title": "Example usage:",
16732         "content": "curl https://{domain}/api/networks/{id} -v -u {name}:{password}",
16733         "type": "json"
16734       }
16735     ],
16736     "name": "ShowNetworks",
16737     "group": "Networks",
16738     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16739     "version": "0.0.0",
16740     "filename": "server/api/network/index.js",
16741     "groupTitle": "Networks"
16742   },
16743   {
16744     "type": "put",
16745     "url": "/api/voice/networks/{id}",
16746     "title": "Update an existing network",
16747     "examples": [
16748       {
16749         "title": "Example usage:",
16750         "content": "curl https://{domain}/api/voice/networks/{id} -v -u {name}:{password} -X PUT",
16751         "type": "json"
16752       }
16753     ],
16754     "name": "Update",
16755     "group": "Networks",
16756     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16757     "version": "0.0.0",
16758     "filename": "server/api/network/index.js",
16759     "groupTitle": "Networks"
16760   },
16761   {
16762     "type": "post",
16763     "url": "/api/openchannel/accounts/{id}/users",
16764     "title": "Add agents to a openchannel account",
16765     "examples": [
16766       {
16767         "title": "Example usage:",
16768         "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",
16769         "type": "json"
16770       }
16771     ],
16772     "name": "AddAgents",
16773     "group": "Openchannel_Accounts",
16774     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16775     "version": "0.0.0",
16776     "filename": "server/api/openchannelAccount/index.js",
16777     "groupTitle": "Openchannel_Accounts"
16778   },
16779   {
16780     "type": "post",
16781     "url": "/api/openchannel/accounts",
16782     "title": "Creates a new Account",
16783     "examples": [
16784       {
16785         "title": "Example usage:",
16786         "content": "curl https://{domain}/api/openchannel/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
16787         "type": "json"
16788       }
16789     ],
16790     "name": "CreateAccounts",
16791     "group": "Openchannel_Accounts",
16792     "parameter": {
16793       "fields": {
16794         "Body": [
16795           {
16796             "group": "Body",
16797             "type": "String",
16798             "optional": false,
16799             "field": "name",
16800             "description": ""
16801           },
16802           {
16803             "group": "Body",
16804             "type": "String",
16805             "optional": true,
16806             "field": "description",
16807             "description": ""
16808           },
16809           {
16810             "group": "Body",
16811             "type": "String",
16812             "optional": true,
16813             "field": "token",
16814             "description": ""
16815           },
16816           {
16817             "group": "Body",
16818             "type": "String",
16819             "optional": true,
16820             "field": "replyUri",
16821             "description": ""
16822           },
16823           {
16824             "group": "Body",
16825             "type": "String",
16826             "optional": false,
16827             "field": "key",
16828             "description": ""
16829           },
16830           {
16831             "group": "Body",
16832             "type": "Text",
16833             "optional": true,
16834             "field": "notificationTemplate",
16835             "description": ""
16836           },
16837           {
16838             "group": "Body",
16839             "type": "Boolean",
16840             "optional": true,
16841             "field": "notificationSound",
16842             "description": ""
16843           },
16844           {
16845             "group": "Body",
16846             "type": "Boolean",
16847             "optional": true,
16848             "field": "notificationShake",
16849             "description": ""
16850           },
16851           {
16852             "group": "Body",
16853             "type": "Integer",
16854             "optional": true,
16855             "field": "waitForTheAssignedAgent",
16856             "description": ""
16857           },
16858           {
16859             "group": "Body",
16860             "type": "String",
16861             "optional": true,
16862             "field": "mapKey",
16863             "description": ""
16864           },
16865           {
16866             "group": "Body",
16867             "type": "Boolean",
16868             "optional": true,
16869             "field": "queueTransfer",
16870             "description": ""
16871           },
16872           {
16873             "group": "Body",
16874             "type": "Integer",
16875             "optional": true,
16876             "field": "queueTransferTimeout",
16877             "description": ""
16878           },
16879           {
16880             "group": "Body",
16881             "type": "Boolean",
16882             "optional": true,
16883             "field": "agentTransfer",
16884             "description": ""
16885           },
16886           {
16887             "group": "Body",
16888             "type": "Integer",
16889             "optional": true,
16890             "field": "agentTransferTimeout",
16891             "description": ""
16892           },
16893           {
16894             "group": "Body",
16895             "type": "Integer",
16896             "optional": true,
16897             "field": "mandatoryDispositionPauseId",
16898             "description": "<p>Status to put when mandatory disposition is enabled</p>"
16899           },
16900           {
16901             "group": "Body",
16902             "type": "Boolean",
16903             "optional": true,
16904             "field": "mandatoryDisposition",
16905             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
16906           }
16907         ]
16908       }
16909     },
16910     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16911     "version": "0.0.0",
16912     "filename": "server/api/openchannelAccount/index.js",
16913     "groupTitle": "Openchannel_Accounts"
16914   },
16915   {
16916     "type": "delete",
16917     "url": "/api/openchannel/accounts/{id}",
16918     "title": "Deletes a Account",
16919     "examples": [
16920       {
16921         "title": "Example usage:",
16922         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password} -X DELETE",
16923         "type": "json"
16924       }
16925     ],
16926     "name": "DeleteAccounts",
16927     "group": "Openchannel_Accounts",
16928     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16929     "version": "0.0.0",
16930     "filename": "server/api/openchannelAccount/index.js",
16931     "groupTitle": "Openchannel_Accounts"
16932   },
16933   {
16934     "type": "get",
16935     "url": "/api/openchannel/accounts/describe",
16936     "title": "Gets table info about Accounts",
16937     "examples": [
16938       {
16939         "title": "Example usage:",
16940         "content": "curl https://{domain}/api/openchannel/accounts/describe -v -u {name}:{password}",
16941         "type": "json"
16942       }
16943     ],
16944     "name": "DescribeAccounts",
16945     "group": "Openchannel_Accounts",
16946     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16947     "version": "0.0.0",
16948     "filename": "server/api/openchannelAccount/index.js",
16949     "groupTitle": "Openchannel_Accounts"
16950   },
16951   {
16952     "type": "get",
16953     "url": "/api/openchannel/accounts",
16954     "title": "Gets a list of Accounts",
16955     "examples": [
16956       {
16957         "title": "Example usage:",
16958         "content": "curl https://{domain}/api/openchannel/accounts -v -u {name}:{password}",
16959         "type": "json"
16960       }
16961     ],
16962     "name": "GetAccounts",
16963     "group": "Openchannel_Accounts",
16964     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
16965     "version": "0.0.0",
16966     "filename": "server/api/openchannelAccount/index.js",
16967     "groupTitle": "Openchannel_Accounts"
16968   },
16969   {
16970     "type": "get",
16971     "url": "/api/openchannel/accounts/{id}/users",
16972     "title": "Gets agents from openchannel account",
16973     "examples": [
16974       {
16975         "title": "Example usage:",
16976         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users -v -u {name}:{password} -X GET",
16977         "type": "json"
16978       }
16979     ],
16980     "name": "GetAgents",
16981     "group": "Openchannel_Accounts",
16982     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
16983     "version": "0.0.0",
16984     "filename": "server/api/openchannelAccount/index.js",
16985     "groupTitle": "Openchannel_Accounts"
16986   },
16987   {
16988     "type": "delete",
16989     "url": "/api/openchannel/accounts/{id}/users",
16990     "title": "Removes agents from a openchannel account",
16991     "examples": [
16992       {
16993         "title": "Example usage:",
16994         "content": "curl https://{domain}/api/openchannel/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
16995         "type": "json"
16996       }
16997     ],
16998     "name": "RemoveAgents",
16999     "group": "Openchannel_Accounts",
17000     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17001     "version": "0.0.0",
17002     "filename": "server/api/openchannelAccount/index.js",
17003     "groupTitle": "Openchannel_Accounts"
17004   },
17005   {
17006     "type": "delete",
17007     "url": "/api/openchannel/accounts/{id}/canned_answers",
17008     "title": "Removes canned answers from account",
17009     "examples": [
17010       {
17011         "title": "Example usage:",
17012         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17013         "type": "json"
17014       }
17015     ],
17016     "name": "RemoveAnswers",
17017     "group": "Openchannel_Accounts",
17018     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17019     "version": "0.0.0",
17020     "filename": "server/api/openchannelAccount/index.js",
17021     "groupTitle": "Openchannel_Accounts"
17022   },
17023   {
17024     "type": "delete",
17025     "url": "/api/openchannel/accounts/{id}/dispositions",
17026     "title": "Removes dispositions from account",
17027     "examples": [
17028       {
17029         "title": "Example usage:",
17030         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17031         "type": "json"
17032       }
17033     ],
17034     "name": "RemoveDispositions",
17035     "group": "Openchannel_Accounts",
17036     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17037     "version": "0.0.0",
17038     "filename": "server/api/openchannelAccount/index.js",
17039     "groupTitle": "Openchannel_Accounts"
17040   },
17041   {
17042     "type": "get",
17043     "url": "/api/openchannel/accounts/{id}",
17044     "title": "Gets a single Account",
17045     "examples": [
17046       {
17047         "title": "Example usage:",
17048         "content": "curl https://{domain}/api/openchannel/accounts/{id} -v -u {name}:{password}",
17049         "type": "json"
17050       }
17051     ],
17052     "name": "ShowAccounts",
17053     "group": "Openchannel_Accounts",
17054     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17055     "version": "0.0.0",
17056     "filename": "server/api/openchannelAccount/index.js",
17057     "groupTitle": "Openchannel_Accounts"
17058   },
17059   {
17060     "type": "post",
17061     "url": "/api/openchannel/accounts/{id}/canned_answers",
17062     "title": "Creates new canned answer",
17063     "examples": [
17064       {
17065         "title": "Example usage:",
17066         "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",
17067         "type": "json"
17068       }
17069     ],
17070     "name": "addAnswer",
17071     "group": "Openchannel_Accounts",
17072     "parameter": {
17073       "fields": {
17074         "Body": [
17075           {
17076             "group": "Body",
17077             "type": "String",
17078             "optional": false,
17079             "field": "key",
17080             "description": ""
17081           },
17082           {
17083             "group": "Body",
17084             "type": "Text",
17085             "optional": false,
17086             "field": "value",
17087             "description": ""
17088           },
17089           {
17090             "group": "Body",
17091             "type": "String",
17092             "optional": true,
17093             "field": "description",
17094             "description": ""
17095           },
17096           {
17097             "group": "Body",
17098             "type": "Virtual",
17099             "optional": true,
17100             "field": "name",
17101             "description": ""
17102           }
17103         ]
17104       }
17105     },
17106     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17107     "version": "0.0.0",
17108     "filename": "server/api/openchannelAccount/index.js",
17109     "groupTitle": "Openchannel_Accounts"
17110   },
17111   {
17112     "type": "post",
17113     "url": "/api/openchannel/accounts/{id}/applications",
17114     "title": "Creates new applications",
17115     "examples": [
17116       {
17117         "title": "Example usage:",
17118         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17119         "type": "json"
17120       }
17121     ],
17122     "name": "addApplications",
17123     "group": "Openchannel_Accounts",
17124     "parameter": {
17125       "fields": {
17126         "Body": [
17127           {
17128             "group": "Body",
17129             "type": "Integer",
17130             "optional": false,
17131             "field": "priority",
17132             "description": ""
17133           },
17134           {
17135             "group": "Body",
17136             "type": "String",
17137             "optional": false,
17138             "field": "app",
17139             "description": ""
17140           },
17141           {
17142             "group": "Body",
17143             "type": "Text",
17144             "optional": true,
17145             "field": "appdata",
17146             "description": ""
17147           },
17148           {
17149             "group": "Body",
17150             "type": "String",
17151             "optional": true,
17152             "field": "description",
17153             "description": ""
17154           },
17155           {
17156             "group": "Body",
17157             "type": "String",
17158             "optional": true,
17159             "field": "interval",
17160             "description": ""
17161           }
17162         ]
17163       }
17164     },
17165     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17166     "version": "0.0.0",
17167     "filename": "server/api/openchannelAccount/index.js",
17168     "groupTitle": "Openchannel_Accounts"
17169   },
17170   {
17171     "type": "post",
17172     "url": "/api/openchannel/accounts/{id}/dispositions",
17173     "title": "Creates new disposition",
17174     "examples": [
17175       {
17176         "title": "Example usage:",
17177         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17178         "type": "json"
17179       }
17180     ],
17181     "name": "addDisposition",
17182     "group": "Openchannel_Accounts",
17183     "parameter": {
17184       "fields": {
17185         "Body": [
17186           {
17187             "group": "Body",
17188             "type": "String",
17189             "optional": false,
17190             "field": "name",
17191             "description": ""
17192           }
17193         ]
17194       }
17195     },
17196     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17197     "version": "0.0.0",
17198     "filename": "server/api/openchannelAccount/index.js",
17199     "groupTitle": "Openchannel_Accounts"
17200   },
17201   {
17202     "type": "get",
17203     "url": "/api/openchannel/accounts/{id}/canned_answers",
17204     "title": "Gets account canned answers",
17205     "examples": [
17206       {
17207         "title": "Example usage:",
17208         "content": "curl https://{domain}/api/openchannel/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
17209         "type": "json"
17210       }
17211     ],
17212     "name": "getAnswers",
17213     "group": "Openchannel_Accounts",
17214     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17215     "version": "0.0.0",
17216     "filename": "server/api/openchannelAccount/index.js",
17217     "groupTitle": "Openchannel_Accounts"
17218   },
17219   {
17220     "type": "get",
17221     "url": "/api/openchannel/accounts/{id}/applications",
17222     "title": "Gets account applications",
17223     "examples": [
17224       {
17225         "title": "Example usage:",
17226         "content": "curl https://{domain}/api/openchannel/accounts/{id}/applications -v -u {name}:{password} -X GET",
17227         "type": "json"
17228       }
17229     ],
17230     "name": "getApplications",
17231     "group": "Openchannel_Accounts",
17232     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17233     "version": "0.0.0",
17234     "filename": "server/api/openchannelAccount/index.js",
17235     "groupTitle": "Openchannel_Accounts"
17236   },
17237   {
17238     "type": "get",
17239     "url": "/api/openchannel/accounts/{id}/dispositions",
17240     "title": "Gets account dispositions",
17241     "examples": [
17242       {
17243         "title": "Example usage:",
17244         "content": "curl https://{domain}/api/openchannel/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
17245         "type": "json"
17246       }
17247     ],
17248     "name": "getDispositions",
17249     "group": "Openchannel_Accounts",
17250     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17251     "version": "0.0.0",
17252     "filename": "server/api/openchannelAccount/index.js",
17253     "groupTitle": "Openchannel_Accounts"
17254   },
17255   {
17256     "type": "get",
17257     "url": "/api/openchannel/accounts/{id}/interactions",
17258     "title": "Gets Openchannel Account Interactions",
17259     "examples": [
17260       {
17261         "title": "Example usage:",
17262         "content": "curl https://{domain}/api/openchannel/accounts/{id}/interactions -v -u {name}:{password} -X GET",
17263         "type": "json"
17264       }
17265     ],
17266     "name": "getInteractions",
17267     "group": "Openchannel_Accounts",
17268     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17269     "version": "0.0.0",
17270     "filename": "server/api/openchannelAccount/index.js",
17271     "groupTitle": "Openchannel_Accounts"
17272   },
17273   {
17274     "type": "post",
17275     "url": "/api/openchannel/accounts/{id}/notify",
17276     "title": "Notify new message",
17277     "examples": [
17278       {
17279         "title": "Example usage:",
17280         "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",
17281         "type": "json"
17282       }
17283     ],
17284     "name": "notify",
17285     "group": "Openchannel_Accounts",
17286     "description": "<p>Motion 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>",
17287     "version": "0.0.0",
17288     "filename": "server/api/openchannelAccount/index.js",
17289     "groupTitle": "Openchannel_Accounts"
17290   },
17291   {
17292     "type": "post",
17293     "url": "/api/openchannel/accounts/{id}/send",
17294     "title": "Send new openchannel message",
17295     "examples": [
17296       {
17297         "title": "Example usage:",
17298         "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",
17299         "type": "json"
17300       }
17301     ],
17302     "name": "sendOpenchannel",
17303     "group": "Openchannel_Accounts",
17304     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17305     "version": "0.0.0",
17306     "filename": "server/api/openchannelAccount/index.js",
17307     "groupTitle": "Openchannel_Accounts"
17308   },
17309   {
17310     "type": "put",
17311     "url": "/api/openchannel/accounts/{id}",
17312     "title": "Update an existing Account",
17313     "examples": [
17314       {
17315         "title": "Example usage:",
17316         "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",
17317         "type": "json"
17318       }
17319     ],
17320     "name": "updateAccounts",
17321     "group": "Openchannel_Accounts",
17322     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17323     "version": "0.0.0",
17324     "filename": "server/api/openchannelAccount/index.js",
17325     "groupTitle": "Openchannel_Accounts"
17326   },
17327   {
17328     "type": "post",
17329     "url": "/api/openchannel/applications",
17330     "title": "Creates a new Application",
17331     "examples": [
17332       {
17333         "title": "Example usage:",
17334         "content": "curl https://{domain}/api/openchannel/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17335         "type": "json"
17336       }
17337     ],
17338     "name": "CreateApplications",
17339     "group": "Openchannel_Applications",
17340     "parameter": {
17341       "fields": {
17342         "Body": [
17343           {
17344             "group": "Body",
17345             "type": "Integer",
17346             "optional": false,
17347             "field": "priority",
17348             "description": ""
17349           },
17350           {
17351             "group": "Body",
17352             "type": "String",
17353             "optional": false,
17354             "field": "app",
17355             "description": ""
17356           },
17357           {
17358             "group": "Body",
17359             "type": "Text",
17360             "optional": true,
17361             "field": "appdata",
17362             "description": ""
17363           },
17364           {
17365             "group": "Body",
17366             "type": "String",
17367             "optional": true,
17368             "field": "description",
17369             "description": ""
17370           },
17371           {
17372             "group": "Body",
17373             "type": "String",
17374             "optional": true,
17375             "field": "interval",
17376             "description": ""
17377           }
17378         ]
17379       }
17380     },
17381     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17382     "version": "0.0.0",
17383     "filename": "server/api/openchannelApplication/index.js",
17384     "groupTitle": "Openchannel_Applications"
17385   },
17386   {
17387     "type": "delete",
17388     "url": "/api/openchannel/applications/{id}",
17389     "title": "Deletes a Application",
17390     "examples": [
17391       {
17392         "title": "Example usage:",
17393         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password} -X DELETE",
17394         "type": "json"
17395       }
17396     ],
17397     "name": "DeleteApplications",
17398     "group": "Openchannel_Applications",
17399     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17400     "version": "0.0.0",
17401     "filename": "server/api/openchannelApplication/index.js",
17402     "groupTitle": "Openchannel_Applications"
17403   },
17404   {
17405     "type": "get",
17406     "url": "/api/openchannel/applications",
17407     "title": "Gets a list of Applications",
17408     "examples": [
17409       {
17410         "title": "Example usage:",
17411         "content": "curl https://{domain}/api/openchannel/applications -v -u {name}:{password}",
17412         "type": "json"
17413       }
17414     ],
17415     "name": "GetApplications",
17416     "group": "Openchannel_Applications",
17417     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17418     "version": "0.0.0",
17419     "filename": "server/api/openchannelApplication/index.js",
17420     "groupTitle": "Openchannel_Applications"
17421   },
17422   {
17423     "type": "get",
17424     "url": "/api/openchannel/applications/{id}",
17425     "title": "Gets a single Application",
17426     "examples": [
17427       {
17428         "title": "Example usage:",
17429         "content": "curl https://{domain}/api/openchannel/applications/{id} -v -u {name}:{password}",
17430         "type": "json"
17431       }
17432     ],
17433     "name": "ShowApplications",
17434     "group": "Openchannel_Applications",
17435     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17436     "version": "0.0.0",
17437     "filename": "server/api/openchannelApplication/index.js",
17438     "groupTitle": "Openchannel_Applications"
17439   },
17440   {
17441     "type": "put",
17442     "url": "/api/openchannel/applications/{id}",
17443     "title": "Update an existing Application",
17444     "examples": [
17445       {
17446         "title": "Example usage:",
17447         "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",
17448         "type": "json"
17449       }
17450     ],
17451     "name": "updateApplications",
17452     "group": "Openchannel_Applications",
17453     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17454     "version": "0.0.0",
17455     "filename": "server/api/openchannelApplication/index.js",
17456     "groupTitle": "Openchannel_Applications"
17457   },
17458   {
17459     "type": "post",
17460     "url": "/api/openchannel/interactions/{id}/tags",
17461     "title": "Add tags to the interaction",
17462     "examples": [
17463       {
17464         "title": "Example usage:",
17465         "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",
17466         "type": "json"
17467       }
17468     ],
17469     "name": "AddTags",
17470     "group": "Openchannel_Interactions",
17471     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17472     "version": "0.0.0",
17473     "filename": "server/api/openchannelInteraction/index.js",
17474     "groupTitle": "Openchannel_Interactions"
17475   },
17476   {
17477     "type": "post",
17478     "url": "/api/openchannel/interactions",
17479     "title": "Creates a new Interaction",
17480     "examples": [
17481       {
17482         "title": "Example usage:",
17483         "content": "curl https://{domain}/api/openchannel/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17484         "type": "json"
17485       }
17486     ],
17487     "name": "CreateInteractions",
17488     "group": "Openchannel_Interactions",
17489     "parameter": {
17490       "fields": {
17491         "Body": [
17492           {
17493             "group": "Body",
17494             "type": "Boolean",
17495             "optional": true,
17496             "field": "closed",
17497             "description": ""
17498           },
17499           {
17500             "group": "Body",
17501             "type": "String",
17502             "optional": true,
17503             "field": "closedAt",
17504             "description": ""
17505           },
17506           {
17507             "group": "Body",
17508             "type": "String",
17509             "optional": true,
17510             "field": "disposition",
17511             "description": ""
17512           },
17513           {
17514             "group": "Body",
17515             "type": "String",
17516             "optional": true,
17517             "field": "note",
17518             "description": ""
17519           },
17520           {
17521             "group": "Body",
17522             "type": "String",
17523             "optional": true,
17524             "field": "read1stAt",
17525             "description": ""
17526           },
17527           {
17528             "group": "Body",
17529             "type": "String",
17530             "optional": true,
17531             "field": "threadId",
17532             "description": ""
17533           },
17534           {
17535             "group": "Body",
17536             "type": "String",
17537             "optional": true,
17538             "field": "externalUrl",
17539             "description": ""
17540           },
17541           {
17542             "group": "Body",
17543             "type": "String",
17544             "optional": true,
17545             "field": "lastMsgAt",
17546             "description": ""
17547           },
17548           {
17549             "group": "Body",
17550             "type": "String",
17551             "allowedValues": [
17552               "\"in\"",
17553               "\"out\""
17554             ],
17555             "optional": false,
17556             "field": "lastMsgDirection",
17557             "description": ""
17558           },
17559           {
17560             "group": "Body",
17561             "type": "String",
17562             "optional": true,
17563             "field": "from",
17564             "description": ""
17565           }
17566         ]
17567       }
17568     },
17569     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17570     "version": "0.0.0",
17571     "filename": "server/api/openchannelInteraction/index.js",
17572     "groupTitle": "Openchannel_Interactions"
17573   },
17574   {
17575     "type": "delete",
17576     "url": "/api/openchannel/interactions/{id}",
17577     "title": "Deletes a Interaction",
17578     "examples": [
17579       {
17580         "title": "Example usage:",
17581         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password} -X DELETE",
17582         "type": "json"
17583       }
17584     ],
17585     "name": "DeleteInteractions",
17586     "group": "Openchannel_Interactions",
17587     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17588     "version": "0.0.0",
17589     "filename": "server/api/openchannelInteraction/index.js",
17590     "groupTitle": "Openchannel_Interactions"
17591   },
17592   {
17593     "type": "get",
17594     "url": "/api/openchannel/interactions/describe",
17595     "title": "Gets table info about Interactions",
17596     "examples": [
17597       {
17598         "title": "Example usage:",
17599         "content": "curl https://{domain}/api/openchannel/interactions/describe -v -u {name}:{password}",
17600         "type": "json"
17601       }
17602     ],
17603     "name": "DescribeInteractions",
17604     "group": "Openchannel_Interactions",
17605     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17606     "version": "0.0.0",
17607     "filename": "server/api/openchannelInteraction/index.js",
17608     "groupTitle": "Openchannel_Interactions"
17609   },
17610   {
17611     "type": "get",
17612     "url": "/api/openchannel/interactions",
17613     "title": "Gets a list of Interactions",
17614     "examples": [
17615       {
17616         "title": "Example usage:",
17617         "content": "curl https://{domain}/api/openchannel/interactions -v -u {name}:{password}",
17618         "type": "json"
17619       }
17620     ],
17621     "name": "GetInteractions",
17622     "group": "Openchannel_Interactions",
17623     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17624     "version": "0.0.0",
17625     "filename": "server/api/openchannelInteraction/index.js",
17626     "groupTitle": "Openchannel_Interactions"
17627   },
17628   {
17629     "type": "delete",
17630     "url": "/api/openchannel/interactions/{id}/tags",
17631     "title": "Removes tags from interaction",
17632     "examples": [
17633       {
17634         "title": "Example usage:",
17635         "content": "curl https://{domain}/api/openchannel/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
17636         "type": "json"
17637       }
17638     ],
17639     "name": "RemoveTags",
17640     "group": "Openchannel_Interactions",
17641     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17642     "version": "0.0.0",
17643     "filename": "server/api/openchannelInteraction/index.js",
17644     "groupTitle": "Openchannel_Interactions"
17645   },
17646   {
17647     "type": "get",
17648     "url": "/api/openchannel/interactions/{id}",
17649     "title": "Gets a single Interaction",
17650     "examples": [
17651       {
17652         "title": "Example usage:",
17653         "content": "curl https://{domain}/api/openchannel/interactions/{id} -v -u {name}:{password}",
17654         "type": "json"
17655       }
17656     ],
17657     "name": "ShowInteractions",
17658     "group": "Openchannel_Interactions",
17659     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17660     "version": "0.0.0",
17661     "filename": "server/api/openchannelInteraction/index.js",
17662     "groupTitle": "Openchannel_Interactions"
17663   },
17664   {
17665     "type": "post",
17666     "url": "/api/openchannel/interactions/{id}/messages",
17667     "title": "Creates new messages",
17668     "examples": [
17669       {
17670         "title": "Example usage:",
17671         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
17672         "type": "json"
17673       }
17674     ],
17675     "name": "addMessage",
17676     "group": "Openchannel_Interactions",
17677     "parameter": {
17678       "fields": {
17679         "Body": [
17680           {
17681             "group": "Body",
17682             "type": "Text",
17683             "optional": false,
17684             "field": "body",
17685             "description": ""
17686           },
17687           {
17688             "group": "Body",
17689             "type": "Boolean",
17690             "optional": true,
17691             "field": "read",
17692             "description": ""
17693           },
17694           {
17695             "group": "Body",
17696             "type": "Boolean",
17697             "optional": true,
17698             "field": "secret",
17699             "description": ""
17700           },
17701           {
17702             "group": "Body",
17703             "type": "String",
17704             "allowedValues": [
17705               "\"in\"",
17706               "\"out\""
17707             ],
17708             "optional": false,
17709             "field": "direction",
17710             "description": ""
17711           },
17712           {
17713             "group": "Body",
17714             "type": "String",
17715             "optional": true,
17716             "field": "readAt",
17717             "description": ""
17718           }
17719         ]
17720       }
17721     },
17722     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17723     "version": "0.0.0",
17724     "filename": "server/api/openchannelInteraction/index.js",
17725     "groupTitle": "Openchannel_Interactions"
17726   },
17727   {
17728     "type": "get",
17729     "url": "/api/openchannel/interactions/{id}/download",
17730     "title": "Gets interaction",
17731     "examples": [
17732       {
17733         "title": "Example usage:",
17734         "content": "curl https://{domain}/api/openchannel/interactions/{id}/download -v -u {name}:{password} -X GET",
17735         "type": "json"
17736       }
17737     ],
17738     "name": "download",
17739     "group": "Openchannel_Interactions",
17740     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17741     "version": "0.0.0",
17742     "filename": "server/api/openchannelInteraction/index.js",
17743     "groupTitle": "Openchannel_Interactions"
17744   },
17745   {
17746     "type": "get",
17747     "url": "/api/openchannel/interactions/{id}/messages",
17748     "title": "Gets interaction messages",
17749     "examples": [
17750       {
17751         "title": "Example usage:",
17752         "content": "curl https://{domain}/api/openchannel/interactions/{id}/messages -v -u {name}:{password} -X GET",
17753         "type": "json"
17754       }
17755     ],
17756     "name": "getMessages",
17757     "group": "Openchannel_Interactions",
17758     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17759     "version": "0.0.0",
17760     "filename": "server/api/openchannelInteraction/index.js",
17761     "groupTitle": "Openchannel_Interactions"
17762   },
17763   {
17764     "type": "put",
17765     "url": "/api/openchannel/interactions/{id}",
17766     "title": "Update an existing Interaction",
17767     "examples": [
17768       {
17769         "title": "Example usage:",
17770         "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",
17771         "type": "json"
17772       }
17773     ],
17774     "name": "updateInteractions",
17775     "group": "Openchannel_Interactions",
17776     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17777     "version": "0.0.0",
17778     "filename": "server/api/openchannelInteraction/index.js",
17779     "groupTitle": "Openchannel_Interactions"
17780   },
17781   {
17782     "type": "post",
17783     "url": "/api/openchannel/messages",
17784     "title": "Creates a new Message",
17785     "examples": [
17786       {
17787         "title": "Example usage:",
17788         "content": "curl https://{domain}/api/openchannel/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
17789         "type": "json"
17790       }
17791     ],
17792     "name": "CreateMessages",
17793     "group": "Openchannel_Messages",
17794     "parameter": {
17795       "fields": {
17796         "Body": [
17797           {
17798             "group": "Body",
17799             "type": "Text",
17800             "optional": false,
17801             "field": "body",
17802             "description": ""
17803           },
17804           {
17805             "group": "Body",
17806             "type": "Boolean",
17807             "optional": true,
17808             "field": "read",
17809             "description": ""
17810           },
17811           {
17812             "group": "Body",
17813             "type": "Boolean",
17814             "optional": true,
17815             "field": "secret",
17816             "description": ""
17817           },
17818           {
17819             "group": "Body",
17820             "type": "String",
17821             "allowedValues": [
17822               "\"in\"",
17823               "\"out\""
17824             ],
17825             "optional": false,
17826             "field": "direction",
17827             "description": ""
17828           },
17829           {
17830             "group": "Body",
17831             "type": "String",
17832             "optional": true,
17833             "field": "readAt",
17834             "description": ""
17835           }
17836         ]
17837       }
17838     },
17839     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17840     "version": "0.0.0",
17841     "filename": "server/api/openchannelMessage/index.js",
17842     "groupTitle": "Openchannel_Messages"
17843   },
17844   {
17845     "type": "delete",
17846     "url": "/api/openchannel/messages/{id}",
17847     "title": "Deletes a Message",
17848     "examples": [
17849       {
17850         "title": "Example usage:",
17851         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password} -X DELETE",
17852         "type": "json"
17853       }
17854     ],
17855     "name": "DeleteMessages",
17856     "group": "Openchannel_Messages",
17857     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17858     "version": "0.0.0",
17859     "filename": "server/api/openchannelMessage/index.js",
17860     "groupTitle": "Openchannel_Messages"
17861   },
17862   {
17863     "type": "get",
17864     "url": "/api/openchannel/messages/describe",
17865     "title": "Gets table info about Messages",
17866     "examples": [
17867       {
17868         "title": "Example usage:",
17869         "content": "curl https://{domain}/api/openchannel/messages/describe -v -u {name}:{password}",
17870         "type": "json"
17871       }
17872     ],
17873     "name": "DescribeMessages",
17874     "group": "Openchannel_Messages",
17875     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17876     "version": "0.0.0",
17877     "filename": "server/api/openchannelMessage/index.js",
17878     "groupTitle": "Openchannel_Messages"
17879   },
17880   {
17881     "type": "get",
17882     "url": "/api/openchannel/messages",
17883     "title": "Gets a list of Messages",
17884     "examples": [
17885       {
17886         "title": "Example usage:",
17887         "content": "curl https://{domain}/api/openchannel/messages -v -u {name}:{password}",
17888         "type": "json"
17889       }
17890     ],
17891     "name": "GetMessages",
17892     "group": "Openchannel_Messages",
17893     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
17894     "version": "0.0.0",
17895     "filename": "server/api/openchannelMessage/index.js",
17896     "groupTitle": "Openchannel_Messages"
17897   },
17898   {
17899     "type": "get",
17900     "url": "/api/openchannel/messages/{id}",
17901     "title": "Gets a single Message",
17902     "examples": [
17903       {
17904         "title": "Example usage:",
17905         "content": "curl https://{domain}/api/openchannel/messages/{id} -v -u {name}:{password}",
17906         "type": "json"
17907       }
17908     ],
17909     "name": "ShowMessages",
17910     "group": "Openchannel_Messages",
17911     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17912     "version": "0.0.0",
17913     "filename": "server/api/openchannelMessage/index.js",
17914     "groupTitle": "Openchannel_Messages"
17915   },
17916   {
17917     "type": "put",
17918     "url": "/api/openchannel/messages/{id}/accept",
17919     "title": "Accepts message",
17920     "examples": [
17921       {
17922         "title": "Example usage:",
17923         "content": "curl https://{domain}/api/openchannel/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
17924         "type": "json"
17925       }
17926     ],
17927     "name": "acceptMessage",
17928     "group": "Openchannel_Messages",
17929     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/openchannelMessage/index.js",
17932     "groupTitle": "Openchannel_Messages"
17933   },
17934   {
17935     "type": "put",
17936     "url": "/api/openchannel/messages/{id}/reject",
17937     "title": "Rejects message",
17938     "examples": [
17939       {
17940         "title": "Example usage:",
17941         "content": "curl https://{domain}/api/openchannel/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
17942         "type": "json"
17943       }
17944     ],
17945     "name": "rejectMessage",
17946     "group": "Openchannel_Messages",
17947     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
17948     "version": "0.0.0",
17949     "filename": "server/api/openchannelMessage/index.js",
17950     "groupTitle": "Openchannel_Messages"
17951   },
17952   {
17953     "type": "put",
17954     "url": "/api/openchannel/messages/{id}",
17955     "title": "Update an existing Message",
17956     "examples": [
17957       {
17958         "title": "Example usage:",
17959         "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",
17960         "type": "json"
17961       }
17962     ],
17963     "name": "updateMessages",
17964     "group": "Openchannel_Messages",
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/openchannelMessage/index.js",
17968     "groupTitle": "Openchannel_Messages"
17969   },
17970   {
17971     "type": "post",
17972     "url": "/api/openchannel/reports/queue",
17973     "title": "Creates a new Openchannel Queue Report",
17974     "examples": [
17975       {
17976         "title": "Example usage:",
17977         "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",
17978         "type": "json"
17979       }
17980     ],
17981     "name": "CreateOpenchannel_Queue_Reports",
17982     "group": "Openchannel_Queue_Reports",
17983     "parameter": {
17984       "fields": {
17985         "Body": [
17986           {
17987             "group": "Body",
17988             "type": "String",
17989             "optional": false,
17990             "field": "uniqueid",
17991             "description": ""
17992           },
17993           {
17994             "group": "Body",
17995             "type": "String",
17996             "optional": true,
17997             "field": "from",
17998             "description": ""
17999           },
18000           {
18001             "group": "Body",
18002             "type": "String",
18003             "optional": true,
18004             "field": "joinAt",
18005             "description": ""
18006           },
18007           {
18008             "group": "Body",
18009             "type": "String",
18010             "optional": true,
18011             "field": "leaveAt",
18012             "description": ""
18013           },
18014           {
18015             "group": "Body",
18016             "type": "String",
18017             "optional": true,
18018             "field": "acceptAt",
18019             "description": ""
18020           },
18021           {
18022             "group": "Body",
18023             "type": "String",
18024             "optional": true,
18025             "field": "exitAt",
18026             "description": ""
18027           },
18028           {
18029             "group": "Body",
18030             "type": "String",
18031             "optional": true,
18032             "field": "reason",
18033             "description": ""
18034           }
18035         ]
18036       }
18037     },
18038     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18039     "version": "0.0.0",
18040     "filename": "server/api/openchannelQueueReport/index.js",
18041     "groupTitle": "Openchannel_Queue_Reports"
18042   },
18043   {
18044     "type": "delete",
18045     "url": "/api/openchannel/reports/queue/{id}",
18046     "title": "Deletes a Openchannel Queue Report",
18047     "examples": [
18048       {
18049         "title": "Example usage:",
18050         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password} -X DELETE",
18051         "type": "json"
18052       }
18053     ],
18054     "name": "DeleteOpenchannel_Queue_Reports",
18055     "group": "Openchannel_Queue_Reports",
18056     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18057     "version": "0.0.0",
18058     "filename": "server/api/openchannelQueueReport/index.js",
18059     "groupTitle": "Openchannel_Queue_Reports"
18060   },
18061   {
18062     "type": "get",
18063     "url": "/api/openchannel/reports/queue/describe",
18064     "title": "Gets table info about Openchannel Queue Reports",
18065     "examples": [
18066       {
18067         "title": "Example usage:",
18068         "content": "curl https://{domain}/api/openchannel/reports/queue/describe -v -u {name}:{password}",
18069         "type": "json"
18070       }
18071     ],
18072     "name": "DescribeOpenchannel_Queue_Reports",
18073     "group": "Openchannel_Queue_Reports",
18074     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18075     "version": "0.0.0",
18076     "filename": "server/api/openchannelQueueReport/index.js",
18077     "groupTitle": "Openchannel_Queue_Reports"
18078   },
18079   {
18080     "type": "get",
18081     "url": "/api/openchannel/reports/queue",
18082     "title": "Gets a list of Openchannel Queue Reports",
18083     "examples": [
18084       {
18085         "title": "Example usage:",
18086         "content": "curl https://{domain}/api/openchannel/reports/queue -v -u {name}:{password}",
18087         "type": "json"
18088       }
18089     ],
18090     "name": "GetOpenchannel_Queue_Reports",
18091     "group": "Openchannel_Queue_Reports",
18092     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18093     "version": "0.0.0",
18094     "filename": "server/api/openchannelQueueReport/index.js",
18095     "groupTitle": "Openchannel_Queue_Reports"
18096   },
18097   {
18098     "type": "get",
18099     "url": "/api/openchannel/reports/queue/{id}",
18100     "title": "Gets a single Openchannel Queue Report",
18101     "examples": [
18102       {
18103         "title": "Example usage:",
18104         "content": "curl https://{domain}/api/openchannel/reports/queue/{id} -v -u {name}:{password}",
18105         "type": "json"
18106       }
18107     ],
18108     "name": "ShowOpenchannel_Queue_Reports",
18109     "group": "Openchannel_Queue_Reports",
18110     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18111     "version": "0.0.0",
18112     "filename": "server/api/openchannelQueueReport/index.js",
18113     "groupTitle": "Openchannel_Queue_Reports"
18114   },
18115   {
18116     "type": "put",
18117     "url": "/api/openchannel/reports/queue/{id}",
18118     "title": "Update an existing Openchannel Queue Report",
18119     "examples": [
18120       {
18121         "title": "Example usage:",
18122         "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",
18123         "type": "json"
18124       }
18125     ],
18126     "name": "updateOpenchannel_Queue_Reports",
18127     "group": "Openchannel_Queue_Reports",
18128     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18129     "version": "0.0.0",
18130     "filename": "server/api/openchannelQueueReport/index.js",
18131     "groupTitle": "Openchannel_Queue_Reports"
18132   },
18133   {
18134     "type": "post",
18135     "url": "/api/openchannel/queues/{id}/users",
18136     "title": "Add agents to a queue",
18137     "examples": [
18138       {
18139         "title": "Example usage:",
18140         "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",
18141         "type": "json"
18142       }
18143     ],
18144     "name": "AddAgents",
18145     "group": "Openchannel_Queues",
18146     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18147     "version": "0.0.0",
18148     "filename": "server/api/openchannelQueue/index.js",
18149     "groupTitle": "Openchannel_Queues"
18150   },
18151   {
18152     "type": "post",
18153     "url": "/api/openchannel/queues/{id}/teams",
18154     "title": "Add teams to a queue",
18155     "examples": [
18156       {
18157         "title": "Example usage:",
18158         "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",
18159         "type": "json"
18160       }
18161     ],
18162     "name": "AddTeams",
18163     "group": "Openchannel_Queues",
18164     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18165     "version": "0.0.0",
18166     "filename": "server/api/openchannelQueue/index.js",
18167     "groupTitle": "Openchannel_Queues"
18168   },
18169   {
18170     "type": "post",
18171     "url": "/api/openchannel/queues",
18172     "title": "Creates a new Queue",
18173     "examples": [
18174       {
18175         "title": "Example usage:",
18176         "content": "curl https://{domain}/api/openchannel/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18177         "type": "json"
18178       }
18179     ],
18180     "name": "CreateQueues",
18181     "group": "Openchannel_Queues",
18182     "parameter": {
18183       "fields": {
18184         "Body": [
18185           {
18186             "group": "Body",
18187             "type": "String",
18188             "optional": true,
18189             "field": "name",
18190             "description": ""
18191           },
18192           {
18193             "group": "Body",
18194             "type": "String",
18195             "optional": true,
18196             "field": "description",
18197             "description": ""
18198           },
18199           {
18200             "group": "Body",
18201             "type": "Integer",
18202             "optional": true,
18203             "field": "timeout",
18204             "description": ""
18205           },
18206           {
18207             "group": "Body",
18208             "type": "String",
18209             "allowedValues": [
18210               "\"rrmemory\"",
18211               "\"beepall\"",
18212               "\"roundrobin\""
18213             ],
18214             "optional": true,
18215             "field": "strategy",
18216             "description": ""
18217           }
18218         ]
18219       }
18220     },
18221     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18222     "version": "0.0.0",
18223     "filename": "server/api/openchannelQueue/index.js",
18224     "groupTitle": "Openchannel_Queues"
18225   },
18226   {
18227     "type": "delete",
18228     "url": "/api/openchannel/queues/{id}",
18229     "title": "Deletes a Queue",
18230     "examples": [
18231       {
18232         "title": "Example usage:",
18233         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password} -X DELETE",
18234         "type": "json"
18235       }
18236     ],
18237     "name": "DeleteQueues",
18238     "group": "Openchannel_Queues",
18239     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18240     "version": "0.0.0",
18241     "filename": "server/api/openchannelQueue/index.js",
18242     "groupTitle": "Openchannel_Queues"
18243   },
18244   {
18245     "type": "get",
18246     "url": "/api/openchannel/queues/describe",
18247     "title": "Gets table info about Queues",
18248     "examples": [
18249       {
18250         "title": "Example usage:",
18251         "content": "curl https://{domain}/api/openchannel/queues/describe -v -u {name}:{password}",
18252         "type": "json"
18253       }
18254     ],
18255     "name": "DescribeQueues",
18256     "group": "Openchannel_Queues",
18257     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18258     "version": "0.0.0",
18259     "filename": "server/api/openchannelQueue/index.js",
18260     "groupTitle": "Openchannel_Queues"
18261   },
18262   {
18263     "type": "get",
18264     "url": "/api/openchannel/queues/{id}/users",
18265     "title": "Gets queue agents",
18266     "examples": [
18267       {
18268         "title": "Example usage:",
18269         "content": "curl https://{domain}/api/openchannel/queues/{id}/users -v -u {name}:{password} -X POST",
18270         "type": "json"
18271       }
18272     ],
18273     "name": "GetAgents",
18274     "group": "Openchannel_Queues",
18275     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18276     "version": "0.0.0",
18277     "filename": "server/api/openchannelQueue/index.js",
18278     "groupTitle": "Openchannel_Queues"
18279   },
18280   {
18281     "type": "get",
18282     "url": "/api/openchannel/queues/{id}/members",
18283     "title": "GetMembers",
18284     "examples": [
18285       {
18286         "title": "Example usage:",
18287         "content": "curl https://{domain}/api/openchannel/queues/{id}/members  -v -u {name}:{password}",
18288         "type": "json"
18289       }
18290     ],
18291     "name": "GetMembers",
18292     "group": "Openchannel_Queues",
18293     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18294     "version": "0.0.0",
18295     "filename": "server/api/openchannelQueue/index.js",
18296     "groupTitle": "Openchannel_Queues"
18297   },
18298   {
18299     "type": "get",
18300     "url": "/api/openchannel/queues",
18301     "title": "Gets a list of Queues",
18302     "examples": [
18303       {
18304         "title": "Example usage:",
18305         "content": "curl https://{domain}/api/openchannel/queues -v -u {name}:{password}",
18306         "type": "json"
18307       }
18308     ],
18309     "name": "GetQueues",
18310     "group": "Openchannel_Queues",
18311     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18312     "version": "0.0.0",
18313     "filename": "server/api/openchannelQueue/index.js",
18314     "groupTitle": "Openchannel_Queues"
18315   },
18316   {
18317     "type": "get",
18318     "url": "/api/openchannel/queues/{id}/teams",
18319     "title": "Gets queues list",
18320     "examples": [
18321       {
18322         "title": "Example usage:",
18323         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password}",
18324         "type": "json"
18325       }
18326     ],
18327     "name": "GetTeams",
18328     "group": "Openchannel_Queues",
18329     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18330     "version": "0.0.0",
18331     "filename": "server/api/openchannelQueue/index.js",
18332     "groupTitle": "Openchannel_Queues"
18333   },
18334   {
18335     "type": "delete",
18336     "url": "/api/openchannel/queues/{id}/users",
18337     "title": "Removes agents from a queue",
18338     "examples": [
18339       {
18340         "title": "Example usage:",
18341         "content": "curl https://{domain}/api/openchannel/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
18342         "type": "json"
18343       }
18344     ],
18345     "name": "RemoveAgents",
18346     "group": "Openchannel_Queues",
18347     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18348     "version": "0.0.0",
18349     "filename": "server/api/openchannelQueue/index.js",
18350     "groupTitle": "Openchannel_Queues"
18351   },
18352   {
18353     "type": "get",
18354     "url": "/api/openchannel/queues/{id}",
18355     "title": "Gets a single Queue",
18356     "examples": [
18357       {
18358         "title": "Example usage:",
18359         "content": "curl https://{domain}/api/openchannel/queues/{id} -v -u {name}:{password}",
18360         "type": "json"
18361       }
18362     ],
18363     "name": "ShowQueues",
18364     "group": "Openchannel_Queues",
18365     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18366     "version": "0.0.0",
18367     "filename": "server/api/openchannelQueue/index.js",
18368     "groupTitle": "Openchannel_Queues"
18369   },
18370   {
18371     "type": "put",
18372     "url": "/api/openchannel/queues/{id}",
18373     "title": "Update an existing Queue",
18374     "examples": [
18375       {
18376         "title": "Example usage:",
18377         "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",
18378         "type": "json"
18379       }
18380     ],
18381     "name": "updateQueues",
18382     "group": "Openchannel_Queues",
18383     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18384     "version": "0.0.0",
18385     "filename": "server/api/openchannelQueue/index.js",
18386     "groupTitle": "Openchannel_Queues"
18387   },
18388   {
18389     "type": "post",
18390     "url": "/api/openchannel/reports/transfer",
18391     "title": "Creates a new Openchannel Transfer Report",
18392     "examples": [
18393       {
18394         "title": "Example usage:",
18395         "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",
18396         "type": "json"
18397       }
18398     ],
18399     "name": "CreateOpenchannel_Transfer_Reports",
18400     "group": "Openchannel_Transfer_Reports",
18401     "parameter": {
18402       "fields": {
18403         "Body": [
18404           {
18405             "group": "Body",
18406             "type": "String",
18407             "optional": false,
18408             "field": "uniqueid",
18409             "description": ""
18410           },
18411           {
18412             "group": "Body",
18413             "type": "String",
18414             "allowedValues": [
18415               "\"account\"",
18416               "\"agent\"",
18417               "\"queue\""
18418             ],
18419             "optional": false,
18420             "field": "type",
18421             "description": ""
18422           },
18423           {
18424             "group": "Body",
18425             "type": "String",
18426             "optional": false,
18427             "field": "transferredAt",
18428             "description": ""
18429           }
18430         ]
18431       }
18432     },
18433     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18434     "version": "0.0.0",
18435     "filename": "server/api/openchannelTransferReport/index.js",
18436     "groupTitle": "Openchannel_Transfer_Reports"
18437   },
18438   {
18439     "type": "delete",
18440     "url": "/api/openchannel/reports/transfer/{id}",
18441     "title": "Deletes a Openchannel Transfer Report",
18442     "examples": [
18443       {
18444         "title": "Example usage:",
18445         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
18446         "type": "json"
18447       }
18448     ],
18449     "name": "DeleteOpenchannel_Transfer_Reports",
18450     "group": "Openchannel_Transfer_Reports",
18451     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18452     "version": "0.0.0",
18453     "filename": "server/api/openchannelTransferReport/index.js",
18454     "groupTitle": "Openchannel_Transfer_Reports"
18455   },
18456   {
18457     "type": "get",
18458     "url": "/api/openchannel/reports/transfer/describe",
18459     "title": "Gets table info about Openchannel Transfer Reports",
18460     "examples": [
18461       {
18462         "title": "Example usage:",
18463         "content": "curl https://{domain}/api/openchannel/reports/transfer/describe -v -u {name}:{password}",
18464         "type": "json"
18465       }
18466     ],
18467     "name": "DescribeOpenchannel_Transfer_Reports",
18468     "group": "Openchannel_Transfer_Reports",
18469     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18470     "version": "0.0.0",
18471     "filename": "server/api/openchannelTransferReport/index.js",
18472     "groupTitle": "Openchannel_Transfer_Reports"
18473   },
18474   {
18475     "type": "get",
18476     "url": "/api/openchannel/reports/transfer",
18477     "title": "Gets a list of Openchannel Transfer Reports",
18478     "examples": [
18479       {
18480         "title": "Example usage:",
18481         "content": "curl https://{domain}/api/openchannel/reports/transfer -v -u {name}:{password}",
18482         "type": "json"
18483       }
18484     ],
18485     "name": "GetOpenchannel_Transfer_Reports",
18486     "group": "Openchannel_Transfer_Reports",
18487     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18488     "version": "0.0.0",
18489     "filename": "server/api/openchannelTransferReport/index.js",
18490     "groupTitle": "Openchannel_Transfer_Reports"
18491   },
18492   {
18493     "type": "get",
18494     "url": "/api/openchannel/reports/transfer/{id}",
18495     "title": "Gets a single Openchannel Transfer Report",
18496     "examples": [
18497       {
18498         "title": "Example usage:",
18499         "content": "curl https://{domain}/api/openchannel/reports/transfer/{id} -v -u {name}:{password}",
18500         "type": "json"
18501       }
18502     ],
18503     "name": "ShowOpenchannel_Transfer_Reports",
18504     "group": "Openchannel_Transfer_Reports",
18505     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18506     "version": "0.0.0",
18507     "filename": "server/api/openchannelTransferReport/index.js",
18508     "groupTitle": "Openchannel_Transfer_Reports"
18509   },
18510   {
18511     "type": "put",
18512     "url": "/api/openchannel/reports/transfer/{id}",
18513     "title": "Update an existing Openchannel Transfer Report",
18514     "examples": [
18515       {
18516         "title": "Example usage:",
18517         "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",
18518         "type": "json"
18519       }
18520     ],
18521     "name": "updateOpenchannel_Transfer_Reports",
18522     "group": "Openchannel_Transfer_Reports",
18523     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18524     "version": "0.0.0",
18525     "filename": "server/api/openchannelTransferReport/index.js",
18526     "groupTitle": "Openchannel_Transfer_Reports"
18527   },
18528   {
18529     "type": "post",
18530     "url": "/api/pauses",
18531     "title": "Creates a new Pause",
18532     "examples": [
18533       {
18534         "title": "Example usage:",
18535         "content": "curl https://{domain}/api/pauses -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
18536         "type": "json"
18537       }
18538     ],
18539     "name": "CreatePauses",
18540     "group": "Pauses",
18541     "parameter": {
18542       "fields": {
18543         "Body": [
18544           {
18545             "group": "Body",
18546             "type": "String",
18547             "optional": false,
18548             "field": "name",
18549             "description": ""
18550           },
18551           {
18552             "group": "Body",
18553             "type": "String",
18554             "optional": true,
18555             "field": "description",
18556             "description": ""
18557           }
18558         ]
18559       }
18560     },
18561     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18562     "version": "0.0.0",
18563     "filename": "server/api/pause/index.js",
18564     "groupTitle": "Pauses"
18565   },
18566   {
18567     "type": "delete",
18568     "url": "/api/pauses/{id}",
18569     "title": "Deletes a Pause",
18570     "examples": [
18571       {
18572         "title": "Example usage:",
18573         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password} -X DELETE",
18574         "type": "json"
18575       }
18576     ],
18577     "name": "DeletePauses",
18578     "group": "Pauses",
18579     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18580     "version": "0.0.0",
18581     "filename": "server/api/pause/index.js",
18582     "groupTitle": "Pauses"
18583   },
18584   {
18585     "type": "get",
18586     "url": "/api/pauses",
18587     "title": "Gets a list of Pauses",
18588     "examples": [
18589       {
18590         "title": "Example usage:",
18591         "content": "curl https://{domain}/api/pauses -v -u {name}:{password}",
18592         "type": "json"
18593       }
18594     ],
18595     "name": "GetPauses",
18596     "group": "Pauses",
18597     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18598     "version": "0.0.0",
18599     "filename": "server/api/pause/index.js",
18600     "groupTitle": "Pauses"
18601   },
18602   {
18603     "type": "get",
18604     "url": "/api/pauses/{id}",
18605     "title": "Gets a single Pause",
18606     "examples": [
18607       {
18608         "title": "Example usage:",
18609         "content": "curl https://{domain}/api/pauses/{id} -v -u {name}:{password}",
18610         "type": "json"
18611       }
18612     ],
18613     "name": "ShowPauses",
18614     "group": "Pauses",
18615     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18616     "version": "0.0.0",
18617     "filename": "server/api/pause/index.js",
18618     "groupTitle": "Pauses"
18619   },
18620   {
18621     "type": "put",
18622     "url": "/api/pauses/{id}",
18623     "title": "Update an existing Pause",
18624     "examples": [
18625       {
18626         "title": "Example usage:",
18627         "content": "curl https://{domain}/api/pauses/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18628         "type": "json"
18629       }
18630     ],
18631     "name": "updatePauses",
18632     "group": "Pauses",
18633     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18634     "version": "0.0.0",
18635     "filename": "server/api/pause/index.js",
18636     "groupTitle": "Pauses"
18637   },
18638   {
18639     "type": "get",
18640     "url": "/api/plugins",
18641     "title": "Gets a list of Plugins",
18642     "examples": [
18643       {
18644         "title": "Example usage:",
18645         "content": "curl https://{domain}/api/plugins -v -u {name}:{password}",
18646         "type": "json"
18647       }
18648     ],
18649     "name": "GetPlugins",
18650     "group": "Plugins",
18651     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
18652     "version": "0.0.0",
18653     "filename": "server/api/plugin/index.js",
18654     "groupTitle": "Plugins"
18655   },
18656   {
18657     "type": "get",
18658     "url": "/api/plugins/{id}",
18659     "title": "Gets a single Plugin",
18660     "examples": [
18661       {
18662         "title": "Example usage:",
18663         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password}",
18664         "type": "json"
18665       }
18666     ],
18667     "name": "ShowPlugins",
18668     "group": "Plugins",
18669     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18670     "version": "0.0.0",
18671     "filename": "server/api/plugin/index.js",
18672     "groupTitle": "Plugins"
18673   },
18674   {
18675     "type": "delete",
18676     "url": "/api/plugins/{id}",
18677     "title": "Delete a plugin",
18678     "examples": [
18679       {
18680         "title": "Example usage:",
18681         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X DELETE",
18682         "type": "json"
18683       }
18684     ],
18685     "name": "destroyPlugin",
18686     "group": "Plugins",
18687     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18688     "version": "0.0.0",
18689     "filename": "server/api/plugin/index.js",
18690     "groupTitle": "Plugins"
18691   },
18692   {
18693     "type": "get",
18694     "url": "/api/plugins/{id}/download",
18695     "title": "Download plugin source code",
18696     "examples": [
18697       {
18698         "title": "Example usage:",
18699         "content": "curl https://{domain}/api/plugins/{id}/download -v -u {name}:{password} -X GET",
18700         "type": "json"
18701       }
18702     ],
18703     "name": "download",
18704     "group": "Plugins",
18705     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18706     "version": "0.0.0",
18707     "filename": "server/api/plugin/index.js",
18708     "groupTitle": "Plugins"
18709   },
18710   {
18711     "type": "put",
18712     "url": "/api/plugins/{id}",
18713     "title": "Update an existing plugin",
18714     "examples": [
18715       {
18716         "title": "Example usage:",
18717         "content": "curl https://{domain}/api/plugins/{id} -v -u {name}:{password} -X PUT",
18718         "type": "json"
18719       }
18720     ],
18721     "name": "updatePlugin",
18722     "group": "Plugins",
18723     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18724     "version": "0.0.0",
18725     "filename": "server/api/plugin/index.js",
18726     "groupTitle": "Plugins"
18727   },
18728   {
18729     "type": "post",
18730     "url": "/api/plugins",
18731     "title": "Upload new plugin",
18732     "examples": [
18733       {
18734         "title": "Example usage:",
18735         "content": "curl https://{domain}/api/plugins -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
18736         "type": "json"
18737       }
18738     ],
18739     "name": "uploadPlugin",
18740     "group": "Plugins",
18741     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18742     "version": "0.0.0",
18743     "filename": "server/api/plugin/index.js",
18744     "groupTitle": "Plugins"
18745   },
18746   {
18747     "type": "post",
18748     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
18749     "title": "Redirect a plugin request to the specified path",
18750     "examples": [
18751       {
18752         "title": "Example usage:",
18753         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -H 'Content-Type: application/json' -X POST",
18754         "type": "json"
18755       }
18756     ],
18757     "name": "webhookPlugin",
18758     "group": "Plugins",
18759     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18760     "version": "0.0.0",
18761     "filename": "server/api/plugin/index.js",
18762     "groupTitle": "Plugins"
18763   },
18764   {
18765     "type": "get",
18766     "url": "/api/plugins/webhook?hostname={host}&port={port}&encoding={encoding}&json={json}&path={path}",
18767     "title": "Redirect a plugin request to the specified path",
18768     "examples": [
18769       {
18770         "title": "Example usage:",
18771         "content": "curl https://{domain}/api/plugins/webhook?port={port}&path={path} -v -u {name}:{password} -X GET",
18772         "type": "json"
18773       }
18774     ],
18775     "name": "webhookPlugin",
18776     "group": "Plugins",
18777     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18778     "version": "0.0.0",
18779     "filename": "server/api/plugin/index.js",
18780     "groupTitle": "Plugins"
18781   },
18782   {
18783     "type": "delete",
18784     "url": "/api/pm2/{id}",
18785     "title": "Deletes an existing process",
18786     "examples": [
18787       {
18788         "title": "Example usage:",
18789         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password} -X DELETE",
18790         "type": "json"
18791       }
18792     ],
18793     "name": "DeletePm2Process",
18794     "group": "Pm2",
18795     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18796     "version": "0.0.0",
18797     "filename": "server/api/pm2/index.js",
18798     "groupTitle": "Pm2"
18799   },
18800   {
18801     "type": "get",
18802     "url": "/api/pm2/{id}",
18803     "title": "Gets a single pm2 process",
18804     "examples": [
18805       {
18806         "title": "Example usage:",
18807         "content": "curl https://{domain}/api/pm2/{id} -v -u {name}:{password}",
18808         "type": "json"
18809       }
18810     ],
18811     "name": "GetPm2Process",
18812     "group": "Pm2",
18813     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18814     "version": "0.0.0",
18815     "filename": "server/api/pm2/index.js",
18816     "groupTitle": "Pm2"
18817   },
18818   {
18819     "type": "get",
18820     "url": "/api/pm2",
18821     "title": "Gets pm2 processes",
18822     "examples": [
18823       {
18824         "title": "Example usage:",
18825         "content": "curl https://{domain}/api/pm2 -v -u {name}:{password}",
18826         "type": "json"
18827       }
18828     ],
18829     "name": "GetPm2Processes",
18830     "group": "Pm2",
18831     "description": "<p>Motion returns the pm2 processes list.</p>",
18832     "version": "0.0.0",
18833     "filename": "server/api/pm2/index.js",
18834     "groupTitle": "Pm2"
18835   },
18836   {
18837     "type": "post",
18838     "url": "/api/pm2",
18839     "title": "Start a single pm2 process",
18840     "examples": [
18841       {
18842         "title": "Example usage:",
18843         "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",
18844         "type": "json"
18845       }
18846     ],
18847     "name": "StartPm2Process",
18848     "group": "Pm2",
18849     "parameter": {
18850       "fields": {
18851         "Body": [
18852           {
18853             "group": "Body",
18854             "type": "String",
18855             "optional": false,
18856             "field": "name",
18857             "description": ""
18858           },
18859           {
18860             "group": "Body",
18861             "type": "String",
18862             "optional": false,
18863             "field": "script",
18864             "description": ""
18865           }
18866         ]
18867       }
18868     },
18869     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18870     "version": "0.0.0",
18871     "filename": "server/api/pm2/index.js",
18872     "groupTitle": "Pm2"
18873   },
18874   {
18875     "type": "put",
18876     "url": "/api/pm2/{id}",
18877     "title": "Update an existing process",
18878     "examples": [
18879       {
18880         "title": "Example usage:",
18881         "content": "curl https://{domain}/api/pm2/{id} -d '{\"status\": \"online\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
18882         "type": "json"
18883       }
18884     ],
18885     "name": "UpdatePm2Process",
18886     "group": "Pm2",
18887     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
18888     "version": "0.0.0",
18889     "filename": "server/api/pm2/index.js",
18890     "groupTitle": "Pm2"
18891   },
18892   {
18893     "type": "get",
18894     "url": "/api/rpc/campaigns/",
18895     "title": "Gets a list of campaigns",
18896     "examples": [
18897       {
18898         "title": "Example usage:",
18899         "content": "curl https://{domain}/api/rpc/campaigns -v -u {name}:{password}",
18900         "type": "json"
18901       }
18902     ],
18903     "name": "Campaigns",
18904     "group": "RPC_Realtime",
18905     "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>",
18906     "version": "0.0.0",
18907     "filename": "server/api/rpc/index.js",
18908     "groupTitle": "RPC_Realtime"
18909   },
18910   {
18911     "type": "get",
18912     "url": "/api/rpc/fax/accounts",
18913     "title": "Gets a list of FaxAccounts",
18914     "examples": [
18915       {
18916         "title": "Example usage:",
18917         "content": "curl https://{domain}/api/rpc/fax/accounts -v -u {name}:{password}",
18918         "type": "json"
18919       }
18920     ],
18921     "name": "FaxAccounts",
18922     "group": "RPC_Realtime",
18923     "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>",
18924     "version": "0.0.0",
18925     "filename": "server/api/rpc/index.js",
18926     "groupTitle": "RPC_Realtime"
18927   },
18928   {
18929     "type": "put",
18930     "url": "/api/rpc/agents/:id/capacity",
18931     "title": "Sets agent capacity",
18932     "examples": [
18933       {
18934         "title": "Example usage:",
18935         "content": "curl https://{domain}/api/rpc/agents/:id/capacity -v -u {name}:{password}",
18936         "type": "json"
18937       }
18938     ],
18939     "name": "RTAgentCapacity",
18940     "group": "RPC_Realtime",
18941     "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>",
18942     "version": "0.0.0",
18943     "filename": "server/api/rpc/index.js",
18944     "groupTitle": "RPC_Realtime"
18945   },
18946   {
18947     "type": "get",
18948     "url": "/api/rpc/agents",
18949     "title": "Gets a list of RTAgents",
18950     "examples": [
18951       {
18952         "title": "Example usage:",
18953         "content": "curl https://{domain}/api/rpc/agents -v -u {name}:{password}",
18954         "type": "json"
18955       }
18956     ],
18957     "name": "RTAgents",
18958     "group": "RPC_Realtime",
18959     "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>",
18960     "version": "0.0.0",
18961     "filename": "server/api/rpc/index.js",
18962     "groupTitle": "RPC_Realtime"
18963   },
18964   {
18965     "type": "get",
18966     "url": "/api/rpc/chat/queues",
18967     "title": "Gets a list of RTChatQueues",
18968     "examples": [
18969       {
18970         "title": "Example usage:",
18971         "content": "curl https://{domain}/api/rpc/chat/queues -v -u {name}:{password}",
18972         "type": "json"
18973       }
18974     ],
18975     "name": "RTChatQueues",
18976     "group": "RPC_Realtime",
18977     "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>",
18978     "version": "0.0.0",
18979     "filename": "server/api/rpc/index.js",
18980     "groupTitle": "RPC_Realtime"
18981   },
18982   {
18983     "type": "get",
18984     "url": "/api/rpc/fax/queues",
18985     "title": "Gets a list of RTFaxQueues",
18986     "examples": [
18987       {
18988         "title": "Example usage:",
18989         "content": "curl https://{domain}/api/rpc/fax/queues -v -u {name}:{password}",
18990         "type": "json"
18991       }
18992     ],
18993     "name": "RTFaxQueues",
18994     "group": "RPC_Realtime",
18995     "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>",
18996     "version": "0.0.0",
18997     "filename": "server/api/rpc/index.js",
18998     "groupTitle": "RPC_Realtime"
18999   },
19000   {
19001     "type": "get",
19002     "url": "/api/rpc/mail/accounts",
19003     "title": "Gets a list of RTMailAccounts",
19004     "examples": [
19005       {
19006         "title": "Example usage:",
19007         "content": "curl https://{domain}/api/rpc/mail/accounts -v -u {name}:{password}",
19008         "type": "json"
19009       }
19010     ],
19011     "name": "RTMailAccounts",
19012     "group": "RPC_Realtime",
19013     "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>",
19014     "version": "0.0.0",
19015     "filename": "server/api/rpc/index.js",
19016     "groupTitle": "RPC_Realtime"
19017   },
19018   {
19019     "type": "get",
19020     "url": "/api/rpc/mail/queues",
19021     "title": "Gets a list of RTMailQueues",
19022     "examples": [
19023       {
19024         "title": "Example usage:",
19025         "content": "curl https://{domain}/api/rpc/mail/queues -v -u {name}:{password}",
19026         "type": "json"
19027       }
19028     ],
19029     "name": "RTMailQueues",
19030     "group": "RPC_Realtime",
19031     "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>",
19032     "version": "0.0.0",
19033     "filename": "server/api/rpc/index.js",
19034     "groupTitle": "RPC_Realtime"
19035   },
19036   {
19037     "type": "get",
19038     "url": "/api/rpc/openchannel/queues",
19039     "title": "Gets a list of RTOpenchannelQueues",
19040     "examples": [
19041       {
19042         "title": "Example usage:",
19043         "content": "curl https://{domain}/api/rpc/openchannel/queues -v -u {name}:{password}",
19044         "type": "json"
19045       }
19046     ],
19047     "name": "RTOpenchannelQueues",
19048     "group": "RPC_Realtime",
19049     "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>",
19050     "version": "0.0.0",
19051     "filename": "server/api/rpc/index.js",
19052     "groupTitle": "RPC_Realtime"
19053   },
19054   {
19055     "type": "get",
19056     "url": "/api/rpc/outbound/channels",
19057     "title": "Gets a list of RTOutboundChannels",
19058     "examples": [
19059       {
19060         "title": "Example usage:",
19061         "content": "curl https://{domain}/api/rpc/outbound/channels -v -u {name}:{password}",
19062         "type": "json"
19063       }
19064     ],
19065     "name": "RTOutboundChannels",
19066     "group": "RPC_Realtime",
19067     "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>",
19068     "version": "0.0.0",
19069     "filename": "server/api/rpc/index.js",
19070     "groupTitle": "RPC_Realtime"
19071   },
19072   {
19073     "type": "get",
19074     "url": "/api/rpc/sms/queues",
19075     "title": "Gets a list of RTSmsQueues",
19076     "examples": [
19077       {
19078         "title": "Example usage:",
19079         "content": "curl https://{domain}/api/rpc/sms/queues -v -u {name}:{password}",
19080         "type": "json"
19081       }
19082     ],
19083     "name": "RTSmsQueues",
19084     "group": "RPC_Realtime",
19085     "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>",
19086     "version": "0.0.0",
19087     "filename": "server/api/rpc/index.js",
19088     "groupTitle": "RPC_Realtime"
19089   },
19090   {
19091     "type": "get",
19092     "url": "/api/rpc/telephones",
19093     "title": "Gets a list of RTTelephones",
19094     "examples": [
19095       {
19096         "title": "Example usage:",
19097         "content": "curl https://{domain}/api/rpc/telephones -v -u {name}:{password}",
19098         "type": "json"
19099       }
19100     ],
19101     "name": "RTTelephones",
19102     "group": "RPC_Realtime",
19103     "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>",
19104     "version": "0.0.0",
19105     "filename": "server/api/rpc/index.js",
19106     "groupTitle": "RPC_Realtime"
19107   },
19108   {
19109     "type": "get",
19110     "url": "/api/rpc/trunks",
19111     "title": "Gets a list of RTTrunks",
19112     "examples": [
19113       {
19114         "title": "Example usage:",
19115         "content": "curl https://{domain}/api/rpc/trunks -v -u {name}:{password}",
19116         "type": "json"
19117       }
19118     ],
19119     "name": "RTTrunks",
19120     "group": "RPC_Realtime",
19121     "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>",
19122     "version": "0.0.0",
19123     "filename": "server/api/rpc/index.js",
19124     "groupTitle": "RPC_Realtime"
19125   },
19126   {
19127     "type": "get",
19128     "url": "/api/rpc/voice/channels",
19129     "title": "Gets a list of RTVoiceChannelMixMonitor",
19130     "examples": [
19131       {
19132         "title": "Example usage:",
19133         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/mixmonitor -v -u {name}:{password}",
19134         "type": "json"
19135       }
19136     ],
19137     "name": "RTVoiceChannelMixMonitor",
19138     "group": "RPC_Realtime",
19139     "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>",
19140     "version": "0.0.0",
19141     "filename": "server/api/rpc/index.js",
19142     "groupTitle": "RPC_Realtime"
19143   },
19144   {
19145     "type": "get",
19146     "url": "/api/rpc/voice/channels",
19147     "title": "Gets a list of RTVoiceChannelStopMixMonitor",
19148     "examples": [
19149       {
19150         "title": "Example usage:",
19151         "content": "curl https://{domain}/api/rpc/voice/channels/{uniqueid}/stopmixmonitor -v -u {name}:{password}",
19152         "type": "json"
19153       }
19154     ],
19155     "name": "RTVoiceChannelStopMixMonitor",
19156     "group": "RPC_Realtime",
19157     "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>",
19158     "version": "0.0.0",
19159     "filename": "server/api/rpc/index.js",
19160     "groupTitle": "RPC_Realtime"
19161   },
19162   {
19163     "type": "get",
19164     "url": "/api/rpc/voice/channels",
19165     "title": "Gets a list of RTVoiceChannels",
19166     "examples": [
19167       {
19168         "title": "Example usage:",
19169         "content": "curl https://{domain}/api/rpc/voice/channels -v -u {name}:{password}",
19170         "type": "json"
19171       }
19172     ],
19173     "name": "RTVoiceChannels",
19174     "group": "RPC_Realtime",
19175     "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>",
19176     "version": "0.0.0",
19177     "filename": "server/api/rpc/index.js",
19178     "groupTitle": "RPC_Realtime"
19179   },
19180   {
19181     "type": "get",
19182     "url": "/api/rpc/voice/queues/channels/{uniqueid}",
19183     "title": "Gets a single RTVoiceQueueChannel",
19184     "examples": [
19185       {
19186         "title": "Example usage:",
19187         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid} -v -u {name}:{password}",
19188         "type": "json"
19189       }
19190     ],
19191     "name": "RTVoiceQueueChannel",
19192     "group": "RPC_Realtime",
19193     "description": "<p>Motion will return a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19194     "version": "0.0.0",
19195     "filename": "server/api/rpc/index.js",
19196     "groupTitle": "RPC_Realtime"
19197   },
19198   {
19199     "type": "get",
19200     "url": "/api/rpc/voice/queues/channels/{uniqueid}/hangup",
19201     "title": "Hangup a single RTVoiceQueueChannel",
19202     "examples": [
19203       {
19204         "title": "Example usage:",
19205         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/hangup -v -u {name}:{password}",
19206         "type": "json"
19207       }
19208     ],
19209     "name": "RTVoiceQueueChannelHangup",
19210     "group": "RPC_Realtime",
19211     "description": "<p>Motion will hangup a specific realtime voice queue channel.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19212     "version": "0.0.0",
19213     "filename": "server/api/rpc/index.js",
19214     "groupTitle": "RPC_Realtime"
19215   },
19216   {
19217     "type": "get",
19218     "url": "/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten}",
19219     "title": "Hangup a single RTVoiceQueueChannel",
19220     "examples": [
19221       {
19222         "title": "Example usage:",
19223         "content": "curl https://{domain}/api/rpc/voice/queues/channels/{uniqueid}/redirect/{exten} -v -u {name}:{password}",
19224         "type": "json"
19225       }
19226     ],
19227     "name": "RTVoiceQueueChannelRedirect",
19228     "group": "RPC_Realtime",
19229     "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>",
19230     "version": "0.0.0",
19231     "filename": "server/api/rpc/index.js",
19232     "groupTitle": "RPC_Realtime"
19233   },
19234   {
19235     "type": "get",
19236     "url": "/api/rpc/voice/queues/preview/{id}",
19237     "title": "Gets a single preview contact",
19238     "examples": [
19239       {
19240         "title": "Example usage:",
19241         "content": "curl https://{domain}/api/rpc/voice/queues/preview/{id} -v -u {name}:{password}",
19242         "type": "json"
19243       }
19244     ],
19245     "name": "RTVoiceQueuePreview",
19246     "group": "RPC_Realtime",
19247     "description": "<p>Motion will return a specific preview contact.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19248     "version": "0.0.0",
19249     "filename": "server/api/rpc/index.js",
19250     "groupTitle": "RPC_Realtime"
19251   },
19252   {
19253     "type": "get",
19254     "url": "/api/rpc/outbound",
19255     "title": "Gets a list of RTOutbound",
19256     "examples": [
19257       {
19258         "title": "Example usage:",
19259         "content": "curl https://{domain}/api/rpc/outbound -v -u {name}:{password}",
19260         "type": "json"
19261       }
19262     ],
19263     "name": "RTVoiceQueues",
19264     "group": "RPC_Realtime",
19265     "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>",
19266     "version": "0.0.0",
19267     "filename": "server/api/rpc/index.js",
19268     "groupTitle": "RPC_Realtime"
19269   },
19270   {
19271     "type": "get",
19272     "url": "/api/rpc/voice/queues",
19273     "title": "Gets a list of RTVoiceQueues",
19274     "examples": [
19275       {
19276         "title": "Example usage:",
19277         "content": "curl https://{domain}/api/rpc/voice/queues -v -u {name}:{password}",
19278         "type": "json"
19279       }
19280     ],
19281     "name": "RTVoiceQueues",
19282     "group": "RPC_Realtime",
19283     "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>",
19284     "version": "0.0.0",
19285     "filename": "server/api/rpc/index.js",
19286     "groupTitle": "RPC_Realtime"
19287   },
19288   {
19289     "type": "get",
19290     "url": "/api/rpc/voice/queues/channels",
19291     "title": "Gets a list of RTVoiceQueuesChannels",
19292     "examples": [
19293       {
19294         "title": "Example usage:",
19295         "content": "curl https://{domain}/api/rpc/voice/queues/channels -v -u {name}:{password}",
19296         "type": "json"
19297       }
19298     ],
19299     "name": "RTVoiceQueuesChannels",
19300     "group": "RPC_Realtime",
19301     "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>",
19302     "version": "0.0.0",
19303     "filename": "server/api/rpc/index.js",
19304     "groupTitle": "RPC_Realtime"
19305   },
19306   {
19307     "type": "get",
19308     "url": "/api/rpc/chat/queues/{id}",
19309     "title": "Gets a single RTChatQueue",
19310     "examples": [
19311       {
19312         "title": "Example usage:",
19313         "content": "curl https://{domain}/api/rpc/chat/queues/{id} -v -u {name}:{password}",
19314         "type": "json"
19315       }
19316     ],
19317     "name": "ShowRTChatQueues",
19318     "group": "RPC_Realtime",
19319     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19320     "version": "0.0.0",
19321     "filename": "server/api/rpc/index.js",
19322     "groupTitle": "RPC_Realtime"
19323   },
19324   {
19325     "type": "get",
19326     "url": "/api/rpc/fax/queues/{id}",
19327     "title": "Gets a single RTFaxQueue",
19328     "examples": [
19329       {
19330         "title": "Example usage:",
19331         "content": "curl https://{domain}/api/rpc/fax/queues/{id} -v -u {name}:{password}",
19332         "type": "json"
19333       }
19334     ],
19335     "name": "ShowRTFaxQueues",
19336     "group": "RPC_Realtime",
19337     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19338     "version": "0.0.0",
19339     "filename": "server/api/rpc/index.js",
19340     "groupTitle": "RPC_Realtime"
19341   },
19342   {
19343     "type": "get",
19344     "url": "/api/rpc/mail/queues/{id}",
19345     "title": "Gets a single RTMailQueue",
19346     "examples": [
19347       {
19348         "title": "Example usage:",
19349         "content": "curl https://{domain}/api/rpc/mail/queues/{id} -v -u {name}:{password}",
19350         "type": "json"
19351       }
19352     ],
19353     "name": "ShowRTMailQueues",
19354     "group": "RPC_Realtime",
19355     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19356     "version": "0.0.0",
19357     "filename": "server/api/rpc/index.js",
19358     "groupTitle": "RPC_Realtime"
19359   },
19360   {
19361     "type": "get",
19362     "url": "/api/rpc/openchannel/queues/{id}",
19363     "title": "Gets a single RTOpenchannelQueue",
19364     "examples": [
19365       {
19366         "title": "Example usage:",
19367         "content": "curl https://{domain}/api/rpc/openchannel/queues/{id} -v -u {name}:{password}",
19368         "type": "json"
19369       }
19370     ],
19371     "name": "ShowRTOpenchannelQueues",
19372     "group": "RPC_Realtime",
19373     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19374     "version": "0.0.0",
19375     "filename": "server/api/rpc/index.js",
19376     "groupTitle": "RPC_Realtime"
19377   },
19378   {
19379     "type": "get",
19380     "url": "/api/rpc/sms/queues/{id}",
19381     "title": "Gets a single RTSmsQueue",
19382     "examples": [
19383       {
19384         "title": "Example usage:",
19385         "content": "curl https://{domain}/api/rpc/sms/queues/{id} -v -u {name}:{password}",
19386         "type": "json"
19387       }
19388     ],
19389     "name": "ShowRTSmsQueues",
19390     "group": "RPC_Realtime",
19391     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19392     "version": "0.0.0",
19393     "filename": "server/api/rpc/index.js",
19394     "groupTitle": "RPC_Realtime"
19395   },
19396   {
19397     "type": "get",
19398     "url": "/api/rpc/voice/queues/{id}",
19399     "title": "Gets a single RTVoiceQueue",
19400     "examples": [
19401       {
19402         "title": "Example usage:",
19403         "content": "curl https://{domain}/api/rpc/voice/queues/{id} -v -u {name}:{password}",
19404         "type": "json"
19405       }
19406     ],
19407     "name": "ShowRTVoiceQueues",
19408     "group": "RPC_Realtime",
19409     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19410     "version": "0.0.0",
19411     "filename": "server/api/rpc/index.js",
19412     "groupTitle": "RPC_Realtime"
19413   },
19414   {
19415     "type": "post",
19416     "url": "/api/rpc/agents/:id/notify",
19417     "title": "Notify message to a specific agent",
19418     "examples": [
19419       {
19420         "title": "Example usage:",
19421         "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",
19422         "type": "json"
19423       }
19424     ],
19425     "name": "agentNotify",
19426     "group": "RPC_Realtime",
19427     "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>",
19428     "version": "0.0.0",
19429     "filename": "server/api/rpc/index.js",
19430     "groupTitle": "RPC_Realtime"
19431   },
19432   {
19433     "type": "post",
19434     "url": "/api/rpc/chat/queues/:id/notify",
19435     "title": "Notify message to a specific queue",
19436     "examples": [
19437       {
19438         "title": "Example usage:",
19439         "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",
19440         "type": "json"
19441       }
19442     ],
19443     "name": "chatQueueNotify",
19444     "group": "RPC_Realtime",
19445     "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>",
19446     "version": "0.0.0",
19447     "filename": "server/api/rpc/index.js",
19448     "groupTitle": "RPC_Realtime"
19449   },
19450   {
19451     "type": "get",
19452     "url": "/api/rpc/chat/queues/waitinginteractions",
19453     "title": "Gets a list of chatQueuesWaitingInteractions",
19454     "examples": [
19455       {
19456         "title": "Example usage:",
19457         "content": "curl https://{domain}/api/rpc/chat/queues/waitinginteractions -v -u {name}:{password}",
19458         "type": "json"
19459       }
19460     ],
19461     "name": "chatQueuesWaitingInteractions",
19462     "group": "RPC_Realtime",
19463     "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>",
19464     "version": "0.0.0",
19465     "filename": "server/api/rpc/index.js",
19466     "groupTitle": "RPC_Realtime"
19467   },
19468   {
19469     "type": "post",
19470     "url": "/api/rpc/fax/queues/:id/notify",
19471     "title": "Notify message to a specific queue",
19472     "examples": [
19473       {
19474         "title": "Example usage:",
19475         "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",
19476         "type": "json"
19477       }
19478     ],
19479     "name": "faxQueueNotify",
19480     "group": "RPC_Realtime",
19481     "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>",
19482     "version": "0.0.0",
19483     "filename": "server/api/rpc/index.js",
19484     "groupTitle": "RPC_Realtime"
19485   },
19486   {
19487     "type": "get",
19488     "url": "/api/rpc/fax/queues/waitinginteractions",
19489     "title": "Gets a list of faxQueuesWaitingInteractions",
19490     "examples": [
19491       {
19492         "title": "Example usage:",
19493         "content": "curl https://{domain}/api/rpc/fax/queues/waitinginteractions -v -u {name}:{password}",
19494         "type": "json"
19495       }
19496     ],
19497     "name": "faxQueuesWaitingInteractions",
19498     "group": "RPC_Realtime",
19499     "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>",
19500     "version": "0.0.0",
19501     "filename": "server/api/rpc/index.js",
19502     "groupTitle": "RPC_Realtime"
19503   },
19504   {
19505     "type": "post",
19506     "url": "/api/rpc/mail/queues/:id/notify",
19507     "title": "Notify message to a specific queue",
19508     "examples": [
19509       {
19510         "title": "Example usage:",
19511         "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",
19512         "type": "json"
19513       }
19514     ],
19515     "name": "mailQueueNotify",
19516     "group": "RPC_Realtime",
19517     "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>",
19518     "version": "0.0.0",
19519     "filename": "server/api/rpc/index.js",
19520     "groupTitle": "RPC_Realtime"
19521   },
19522   {
19523     "type": "get",
19524     "url": "/api/rpc/mail/queues/waitinginteractions",
19525     "title": "Gets a list of mailQueuesWaitingInteractions",
19526     "examples": [
19527       {
19528         "title": "Example usage:",
19529         "content": "curl https://{domain}/api/rpc/mail/queues/waitinginteractions -v -u {name}:{password}",
19530         "type": "json"
19531       }
19532     ],
19533     "name": "mailQueuesWaitingInteractions",
19534     "group": "RPC_Realtime",
19535     "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>",
19536     "version": "0.0.0",
19537     "filename": "server/api/rpc/index.js",
19538     "groupTitle": "RPC_Realtime"
19539   },
19540   {
19541     "type": "post",
19542     "url": "/api/rpc/openchannel/queues/:id/notify",
19543     "title": "Notify message to a specific queue",
19544     "examples": [
19545       {
19546         "title": "Example usage:",
19547         "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",
19548         "type": "json"
19549       }
19550     ],
19551     "name": "openchannelQueueNotify",
19552     "group": "RPC_Realtime",
19553     "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>",
19554     "version": "0.0.0",
19555     "filename": "server/api/rpc/index.js",
19556     "groupTitle": "RPC_Realtime"
19557   },
19558   {
19559     "type": "get",
19560     "url": "/api/rpc/openchannel/queues/waitinginteractions",
19561     "title": "Gets a list of openchannelQueuesWaitingInteractions",
19562     "examples": [
19563       {
19564         "title": "Example usage:",
19565         "content": "curl https://{domain}/api/rpc/openchannel/queues/waitinginteractions -v -u {name}:{password}",
19566         "type": "json"
19567       }
19568     ],
19569     "name": "openchannelQueuesWaitingInteractions",
19570     "group": "RPC_Realtime",
19571     "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>",
19572     "version": "0.0.0",
19573     "filename": "server/api/rpc/index.js",
19574     "groupTitle": "RPC_Realtime"
19575   },
19576   {
19577     "type": "post",
19578     "url": "/api/rpc/sms/queues/:id/notify",
19579     "title": "Notify message to a specific queue",
19580     "examples": [
19581       {
19582         "title": "Example usage:",
19583         "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",
19584         "type": "json"
19585       }
19586     ],
19587     "name": "smsQueueNotify",
19588     "group": "RPC_Realtime",
19589     "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>",
19590     "version": "0.0.0",
19591     "filename": "server/api/rpc/index.js",
19592     "groupTitle": "RPC_Realtime"
19593   },
19594   {
19595     "type": "get",
19596     "url": "/api/rpc/sms/queues/waitinginteractions",
19597     "title": "Gets a list of smsQueuesWaitingInteractions",
19598     "examples": [
19599       {
19600         "title": "Example usage:",
19601         "content": "curl https://{domain}/api/rpc/sms/queues/waitinginteractions -v -u {name}:{password}",
19602         "type": "json"
19603       }
19604     ],
19605     "name": "smsQueuesWaitingInteractions",
19606     "group": "RPC_Realtime",
19607     "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>",
19608     "version": "0.0.0",
19609     "filename": "server/api/rpc/index.js",
19610     "groupTitle": "RPC_Realtime"
19611   },
19612   {
19613     "type": "post",
19614     "url": "/api/integrations/salesforce/accounts",
19615     "title": "Creates a new Salesforce Account",
19616     "examples": [
19617       {
19618         "title": "Example usage:",
19619         "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",
19620         "type": "json"
19621       }
19622     ],
19623     "name": "CreateSalesforce_Accounts",
19624     "group": "Salesforce_Accounts",
19625     "parameter": {
19626       "fields": {
19627         "Body": [
19628           {
19629             "group": "Body",
19630             "type": "String",
19631             "optional": true,
19632             "field": "name",
19633             "description": ""
19634           },
19635           {
19636             "group": "Body",
19637             "type": "String",
19638             "optional": true,
19639             "field": "description",
19640             "description": ""
19641           },
19642           {
19643             "group": "Body",
19644             "type": "String",
19645             "optional": true,
19646             "field": "username",
19647             "description": ""
19648           },
19649           {
19650             "group": "Body",
19651             "type": "String",
19652             "optional": true,
19653             "field": "remoteUri",
19654             "description": ""
19655           },
19656           {
19657             "group": "Body",
19658             "type": "String",
19659             "optional": true,
19660             "field": "password",
19661             "description": ""
19662           },
19663           {
19664             "group": "Body",
19665             "type": "String",
19666             "optional": true,
19667             "field": "clientId",
19668             "description": ""
19669           },
19670           {
19671             "group": "Body",
19672             "type": "String",
19673             "optional": true,
19674             "field": "clientSecret",
19675             "description": ""
19676           },
19677           {
19678             "group": "Body",
19679             "type": "String",
19680             "optional": true,
19681             "field": "securityToken",
19682             "description": ""
19683           },
19684           {
19685             "group": "Body",
19686             "type": "String",
19687             "optional": true,
19688             "field": "serverUrl",
19689             "description": ""
19690           },
19691           {
19692             "group": "Body",
19693             "type": "String",
19694             "allowedValues": [
19695               "\"integrationTab\"",
19696               "\"newTab\""
19697             ],
19698             "optional": true,
19699             "field": "type",
19700             "description": ""
19701           }
19702         ]
19703       }
19704     },
19705     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19706     "version": "0.0.0",
19707     "filename": "server/api/intSalesforceAccount/index.js",
19708     "groupTitle": "Salesforce_Accounts"
19709   },
19710   {
19711     "type": "delete",
19712     "url": "/api/integrations/salesforce/accounts/{id}",
19713     "title": "Deletes a Salesforce Account",
19714     "examples": [
19715       {
19716         "title": "Example usage:",
19717         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password} -X DELETE",
19718         "type": "json"
19719       }
19720     ],
19721     "name": "DeleteSalesforce_Accounts",
19722     "group": "Salesforce_Accounts",
19723     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19724     "version": "0.0.0",
19725     "filename": "server/api/intSalesforceAccount/index.js",
19726     "groupTitle": "Salesforce_Accounts"
19727   },
19728   {
19729     "type": "get",
19730     "url": "/api/integrations/salesforce/accounts",
19731     "title": "Gets a list of Salesforce Accounts",
19732     "examples": [
19733       {
19734         "title": "Example usage:",
19735         "content": "curl https://{domain}/api/integrations/salesforce/accounts -v -u {name}:{password}",
19736         "type": "json"
19737       }
19738     ],
19739     "name": "GetSalesforce_Accounts",
19740     "group": "Salesforce_Accounts",
19741     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19742     "version": "0.0.0",
19743     "filename": "server/api/intSalesforceAccount/index.js",
19744     "groupTitle": "Salesforce_Accounts"
19745   },
19746   {
19747     "type": "get",
19748     "url": "/api/integrations/salesforce/accounts/{id}",
19749     "title": "Gets a single Salesforce Account",
19750     "examples": [
19751       {
19752         "title": "Example usage:",
19753         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id} -v -u {name}:{password}",
19754         "type": "json"
19755       }
19756     ],
19757     "name": "ShowSalesforce_Accounts",
19758     "group": "Salesforce_Accounts",
19759     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19760     "version": "0.0.0",
19761     "filename": "server/api/intSalesforceAccount/index.js",
19762     "groupTitle": "Salesforce_Accounts"
19763   },
19764   {
19765     "type": "post",
19766     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
19767     "title": "Creates new configuration",
19768     "examples": [
19769       {
19770         "title": "Example usage:",
19771         "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",
19772         "type": "json"
19773       }
19774     ],
19775     "name": "addConfiguration",
19776     "group": "Salesforce_Accounts",
19777     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19778     "version": "0.0.0",
19779     "filename": "server/api/intSalesforceAccount/index.js",
19780     "groupTitle": "Salesforce_Accounts"
19781   },
19782   {
19783     "type": "get",
19784     "url": "/api/integrations/salesforce/accounts/{id}/configurations",
19785     "title": "Gets account configurations",
19786     "examples": [
19787       {
19788         "title": "Example usage:",
19789         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/configurations -v -u {name}:{password} -X GET",
19790         "type": "json"
19791       }
19792     ],
19793     "name": "getConfigurations",
19794     "group": "Salesforce_Accounts",
19795     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19796     "version": "0.0.0",
19797     "filename": "server/api/intSalesforceAccount/index.js",
19798     "groupTitle": "Salesforce_Accounts"
19799   },
19800   {
19801     "type": "get",
19802     "url": "/api/integrations/salesforce/accounts/{id}/fields",
19803     "title": "Gets account fields",
19804     "examples": [
19805       {
19806         "title": "Example usage:",
19807         "content": "curl https://{domain}/api/integrations/salesforce/accounts/{id}/fields -v -u {name}:{password} -X GET",
19808         "type": "json"
19809       }
19810     ],
19811     "name": "getFields",
19812     "group": "Salesforce_Accounts",
19813     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19814     "version": "0.0.0",
19815     "filename": "server/api/intSalesforceAccount/index.js",
19816     "groupTitle": "Salesforce_Accounts"
19817   },
19818   {
19819     "type": "put",
19820     "url": "/api/integrations/salesforce/accounts/{id}",
19821     "title": "Update an existing Salesforce Account",
19822     "examples": [
19823       {
19824         "title": "Example usage:",
19825         "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",
19826         "type": "json"
19827       }
19828     ],
19829     "name": "updateSalesforce_Accounts",
19830     "group": "Salesforce_Accounts",
19831     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19832     "version": "0.0.0",
19833     "filename": "server/api/intSalesforceAccount/index.js",
19834     "groupTitle": "Salesforce_Accounts"
19835   },
19836   {
19837     "type": "post",
19838     "url": "/api/integrations/salesforce/configurations",
19839     "title": "Creates a new Salesforce Configuration",
19840     "examples": [
19841       {
19842         "title": "Example usage:",
19843         "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",
19844         "type": "json"
19845       }
19846     ],
19847     "name": "CreateSalesforce_Configurations",
19848     "group": "Salesforce_Configurations",
19849     "parameter": {
19850       "fields": {
19851         "Body": [
19852           {
19853             "group": "Body",
19854             "type": "String",
19855             "optional": true,
19856             "field": "name",
19857             "description": ""
19858           },
19859           {
19860             "group": "Body",
19861             "type": "String",
19862             "optional": true,
19863             "field": "description",
19864             "description": ""
19865           },
19866           {
19867             "group": "Body",
19868             "type": "String",
19869             "allowedValues": [
19870               "\"Task\"",
19871               "\"Case\""
19872             ],
19873             "optional": true,
19874             "field": "ticketType",
19875             "description": ""
19876           },
19877           {
19878             "group": "Body",
19879             "type": "String",
19880             "allowedValues": [
19881               "\"contact_lead\"",
19882               "\"contact\"",
19883               "\"lead\""
19884             ],
19885             "optional": true,
19886             "field": "moduleSearch",
19887             "description": ""
19888           },
19889           {
19890             "group": "Body",
19891             "type": "String",
19892             "allowedValues": [
19893               "\"nothing\"",
19894               "\"contact\"",
19895               "\"lead\""
19896             ],
19897             "optional": true,
19898             "field": "moduleCreate",
19899             "description": ""
19900           }
19901         ]
19902       }
19903     },
19904     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19905     "version": "0.0.0",
19906     "filename": "server/api/intSalesforceConfiguration/index.js",
19907     "groupTitle": "Salesforce_Configurations"
19908   },
19909   {
19910     "type": "delete",
19911     "url": "/api/integrations/salesforce/configurations/{id}",
19912     "title": "Deletes a Salesforce Configuration",
19913     "examples": [
19914       {
19915         "title": "Example usage:",
19916         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password} -X DELETE",
19917         "type": "json"
19918       }
19919     ],
19920     "name": "DeleteSalesforce_Configurations",
19921     "group": "Salesforce_Configurations",
19922     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19923     "version": "0.0.0",
19924     "filename": "server/api/intSalesforceConfiguration/index.js",
19925     "groupTitle": "Salesforce_Configurations"
19926   },
19927   {
19928     "type": "get",
19929     "url": "/api/integrations/salesforce/configurations",
19930     "title": "Gets a list of Salesforce Configurations",
19931     "examples": [
19932       {
19933         "title": "Example usage:",
19934         "content": "curl https://{domain}/api/integrations/salesforce/configurations -v -u {name}:{password}",
19935         "type": "json"
19936       }
19937     ],
19938     "name": "GetSalesforce_Configurations",
19939     "group": "Salesforce_Configurations",
19940     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
19941     "version": "0.0.0",
19942     "filename": "server/api/intSalesforceConfiguration/index.js",
19943     "groupTitle": "Salesforce_Configurations"
19944   },
19945   {
19946     "type": "get",
19947     "url": "/api/integrations/salesforce/configurations/{id}",
19948     "title": "Gets a single Salesforce Configuration",
19949     "examples": [
19950       {
19951         "title": "Example usage:",
19952         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id} -v -u {name}:{password}",
19953         "type": "json"
19954       }
19955     ],
19956     "name": "ShowSalesforce_Configurations",
19957     "group": "Salesforce_Configurations",
19958     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19959     "version": "0.0.0",
19960     "filename": "server/api/intSalesforceConfiguration/index.js",
19961     "groupTitle": "Salesforce_Configurations"
19962   },
19963   {
19964     "type": "get",
19965     "url": "/api/integrations/salesforce/configurations/{id}/descriptions",
19966     "title": "Gets configurations descriptions",
19967     "examples": [
19968       {
19969         "title": "Example usage:",
19970         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
19971         "type": "json"
19972       }
19973     ],
19974     "name": "getDescriptions",
19975     "group": "Salesforce_Configurations",
19976     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19977     "version": "0.0.0",
19978     "filename": "server/api/intSalesforceConfiguration/index.js",
19979     "groupTitle": "Salesforce_Configurations"
19980   },
19981   {
19982     "type": "get",
19983     "url": "/api/integrations/salesforce/configurations/{id}/fields",
19984     "title": "Gets configurations fields",
19985     "examples": [
19986       {
19987         "title": "Example usage:",
19988         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/fields -v -u {name}:{password} -X GET",
19989         "type": "json"
19990       }
19991     ],
19992     "name": "getFields",
19993     "group": "Salesforce_Configurations",
19994     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
19995     "version": "0.0.0",
19996     "filename": "server/api/intSalesforceConfiguration/index.js",
19997     "groupTitle": "Salesforce_Configurations"
19998   },
19999   {
20000     "type": "get",
20001     "url": "/api/integrations/salesforce/configurations/{id}/subjects",
20002     "title": "Gets configurations subjects",
20003     "examples": [
20004       {
20005         "title": "Example usage:",
20006         "content": "curl https://{domain}/api/integrations/salesforce/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20007         "type": "json"
20008       }
20009     ],
20010     "name": "getSubjects",
20011     "group": "Salesforce_Configurations",
20012     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20013     "version": "0.0.0",
20014     "filename": "server/api/intSalesforceConfiguration/index.js",
20015     "groupTitle": "Salesforce_Configurations"
20016   },
20017   {
20018     "type": "put",
20019     "url": "/api/integrations/salesforce/configurations/{id}",
20020     "title": "Update an existing Salesforce Configuration",
20021     "examples": [
20022       {
20023         "title": "Example usage:",
20024         "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",
20025         "type": "json"
20026       }
20027     ],
20028     "name": "updateSalesforce_Configurations",
20029     "group": "Salesforce_Configurations",
20030     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20031     "version": "0.0.0",
20032     "filename": "server/api/intSalesforceConfiguration/index.js",
20033     "groupTitle": "Salesforce_Configurations"
20034   },
20035   {
20036     "type": "post",
20037     "url": "/api/integrations/salesforce/fields",
20038     "title": "Creates a new Salesforce Field",
20039     "examples": [
20040       {
20041         "title": "Example usage:",
20042         "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",
20043         "type": "json"
20044       }
20045     ],
20046     "name": "CreateSalesforce_Fields",
20047     "group": "Salesforce_Fields",
20048     "parameter": {
20049       "fields": {
20050         "Body": [
20051           {
20052             "group": "Body",
20053             "type": "String",
20054             "allowedValues": [
20055               "\"string\"",
20056               "\"variable\"",
20057               "\"customVariable\"",
20058               "\"keyValue\""
20059             ],
20060             "optional": true,
20061             "field": "type",
20062             "description": ""
20063           },
20064           {
20065             "group": "Body",
20066             "type": "String",
20067             "optional": true,
20068             "field": "content",
20069             "description": ""
20070           },
20071           {
20072             "group": "Body",
20073             "type": "String",
20074             "optional": true,
20075             "field": "key",
20076             "description": ""
20077           },
20078           {
20079             "group": "Body",
20080             "type": "String",
20081             "allowedValues": [
20082               "\"string\"",
20083               "\"variable\"",
20084               "\"customVariable\""
20085             ],
20086             "optional": true,
20087             "field": "keyType",
20088             "description": ""
20089           },
20090           {
20091             "group": "Body",
20092             "type": "String",
20093             "optional": true,
20094             "field": "keyContent",
20095             "description": ""
20096           },
20097           {
20098             "group": "Body",
20099             "type": "String",
20100             "optional": true,
20101             "field": "idField",
20102             "description": ""
20103           },
20104           {
20105             "group": "Body",
20106             "type": "String",
20107             "optional": true,
20108             "field": "variableName",
20109             "description": ""
20110           }
20111         ]
20112       }
20113     },
20114     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20115     "version": "0.0.0",
20116     "filename": "server/api/intSalesforceField/index.js",
20117     "groupTitle": "Salesforce_Fields"
20118   },
20119   {
20120     "type": "delete",
20121     "url": "/api/integrations/salesforce/fields/{id}",
20122     "title": "Deletes a Salesforce Field",
20123     "examples": [
20124       {
20125         "title": "Example usage:",
20126         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password} -X DELETE",
20127         "type": "json"
20128       }
20129     ],
20130     "name": "DeleteSalesforce_Fields",
20131     "group": "Salesforce_Fields",
20132     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20133     "version": "0.0.0",
20134     "filename": "server/api/intSalesforceField/index.js",
20135     "groupTitle": "Salesforce_Fields"
20136   },
20137   {
20138     "type": "get",
20139     "url": "/api/integrations/salesforce/fields",
20140     "title": "Gets a list of Salesforce Fields",
20141     "examples": [
20142       {
20143         "title": "Example usage:",
20144         "content": "curl https://{domain}/api/integrations/salesforce/fields -v -u {name}:{password}",
20145         "type": "json"
20146       }
20147     ],
20148     "name": "GetSalesforce_Fields",
20149     "group": "Salesforce_Fields",
20150     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20151     "version": "0.0.0",
20152     "filename": "server/api/intSalesforceField/index.js",
20153     "groupTitle": "Salesforce_Fields"
20154   },
20155   {
20156     "type": "get",
20157     "url": "/api/integrations/salesforce/fields/{id}",
20158     "title": "Gets a single Salesforce Field",
20159     "examples": [
20160       {
20161         "title": "Example usage:",
20162         "content": "curl https://{domain}/api/integrations/salesforce/fields/{id} -v -u {name}:{password}",
20163         "type": "json"
20164       }
20165     ],
20166     "name": "ShowSalesforce_Fields",
20167     "group": "Salesforce_Fields",
20168     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20169     "version": "0.0.0",
20170     "filename": "server/api/intSalesforceField/index.js",
20171     "groupTitle": "Salesforce_Fields"
20172   },
20173   {
20174     "type": "put",
20175     "url": "/api/integrations/salesforce/fields/{id}",
20176     "title": "Update an existing Salesforce Field",
20177     "examples": [
20178       {
20179         "title": "Example usage:",
20180         "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",
20181         "type": "json"
20182       }
20183     ],
20184     "name": "updateSalesforce_Fields",
20185     "group": "Salesforce_Fields",
20186     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20187     "version": "0.0.0",
20188     "filename": "server/api/intSalesforceField/index.js",
20189     "groupTitle": "Salesforce_Fields"
20190   },
20191   {
20192     "type": "post",
20193     "url": "/api/schedules",
20194     "title": "Creates a new Schedule",
20195     "examples": [
20196       {
20197         "title": "Example usage:",
20198         "content": "curl https://{domain}/api/schedules -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20199         "type": "json"
20200       }
20201     ],
20202     "name": "CreateSchedules",
20203     "group": "Schedules",
20204     "parameter": {
20205       "fields": {
20206         "Body": [
20207           {
20208             "group": "Body",
20209             "type": "String",
20210             "optional": false,
20211             "field": "name",
20212             "description": ""
20213           },
20214           {
20215             "group": "Body",
20216             "type": "String",
20217             "optional": true,
20218             "field": "description",
20219             "description": ""
20220           },
20221           {
20222             "group": "Body",
20223             "type": "Boolean",
20224             "optional": false,
20225             "field": "active",
20226             "description": ""
20227           },
20228           {
20229             "group": "Body",
20230             "type": "String",
20231             "optional": false,
20232             "field": "cron",
20233             "description": ""
20234           },
20235           {
20236             "group": "Body",
20237             "type": "String",
20238             "optional": false,
20239             "field": "startAt",
20240             "description": ""
20241           },
20242           {
20243             "group": "Body",
20244             "type": "String",
20245             "optional": false,
20246             "field": "endAt",
20247             "description": ""
20248           },
20249           {
20250             "group": "Body",
20251             "type": "Integer",
20252             "optional": false,
20253             "field": "subtractNumber",
20254             "description": ""
20255           },
20256           {
20257             "group": "Body",
20258             "type": "String",
20259             "allowedValues": [
20260               "\"years\"",
20261               "\"quarters\"",
20262               "\"months\"",
20263               "\"weeks\"",
20264               "\"days\"",
20265               "\"hours\"",
20266               "\"minutes\""
20267             ],
20268             "optional": false,
20269             "field": "subtractUnit",
20270             "description": ""
20271           },
20272           {
20273             "group": "Body",
20274             "type": "String",
20275             "allowedValues": [
20276               "\"csv\"",
20277               "\"pdf\"",
20278               "\"xlsx\""
20279             ],
20280             "optional": false,
20281             "field": "output",
20282             "description": ""
20283           },
20284           {
20285             "group": "Body",
20286             "type": "String",
20287             "allowedValues": [
20288               "\"custom\"",
20289               "\"default\""
20290             ],
20291             "optional": false,
20292             "field": "type",
20293             "description": ""
20294           },
20295           {
20296             "group": "Body",
20297             "type": "Boolean",
20298             "optional": true,
20299             "field": "sendMail",
20300             "description": ""
20301           },
20302           {
20303             "group": "Body",
20304             "type": "String",
20305             "optional": true,
20306             "field": "email",
20307             "description": ""
20308           },
20309           {
20310             "group": "Body",
20311             "type": "Text",
20312             "optional": true,
20313             "field": "cc",
20314             "description": ""
20315           },
20316           {
20317             "group": "Body",
20318             "type": "Text",
20319             "optional": true,
20320             "field": "bcc",
20321             "description": ""
20322           },
20323           {
20324             "group": "Body",
20325             "type": "Boolean",
20326             "optional": true,
20327             "field": "sendIfEmpty",
20328             "description": ""
20329           }
20330         ]
20331       }
20332     },
20333     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20334     "version": "0.0.0",
20335     "filename": "server/api/schedule/index.js",
20336     "groupTitle": "Schedules"
20337   },
20338   {
20339     "type": "delete",
20340     "url": "/api/schedules/{id}",
20341     "title": "Deletes a Schedule",
20342     "examples": [
20343       {
20344         "title": "Example usage:",
20345         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password} -X DELETE",
20346         "type": "json"
20347       }
20348     ],
20349     "name": "DeleteSchedules",
20350     "group": "Schedules",
20351     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20352     "version": "0.0.0",
20353     "filename": "server/api/schedule/index.js",
20354     "groupTitle": "Schedules"
20355   },
20356   {
20357     "type": "get",
20358     "url": "/api/schedules",
20359     "title": "Gets a list of Schedules",
20360     "examples": [
20361       {
20362         "title": "Example usage:",
20363         "content": "curl https://{domain}/api/schedules -v -u {name}:{password}",
20364         "type": "json"
20365       }
20366     ],
20367     "name": "GetSchedules",
20368     "group": "Schedules",
20369     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20370     "version": "0.0.0",
20371     "filename": "server/api/schedule/index.js",
20372     "groupTitle": "Schedules"
20373   },
20374   {
20375     "type": "get",
20376     "url": "/api/schedules/{id}",
20377     "title": "Gets a single Schedule",
20378     "examples": [
20379       {
20380         "title": "Example usage:",
20381         "content": "curl https://{domain}/api/schedules/{id} -v -u {name}:{password}",
20382         "type": "json"
20383       }
20384     ],
20385     "name": "ShowSchedules",
20386     "group": "Schedules",
20387     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20388     "version": "0.0.0",
20389     "filename": "server/api/schedule/index.js",
20390     "groupTitle": "Schedules"
20391   },
20392   {
20393     "type": "get",
20394     "url": "/api/schedules/{id}/run",
20395     "title": "Run Scheduler",
20396     "examples": [
20397       {
20398         "title": "Example usage:",
20399         "content": "curl https://{domain}/api/schedules/{id}/run -v -u {name}:{password} -X GET",
20400         "type": "json"
20401       }
20402     ],
20403     "name": "run",
20404     "group": "Schedules",
20405     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20406     "version": "0.0.0",
20407     "filename": "server/api/schedule/index.js",
20408     "groupTitle": "Schedules"
20409   },
20410   {
20411     "type": "put",
20412     "url": "/api/schedules/{id}",
20413     "title": "Update an existing Schedule",
20414     "examples": [
20415       {
20416         "title": "Example usage:",
20417         "content": "curl https://{domain}/api/schedules/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
20418         "type": "json"
20419       }
20420     ],
20421     "name": "updateSchedules",
20422     "group": "Schedules",
20423     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20424     "version": "0.0.0",
20425     "filename": "server/api/schedule/index.js",
20426     "groupTitle": "Schedules"
20427   },
20428   {
20429     "type": "post",
20430     "url": "/api/screen/recordings",
20431     "title": "Creates a new Recording",
20432     "examples": [
20433       {
20434         "title": "Example usage:",
20435         "content": "curl https://{domain}/api/screen/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
20436         "type": "json"
20437       }
20438     ],
20439     "name": "CreateRecordings",
20440     "group": "Screen_Recordings",
20441     "parameter": {
20442       "fields": {
20443         "Body": [
20444           {
20445             "group": "Body",
20446             "type": "Virtual",
20447             "optional": true,
20448             "field": "format",
20449             "description": ""
20450           },
20451           {
20452             "group": "Body",
20453             "type": "String",
20454             "optional": true,
20455             "field": "interactionid",
20456             "description": ""
20457           },
20458           {
20459             "group": "Body",
20460             "type": "String",
20461             "optional": true,
20462             "field": "channel",
20463             "description": ""
20464           },
20465           {
20466             "group": "Body",
20467             "type": "String",
20468             "optional": true,
20469             "field": "value",
20470             "description": ""
20471           },
20472           {
20473             "group": "Body",
20474             "type": "Integer",
20475             "optional": true,
20476             "field": "rating",
20477             "description": ""
20478           },
20479           {
20480             "group": "Body",
20481             "type": "Integer",
20482             "optional": true,
20483             "field": "duration",
20484             "description": ""
20485           },
20486           {
20487             "group": "Body",
20488             "type": "String",
20489             "optional": true,
20490             "field": "startedAt",
20491             "description": ""
20492           },
20493           {
20494             "group": "Body",
20495             "type": "String",
20496             "optional": true,
20497             "field": "closedAt",
20498             "description": ""
20499           },
20500           {
20501             "group": "Body",
20502             "type": "String",
20503             "optional": true,
20504             "field": "createdAt",
20505             "description": ""
20506           },
20507           {
20508             "group": "Body",
20509             "type": "String",
20510             "optional": true,
20511             "field": "updatedAt",
20512             "description": ""
20513           }
20514         ]
20515       }
20516     },
20517     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20518     "version": "0.0.0",
20519     "filename": "server/api/screenRecording/index.js",
20520     "groupTitle": "Screen_Recordings"
20521   },
20522   {
20523     "type": "get",
20524     "url": "/api/screen/recordings/describe",
20525     "title": "Gets table info about Recordings",
20526     "examples": [
20527       {
20528         "title": "Example usage:",
20529         "content": "curl https://{domain}/api/screen/recordings/describe -v -u {name}:{password}",
20530         "type": "json"
20531       }
20532     ],
20533     "name": "DescribeRecordings",
20534     "group": "Screen_Recordings",
20535     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20536     "version": "0.0.0",
20537     "filename": "server/api/screenRecording/index.js",
20538     "groupTitle": "Screen_Recordings"
20539   },
20540   {
20541     "type": "get",
20542     "url": "/api/screen/recordings",
20543     "title": "Gets a list of Recordings",
20544     "examples": [
20545       {
20546         "title": "Example usage:",
20547         "content": "curl https://{domain}/api/screen/recordings -v -u {name}:{password}",
20548         "type": "json"
20549       }
20550     ],
20551     "name": "GetRecordings",
20552     "group": "Screen_Recordings",
20553     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20554     "version": "0.0.0",
20555     "filename": "server/api/screenRecording/index.js",
20556     "groupTitle": "Screen_Recordings"
20557   },
20558   {
20559     "type": "get",
20560     "url": "/api/screen/recordings/{id}",
20561     "title": "Gets a single Recording",
20562     "examples": [
20563       {
20564         "title": "Example usage:",
20565         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password}",
20566         "type": "json"
20567       }
20568     ],
20569     "name": "ShowRecordings",
20570     "group": "Screen_Recordings",
20571     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20572     "version": "0.0.0",
20573     "filename": "server/api/screenRecording/index.js",
20574     "groupTitle": "Screen_Recordings"
20575   },
20576   {
20577     "type": "delete",
20578     "url": "/api/screen/recordings/{id}",
20579     "title": "Delete screen recording",
20580     "examples": [
20581       {
20582         "title": "Example usage:",
20583         "content": "curl https://{domain}/api/screen/recordings/{id} -v -u {name}:{password} -X DELETE",
20584         "type": "json"
20585       }
20586     ],
20587     "name": "destroy",
20588     "group": "Screen_Recordings",
20589     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20590     "version": "0.0.0",
20591     "filename": "server/api/screenRecording/index.js",
20592     "groupTitle": "Screen_Recordings"
20593   },
20594   {
20595     "type": "get",
20596     "url": "/api/screen/recordings/{id}/download",
20597     "title": "Download Recording",
20598     "examples": [
20599       {
20600         "title": "Example usage:",
20601         "content": "curl https://{domain}/api/screen/recordings/{id}/download -v -u {name}:{password} -X GET",
20602         "type": "json"
20603       }
20604     ],
20605     "name": "download",
20606     "group": "Screen_Recordings",
20607     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20608     "version": "0.0.0",
20609     "filename": "server/api/screenRecording/index.js",
20610     "groupTitle": "Screen_Recordings"
20611   },
20612   {
20613     "type": "put",
20614     "url": "/api/screen/recordings/{id}",
20615     "title": "Update an existing Recording",
20616     "examples": [
20617       {
20618         "title": "Example usage:",
20619         "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",
20620         "type": "json"
20621       }
20622     ],
20623     "name": "updateRecordings",
20624     "group": "Screen_Recordings",
20625     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20626     "version": "0.0.0",
20627     "filename": "server/api/screenRecording/index.js",
20628     "groupTitle": "Screen_Recordings"
20629   },
20630   {
20631     "type": "post",
20632     "url": "/api/integrations/servicenow/accounts",
20633     "title": "Creates a new Servicenow Account",
20634     "examples": [
20635       {
20636         "title": "Example usage:",
20637         "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",
20638         "type": "json"
20639       }
20640     ],
20641     "name": "CreateServicenow_Accounts",
20642     "group": "Servicenow_Accounts",
20643     "parameter": {
20644       "fields": {
20645         "Body": [
20646           {
20647             "group": "Body",
20648             "type": "String",
20649             "optional": true,
20650             "field": "name",
20651             "description": ""
20652           },
20653           {
20654             "group": "Body",
20655             "type": "String",
20656             "optional": true,
20657             "field": "description",
20658             "description": ""
20659           },
20660           {
20661             "group": "Body",
20662             "type": "String",
20663             "optional": true,
20664             "field": "username",
20665             "description": ""
20666           },
20667           {
20668             "group": "Body",
20669             "type": "String",
20670             "optional": true,
20671             "field": "password",
20672             "description": ""
20673           },
20674           {
20675             "group": "Body",
20676             "type": "String",
20677             "optional": true,
20678             "field": "email",
20679             "description": ""
20680           },
20681           {
20682             "group": "Body",
20683             "type": "String",
20684             "optional": true,
20685             "field": "remoteUri",
20686             "description": ""
20687           },
20688           {
20689             "group": "Body",
20690             "type": "String",
20691             "optional": true,
20692             "field": "serverUrl",
20693             "description": ""
20694           }
20695         ]
20696       }
20697     },
20698     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20699     "version": "0.0.0",
20700     "filename": "server/api/intServicenowAccount/index.js",
20701     "groupTitle": "Servicenow_Accounts"
20702   },
20703   {
20704     "type": "delete",
20705     "url": "/api/integrations/servicenow/accounts/{id}",
20706     "title": "Deletes a Servicenow Account",
20707     "examples": [
20708       {
20709         "title": "Example usage:",
20710         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password} -X DELETE",
20711         "type": "json"
20712       }
20713     ],
20714     "name": "DeleteServicenow_Accounts",
20715     "group": "Servicenow_Accounts",
20716     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20717     "version": "0.0.0",
20718     "filename": "server/api/intServicenowAccount/index.js",
20719     "groupTitle": "Servicenow_Accounts"
20720   },
20721   {
20722     "type": "get",
20723     "url": "/api/integrations/servicenow/accounts",
20724     "title": "Gets a list of Servicenow Accounts",
20725     "examples": [
20726       {
20727         "title": "Example usage:",
20728         "content": "curl https://{domain}/api/integrations/servicenow/accounts -v -u {name}:{password}",
20729         "type": "json"
20730       }
20731     ],
20732     "name": "GetServicenow_Accounts",
20733     "group": "Servicenow_Accounts",
20734     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20735     "version": "0.0.0",
20736     "filename": "server/api/intServicenowAccount/index.js",
20737     "groupTitle": "Servicenow_Accounts"
20738   },
20739   {
20740     "type": "get",
20741     "url": "/api/integrations/servicenow/accounts/{id}",
20742     "title": "Gets a single Servicenow Account",
20743     "examples": [
20744       {
20745         "title": "Example usage:",
20746         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id} -v -u {name}:{password}",
20747         "type": "json"
20748       }
20749     ],
20750     "name": "ShowServicenow_Accounts",
20751     "group": "Servicenow_Accounts",
20752     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20753     "version": "0.0.0",
20754     "filename": "server/api/intServicenowAccount/index.js",
20755     "groupTitle": "Servicenow_Accounts"
20756   },
20757   {
20758     "type": "post",
20759     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
20760     "title": "Creates new configuration",
20761     "examples": [
20762       {
20763         "title": "Example usage:",
20764         "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",
20765         "type": "json"
20766       }
20767     ],
20768     "name": "addConfiguration",
20769     "group": "Servicenow_Accounts",
20770     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20771     "version": "0.0.0",
20772     "filename": "server/api/intServicenowAccount/index.js",
20773     "groupTitle": "Servicenow_Accounts"
20774   },
20775   {
20776     "type": "get",
20777     "url": "/api/integrations/servicenow/accounts/{id}/configurations",
20778     "title": "Gets account configurations",
20779     "examples": [
20780       {
20781         "title": "Example usage:",
20782         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/configurations -v -u {name}:{password} -X GET",
20783         "type": "json"
20784       }
20785     ],
20786     "name": "getConfigurations",
20787     "group": "Servicenow_Accounts",
20788     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20789     "version": "0.0.0",
20790     "filename": "server/api/intServicenowAccount/index.js",
20791     "groupTitle": "Servicenow_Accounts"
20792   },
20793   {
20794     "type": "get",
20795     "url": "/api/integrations/servicenow/accounts/{id}/fields",
20796     "title": "Gets account fields",
20797     "examples": [
20798       {
20799         "title": "Example usage:",
20800         "content": "curl https://{domain}/api/integrations/servicenow/accounts/{id}/fields -v -u {name}:{password} -X GET",
20801         "type": "json"
20802       }
20803     ],
20804     "name": "getFields",
20805     "group": "Servicenow_Accounts",
20806     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20807     "version": "0.0.0",
20808     "filename": "server/api/intServicenowAccount/index.js",
20809     "groupTitle": "Servicenow_Accounts"
20810   },
20811   {
20812     "type": "put",
20813     "url": "/api/integrations/servicenow/accounts/{id}",
20814     "title": "Update an existing Servicenow Account",
20815     "examples": [
20816       {
20817         "title": "Example usage:",
20818         "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",
20819         "type": "json"
20820       }
20821     ],
20822     "name": "updateServicenow_Accounts",
20823     "group": "Servicenow_Accounts",
20824     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20825     "version": "0.0.0",
20826     "filename": "server/api/intServicenowAccount/index.js",
20827     "groupTitle": "Servicenow_Accounts"
20828   },
20829   {
20830     "type": "post",
20831     "url": "/api/integrations/servicenow/configurations",
20832     "title": "Creates a new Servicenow Configuration",
20833     "examples": [
20834       {
20835         "title": "Example usage:",
20836         "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",
20837         "type": "json"
20838       }
20839     ],
20840     "name": "CreateServicenow_Configurations",
20841     "group": "Servicenow_Configurations",
20842     "parameter": {
20843       "fields": {
20844         "Body": [
20845           {
20846             "group": "Body",
20847             "type": "String",
20848             "optional": true,
20849             "field": "name",
20850             "description": ""
20851           },
20852           {
20853             "group": "Body",
20854             "type": "String",
20855             "optional": true,
20856             "field": "description",
20857             "description": ""
20858           }
20859         ]
20860       }
20861     },
20862     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20863     "version": "0.0.0",
20864     "filename": "server/api/intServicenowConfiguration/index.js",
20865     "groupTitle": "Servicenow_Configurations"
20866   },
20867   {
20868     "type": "delete",
20869     "url": "/api/integrations/servicenow/configurations/{id}",
20870     "title": "Deletes a Servicenow Configuration",
20871     "examples": [
20872       {
20873         "title": "Example usage:",
20874         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password} -X DELETE",
20875         "type": "json"
20876       }
20877     ],
20878     "name": "DeleteServicenow_Configurations",
20879     "group": "Servicenow_Configurations",
20880     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20881     "version": "0.0.0",
20882     "filename": "server/api/intServicenowConfiguration/index.js",
20883     "groupTitle": "Servicenow_Configurations"
20884   },
20885   {
20886     "type": "get",
20887     "url": "/api/integrations/servicenow/configurations",
20888     "title": "Gets a list of Servicenow Configurations",
20889     "examples": [
20890       {
20891         "title": "Example usage:",
20892         "content": "curl https://{domain}/api/integrations/servicenow/configurations -v -u {name}:{password}",
20893         "type": "json"
20894       }
20895     ],
20896     "name": "GetServicenow_Configurations",
20897     "group": "Servicenow_Configurations",
20898     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
20899     "version": "0.0.0",
20900     "filename": "server/api/intServicenowConfiguration/index.js",
20901     "groupTitle": "Servicenow_Configurations"
20902   },
20903   {
20904     "type": "get",
20905     "url": "/api/integrations/servicenow/configurations/{id}",
20906     "title": "Gets a single Servicenow Configuration",
20907     "examples": [
20908       {
20909         "title": "Example usage:",
20910         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id} -v -u {name}:{password}",
20911         "type": "json"
20912       }
20913     ],
20914     "name": "ShowServicenow_Configurations",
20915     "group": "Servicenow_Configurations",
20916     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20917     "version": "0.0.0",
20918     "filename": "server/api/intServicenowConfiguration/index.js",
20919     "groupTitle": "Servicenow_Configurations"
20920   },
20921   {
20922     "type": "get",
20923     "url": "/api/integrations/servicenow/configurations/{id}/descriptions",
20924     "title": "Gets configurations descriptions",
20925     "examples": [
20926       {
20927         "title": "Example usage:",
20928         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
20929         "type": "json"
20930       }
20931     ],
20932     "name": "getDescriptions",
20933     "group": "Servicenow_Configurations",
20934     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20935     "version": "0.0.0",
20936     "filename": "server/api/intServicenowConfiguration/index.js",
20937     "groupTitle": "Servicenow_Configurations"
20938   },
20939   {
20940     "type": "get",
20941     "url": "/api/integrations/servicenow/configurations/{id}/fields",
20942     "title": "Gets configurations fields",
20943     "examples": [
20944       {
20945         "title": "Example usage:",
20946         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/fields -v -u {name}:{password} -X GET",
20947         "type": "json"
20948       }
20949     ],
20950     "name": "getFields",
20951     "group": "Servicenow_Configurations",
20952     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20953     "version": "0.0.0",
20954     "filename": "server/api/intServicenowConfiguration/index.js",
20955     "groupTitle": "Servicenow_Configurations"
20956   },
20957   {
20958     "type": "get",
20959     "url": "/api/integrations/servicenow/configurations/{id}/subjects",
20960     "title": "Gets configurations subjects",
20961     "examples": [
20962       {
20963         "title": "Example usage:",
20964         "content": "curl https://{domain}/api/integrations/servicenow/configurations/{id}/subjects -v -u {name}:{password} -X GET",
20965         "type": "json"
20966       }
20967     ],
20968     "name": "getSubjects",
20969     "group": "Servicenow_Configurations",
20970     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20971     "version": "0.0.0",
20972     "filename": "server/api/intServicenowConfiguration/index.js",
20973     "groupTitle": "Servicenow_Configurations"
20974   },
20975   {
20976     "type": "put",
20977     "url": "/api/integrations/servicenow/configurations/{id}",
20978     "title": "Update an existing Servicenow Configuration",
20979     "examples": [
20980       {
20981         "title": "Example usage:",
20982         "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",
20983         "type": "json"
20984       }
20985     ],
20986     "name": "updateServicenow_Configurations",
20987     "group": "Servicenow_Configurations",
20988     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
20989     "version": "0.0.0",
20990     "filename": "server/api/intServicenowConfiguration/index.js",
20991     "groupTitle": "Servicenow_Configurations"
20992   },
20993   {
20994     "type": "post",
20995     "url": "/api/integrations/servicenow/fields",
20996     "title": "Creates a new Servicenow Field",
20997     "examples": [
20998       {
20999         "title": "Example usage:",
21000         "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",
21001         "type": "json"
21002       }
21003     ],
21004     "name": "CreateServicenow_Fields",
21005     "group": "Servicenow_Fields",
21006     "parameter": {
21007       "fields": {
21008         "Body": [
21009           {
21010             "group": "Body",
21011             "type": "String",
21012             "allowedValues": [
21013               "\"string\"",
21014               "\"variable\"",
21015               "\"customVariable\"",
21016               "\"keyValue\""
21017             ],
21018             "optional": true,
21019             "field": "type",
21020             "description": ""
21021           },
21022           {
21023             "group": "Body",
21024             "type": "String",
21025             "optional": true,
21026             "field": "content",
21027             "description": ""
21028           },
21029           {
21030             "group": "Body",
21031             "type": "String",
21032             "optional": true,
21033             "field": "key",
21034             "description": ""
21035           },
21036           {
21037             "group": "Body",
21038             "type": "String",
21039             "allowedValues": [
21040               "\"string\"",
21041               "\"variable\"",
21042               "\"customVariable\""
21043             ],
21044             "optional": true,
21045             "field": "keyType",
21046             "description": ""
21047           },
21048           {
21049             "group": "Body",
21050             "type": "String",
21051             "optional": true,
21052             "field": "keyContent",
21053             "description": ""
21054           },
21055           {
21056             "group": "Body",
21057             "type": "String",
21058             "optional": true,
21059             "field": "idField",
21060             "description": ""
21061           },
21062           {
21063             "group": "Body",
21064             "type": "String",
21065             "optional": true,
21066             "field": "nameField",
21067             "description": ""
21068           },
21069           {
21070             "group": "Body",
21071             "type": "Boolean",
21072             "optional": true,
21073             "field": "customField",
21074             "description": ""
21075           },
21076           {
21077             "group": "Body",
21078             "type": "String",
21079             "optional": true,
21080             "field": "variableName",
21081             "description": ""
21082           }
21083         ]
21084       }
21085     },
21086     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21087     "version": "0.0.0",
21088     "filename": "server/api/intServicenowField/index.js",
21089     "groupTitle": "Servicenow_Fields"
21090   },
21091   {
21092     "type": "delete",
21093     "url": "/api/integrations/servicenow/fields/{id}",
21094     "title": "Deletes a Servicenow Field",
21095     "examples": [
21096       {
21097         "title": "Example usage:",
21098         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password} -X DELETE",
21099         "type": "json"
21100       }
21101     ],
21102     "name": "DeleteServicenow_Fields",
21103     "group": "Servicenow_Fields",
21104     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21105     "version": "0.0.0",
21106     "filename": "server/api/intServicenowField/index.js",
21107     "groupTitle": "Servicenow_Fields"
21108   },
21109   {
21110     "type": "get",
21111     "url": "/api/integrations/servicenow/fields",
21112     "title": "Gets a list of Servicenow Fields",
21113     "examples": [
21114       {
21115         "title": "Example usage:",
21116         "content": "curl https://{domain}/api/integrations/servicenow/fields -v -u {name}:{password}",
21117         "type": "json"
21118       }
21119     ],
21120     "name": "GetServicenow_Fields",
21121     "group": "Servicenow_Fields",
21122     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21123     "version": "0.0.0",
21124     "filename": "server/api/intServicenowField/index.js",
21125     "groupTitle": "Servicenow_Fields"
21126   },
21127   {
21128     "type": "get",
21129     "url": "/api/integrations/servicenow/fields/{id}",
21130     "title": "Gets a single Servicenow Field",
21131     "examples": [
21132       {
21133         "title": "Example usage:",
21134         "content": "curl https://{domain}/api/integrations/servicenow/fields/{id} -v -u {name}:{password}",
21135         "type": "json"
21136       }
21137     ],
21138     "name": "ShowServicenow_Fields",
21139     "group": "Servicenow_Fields",
21140     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21141     "version": "0.0.0",
21142     "filename": "server/api/intServicenowField/index.js",
21143     "groupTitle": "Servicenow_Fields"
21144   },
21145   {
21146     "type": "put",
21147     "url": "/api/integrations/servicenow/fields/{id}",
21148     "title": "Update an existing Servicenow Field",
21149     "examples": [
21150       {
21151         "title": "Example usage:",
21152         "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",
21153         "type": "json"
21154       }
21155     ],
21156     "name": "updateServicenow_Fields",
21157     "group": "Servicenow_Fields",
21158     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21159     "version": "0.0.0",
21160     "filename": "server/api/intServicenowField/index.js",
21161     "groupTitle": "Servicenow_Fields"
21162   },
21163   {
21164     "type": "get",
21165     "url": "/api/settings",
21166     "title": "Gets a list of Settings",
21167     "examples": [
21168       {
21169         "title": "Example usage:",
21170         "content": "curl https://{domain}/api/settings -v -u {name}:{password}",
21171         "type": "json"
21172       }
21173     ],
21174     "name": "GetSettings",
21175     "group": "Settings",
21176     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21177     "version": "0.0.0",
21178     "filename": "server/api/setting/index.js",
21179     "groupTitle": "Settings"
21180   },
21181   {
21182     "type": "get",
21183     "url": "/api/settings/{id}",
21184     "title": "Gets a single Setting",
21185     "examples": [
21186       {
21187         "title": "Example usage:",
21188         "content": "curl https://{domain}/api/settings/{id} -v -u {name}:{password}",
21189         "type": "json"
21190       }
21191     ],
21192     "name": "ShowSettings",
21193     "group": "Settings",
21194     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21195     "version": "0.0.0",
21196     "filename": "server/api/setting/index.js",
21197     "groupTitle": "Settings"
21198   },
21199   {
21200     "type": "post",
21201     "url": "/api/settings/{id}/favicon",
21202     "title": "Add Favicon",
21203     "examples": [
21204       {
21205         "title": "Example usage:",
21206         "content": "curl https://{domain}/api/settings/{id}/favicon -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21207         "type": "json"
21208       }
21209     ],
21210     "name": "addFavicon",
21211     "group": "Settings",
21212     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21213     "version": "0.0.0",
21214     "filename": "server/api/setting/index.js",
21215     "groupTitle": "Settings"
21216   },
21217   {
21218     "type": "post",
21219     "url": "/api/settings/{id}/logo",
21220     "title": "Add logo",
21221     "examples": [
21222       {
21223         "title": "Example usage:",
21224         "content": "curl https://{domain}/api/settings/{id}/logo -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21225         "type": "json"
21226       }
21227     ],
21228     "name": "addLogo",
21229     "group": "Settings",
21230     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21231     "version": "0.0.0",
21232     "filename": "server/api/setting/index.js",
21233     "groupTitle": "Settings"
21234   },
21235   {
21236     "type": "post",
21237     "url": "/api/settings/{id}/logo_login",
21238     "title": "Add logo login",
21239     "examples": [
21240       {
21241         "title": "Example usage:",
21242         "content": "curl https://{domain}/api/settings/{id}/logo_login -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21243         "type": "json"
21244       }
21245     ],
21246     "name": "addLogoLogin",
21247     "group": "Settings",
21248     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21249     "version": "0.0.0",
21250     "filename": "server/api/setting/index.js",
21251     "groupTitle": "Settings"
21252   },
21253   {
21254     "type": "post",
21255     "url": "/api/settings/{id}/preferred",
21256     "title": "Add Preferred",
21257     "examples": [
21258       {
21259         "title": "Example usage:",
21260         "content": "curl https://{domain}/api/settings/{id}/preferred -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
21261         "type": "json"
21262       }
21263     ],
21264     "name": "addPreferred",
21265     "group": "Settings",
21266     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21267     "version": "0.0.0",
21268     "filename": "server/api/setting/index.js",
21269     "groupTitle": "Settings"
21270   },
21271   {
21272     "type": "get",
21273     "url": "/api/settings/{id}/favicon",
21274     "title": "Get Favicon",
21275     "examples": [
21276       {
21277         "title": "Example usage:",
21278         "content": "curl https://{domain}/api/settings/{id}/favicon -v -X GET",
21279         "type": "json"
21280       }
21281     ],
21282     "name": "getFavicon",
21283     "group": "Settings",
21284     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21285     "version": "0.0.0",
21286     "filename": "server/api/setting/index.js",
21287     "groupTitle": "Settings"
21288   },
21289   {
21290     "type": "get",
21291     "url": "/api/settings/{id}/gdpr",
21292     "title": "Get gdpr settings",
21293     "examples": [
21294       {
21295         "title": "Example usage:",
21296         "content": "curl https://{domain}/api/settings/{id}/gdpr -v -u {name}:{password} -X GET",
21297         "type": "json"
21298       }
21299     ],
21300     "name": "getGdpr",
21301     "group": "Settings",
21302     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21303     "version": "0.0.0",
21304     "filename": "server/api/setting/index.js",
21305     "groupTitle": "Settings"
21306   },
21307   {
21308     "type": "get",
21309     "url": "/api/settings/{id}/logo",
21310     "title": "Get logo",
21311     "examples": [
21312       {
21313         "title": "Example usage:",
21314         "content": "curl https://{domain}/api/settings/{id}/logo -v -X GET",
21315         "type": "json"
21316       }
21317     ],
21318     "name": "getLogo",
21319     "group": "Settings",
21320     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21321     "version": "0.0.0",
21322     "filename": "server/api/setting/index.js",
21323     "groupTitle": "Settings"
21324   },
21325   {
21326     "type": "get",
21327     "url": "/api/settings/{id}/logo_login",
21328     "title": "Get logo login",
21329     "examples": [
21330       {
21331         "title": "Example usage:",
21332         "content": "curl https://{domain}/api/settings/{id}/logo_login -v -X GET",
21333         "type": "json"
21334       }
21335     ],
21336     "name": "getLogoLogin",
21337     "group": "Settings",
21338     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21339     "version": "0.0.0",
21340     "filename": "server/api/setting/index.js",
21341     "groupTitle": "Settings"
21342   },
21343   {
21344     "type": "get",
21345     "url": "/api/settings/{id}/preferred",
21346     "title": "Get Preferred",
21347     "examples": [
21348       {
21349         "title": "Example usage:",
21350         "content": "curl https://{domain}/api/settings/{id}/preferred -v -X GET",
21351         "type": "json"
21352       }
21353     ],
21354     "name": "getPreferred",
21355     "group": "Settings",
21356     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21357     "version": "0.0.0",
21358     "filename": "server/api/setting/index.js",
21359     "groupTitle": "Settings"
21360   },
21361   {
21362     "type": "put",
21363     "url": "/api/settings/{id}",
21364     "title": "Update an existing Setting",
21365     "examples": [
21366       {
21367         "title": "Example usage:",
21368         "content": "curl https://{domain}/api/settings/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
21369         "type": "json"
21370       }
21371     ],
21372     "name": "updateSettings",
21373     "group": "Settings",
21374     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21375     "version": "0.0.0",
21376     "filename": "server/api/setting/index.js",
21377     "groupTitle": "Settings"
21378   },
21379   {
21380     "type": "post",
21381     "url": "/api/sms/accounts/{id}/users",
21382     "title": "Add agents to a sms account",
21383     "examples": [
21384       {
21385         "title": "Example usage:",
21386         "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",
21387         "type": "json"
21388       }
21389     ],
21390     "name": "AddAgents",
21391     "group": "Sms_Accounts",
21392     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21393     "version": "0.0.0",
21394     "filename": "server/api/smsAccount/index.js",
21395     "groupTitle": "Sms_Accounts"
21396   },
21397   {
21398     "type": "post",
21399     "url": "/api/sms/accounts",
21400     "title": "Creates a new Account",
21401     "examples": [
21402       {
21403         "title": "Example usage:",
21404         "content": "curl https://{domain}/api/sms/accounts -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
21405         "type": "json"
21406       }
21407     ],
21408     "name": "CreateAccounts",
21409     "group": "Sms_Accounts",
21410     "parameter": {
21411       "fields": {
21412         "Body": [
21413           {
21414             "group": "Body",
21415             "type": "String",
21416             "optional": false,
21417             "field": "name",
21418             "description": ""
21419           },
21420           {
21421             "group": "Body",
21422             "type": "String",
21423             "optional": false,
21424             "field": "key",
21425             "description": ""
21426           },
21427           {
21428             "group": "Body",
21429             "type": "String",
21430             "optional": false,
21431             "field": "remote",
21432             "description": ""
21433           },
21434           {
21435             "group": "Body",
21436             "type": "String",
21437             "optional": true,
21438             "field": "token",
21439             "description": ""
21440           },
21441           {
21442             "group": "Body",
21443             "type": "String",
21444             "optional": true,
21445             "field": "phone",
21446             "description": ""
21447           },
21448           {
21449             "group": "Body",
21450             "type": "String",
21451             "allowedValues": [
21452               "\"twilio\"",
21453               "\"skebby\"",
21454               "\"connectel\"",
21455               "\"clicksend\"",
21456               "\"plivo\"",
21457               "\"clickatell\"",
21458               "\"csc\"",
21459               "\"infobip\"",
21460               "\"intelepeer\""
21461             ],
21462             "optional": true,
21463             "field": "type",
21464             "description": ""
21465           },
21466           {
21467             "group": "Body",
21468             "type": "String",
21469             "optional": true,
21470             "field": "accountSid",
21471             "description": ""
21472           },
21473           {
21474             "group": "Body",
21475             "type": "String",
21476             "optional": true,
21477             "field": "authId",
21478             "description": ""
21479           },
21480           {
21481             "group": "Body",
21482             "type": "String",
21483             "optional": true,
21484             "field": "authToken",
21485             "description": ""
21486           },
21487           {
21488             "group": "Body",
21489             "type": "String",
21490             "allowedValues": [
21491               "\"SI\"",
21492               "\"TI\"",
21493               "\"GP\""
21494             ],
21495             "optional": true,
21496             "field": "smsMethod",
21497             "description": ""
21498           },
21499           {
21500             "group": "Body",
21501             "type": "String",
21502             "optional": true,
21503             "field": "username",
21504             "description": ""
21505           },
21506           {
21507             "group": "Body",
21508             "type": "String",
21509             "optional": true,
21510             "field": "password",
21511             "description": ""
21512           },
21513           {
21514             "group": "Body",
21515             "type": "String",
21516             "optional": true,
21517             "field": "apiKey",
21518             "description": ""
21519           },
21520           {
21521             "group": "Body",
21522             "type": "String",
21523             "optional": true,
21524             "field": "senderString",
21525             "description": ""
21526           },
21527           {
21528             "group": "Body",
21529             "type": "Boolean",
21530             "optional": true,
21531             "field": "deliveryReport",
21532             "description": ""
21533           },
21534           {
21535             "group": "Body",
21536             "type": "String",
21537             "optional": true,
21538             "field": "description",
21539             "description": ""
21540           },
21541           {
21542             "group": "Body",
21543             "type": "Text",
21544             "optional": true,
21545             "field": "notificationTemplate",
21546             "description": ""
21547           },
21548           {
21549             "group": "Body",
21550             "type": "Boolean",
21551             "optional": true,
21552             "field": "notificationSound",
21553             "description": ""
21554           },
21555           {
21556             "group": "Body",
21557             "type": "Boolean",
21558             "optional": true,
21559             "field": "notificationShake",
21560             "description": ""
21561           },
21562           {
21563             "group": "Body",
21564             "type": "Integer",
21565             "optional": true,
21566             "field": "waitForTheAssignedAgent",
21567             "description": ""
21568           },
21569           {
21570             "group": "Body",
21571             "type": "Boolean",
21572             "optional": true,
21573             "field": "queueTransfer",
21574             "description": ""
21575           },
21576           {
21577             "group": "Body",
21578             "type": "Integer",
21579             "optional": true,
21580             "field": "queueTransferTimeout",
21581             "description": ""
21582           },
21583           {
21584             "group": "Body",
21585             "type": "Boolean",
21586             "optional": true,
21587             "field": "agentTransfer",
21588             "description": ""
21589           },
21590           {
21591             "group": "Body",
21592             "type": "Integer",
21593             "optional": true,
21594             "field": "agentTransferTimeout",
21595             "description": ""
21596           },
21597           {
21598             "group": "Body",
21599             "type": "String",
21600             "optional": true,
21601             "field": "baseUrl",
21602             "description": ""
21603           },
21604           {
21605             "group": "Body",
21606             "type": "Integer",
21607             "optional": true,
21608             "field": "mandatoryDispositionPauseId",
21609             "description": "<p>Status to put when mandatory disposition is enabled</p>"
21610           },
21611           {
21612             "group": "Body",
21613             "type": "Boolean",
21614             "optional": true,
21615             "field": "mandatoryDisposition",
21616             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
21617           }
21618         ]
21619       }
21620     },
21621     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21622     "version": "0.0.0",
21623     "filename": "server/api/smsAccount/index.js",
21624     "groupTitle": "Sms_Accounts"
21625   },
21626   {
21627     "type": "delete",
21628     "url": "/api/sms/accounts/{id}",
21629     "title": "Deletes a Account",
21630     "examples": [
21631       {
21632         "title": "Example usage:",
21633         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password} -X DELETE",
21634         "type": "json"
21635       }
21636     ],
21637     "name": "DeleteAccounts",
21638     "group": "Sms_Accounts",
21639     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21640     "version": "0.0.0",
21641     "filename": "server/api/smsAccount/index.js",
21642     "groupTitle": "Sms_Accounts"
21643   },
21644   {
21645     "type": "get",
21646     "url": "/api/sms/accounts/describe",
21647     "title": "Gets table info about Accounts",
21648     "examples": [
21649       {
21650         "title": "Example usage:",
21651         "content": "curl https://{domain}/api/sms/accounts/describe -v -u {name}:{password}",
21652         "type": "json"
21653       }
21654     ],
21655     "name": "DescribeAccounts",
21656     "group": "Sms_Accounts",
21657     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21658     "version": "0.0.0",
21659     "filename": "server/api/smsAccount/index.js",
21660     "groupTitle": "Sms_Accounts"
21661   },
21662   {
21663     "type": "get",
21664     "url": "/api/sms/accounts",
21665     "title": "Gets a list of Accounts",
21666     "examples": [
21667       {
21668         "title": "Example usage:",
21669         "content": "curl https://{domain}/api/sms/accounts -v -u {name}:{password}",
21670         "type": "json"
21671       }
21672     ],
21673     "name": "GetAccounts",
21674     "group": "Sms_Accounts",
21675     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
21676     "version": "0.0.0",
21677     "filename": "server/api/smsAccount/index.js",
21678     "groupTitle": "Sms_Accounts"
21679   },
21680   {
21681     "type": "get",
21682     "url": "/api/sms/accounts/{id}/users",
21683     "title": "Gets agents from sms account",
21684     "examples": [
21685       {
21686         "title": "Example usage:",
21687         "content": "curl https://{domain}/api/sms/accounts/{id}/users -v -u {name}:{password} -X GET",
21688         "type": "json"
21689       }
21690     ],
21691     "name": "GetAgents",
21692     "group": "Sms_Accounts",
21693     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21694     "version": "0.0.0",
21695     "filename": "server/api/smsAccount/index.js",
21696     "groupTitle": "Sms_Accounts"
21697   },
21698   {
21699     "type": "delete",
21700     "url": "/api/sms/accounts/{id}/users",
21701     "title": "Removes agents from a sms account",
21702     "examples": [
21703       {
21704         "title": "Example usage:",
21705         "content": "curl https://{domain}/api/sms/accounts/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
21706         "type": "json"
21707       }
21708     ],
21709     "name": "RemoveAgents",
21710     "group": "Sms_Accounts",
21711     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21712     "version": "0.0.0",
21713     "filename": "server/api/smsAccount/index.js",
21714     "groupTitle": "Sms_Accounts"
21715   },
21716   {
21717     "type": "delete",
21718     "url": "/api/sms/accounts/{id}/canned_answers",
21719     "title": "Removes canned answers from account",
21720     "examples": [
21721       {
21722         "title": "Example usage:",
21723         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
21724         "type": "json"
21725       }
21726     ],
21727     "name": "RemoveAnswers",
21728     "group": "Sms_Accounts",
21729     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21730     "version": "0.0.0",
21731     "filename": "server/api/smsAccount/index.js",
21732     "groupTitle": "Sms_Accounts"
21733   },
21734   {
21735     "type": "delete",
21736     "url": "/api/sms/accounts/{id}/dispositions",
21737     "title": "Removes dispositions from account",
21738     "examples": [
21739       {
21740         "title": "Example usage:",
21741         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
21742         "type": "json"
21743       }
21744     ],
21745     "name": "RemoveDispositions",
21746     "group": "Sms_Accounts",
21747     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21748     "version": "0.0.0",
21749     "filename": "server/api/smsAccount/index.js",
21750     "groupTitle": "Sms_Accounts"
21751   },
21752   {
21753     "type": "get",
21754     "url": "/api/sms/accounts/{id}",
21755     "title": "Gets a single Account",
21756     "examples": [
21757       {
21758         "title": "Example usage:",
21759         "content": "curl https://{domain}/api/sms/accounts/{id} -v -u {name}:{password}",
21760         "type": "json"
21761       }
21762     ],
21763     "name": "ShowAccounts",
21764     "group": "Sms_Accounts",
21765     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21766     "version": "0.0.0",
21767     "filename": "server/api/smsAccount/index.js",
21768     "groupTitle": "Sms_Accounts"
21769   },
21770   {
21771     "type": "put",
21772     "url": "/api/sms/messages/{id}/accept",
21773     "title": "Accepts message",
21774     "examples": [
21775       {
21776         "title": "Example usage:",
21777         "content": "curl https://{domain}/api/sms/messages/{id}/accept \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
21778         "type": "json"
21779       }
21780     ],
21781     "name": "acceptMessage",
21782     "group": "Sms_Accounts",
21783     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21784     "version": "0.0.0",
21785     "filename": "server/api/smsMessage/index.js",
21786     "groupTitle": "Sms_Accounts"
21787   },
21788   {
21789     "type": "post",
21790     "url": "/api/sms/accounts/{id}/canned_answers",
21791     "title": "Creates new canned answer",
21792     "examples": [
21793       {
21794         "title": "Example usage:",
21795         "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",
21796         "type": "json"
21797       }
21798     ],
21799     "name": "addAnswer",
21800     "group": "Sms_Accounts",
21801     "parameter": {
21802       "fields": {
21803         "Body": [
21804           {
21805             "group": "Body",
21806             "type": "String",
21807             "optional": false,
21808             "field": "key",
21809             "description": ""
21810           },
21811           {
21812             "group": "Body",
21813             "type": "Text",
21814             "optional": false,
21815             "field": "value",
21816             "description": ""
21817           },
21818           {
21819             "group": "Body",
21820             "type": "String",
21821             "optional": true,
21822             "field": "description",
21823             "description": ""
21824           },
21825           {
21826             "group": "Body",
21827             "type": "Virtual",
21828             "optional": true,
21829             "field": "name",
21830             "description": ""
21831           }
21832         ]
21833       }
21834     },
21835     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21836     "version": "0.0.0",
21837     "filename": "server/api/smsAccount/index.js",
21838     "groupTitle": "Sms_Accounts"
21839   },
21840   {
21841     "type": "post",
21842     "url": "/api/sms/accounts/{id}/applications",
21843     "title": "Creates new applications",
21844     "examples": [
21845       {
21846         "title": "Example usage:",
21847         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -d '[{\"app\": \"queue\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
21848         "type": "json"
21849       }
21850     ],
21851     "name": "addApplications",
21852     "group": "Sms_Accounts",
21853     "parameter": {
21854       "fields": {
21855         "Body": [
21856           {
21857             "group": "Body",
21858             "type": "Integer",
21859             "optional": false,
21860             "field": "priority",
21861             "description": ""
21862           },
21863           {
21864             "group": "Body",
21865             "type": "String",
21866             "optional": false,
21867             "field": "app",
21868             "description": ""
21869           },
21870           {
21871             "group": "Body",
21872             "type": "Text",
21873             "optional": true,
21874             "field": "appdata",
21875             "description": ""
21876           },
21877           {
21878             "group": "Body",
21879             "type": "String",
21880             "optional": true,
21881             "field": "description",
21882             "description": ""
21883           },
21884           {
21885             "group": "Body",
21886             "type": "String",
21887             "optional": true,
21888             "field": "interval",
21889             "description": ""
21890           }
21891         ]
21892       }
21893     },
21894     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21895     "version": "0.0.0",
21896     "filename": "server/api/smsAccount/index.js",
21897     "groupTitle": "Sms_Accounts"
21898   },
21899   {
21900     "type": "post",
21901     "url": "/api/sms/accounts/{id}/dispositions",
21902     "title": "Creates new disposition",
21903     "examples": [
21904       {
21905         "title": "Example usage:",
21906         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -d '{\"name\": \"vip\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
21907         "type": "json"
21908       }
21909     ],
21910     "name": "addDisposition",
21911     "group": "Sms_Accounts",
21912     "parameter": {
21913       "fields": {
21914         "Body": [
21915           {
21916             "group": "Body",
21917             "type": "String",
21918             "optional": false,
21919             "field": "name",
21920             "description": ""
21921           }
21922         ]
21923       }
21924     },
21925     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21926     "version": "0.0.0",
21927     "filename": "server/api/smsAccount/index.js",
21928     "groupTitle": "Sms_Accounts"
21929   },
21930   {
21931     "type": "get",
21932     "url": "/api/sms/accounts/{id}/canned_answers",
21933     "title": "Gets account canned answers",
21934     "examples": [
21935       {
21936         "title": "Example usage:",
21937         "content": "curl https://{domain}/api/sms/accounts/{id}/canned_answers -v -u {name}:{password} -X GET",
21938         "type": "json"
21939       }
21940     ],
21941     "name": "getAnswers",
21942     "group": "Sms_Accounts",
21943     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21944     "version": "0.0.0",
21945     "filename": "server/api/smsAccount/index.js",
21946     "groupTitle": "Sms_Accounts"
21947   },
21948   {
21949     "type": "get",
21950     "url": "/api/sms/accounts/{id}/applications",
21951     "title": "Gets account applications",
21952     "examples": [
21953       {
21954         "title": "Example usage:",
21955         "content": "curl https://{domain}/api/sms/accounts/{id}/applications -v -u {name}:{password} -X GET",
21956         "type": "json"
21957       }
21958     ],
21959     "name": "getApplications",
21960     "group": "Sms_Accounts",
21961     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21962     "version": "0.0.0",
21963     "filename": "server/api/smsAccount/index.js",
21964     "groupTitle": "Sms_Accounts"
21965   },
21966   {
21967     "type": "get",
21968     "url": "/api/sms/accounts/{id}/dispositions",
21969     "title": "Gets account dispositions",
21970     "examples": [
21971       {
21972         "title": "Example usage:",
21973         "content": "curl https://{domain}/api/sms/accounts/{id}/dispositions -v -u {name}:{password} -X GET",
21974         "type": "json"
21975       }
21976     ],
21977     "name": "getDispositions",
21978     "group": "Sms_Accounts",
21979     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21980     "version": "0.0.0",
21981     "filename": "server/api/smsAccount/index.js",
21982     "groupTitle": "Sms_Accounts"
21983   },
21984   {
21985     "type": "get",
21986     "url": "/api/sms/accounts/{id}/interactions",
21987     "title": "Gets Sms Account interactions",
21988     "examples": [
21989       {
21990         "title": "Example usage:",
21991         "content": "curl https://{domain}/api/sms/accounts/{id}/interactions -v -u {name}:{password} -X GET",
21992         "type": "json"
21993       }
21994     ],
21995     "name": "getInteractions",
21996     "group": "Sms_Accounts",
21997     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
21998     "version": "0.0.0",
21999     "filename": "server/api/smsAccount/index.js",
22000     "groupTitle": "Sms_Accounts"
22001   },
22002   {
22003     "type": "post",
22004     "url": "/api/sms/accounts/{id}/notify",
22005     "title": "Notify new message",
22006     "examples": [
22007       {
22008         "title": "Example usage:",
22009         "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",
22010         "type": "json"
22011       }
22012     ],
22013     "name": "notify",
22014     "group": "Sms_Accounts",
22015     "description": "<p>Motion 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>",
22016     "version": "0.0.0",
22017     "filename": "server/api/smsAccount/index.js",
22018     "groupTitle": "Sms_Accounts"
22019   },
22020   {
22021     "type": "put",
22022     "url": "/api/sms/messages/{id}/reject",
22023     "title": "Rejects message",
22024     "examples": [
22025       {
22026         "title": "Example usage:",
22027         "content": "curl https://{domain}/api/sms/messages/{id}/reject \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X PUT",
22028         "type": "json"
22029       }
22030     ],
22031     "name": "rejectMessage",
22032     "group": "Sms_Accounts",
22033     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22034     "version": "0.0.0",
22035     "filename": "server/api/smsMessage/index.js",
22036     "groupTitle": "Sms_Accounts"
22037   },
22038   {
22039     "type": "post",
22040     "url": "/api/sms/accounts/{id}/send",
22041     "title": "Send new sms message",
22042     "examples": [
22043       {
22044         "title": "Example usage:",
22045         "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",
22046         "type": "json"
22047       }
22048     ],
22049     "name": "sendSms",
22050     "group": "Sms_Accounts",
22051     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22052     "version": "0.0.0",
22053     "filename": "server/api/smsAccount/index.js",
22054     "groupTitle": "Sms_Accounts"
22055   },
22056   {
22057     "type": "get",
22058     "url": "/api/sms/accounts/{id}/status",
22059     "title": "Receive message status as get request",
22060     "examples": [
22061       {
22062         "title": "Example usage:",
22063         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X GET",
22064         "type": "json"
22065       }
22066     ],
22067     "name": "statusMessage",
22068     "group": "Sms_Accounts",
22069     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22070     "version": "0.0.0",
22071     "filename": "server/api/smsAccount/index.js",
22072     "groupTitle": "Sms_Accounts"
22073   },
22074   {
22075     "type": "post",
22076     "url": "/api/sms/accounts/{id}/status",
22077     "title": "Receive message status",
22078     "examples": [
22079       {
22080         "title": "Example usage:",
22081         "content": "curl https://{domain}/api/sms/accounts/{id}/status -H 'Content-Type: application/json' -v -X POST",
22082         "type": "json"
22083       }
22084     ],
22085     "name": "statusMessage",
22086     "group": "Sms_Accounts",
22087     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22088     "version": "0.0.0",
22089     "filename": "server/api/smsAccount/index.js",
22090     "groupTitle": "Sms_Accounts"
22091   },
22092   {
22093     "type": "post",
22094     "url": "/api/sms/messages/{id}/status",
22095     "title": "Receive message status",
22096     "examples": [
22097       {
22098         "title": "Example usage:",
22099         "content": "curl https://{domain}/api/sms/messages/{id}/status \\ \n -H 'Content-Type: application/json' -v -X POST",
22100         "type": "json"
22101       }
22102     ],
22103     "name": "statusMessage",
22104     "group": "Sms_Accounts",
22105     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22106     "version": "0.0.0",
22107     "filename": "server/api/smsMessage/index.js",
22108     "groupTitle": "Sms_Accounts"
22109   },
22110   {
22111     "type": "put",
22112     "url": "/api/sms/accounts/{id}",
22113     "title": "Update an existing Account",
22114     "examples": [
22115       {
22116         "title": "Example usage:",
22117         "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",
22118         "type": "json"
22119       }
22120     ],
22121     "name": "updateAccounts",
22122     "group": "Sms_Accounts",
22123     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22124     "version": "0.0.0",
22125     "filename": "server/api/smsAccount/index.js",
22126     "groupTitle": "Sms_Accounts"
22127   },
22128   {
22129     "type": "post",
22130     "url": "/api/sms/applications",
22131     "title": "Creates a new Application",
22132     "examples": [
22133       {
22134         "title": "Example usage:",
22135         "content": "curl https://{domain}/api/sms/applications -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22136         "type": "json"
22137       }
22138     ],
22139     "name": "CreateApplications",
22140     "group": "Sms_Applications",
22141     "parameter": {
22142       "fields": {
22143         "Body": [
22144           {
22145             "group": "Body",
22146             "type": "Integer",
22147             "optional": false,
22148             "field": "priority",
22149             "description": ""
22150           },
22151           {
22152             "group": "Body",
22153             "type": "String",
22154             "optional": false,
22155             "field": "app",
22156             "description": ""
22157           },
22158           {
22159             "group": "Body",
22160             "type": "Text",
22161             "optional": true,
22162             "field": "appdata",
22163             "description": ""
22164           },
22165           {
22166             "group": "Body",
22167             "type": "String",
22168             "optional": true,
22169             "field": "description",
22170             "description": ""
22171           },
22172           {
22173             "group": "Body",
22174             "type": "String",
22175             "optional": true,
22176             "field": "interval",
22177             "description": ""
22178           }
22179         ]
22180       }
22181     },
22182     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22183     "version": "0.0.0",
22184     "filename": "server/api/smsApplication/index.js",
22185     "groupTitle": "Sms_Applications"
22186   },
22187   {
22188     "type": "delete",
22189     "url": "/api/sms/applications/{id}",
22190     "title": "Deletes a Application",
22191     "examples": [
22192       {
22193         "title": "Example usage:",
22194         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password} -X DELETE",
22195         "type": "json"
22196       }
22197     ],
22198     "name": "DeleteApplications",
22199     "group": "Sms_Applications",
22200     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22201     "version": "0.0.0",
22202     "filename": "server/api/smsApplication/index.js",
22203     "groupTitle": "Sms_Applications"
22204   },
22205   {
22206     "type": "get",
22207     "url": "/api/sms/applications",
22208     "title": "Gets a list of Applications",
22209     "examples": [
22210       {
22211         "title": "Example usage:",
22212         "content": "curl https://{domain}/api/sms/applications -v -u {name}:{password}",
22213         "type": "json"
22214       }
22215     ],
22216     "name": "GetApplications",
22217     "group": "Sms_Applications",
22218     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22219     "version": "0.0.0",
22220     "filename": "server/api/smsApplication/index.js",
22221     "groupTitle": "Sms_Applications"
22222   },
22223   {
22224     "type": "get",
22225     "url": "/api/sms/applications/{id}",
22226     "title": "Gets a single Application",
22227     "examples": [
22228       {
22229         "title": "Example usage:",
22230         "content": "curl https://{domain}/api/sms/applications/{id} -v -u {name}:{password}",
22231         "type": "json"
22232       }
22233     ],
22234     "name": "ShowApplications",
22235     "group": "Sms_Applications",
22236     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22237     "version": "0.0.0",
22238     "filename": "server/api/smsApplication/index.js",
22239     "groupTitle": "Sms_Applications"
22240   },
22241   {
22242     "type": "put",
22243     "url": "/api/sms/applications/{id}",
22244     "title": "Update an existing Application",
22245     "examples": [
22246       {
22247         "title": "Example usage:",
22248         "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",
22249         "type": "json"
22250       }
22251     ],
22252     "name": "updateApplications",
22253     "group": "Sms_Applications",
22254     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22255     "version": "0.0.0",
22256     "filename": "server/api/smsApplication/index.js",
22257     "groupTitle": "Sms_Applications"
22258   },
22259   {
22260     "type": "post",
22261     "url": "/api/sms/interactions/{id}/tags",
22262     "title": "Add tags to the interaction",
22263     "examples": [
22264       {
22265         "title": "Example usage:",
22266         "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",
22267         "type": "json"
22268       }
22269     ],
22270     "name": "AddTags",
22271     "group": "Sms_Interactions",
22272     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22273     "version": "0.0.0",
22274     "filename": "server/api/smsInteraction/index.js",
22275     "groupTitle": "Sms_Interactions"
22276   },
22277   {
22278     "type": "post",
22279     "url": "/api/sms/interactions",
22280     "title": "Creates a new Interaction",
22281     "examples": [
22282       {
22283         "title": "Example usage:",
22284         "content": "curl https://{domain}/api/sms/interactions -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22285         "type": "json"
22286       }
22287     ],
22288     "name": "CreateInteractions",
22289     "group": "Sms_Interactions",
22290     "parameter": {
22291       "fields": {
22292         "Body": [
22293           {
22294             "group": "Body",
22295             "type": "Boolean",
22296             "optional": true,
22297             "field": "closed",
22298             "description": ""
22299           },
22300           {
22301             "group": "Body",
22302             "type": "String",
22303             "optional": true,
22304             "field": "closedAt",
22305             "description": ""
22306           },
22307           {
22308             "group": "Body",
22309             "type": "String",
22310             "optional": true,
22311             "field": "disposition",
22312             "description": ""
22313           },
22314           {
22315             "group": "Body",
22316             "type": "String",
22317             "optional": true,
22318             "field": "note",
22319             "description": ""
22320           },
22321           {
22322             "group": "Body",
22323             "type": "String",
22324             "optional": true,
22325             "field": "phone",
22326             "description": ""
22327           },
22328           {
22329             "group": "Body",
22330             "type": "String",
22331             "optional": true,
22332             "field": "read1stAt",
22333             "description": ""
22334           },
22335           {
22336             "group": "Body",
22337             "type": "String",
22338             "allowedValues": [
22339               "\"in\"",
22340               "\"out\""
22341             ],
22342             "optional": false,
22343             "field": "firstMsgDirection",
22344             "description": ""
22345           },
22346           {
22347             "group": "Body",
22348             "type": "String",
22349             "optional": true,
22350             "field": "lastMsgAt",
22351             "description": ""
22352           },
22353           {
22354             "group": "Body",
22355             "type": "String",
22356             "allowedValues": [
22357               "\"in\"",
22358               "\"out\""
22359             ],
22360             "optional": false,
22361             "field": "lastMsgDirection",
22362             "description": ""
22363           }
22364         ]
22365       }
22366     },
22367     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22368     "version": "0.0.0",
22369     "filename": "server/api/smsInteraction/index.js",
22370     "groupTitle": "Sms_Interactions"
22371   },
22372   {
22373     "type": "delete",
22374     "url": "/api/sms/interactions/{id}",
22375     "title": "Deletes a Interaction",
22376     "examples": [
22377       {
22378         "title": "Example usage:",
22379         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password} -X DELETE",
22380         "type": "json"
22381       }
22382     ],
22383     "name": "DeleteInteractions",
22384     "group": "Sms_Interactions",
22385     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22386     "version": "0.0.0",
22387     "filename": "server/api/smsInteraction/index.js",
22388     "groupTitle": "Sms_Interactions"
22389   },
22390   {
22391     "type": "get",
22392     "url": "/api/sms/interactions/describe",
22393     "title": "Gets table info about Interactions",
22394     "examples": [
22395       {
22396         "title": "Example usage:",
22397         "content": "curl https://{domain}/api/sms/interactions/describe -v -u {name}:{password}",
22398         "type": "json"
22399       }
22400     ],
22401     "name": "DescribeInteractions",
22402     "group": "Sms_Interactions",
22403     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22404     "version": "0.0.0",
22405     "filename": "server/api/smsInteraction/index.js",
22406     "groupTitle": "Sms_Interactions"
22407   },
22408   {
22409     "type": "get",
22410     "url": "/api/sms/interactions",
22411     "title": "Gets a list of Interactions",
22412     "examples": [
22413       {
22414         "title": "Example usage:",
22415         "content": "curl https://{domain}/api/sms/interactions -v -u {name}:{password}",
22416         "type": "json"
22417       }
22418     ],
22419     "name": "GetInteractions",
22420     "group": "Sms_Interactions",
22421     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22422     "version": "0.0.0",
22423     "filename": "server/api/smsInteraction/index.js",
22424     "groupTitle": "Sms_Interactions"
22425   },
22426   {
22427     "type": "delete",
22428     "url": "/api/sms/interactions/{id}/tags",
22429     "title": "Removes tags from interaction",
22430     "examples": [
22431       {
22432         "title": "Example usage:",
22433         "content": "curl https://{domain}/api/sms/interactions/{id}/tags?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
22434         "type": "json"
22435       }
22436     ],
22437     "name": "RemoveTags",
22438     "group": "Sms_Interactions",
22439     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22440     "version": "0.0.0",
22441     "filename": "server/api/smsInteraction/index.js",
22442     "groupTitle": "Sms_Interactions"
22443   },
22444   {
22445     "type": "get",
22446     "url": "/api/sms/interactions/{id}",
22447     "title": "Gets a single Interaction",
22448     "examples": [
22449       {
22450         "title": "Example usage:",
22451         "content": "curl https://{domain}/api/sms/interactions/{id} -v -u {name}:{password}",
22452         "type": "json"
22453       }
22454     ],
22455     "name": "ShowInteractions",
22456     "group": "Sms_Interactions",
22457     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22458     "version": "0.0.0",
22459     "filename": "server/api/smsInteraction/index.js",
22460     "groupTitle": "Sms_Interactions"
22461   },
22462   {
22463     "type": "post",
22464     "url": "/api/sms/interactions/{id}/messages",
22465     "title": "Creates new messages",
22466     "examples": [
22467       {
22468         "title": "Example usage:",
22469         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -d '[{\"to\": \"+3901119886500\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
22470         "type": "json"
22471       }
22472     ],
22473     "name": "addMessage",
22474     "group": "Sms_Interactions",
22475     "parameter": {
22476       "fields": {
22477         "Body": [
22478           {
22479             "group": "Body",
22480             "type": "Text",
22481             "optional": false,
22482             "field": "body",
22483             "description": ""
22484           },
22485           {
22486             "group": "Body",
22487             "type": "Boolean",
22488             "optional": true,
22489             "field": "read",
22490             "description": ""
22491           },
22492           {
22493             "group": "Body",
22494             "type": "String",
22495             "allowedValues": [
22496               "\"in\"",
22497               "\"out\""
22498             ],
22499             "optional": false,
22500             "field": "direction",
22501             "description": ""
22502           },
22503           {
22504             "group": "Body",
22505             "type": "String",
22506             "optional": true,
22507             "field": "messageId",
22508             "description": ""
22509           },
22510           {
22511             "group": "Body",
22512             "type": "String",
22513             "optional": true,
22514             "field": "phone",
22515             "description": ""
22516           },
22517           {
22518             "group": "Body",
22519             "type": "String",
22520             "optional": true,
22521             "field": "readAt",
22522             "description": ""
22523           },
22524           {
22525             "group": "Body",
22526             "type": "Boolean",
22527             "optional": true,
22528             "field": "secret",
22529             "description": ""
22530           }
22531         ]
22532       }
22533     },
22534     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22535     "version": "0.0.0",
22536     "filename": "server/api/smsInteraction/index.js",
22537     "groupTitle": "Sms_Interactions"
22538   },
22539   {
22540     "type": "get",
22541     "url": "/api/sms/interactions/{id}/download",
22542     "title": "Gets interaction",
22543     "examples": [
22544       {
22545         "title": "Example usage:",
22546         "content": "curl https://{domain}/api/sms/interactions/{id}/download -v -u {name}:{password} -X GET",
22547         "type": "json"
22548       }
22549     ],
22550     "name": "download",
22551     "group": "Sms_Interactions",
22552     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22553     "version": "0.0.0",
22554     "filename": "server/api/smsInteraction/index.js",
22555     "groupTitle": "Sms_Interactions"
22556   },
22557   {
22558     "type": "get",
22559     "url": "/api/sms/interactions/{id}/messages",
22560     "title": "Gets interaction messages",
22561     "examples": [
22562       {
22563         "title": "Example usage:",
22564         "content": "curl https://{domain}/api/sms/interactions/{id}/messages -v -u {name}:{password} -X GET",
22565         "type": "json"
22566       }
22567     ],
22568     "name": "getMessages",
22569     "group": "Sms_Interactions",
22570     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22571     "version": "0.0.0",
22572     "filename": "server/api/smsInteraction/index.js",
22573     "groupTitle": "Sms_Interactions"
22574   },
22575   {
22576     "type": "put",
22577     "url": "/api/sms/interactions/{id}",
22578     "title": "Update an existing Interaction",
22579     "examples": [
22580       {
22581         "title": "Example usage:",
22582         "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",
22583         "type": "json"
22584       }
22585     ],
22586     "name": "updateInteractions",
22587     "group": "Sms_Interactions",
22588     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22589     "version": "0.0.0",
22590     "filename": "server/api/smsInteraction/index.js",
22591     "groupTitle": "Sms_Interactions"
22592   },
22593   {
22594     "type": "post",
22595     "url": "/api/sms/messages",
22596     "title": "Creates a new Message",
22597     "examples": [
22598       {
22599         "title": "Example usage:",
22600         "content": "curl https://{domain}/api/sms/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22601         "type": "json"
22602       }
22603     ],
22604     "name": "CreateMessages",
22605     "group": "Sms_Messages",
22606     "parameter": {
22607       "fields": {
22608         "Body": [
22609           {
22610             "group": "Body",
22611             "type": "Text",
22612             "optional": false,
22613             "field": "body",
22614             "description": ""
22615           },
22616           {
22617             "group": "Body",
22618             "type": "Boolean",
22619             "optional": true,
22620             "field": "read",
22621             "description": ""
22622           },
22623           {
22624             "group": "Body",
22625             "type": "String",
22626             "allowedValues": [
22627               "\"in\"",
22628               "\"out\""
22629             ],
22630             "optional": false,
22631             "field": "direction",
22632             "description": ""
22633           },
22634           {
22635             "group": "Body",
22636             "type": "String",
22637             "optional": true,
22638             "field": "messageId",
22639             "description": ""
22640           },
22641           {
22642             "group": "Body",
22643             "type": "String",
22644             "optional": true,
22645             "field": "phone",
22646             "description": ""
22647           },
22648           {
22649             "group": "Body",
22650             "type": "String",
22651             "optional": true,
22652             "field": "readAt",
22653             "description": ""
22654           },
22655           {
22656             "group": "Body",
22657             "type": "Boolean",
22658             "optional": true,
22659             "field": "secret",
22660             "description": ""
22661           }
22662         ]
22663       }
22664     },
22665     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22666     "version": "0.0.0",
22667     "filename": "server/api/smsMessage/index.js",
22668     "groupTitle": "Sms_Messages"
22669   },
22670   {
22671     "type": "delete",
22672     "url": "/api/sms/messages/{id}",
22673     "title": "Deletes a Message",
22674     "examples": [
22675       {
22676         "title": "Example usage:",
22677         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password} -X DELETE",
22678         "type": "json"
22679       }
22680     ],
22681     "name": "DeleteMessages",
22682     "group": "Sms_Messages",
22683     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22684     "version": "0.0.0",
22685     "filename": "server/api/smsMessage/index.js",
22686     "groupTitle": "Sms_Messages"
22687   },
22688   {
22689     "type": "get",
22690     "url": "/api/sms/messages/describe",
22691     "title": "Gets table info about Messages",
22692     "examples": [
22693       {
22694         "title": "Example usage:",
22695         "content": "curl https://{domain}/api/sms/messages/describe -v -u {name}:{password}",
22696         "type": "json"
22697       }
22698     ],
22699     "name": "DescribeMessages",
22700     "group": "Sms_Messages",
22701     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22702     "version": "0.0.0",
22703     "filename": "server/api/smsMessage/index.js",
22704     "groupTitle": "Sms_Messages"
22705   },
22706   {
22707     "type": "get",
22708     "url": "/api/sms/messages",
22709     "title": "Gets a list of Messages",
22710     "examples": [
22711       {
22712         "title": "Example usage:",
22713         "content": "curl https://{domain}/api/sms/messages -v -u {name}:{password}",
22714         "type": "json"
22715       }
22716     ],
22717     "name": "GetMessages",
22718     "group": "Sms_Messages",
22719     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22720     "version": "0.0.0",
22721     "filename": "server/api/smsMessage/index.js",
22722     "groupTitle": "Sms_Messages"
22723   },
22724   {
22725     "type": "get",
22726     "url": "/api/sms/messages/{id}",
22727     "title": "Gets a single Message",
22728     "examples": [
22729       {
22730         "title": "Example usage:",
22731         "content": "curl https://{domain}/api/sms/messages/{id} -v -u {name}:{password}",
22732         "type": "json"
22733       }
22734     ],
22735     "name": "ShowMessages",
22736     "group": "Sms_Messages",
22737     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22738     "version": "0.0.0",
22739     "filename": "server/api/smsMessage/index.js",
22740     "groupTitle": "Sms_Messages"
22741   },
22742   {
22743     "type": "put",
22744     "url": "/api/sms/messages/{id}",
22745     "title": "Update an existing Message",
22746     "examples": [
22747       {
22748         "title": "Example usage:",
22749         "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",
22750         "type": "json"
22751       }
22752     ],
22753     "name": "updateMessages",
22754     "group": "Sms_Messages",
22755     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22756     "version": "0.0.0",
22757     "filename": "server/api/smsMessage/index.js",
22758     "groupTitle": "Sms_Messages"
22759   },
22760   {
22761     "type": "post",
22762     "url": "/api/sms/reports/queue",
22763     "title": "Creates a new Sms Queue Report",
22764     "examples": [
22765       {
22766         "title": "Example usage:",
22767         "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",
22768         "type": "json"
22769       }
22770     ],
22771     "name": "CreateSms_Queue_Reports",
22772     "group": "Sms_Queue_Reports",
22773     "parameter": {
22774       "fields": {
22775         "Body": [
22776           {
22777             "group": "Body",
22778             "type": "String",
22779             "optional": false,
22780             "field": "uniqueid",
22781             "description": ""
22782           },
22783           {
22784             "group": "Body",
22785             "type": "String",
22786             "optional": true,
22787             "field": "from",
22788             "description": ""
22789           },
22790           {
22791             "group": "Body",
22792             "type": "String",
22793             "optional": true,
22794             "field": "joinAt",
22795             "description": ""
22796           },
22797           {
22798             "group": "Body",
22799             "type": "String",
22800             "optional": true,
22801             "field": "leaveAt",
22802             "description": ""
22803           },
22804           {
22805             "group": "Body",
22806             "type": "String",
22807             "optional": true,
22808             "field": "acceptAt",
22809             "description": ""
22810           },
22811           {
22812             "group": "Body",
22813             "type": "String",
22814             "optional": true,
22815             "field": "exitAt",
22816             "description": ""
22817           },
22818           {
22819             "group": "Body",
22820             "type": "String",
22821             "optional": true,
22822             "field": "reason",
22823             "description": ""
22824           }
22825         ]
22826       }
22827     },
22828     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22829     "version": "0.0.0",
22830     "filename": "server/api/smsQueueReport/index.js",
22831     "groupTitle": "Sms_Queue_Reports"
22832   },
22833   {
22834     "type": "delete",
22835     "url": "/api/sms/reports/queue/{id}",
22836     "title": "Deletes a Sms Queue Report",
22837     "examples": [
22838       {
22839         "title": "Example usage:",
22840         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password} -X DELETE",
22841         "type": "json"
22842       }
22843     ],
22844     "name": "DeleteSms_Queue_Reports",
22845     "group": "Sms_Queue_Reports",
22846     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22847     "version": "0.0.0",
22848     "filename": "server/api/smsQueueReport/index.js",
22849     "groupTitle": "Sms_Queue_Reports"
22850   },
22851   {
22852     "type": "get",
22853     "url": "/api/sms/reports/queue/describe",
22854     "title": "Gets table info about Sms Queue Reports",
22855     "examples": [
22856       {
22857         "title": "Example usage:",
22858         "content": "curl https://{domain}/api/sms/reports/queue/describe -v -u {name}:{password}",
22859         "type": "json"
22860       }
22861     ],
22862     "name": "DescribeSms_Queue_Reports",
22863     "group": "Sms_Queue_Reports",
22864     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22865     "version": "0.0.0",
22866     "filename": "server/api/smsQueueReport/index.js",
22867     "groupTitle": "Sms_Queue_Reports"
22868   },
22869   {
22870     "type": "get",
22871     "url": "/api/sms/reports/queue",
22872     "title": "Gets a list of Sms Queue Reports",
22873     "examples": [
22874       {
22875         "title": "Example usage:",
22876         "content": "curl https://{domain}/api/sms/reports/queue -v -u {name}:{password}",
22877         "type": "json"
22878       }
22879     ],
22880     "name": "GetSms_Queue_Reports",
22881     "group": "Sms_Queue_Reports",
22882     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
22883     "version": "0.0.0",
22884     "filename": "server/api/smsQueueReport/index.js",
22885     "groupTitle": "Sms_Queue_Reports"
22886   },
22887   {
22888     "type": "get",
22889     "url": "/api/sms/reports/queue/{id}",
22890     "title": "Gets a single Sms Queue Report",
22891     "examples": [
22892       {
22893         "title": "Example usage:",
22894         "content": "curl https://{domain}/api/sms/reports/queue/{id} -v -u {name}:{password}",
22895         "type": "json"
22896       }
22897     ],
22898     "name": "ShowSms_Queue_Reports",
22899     "group": "Sms_Queue_Reports",
22900     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22901     "version": "0.0.0",
22902     "filename": "server/api/smsQueueReport/index.js",
22903     "groupTitle": "Sms_Queue_Reports"
22904   },
22905   {
22906     "type": "put",
22907     "url": "/api/sms/reports/queue/{id}",
22908     "title": "Update an existing Sms Queue Report",
22909     "examples": [
22910       {
22911         "title": "Example usage:",
22912         "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",
22913         "type": "json"
22914       }
22915     ],
22916     "name": "updateSms_Queue_Reports",
22917     "group": "Sms_Queue_Reports",
22918     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22919     "version": "0.0.0",
22920     "filename": "server/api/smsQueueReport/index.js",
22921     "groupTitle": "Sms_Queue_Reports"
22922   },
22923   {
22924     "type": "post",
22925     "url": "/api/sms/queues/{id}/users",
22926     "title": "Add agents to a queue",
22927     "examples": [
22928       {
22929         "title": "Example usage:",
22930         "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",
22931         "type": "json"
22932       }
22933     ],
22934     "name": "AddAgents",
22935     "group": "Sms_Queues",
22936     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22937     "version": "0.0.0",
22938     "filename": "server/api/smsQueue/index.js",
22939     "groupTitle": "Sms_Queues"
22940   },
22941   {
22942     "type": "post",
22943     "url": "/api/sms/queues/{id}/teams",
22944     "title": "Add teams to a queue",
22945     "examples": [
22946       {
22947         "title": "Example usage:",
22948         "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",
22949         "type": "json"
22950       }
22951     ],
22952     "name": "AddTeams",
22953     "group": "Sms_Queues",
22954     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
22955     "version": "0.0.0",
22956     "filename": "server/api/smsQueue/index.js",
22957     "groupTitle": "Sms_Queues"
22958   },
22959   {
22960     "type": "post",
22961     "url": "/api/sms/queues",
22962     "title": "Creates a new Queue",
22963     "examples": [
22964       {
22965         "title": "Example usage:",
22966         "content": "curl https://{domain}/api/sms/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
22967         "type": "json"
22968       }
22969     ],
22970     "name": "CreateQueues",
22971     "group": "Sms_Queues",
22972     "parameter": {
22973       "fields": {
22974         "Body": [
22975           {
22976             "group": "Body",
22977             "type": "String",
22978             "optional": true,
22979             "field": "name",
22980             "description": ""
22981           },
22982           {
22983             "group": "Body",
22984             "type": "String",
22985             "optional": true,
22986             "field": "description",
22987             "description": ""
22988           },
22989           {
22990             "group": "Body",
22991             "type": "Integer",
22992             "optional": true,
22993             "field": "timeout",
22994             "description": ""
22995           },
22996           {
22997             "group": "Body",
22998             "type": "String",
22999             "allowedValues": [
23000               "\"rrmemory\"",
23001               "\"beepall\"",
23002               "\"roundrobin\""
23003             ],
23004             "optional": true,
23005             "field": "strategy",
23006             "description": ""
23007           }
23008         ]
23009       }
23010     },
23011     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23012     "version": "0.0.0",
23013     "filename": "server/api/smsQueue/index.js",
23014     "groupTitle": "Sms_Queues"
23015   },
23016   {
23017     "type": "delete",
23018     "url": "/api/sms/queues/{id}",
23019     "title": "Deletes a Queue",
23020     "examples": [
23021       {
23022         "title": "Example usage:",
23023         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password} -X DELETE",
23024         "type": "json"
23025       }
23026     ],
23027     "name": "DeleteQueues",
23028     "group": "Sms_Queues",
23029     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23030     "version": "0.0.0",
23031     "filename": "server/api/smsQueue/index.js",
23032     "groupTitle": "Sms_Queues"
23033   },
23034   {
23035     "type": "get",
23036     "url": "/api/sms/queues/describe",
23037     "title": "Gets table info about Queues",
23038     "examples": [
23039       {
23040         "title": "Example usage:",
23041         "content": "curl https://{domain}/api/sms/queues/describe -v -u {name}:{password}",
23042         "type": "json"
23043       }
23044     ],
23045     "name": "DescribeQueues",
23046     "group": "Sms_Queues",
23047     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23048     "version": "0.0.0",
23049     "filename": "server/api/smsQueue/index.js",
23050     "groupTitle": "Sms_Queues"
23051   },
23052   {
23053     "type": "get",
23054     "url": "/api/sms/queues/{id}/users",
23055     "title": "Gets queue agents",
23056     "examples": [
23057       {
23058         "title": "Example usage:",
23059         "content": "curl https://{domain}/api/sms/queues/{id}/users -v -u {name}:{password} -X POST",
23060         "type": "json"
23061       }
23062     ],
23063     "name": "GetAgents",
23064     "group": "Sms_Queues",
23065     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23066     "version": "0.0.0",
23067     "filename": "server/api/smsQueue/index.js",
23068     "groupTitle": "Sms_Queues"
23069   },
23070   {
23071     "type": "get",
23072     "url": "/api/sms/queues/{id}/members",
23073     "title": "GetMembers",
23074     "examples": [
23075       {
23076         "title": "Example usage:",
23077         "content": "curl https://{domain}/api/sms/queues/{id}/members  -v -u {name}:{password}",
23078         "type": "json"
23079       }
23080     ],
23081     "name": "GetMembers",
23082     "group": "Sms_Queues",
23083     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23084     "version": "0.0.0",
23085     "filename": "server/api/smsQueue/index.js",
23086     "groupTitle": "Sms_Queues"
23087   },
23088   {
23089     "type": "get",
23090     "url": "/api/sms/queues",
23091     "title": "Gets a list of Queues",
23092     "examples": [
23093       {
23094         "title": "Example usage:",
23095         "content": "curl https://{domain}/api/sms/queues -v -u {name}:{password}",
23096         "type": "json"
23097       }
23098     ],
23099     "name": "GetQueues",
23100     "group": "Sms_Queues",
23101     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23102     "version": "0.0.0",
23103     "filename": "server/api/smsQueue/index.js",
23104     "groupTitle": "Sms_Queues"
23105   },
23106   {
23107     "type": "get",
23108     "url": "/api/sms/queues/{id}/teams",
23109     "title": "Gets queues list",
23110     "examples": [
23111       {
23112         "title": "Example usage:",
23113         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password}",
23114         "type": "json"
23115       }
23116     ],
23117     "name": "GetTeams",
23118     "group": "Sms_Queues",
23119     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23120     "version": "0.0.0",
23121     "filename": "server/api/smsQueue/index.js",
23122     "groupTitle": "Sms_Queues"
23123   },
23124   {
23125     "type": "delete",
23126     "url": "/api/sms/queues/{id}/users",
23127     "title": "Removes agents from a queue",
23128     "examples": [
23129       {
23130         "title": "Example usage:",
23131         "content": "curl https://{domain}/api/sms/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23132         "type": "json"
23133       }
23134     ],
23135     "name": "RemoveAgents",
23136     "group": "Sms_Queues",
23137     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23138     "version": "0.0.0",
23139     "filename": "server/api/smsQueue/index.js",
23140     "groupTitle": "Sms_Queues"
23141   },
23142   {
23143     "type": "get",
23144     "url": "/api/sms/queues/{id}",
23145     "title": "Gets a single Queue",
23146     "examples": [
23147       {
23148         "title": "Example usage:",
23149         "content": "curl https://{domain}/api/sms/queues/{id} -v -u {name}:{password}",
23150         "type": "json"
23151       }
23152     ],
23153     "name": "ShowQueues",
23154     "group": "Sms_Queues",
23155     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23156     "version": "0.0.0",
23157     "filename": "server/api/smsQueue/index.js",
23158     "groupTitle": "Sms_Queues"
23159   },
23160   {
23161     "type": "put",
23162     "url": "/api/sms/queues/{id}",
23163     "title": "Update an existing Queue",
23164     "examples": [
23165       {
23166         "title": "Example usage:",
23167         "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",
23168         "type": "json"
23169       }
23170     ],
23171     "name": "updateQueues",
23172     "group": "Sms_Queues",
23173     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23174     "version": "0.0.0",
23175     "filename": "server/api/smsQueue/index.js",
23176     "groupTitle": "Sms_Queues"
23177   },
23178   {
23179     "type": "post",
23180     "url": "/api/sms/reports/transfer",
23181     "title": "Creates a new Sms Transfer Report",
23182     "examples": [
23183       {
23184         "title": "Example usage:",
23185         "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",
23186         "type": "json"
23187       }
23188     ],
23189     "name": "CreateSms_Transfer_Reports",
23190     "group": "Sms_Transfer_Reports",
23191     "parameter": {
23192       "fields": {
23193         "Body": [
23194           {
23195             "group": "Body",
23196             "type": "String",
23197             "optional": false,
23198             "field": "uniqueid",
23199             "description": ""
23200           },
23201           {
23202             "group": "Body",
23203             "type": "String",
23204             "allowedValues": [
23205               "\"account\"",
23206               "\"agent\"",
23207               "\"queue\""
23208             ],
23209             "optional": false,
23210             "field": "type",
23211             "description": ""
23212           },
23213           {
23214             "group": "Body",
23215             "type": "String",
23216             "optional": false,
23217             "field": "transferredAt",
23218             "description": ""
23219           }
23220         ]
23221       }
23222     },
23223     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23224     "version": "0.0.0",
23225     "filename": "server/api/smsTransferReport/index.js",
23226     "groupTitle": "Sms_Transfer_Reports"
23227   },
23228   {
23229     "type": "delete",
23230     "url": "/api/sms/reports/transfer/{id}",
23231     "title": "Deletes a Sms Transfer Report",
23232     "examples": [
23233       {
23234         "title": "Example usage:",
23235         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password} -X DELETE",
23236         "type": "json"
23237       }
23238     ],
23239     "name": "DeleteSms_Transfer_Reports",
23240     "group": "Sms_Transfer_Reports",
23241     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23242     "version": "0.0.0",
23243     "filename": "server/api/smsTransferReport/index.js",
23244     "groupTitle": "Sms_Transfer_Reports"
23245   },
23246   {
23247     "type": "get",
23248     "url": "/api/sms/reports/transfer/describe",
23249     "title": "Gets table info about Sms Transfer Reports",
23250     "examples": [
23251       {
23252         "title": "Example usage:",
23253         "content": "curl https://{domain}/api/sms/reports/transfer/describe -v -u {name}:{password}",
23254         "type": "json"
23255       }
23256     ],
23257     "name": "DescribeSms_Transfer_Reports",
23258     "group": "Sms_Transfer_Reports",
23259     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23260     "version": "0.0.0",
23261     "filename": "server/api/smsTransferReport/index.js",
23262     "groupTitle": "Sms_Transfer_Reports"
23263   },
23264   {
23265     "type": "get",
23266     "url": "/api/sms/reports/transfer",
23267     "title": "Gets a list of Sms Transfer Reports",
23268     "examples": [
23269       {
23270         "title": "Example usage:",
23271         "content": "curl https://{domain}/api/sms/reports/transfer -v -u {name}:{password}",
23272         "type": "json"
23273       }
23274     ],
23275     "name": "GetSms_Transfer_Reports",
23276     "group": "Sms_Transfer_Reports",
23277     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23278     "version": "0.0.0",
23279     "filename": "server/api/smsTransferReport/index.js",
23280     "groupTitle": "Sms_Transfer_Reports"
23281   },
23282   {
23283     "type": "get",
23284     "url": "/api/sms/reports/transfer/{id}",
23285     "title": "Gets a single Sms Transfer Report",
23286     "examples": [
23287       {
23288         "title": "Example usage:",
23289         "content": "curl https://{domain}/api/sms/reports/transfer/{id} -v -u {name}:{password}",
23290         "type": "json"
23291       }
23292     ],
23293     "name": "ShowSms_Transfer_Reports",
23294     "group": "Sms_Transfer_Reports",
23295     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23296     "version": "0.0.0",
23297     "filename": "server/api/smsTransferReport/index.js",
23298     "groupTitle": "Sms_Transfer_Reports"
23299   },
23300   {
23301     "type": "put",
23302     "url": "/api/sms/reports/transfer/{id}",
23303     "title": "Update an existing Sms Transfer Report",
23304     "examples": [
23305       {
23306         "title": "Example usage:",
23307         "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",
23308         "type": "json"
23309       }
23310     ],
23311     "name": "updateSms_Transfer_Reports",
23312     "group": "Sms_Transfer_Reports",
23313     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23314     "version": "0.0.0",
23315     "filename": "server/api/smsTransferReport/index.js",
23316     "groupTitle": "Sms_Transfer_Reports"
23317   },
23318   {
23319     "type": "get",
23320     "url": "/api/sounds",
23321     "title": "Gets a list of Sounds",
23322     "examples": [
23323       {
23324         "title": "Example usage:",
23325         "content": "curl https://{domain}/api/sounds -v -u {name}:{password}",
23326         "type": "json"
23327       }
23328     ],
23329     "name": "GetSounds",
23330     "group": "Sounds",
23331     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23332     "version": "0.0.0",
23333     "filename": "server/api/sound/index.js",
23334     "groupTitle": "Sounds"
23335   },
23336   {
23337     "type": "get",
23338     "url": "/api/sounds/{id}",
23339     "title": "Gets a single Sound",
23340     "examples": [
23341       {
23342         "title": "Example usage:",
23343         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password}",
23344         "type": "json"
23345       }
23346     ],
23347     "name": "ShowSounds",
23348     "group": "Sounds",
23349     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23350     "version": "0.0.0",
23351     "filename": "server/api/sound/index.js",
23352     "groupTitle": "Sounds"
23353   },
23354   {
23355     "type": "post",
23356     "url": "/api/sounds",
23357     "title": "Create a new sound",
23358     "examples": [
23359       {
23360         "title": "Example usage:",
23361         "content": "curl https://{domain}/api/sounds -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
23362         "type": "json"
23363       }
23364     ],
23365     "name": "addSound",
23366     "group": "Sounds",
23367     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23368     "version": "0.0.0",
23369     "filename": "server/api/sound/index.js",
23370     "groupTitle": "Sounds"
23371   },
23372   {
23373     "type": "delete",
23374     "url": "/api/sounds/{id}",
23375     "title": "Deletes a sound",
23376     "examples": [
23377       {
23378         "title": "Example usage:",
23379         "content": "curl https://{domain}/api/sounds/{id} -v -u {name}:{password} -X DELETE",
23380         "type": "json"
23381       }
23382     ],
23383     "name": "destroySound",
23384     "group": "Sounds",
23385     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23386     "version": "0.0.0",
23387     "filename": "server/api/sound/index.js",
23388     "groupTitle": "Sounds"
23389   },
23390   {
23391     "type": "get",
23392     "url": "/api/sounds/{id}/download",
23393     "title": "Download Sound",
23394     "examples": [
23395       {
23396         "title": "Example usage:",
23397         "content": "curl https://{domain}/api/sounds/{id}/download -v -u {name}:{password} -X GET",
23398         "type": "json"
23399       }
23400     ],
23401     "name": "download",
23402     "group": "Sounds",
23403     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23404     "version": "0.0.0",
23405     "filename": "server/api/sound/index.js",
23406     "groupTitle": "Sounds"
23407   },
23408   {
23409     "type": "put",
23410     "url": "/api/sounds",
23411     "title": "Update an existing new sound",
23412     "examples": [
23413       {
23414         "title": "Example usage:",
23415         "content": "curl https://{domain}/api/sounds -d '[\"name\": \"sound_name\", \"description\": \"sound_desc\"]' -v -u {name}:{password} -X PUT",
23416         "type": "json"
23417       }
23418     ],
23419     "name": "updateSound",
23420     "group": "Sounds",
23421     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23422     "version": "0.0.0",
23423     "filename": "server/api/sound/index.js",
23424     "groupTitle": "Sounds"
23425   },
23426   {
23427     "type": "post",
23428     "url": "/api/square/details/reports",
23429     "title": "Creates a new Square Detail Report",
23430     "examples": [
23431       {
23432         "title": "Example usage:",
23433         "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",
23434         "type": "json"
23435       }
23436     ],
23437     "name": "CreateSquare_Detail_Reports",
23438     "group": "Square_Details_Reports",
23439     "parameter": {
23440       "fields": {
23441         "Body": [
23442           {
23443             "group": "Body",
23444             "type": "String",
23445             "optional": true,
23446             "field": "uniqueid",
23447             "description": ""
23448           },
23449           {
23450             "group": "Body",
23451             "type": "String",
23452             "optional": true,
23453             "field": "node",
23454             "description": ""
23455           },
23456           {
23457             "group": "Body",
23458             "type": "String",
23459             "optional": true,
23460             "field": "application",
23461             "description": ""
23462           },
23463           {
23464             "group": "Body",
23465             "type": "Text",
23466             "optional": true,
23467             "field": "data",
23468             "description": ""
23469           },
23470           {
23471             "group": "Body",
23472             "type": "String",
23473             "optional": true,
23474             "field": "project_name",
23475             "description": ""
23476           },
23477           {
23478             "group": "Body",
23479             "type": "String",
23480             "optional": true,
23481             "field": "callerid",
23482             "description": ""
23483           }
23484         ]
23485       }
23486     },
23487     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23488     "version": "0.0.0",
23489     "filename": "server/api/squareReportDetail/index.js",
23490     "groupTitle": "Square_Details_Reports"
23491   },
23492   {
23493     "type": "delete",
23494     "url": "/api/square/details/reports/{id}",
23495     "title": "Deletes a Square Detail Report",
23496     "examples": [
23497       {
23498         "title": "Example usage:",
23499         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password} -X DELETE",
23500         "type": "json"
23501       }
23502     ],
23503     "name": "DeleteSquare_Detail_Reports",
23504     "group": "Square_Details_Reports",
23505     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23506     "version": "0.0.0",
23507     "filename": "server/api/squareReportDetail/index.js",
23508     "groupTitle": "Square_Details_Reports"
23509   },
23510   {
23511     "type": "get",
23512     "url": "/api/square/details/reports/describe",
23513     "title": "Gets table info about Square Detail Reports",
23514     "examples": [
23515       {
23516         "title": "Example usage:",
23517         "content": "curl https://{domain}/api/square/details/reports/describe -v -u {name}:{password}",
23518         "type": "json"
23519       }
23520     ],
23521     "name": "DescribeSquare_Detail_Reports",
23522     "group": "Square_Details_Reports",
23523     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23524     "version": "0.0.0",
23525     "filename": "server/api/squareReportDetail/index.js",
23526     "groupTitle": "Square_Details_Reports"
23527   },
23528   {
23529     "type": "get",
23530     "url": "/api/square/details/reports",
23531     "title": "Gets a list of Square Detail Reports",
23532     "examples": [
23533       {
23534         "title": "Example usage:",
23535         "content": "curl https://{domain}/api/square/details/reports -v -u {name}:{password}",
23536         "type": "json"
23537       }
23538     ],
23539     "name": "GetSquare_Detail_Reports",
23540     "group": "Square_Details_Reports",
23541     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23542     "version": "0.0.0",
23543     "filename": "server/api/squareReportDetail/index.js",
23544     "groupTitle": "Square_Details_Reports"
23545   },
23546   {
23547     "type": "get",
23548     "url": "/api/square/details/reports/{id}",
23549     "title": "Gets a single Square Detail Report",
23550     "examples": [
23551       {
23552         "title": "Example usage:",
23553         "content": "curl https://{domain}/api/square/details/reports/{id} -v -u {name}:{password}",
23554         "type": "json"
23555       }
23556     ],
23557     "name": "ShowSquare_Detail_Reports",
23558     "group": "Square_Details_Reports",
23559     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23560     "version": "0.0.0",
23561     "filename": "server/api/squareReportDetail/index.js",
23562     "groupTitle": "Square_Details_Reports"
23563   },
23564   {
23565     "type": "put",
23566     "url": "/api/square/details/reports/{id}",
23567     "title": "Update an existing Square Detail Report",
23568     "examples": [
23569       {
23570         "title": "Example usage:",
23571         "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",
23572         "type": "json"
23573       }
23574     ],
23575     "name": "updateSquare_Detail_Reports",
23576     "group": "Square_Details_Reports",
23577     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23578     "version": "0.0.0",
23579     "filename": "server/api/squareReportDetail/index.js",
23580     "groupTitle": "Square_Details_Reports"
23581   },
23582   {
23583     "type": "post",
23584     "url": "/api/square/messages",
23585     "title": "Creates a new Message",
23586     "examples": [
23587       {
23588         "title": "Example usage:",
23589         "content": "curl https://{domain}/api/square/messages -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23590         "type": "json"
23591       }
23592     ],
23593     "name": "CreateMessages",
23594     "group": "Square_Messages",
23595     "parameter": {
23596       "fields": {
23597         "Body": [
23598           {
23599             "group": "Body",
23600             "type": "String",
23601             "optional": true,
23602             "field": "uniqueid",
23603             "description": ""
23604           },
23605           {
23606             "group": "Body",
23607             "type": "Text",
23608             "optional": false,
23609             "field": "body",
23610             "description": ""
23611           },
23612           {
23613             "group": "Body",
23614             "type": "String",
23615             "allowedValues": [
23616               "\"in\"",
23617               "\"out\""
23618             ],
23619             "optional": false,
23620             "field": "direction",
23621             "description": ""
23622           }
23623         ]
23624       }
23625     },
23626     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23627     "version": "0.0.0",
23628     "filename": "server/api/squareMessage/index.js",
23629     "groupTitle": "Square_Messages"
23630   },
23631   {
23632     "type": "delete",
23633     "url": "/api/square/messages/{id}",
23634     "title": "Deletes a Message",
23635     "examples": [
23636       {
23637         "title": "Example usage:",
23638         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password} -X DELETE",
23639         "type": "json"
23640       }
23641     ],
23642     "name": "DeleteMessages",
23643     "group": "Square_Messages",
23644     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23645     "version": "0.0.0",
23646     "filename": "server/api/squareMessage/index.js",
23647     "groupTitle": "Square_Messages"
23648   },
23649   {
23650     "type": "get",
23651     "url": "/api/square/messages",
23652     "title": "Gets a list of Messages",
23653     "examples": [
23654       {
23655         "title": "Example usage:",
23656         "content": "curl https://{domain}/api/square/messages -v -u {name}:{password}",
23657         "type": "json"
23658       }
23659     ],
23660     "name": "GetMessages",
23661     "group": "Square_Messages",
23662     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23663     "version": "0.0.0",
23664     "filename": "server/api/squareMessage/index.js",
23665     "groupTitle": "Square_Messages"
23666   },
23667   {
23668     "type": "get",
23669     "url": "/api/square/messages/{id}",
23670     "title": "Gets a single Message",
23671     "examples": [
23672       {
23673         "title": "Example usage:",
23674         "content": "curl https://{domain}/api/square/messages/{id} -v -u {name}:{password}",
23675         "type": "json"
23676       }
23677     ],
23678     "name": "ShowMessages",
23679     "group": "Square_Messages",
23680     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23681     "version": "0.0.0",
23682     "filename": "server/api/squareMessage/index.js",
23683     "groupTitle": "Square_Messages"
23684   },
23685   {
23686     "type": "put",
23687     "url": "/api/square/messages/{id}",
23688     "title": "Update an existing Message",
23689     "examples": [
23690       {
23691         "title": "Example usage:",
23692         "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",
23693         "type": "json"
23694       }
23695     ],
23696     "name": "updateMessages",
23697     "group": "Square_Messages",
23698     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23699     "version": "0.0.0",
23700     "filename": "server/api/squareMessage/index.js",
23701     "groupTitle": "Square_Messages"
23702   },
23703   {
23704     "type": "post",
23705     "url": "/api/square/odbc",
23706     "title": "Creates a new ODBC",
23707     "examples": [
23708       {
23709         "title": "Example usage:",
23710         "content": "curl https://{domain}/api/square/odbc -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23711         "type": "json"
23712       }
23713     ],
23714     "name": "CreateODBCs",
23715     "group": "Square_ODBC",
23716     "parameter": {
23717       "fields": {
23718         "Body": [
23719           {
23720             "group": "Body",
23721             "type": "String",
23722             "optional": false,
23723             "field": "name",
23724             "description": ""
23725           },
23726           {
23727             "group": "Body",
23728             "type": "String",
23729             "optional": true,
23730             "field": "dsn",
23731             "description": ""
23732           },
23733           {
23734             "group": "Body",
23735             "type": "String",
23736             "optional": true,
23737             "field": "description",
23738             "description": ""
23739           }
23740         ]
23741       }
23742     },
23743     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23744     "version": "0.0.0",
23745     "filename": "server/api/squareOdbc/index.js",
23746     "groupTitle": "Square_ODBC"
23747   },
23748   {
23749     "type": "delete",
23750     "url": "/api/square/odbc/{id}",
23751     "title": "Deletes a ODBC",
23752     "examples": [
23753       {
23754         "title": "Example usage:",
23755         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password} -X DELETE",
23756         "type": "json"
23757       }
23758     ],
23759     "name": "DeleteODBCs",
23760     "group": "Square_ODBC",
23761     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23762     "version": "0.0.0",
23763     "filename": "server/api/squareOdbc/index.js",
23764     "groupTitle": "Square_ODBC"
23765   },
23766   {
23767     "type": "get",
23768     "url": "/api/square/odbc",
23769     "title": "Gets a list of ODBCs",
23770     "examples": [
23771       {
23772         "title": "Example usage:",
23773         "content": "curl https://{domain}/api/square/odbc -v -u {name}:{password}",
23774         "type": "json"
23775       }
23776     ],
23777     "name": "GetODBCs",
23778     "group": "Square_ODBC",
23779     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23780     "version": "0.0.0",
23781     "filename": "server/api/squareOdbc/index.js",
23782     "groupTitle": "Square_ODBC"
23783   },
23784   {
23785     "type": "get",
23786     "url": "/api/square/odbc/{id}",
23787     "title": "Gets a single ODBC",
23788     "examples": [
23789       {
23790         "title": "Example usage:",
23791         "content": "curl https://{domain}/api/square/odbc/{id} -v -u {name}:{password}",
23792         "type": "json"
23793       }
23794     ],
23795     "name": "ShowODBCs",
23796     "group": "Square_ODBC",
23797     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23798     "version": "0.0.0",
23799     "filename": "server/api/squareOdbc/index.js",
23800     "groupTitle": "Square_ODBC"
23801   },
23802   {
23803     "type": "get",
23804     "url": "/api/square/odbc/{id}/test",
23805     "title": "Test Odbc",
23806     "examples": [
23807       {
23808         "title": "Example usage:",
23809         "content": "curl https://{domain}/api/square/odbc/{id}/test -v -u {name}:{password} -X GET",
23810         "type": "json"
23811       }
23812     ],
23813     "name": "test",
23814     "group": "Square_ODBC",
23815     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23816     "version": "0.0.0",
23817     "filename": "server/api/squareOdbc/index.js",
23818     "groupTitle": "Square_ODBC"
23819   },
23820   {
23821     "type": "put",
23822     "url": "/api/square/odbc/{id}",
23823     "title": "Update an existing ODBC",
23824     "examples": [
23825       {
23826         "title": "Example usage:",
23827         "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",
23828         "type": "json"
23829       }
23830     ],
23831     "name": "updateODBCs",
23832     "group": "Square_ODBC",
23833     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23834     "version": "0.0.0",
23835     "filename": "server/api/squareOdbc/index.js",
23836     "groupTitle": "Square_ODBC"
23837   },
23838   {
23839     "type": "post",
23840     "url": "/api/square/projects",
23841     "title": "Creates a new Project",
23842     "examples": [
23843       {
23844         "title": "Example usage:",
23845         "content": "curl https://{domain}/api/square/projects -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
23846         "type": "json"
23847       }
23848     ],
23849     "name": "CreateProjects",
23850     "group": "Square_Projects",
23851     "parameter": {
23852       "fields": {
23853         "Body": [
23854           {
23855             "group": "Body",
23856             "type": "String",
23857             "optional": false,
23858             "field": "name",
23859             "description": ""
23860           },
23861           {
23862             "group": "Body",
23863             "type": "String",
23864             "optional": true,
23865             "field": "description",
23866             "description": ""
23867           },
23868           {
23869             "group": "Body",
23870             "type": "Text",
23871             "optional": true,
23872             "field": "notes",
23873             "description": ""
23874           },
23875           {
23876             "group": "Body",
23877             "type": "Blob",
23878             "optional": true,
23879             "field": "preproduction",
23880             "description": ""
23881           },
23882           {
23883             "group": "Body",
23884             "type": "Blob",
23885             "optional": true,
23886             "field": "production",
23887             "description": ""
23888           }
23889         ]
23890       }
23891     },
23892     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23893     "version": "0.0.0",
23894     "filename": "server/api/squareProject/index.js",
23895     "groupTitle": "Square_Projects"
23896   },
23897   {
23898     "type": "delete",
23899     "url": "/api/square/projects/{id}",
23900     "title": "Deletes a Project",
23901     "examples": [
23902       {
23903         "title": "Example usage:",
23904         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password} -X DELETE",
23905         "type": "json"
23906       }
23907     ],
23908     "name": "DeleteProjects",
23909     "group": "Square_Projects",
23910     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23911     "version": "0.0.0",
23912     "filename": "server/api/squareProject/index.js",
23913     "groupTitle": "Square_Projects"
23914   },
23915   {
23916     "type": "get",
23917     "url": "/api/square/projects",
23918     "title": "Gets a list of Projects",
23919     "examples": [
23920       {
23921         "title": "Example usage:",
23922         "content": "curl https://{domain}/api/square/projects -v -u {name}:{password}",
23923         "type": "json"
23924       }
23925     ],
23926     "name": "GetProjects",
23927     "group": "Square_Projects",
23928     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
23929     "version": "0.0.0",
23930     "filename": "server/api/squareProject/index.js",
23931     "groupTitle": "Square_Projects"
23932   },
23933   {
23934     "type": "get",
23935     "url": "/api/square/projects/{id}",
23936     "title": "Gets a single Project",
23937     "examples": [
23938       {
23939         "title": "Example usage:",
23940         "content": "curl https://{domain}/api/square/projects/{id} -v -u {name}:{password}",
23941         "type": "json"
23942       }
23943     ],
23944     "name": "ShowProjects",
23945     "group": "Square_Projects",
23946     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23947     "version": "0.0.0",
23948     "filename": "server/api/squareProject/index.js",
23949     "groupTitle": "Square_Projects"
23950   },
23951   {
23952     "type": "post",
23953     "url": "/api/square/projects/{id}/users",
23954     "title": "Adds user permissions to a Project",
23955     "examples": [
23956       {
23957         "title": "Example usage:",
23958         "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",
23959         "type": "json"
23960       }
23961     ],
23962     "name": "addUsers",
23963     "group": "Square_Projects",
23964     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23965     "version": "0.0.0",
23966     "filename": "server/api/squareProject/index.js",
23967     "groupTitle": "Square_Projects"
23968   },
23969   {
23970     "type": "get",
23971     "url": "/api/square/projects/{id}/users",
23972     "title": "Gets users permissions from Project",
23973     "examples": [
23974       {
23975         "title": "Example usage:",
23976         "content": "curl https://{domain}/api/square/projects/{id}/users -v -u {name}:{password} -X GET",
23977         "type": "json"
23978       }
23979     ],
23980     "name": "getUsers",
23981     "group": "Square_Projects",
23982     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
23983     "version": "0.0.0",
23984     "filename": "server/api/squareProject/index.js",
23985     "groupTitle": "Square_Projects"
23986   },
23987   {
23988     "type": "delete",
23989     "url": "/api/square/projects/{id}/users",
23990     "title": "Removes user permissions from a Project",
23991     "examples": [
23992       {
23993         "title": "Example usage:",
23994         "content": "curl https://{domain}/api/square/projects/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
23995         "type": "json"
23996       }
23997     ],
23998     "name": "removeUsers",
23999     "group": "Square_Projects",
24000     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24001     "version": "0.0.0",
24002     "filename": "server/api/squareProject/index.js",
24003     "groupTitle": "Square_Projects"
24004   },
24005   {
24006     "type": "put",
24007     "url": "/api/square/projects/{id}",
24008     "title": "Update an existing Project",
24009     "examples": [
24010       {
24011         "title": "Example usage:",
24012         "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",
24013         "type": "json"
24014       }
24015     ],
24016     "name": "updateProjects",
24017     "group": "Square_Projects",
24018     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24019     "version": "0.0.0",
24020     "filename": "server/api/squareProject/index.js",
24021     "groupTitle": "Square_Projects"
24022   },
24023   {
24024     "type": "post",
24025     "url": "/api/square/recordings",
24026     "title": "Creates a new Recording",
24027     "examples": [
24028       {
24029         "title": "Example usage:",
24030         "content": "curl https://{domain}/api/square/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24031         "type": "json"
24032       }
24033     ],
24034     "name": "CreateRecordings",
24035     "group": "Square_Recordings",
24036     "parameter": {
24037       "fields": {
24038         "Body": [
24039           {
24040             "group": "Body",
24041             "type": "String",
24042             "optional": true,
24043             "field": "uniqueid",
24044             "description": ""
24045           },
24046           {
24047             "group": "Body",
24048             "type": "String",
24049             "optional": true,
24050             "field": "callerid",
24051             "description": ""
24052           },
24053           {
24054             "group": "Body",
24055             "type": "String",
24056             "optional": true,
24057             "field": "calleridname",
24058             "description": ""
24059           },
24060           {
24061             "group": "Body",
24062             "type": "String",
24063             "optional": true,
24064             "field": "context",
24065             "description": ""
24066           },
24067           {
24068             "group": "Body",
24069             "type": "String",
24070             "optional": true,
24071             "field": "extension",
24072             "description": ""
24073           },
24074           {
24075             "group": "Body",
24076             "type": "String",
24077             "optional": true,
24078             "field": "priority",
24079             "description": ""
24080           },
24081           {
24082             "group": "Body",
24083             "type": "String",
24084             "optional": true,
24085             "field": "accountcode",
24086             "description": ""
24087           },
24088           {
24089             "group": "Body",
24090             "type": "String",
24091             "optional": true,
24092             "field": "dnid",
24093             "description": ""
24094           },
24095           {
24096             "group": "Body",
24097             "type": "String",
24098             "optional": true,
24099             "field": "projectName",
24100             "description": ""
24101           },
24102           {
24103             "group": "Body",
24104             "type": "String",
24105             "optional": true,
24106             "field": "saveName",
24107             "description": ""
24108           },
24109           {
24110             "group": "Body",
24111             "type": "String",
24112             "optional": true,
24113             "field": "filename",
24114             "description": ""
24115           },
24116           {
24117             "group": "Body",
24118             "type": "String",
24119             "optional": true,
24120             "field": "savePath",
24121             "description": ""
24122           },
24123           {
24124             "group": "Body",
24125             "type": "Virtual",
24126             "optional": true,
24127             "field": "format",
24128             "description": ""
24129           }
24130         ]
24131       }
24132     },
24133     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24134     "version": "0.0.0",
24135     "filename": "server/api/squareRecording/index.js",
24136     "groupTitle": "Square_Recordings"
24137   },
24138   {
24139     "type": "get",
24140     "url": "/api/square/recordings",
24141     "title": "Gets a list of Recordings",
24142     "examples": [
24143       {
24144         "title": "Example usage:",
24145         "content": "curl https://{domain}/api/square/recordings -v -u {name}:{password}",
24146         "type": "json"
24147       }
24148     ],
24149     "name": "GetRecordings",
24150     "group": "Square_Recordings",
24151     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24152     "version": "0.0.0",
24153     "filename": "server/api/squareRecording/index.js",
24154     "groupTitle": "Square_Recordings"
24155   },
24156   {
24157     "type": "get",
24158     "url": "/api/square/recordings/{id}",
24159     "title": "Gets a single Recording",
24160     "examples": [
24161       {
24162         "title": "Example usage:",
24163         "content": "curl https://{domain}/api/square/recordings/{id} -v -u {name}:{password}",
24164         "type": "json"
24165       }
24166     ],
24167     "name": "ShowRecordings",
24168     "group": "Square_Recordings",
24169     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24170     "version": "0.0.0",
24171     "filename": "server/api/squareRecording/index.js",
24172     "groupTitle": "Square_Recordings"
24173   },
24174   {
24175     "type": "delete",
24176     "url": "/api/square/recordings/{id}/delete",
24177     "title": "Delete recording",
24178     "examples": [
24179       {
24180         "title": "Example usage:",
24181         "content": "curl https://{domain}/api/square/recordings/{id}/delete -v -u {name}:{password} -X DELETE",
24182         "type": "json"
24183       }
24184     ],
24185     "name": "destroy",
24186     "group": "Square_Recordings",
24187     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24188     "version": "0.0.0",
24189     "filename": "server/api/squareRecording/index.js",
24190     "groupTitle": "Square_Recordings"
24191   },
24192   {
24193     "type": "get",
24194     "url": "/api/square/recordings/{id}/download",
24195     "title": "Download Recording",
24196     "examples": [
24197       {
24198         "title": "Example usage:",
24199         "content": "curl https://{domain}/api/square/recordings/{id}/download -v -u {name}:{password} -X GET",
24200         "type": "json"
24201       }
24202     ],
24203     "name": "download",
24204     "group": "Square_Recordings",
24205     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24206     "version": "0.0.0",
24207     "filename": "server/api/squareRecording/index.js",
24208     "groupTitle": "Square_Recordings"
24209   },
24210   {
24211     "type": "put",
24212     "url": "/api/square/recordings/{id}",
24213     "title": "Update an existing Recording",
24214     "examples": [
24215       {
24216         "title": "Example usage:",
24217         "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",
24218         "type": "json"
24219       }
24220     ],
24221     "name": "updateRecordings",
24222     "group": "Square_Recordings",
24223     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24224     "version": "0.0.0",
24225     "filename": "server/api/squareRecording/index.js",
24226     "groupTitle": "Square_Recordings"
24227   },
24228   {
24229     "type": "post",
24230     "url": "/api/square/reports",
24231     "title": "Creates a new Square Report",
24232     "examples": [
24233       {
24234         "title": "Example usage:",
24235         "content": "curl https://{domain}/api/square/reports -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
24236         "type": "json"
24237       }
24238     ],
24239     "name": "CreateSquare_Reports",
24240     "group": "Square_Reports",
24241     "parameter": {
24242       "fields": {
24243         "Body": [
24244           {
24245             "group": "Body",
24246             "type": "String",
24247             "optional": true,
24248             "field": "network",
24249             "description": ""
24250           },
24251           {
24252             "group": "Body",
24253             "type": "String",
24254             "optional": true,
24255             "field": "network_script",
24256             "description": ""
24257           },
24258           {
24259             "group": "Body",
24260             "type": "String",
24261             "optional": true,
24262             "field": "request",
24263             "description": ""
24264           },
24265           {
24266             "group": "Body",
24267             "type": "String",
24268             "optional": true,
24269             "field": "channel",
24270             "description": ""
24271           },
24272           {
24273             "group": "Body",
24274             "type": "String",
24275             "optional": true,
24276             "field": "language",
24277             "description": ""
24278           },
24279           {
24280             "group": "Body",
24281             "type": "String",
24282             "optional": true,
24283             "field": "type",
24284             "description": ""
24285           },
24286           {
24287             "group": "Body",
24288             "type": "String",
24289             "optional": true,
24290             "field": "uniqueid",
24291             "description": ""
24292           },
24293           {
24294             "group": "Body",
24295             "type": "String",
24296             "optional": true,
24297             "field": "version",
24298             "description": ""
24299           },
24300           {
24301             "group": "Body",
24302             "type": "String",
24303             "optional": true,
24304             "field": "callerid",
24305             "description": ""
24306           },
24307           {
24308             "group": "Body",
24309             "type": "String",
24310             "optional": true,
24311             "field": "calleridname",
24312             "description": ""
24313           },
24314           {
24315             "group": "Body",
24316             "type": "String",
24317             "optional": true,
24318             "field": "callingpres",
24319             "description": ""
24320           },
24321           {
24322             "group": "Body",
24323             "type": "String",
24324             "optional": true,
24325             "field": "callingani2",
24326             "description": ""
24327           },
24328           {
24329             "group": "Body",
24330             "type": "String",
24331             "optional": true,
24332             "field": "callington",
24333             "description": ""
24334           },
24335           {
24336             "group": "Body",
24337             "type": "String",
24338             "optional": true,
24339             "field": "callingtns",
24340             "description": ""
24341           },
24342           {
24343             "group": "Body",
24344             "type": "String",
24345             "optional": true,
24346             "field": "dnid",
24347             "description": ""
24348           },
24349           {
24350             "group": "Body",
24351             "type": "String",
24352             "optional": true,
24353             "field": "rdnis",
24354             "description": ""
24355           },
24356           {
24357             "group": "Body",
24358             "type": "String",
24359             "optional": true,
24360             "field": "context",
24361             "description": ""
24362           },
24363           {
24364             "group": "Body",
24365             "type": "String",
24366             "optional": true,
24367             "field": "extension",
24368             "description": ""
24369           },
24370           {
24371             "group": "Body",
24372             "type": "String",
24373             "optional": true,
24374             "field": "priority",
24375             "description": ""
24376           },
24377           {
24378             "group": "Body",
24379             "type": "String",
24380             "optional": true,
24381             "field": "enhanced",
24382             "description": ""
24383           },
24384           {
24385             "group": "Body",
24386             "type": "String",
24387             "optional": true,
24388             "field": "accountcode",
24389             "description": ""
24390           },
24391           {
24392             "group": "Body",
24393             "type": "String",
24394             "optional": true,
24395             "field": "threadid",
24396             "description": ""
24397           },
24398           {
24399             "group": "Body",
24400             "type": "String",
24401             "optional": true,
24402             "field": "project_name",
24403             "description": ""
24404           },
24405           {
24406             "group": "Body",
24407             "type": "String",
24408             "optional": true,
24409             "field": "joinAt",
24410             "description": ""
24411           },
24412           {
24413             "group": "Body",
24414             "type": "String",
24415             "optional": true,
24416             "field": "leaveAt",
24417             "description": ""
24418           },
24419           {
24420             "group": "Body",
24421             "type": "Boolean",
24422             "optional": true,
24423             "field": "bot",
24424             "description": ""
24425           }
24426         ]
24427       }
24428     },
24429     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24430     "version": "0.0.0",
24431     "filename": "server/api/squareReport/index.js",
24432     "groupTitle": "Square_Reports"
24433   },
24434   {
24435     "type": "delete",
24436     "url": "/api/square/reports/{id}",
24437     "title": "Deletes a Square Report",
24438     "examples": [
24439       {
24440         "title": "Example usage:",
24441         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password} -X DELETE",
24442         "type": "json"
24443       }
24444     ],
24445     "name": "DeleteSquare_Reports",
24446     "group": "Square_Reports",
24447     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24448     "version": "0.0.0",
24449     "filename": "server/api/squareReport/index.js",
24450     "groupTitle": "Square_Reports"
24451   },
24452   {
24453     "type": "get",
24454     "url": "/api/square/reports/describe",
24455     "title": "Gets table info about Square Reports",
24456     "examples": [
24457       {
24458         "title": "Example usage:",
24459         "content": "curl https://{domain}/api/square/reports/describe -v -u {name}:{password}",
24460         "type": "json"
24461       }
24462     ],
24463     "name": "DescribeSquare_Reports",
24464     "group": "Square_Reports",
24465     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24466     "version": "0.0.0",
24467     "filename": "server/api/squareReport/index.js",
24468     "groupTitle": "Square_Reports"
24469   },
24470   {
24471     "type": "get",
24472     "url": "/api/square/reports",
24473     "title": "Gets a list of Square Reports",
24474     "examples": [
24475       {
24476         "title": "Example usage:",
24477         "content": "curl https://{domain}/api/square/reports -v -u {name}:{password}",
24478         "type": "json"
24479       }
24480     ],
24481     "name": "GetSquare_Reports",
24482     "group": "Square_Reports",
24483     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24484     "version": "0.0.0",
24485     "filename": "server/api/squareReport/index.js",
24486     "groupTitle": "Square_Reports"
24487   },
24488   {
24489     "type": "get",
24490     "url": "/api/square/reports/{id}",
24491     "title": "Gets a single Square Report",
24492     "examples": [
24493       {
24494         "title": "Example usage:",
24495         "content": "curl https://{domain}/api/square/reports/{id} -v -u {name}:{password}",
24496         "type": "json"
24497       }
24498     ],
24499     "name": "ShowSquare_Reports",
24500     "group": "Square_Reports",
24501     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24502     "version": "0.0.0",
24503     "filename": "server/api/squareReport/index.js",
24504     "groupTitle": "Square_Reports"
24505   },
24506   {
24507     "type": "put",
24508     "url": "/api/square/reports/{id}",
24509     "title": "Update an existing Square Report",
24510     "examples": [
24511       {
24512         "title": "Example usage:",
24513         "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",
24514         "type": "json"
24515       }
24516     ],
24517     "name": "updateSquare_Reports",
24518     "group": "Square_Reports",
24519     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24520     "version": "0.0.0",
24521     "filename": "server/api/squareReport/index.js",
24522     "groupTitle": "Square_Reports"
24523   },
24524   {
24525     "type": "post",
24526     "url": "/api/integrations/sugarcrm/configurations",
24527     "title": "Creates a new SugarCRM Configuration",
24528     "examples": [
24529       {
24530         "title": "Example usage:",
24531         "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",
24532         "type": "json"
24533       }
24534     ],
24535     "name": "CreateSugarCRM_Configurations",
24536     "group": "SugarCRM_Configurations",
24537     "parameter": {
24538       "fields": {
24539         "Body": [
24540           {
24541             "group": "Body",
24542             "type": "String",
24543             "optional": true,
24544             "field": "name",
24545             "description": ""
24546           },
24547           {
24548             "group": "Body",
24549             "type": "String",
24550             "optional": true,
24551             "field": "description",
24552             "description": ""
24553           }
24554         ]
24555       }
24556     },
24557     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24558     "version": "0.0.0",
24559     "filename": "server/api/intSugarcrmConfiguration/index.js",
24560     "groupTitle": "SugarCRM_Configurations"
24561   },
24562   {
24563     "type": "delete",
24564     "url": "/api/integrations/sugarcrm/configurations/{id}",
24565     "title": "Deletes a SugarCRM Configuration",
24566     "examples": [
24567       {
24568         "title": "Example usage:",
24569         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password} -X DELETE",
24570         "type": "json"
24571       }
24572     ],
24573     "name": "DeleteSugarCRM_Configurations",
24574     "group": "SugarCRM_Configurations",
24575     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24576     "version": "0.0.0",
24577     "filename": "server/api/intSugarcrmConfiguration/index.js",
24578     "groupTitle": "SugarCRM_Configurations"
24579   },
24580   {
24581     "type": "get",
24582     "url": "/api/integrations/sugarcrm/configurations",
24583     "title": "Gets a list of SugarCRM Configurations",
24584     "examples": [
24585       {
24586         "title": "Example usage:",
24587         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations -v -u {name}:{password}",
24588         "type": "json"
24589       }
24590     ],
24591     "name": "GetSugarCRM_Configurations",
24592     "group": "SugarCRM_Configurations",
24593     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24594     "version": "0.0.0",
24595     "filename": "server/api/intSugarcrmConfiguration/index.js",
24596     "groupTitle": "SugarCRM_Configurations"
24597   },
24598   {
24599     "type": "get",
24600     "url": "/api/integrations/sugarcrm/configurations/{id}",
24601     "title": "Gets a single SugarCRM Configuration",
24602     "examples": [
24603       {
24604         "title": "Example usage:",
24605         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id} -v -u {name}:{password}",
24606         "type": "json"
24607       }
24608     ],
24609     "name": "ShowSugarCRM_Configurations",
24610     "group": "SugarCRM_Configurations",
24611     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24612     "version": "0.0.0",
24613     "filename": "server/api/intSugarcrmConfiguration/index.js",
24614     "groupTitle": "SugarCRM_Configurations"
24615   },
24616   {
24617     "type": "put",
24618     "url": "/api/integrations/sugarcrm/configurations/{id}",
24619     "title": "Update an existing SugarCRM Configuration",
24620     "examples": [
24621       {
24622         "title": "Example usage:",
24623         "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",
24624         "type": "json"
24625       }
24626     ],
24627     "name": "updateSugarCRM_Configurations",
24628     "group": "SugarCRM_Configurations",
24629     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24630     "version": "0.0.0",
24631     "filename": "server/api/intSugarcrmConfiguration/index.js",
24632     "groupTitle": "SugarCRM_Configurations"
24633   },
24634   {
24635     "type": "post",
24636     "url": "/api/integrations/sugarcrm/accounts",
24637     "title": "Creates a new Sugarcrm Account",
24638     "examples": [
24639       {
24640         "title": "Example usage:",
24641         "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",
24642         "type": "json"
24643       }
24644     ],
24645     "name": "CreateSugarcrm_Accounts",
24646     "group": "Sugarcrm_Accounts",
24647     "parameter": {
24648       "fields": {
24649         "Body": [
24650           {
24651             "group": "Body",
24652             "type": "String",
24653             "optional": true,
24654             "field": "name",
24655             "description": ""
24656           },
24657           {
24658             "group": "Body",
24659             "type": "String",
24660             "optional": true,
24661             "field": "description",
24662             "description": ""
24663           },
24664           {
24665             "group": "Body",
24666             "type": "String",
24667             "optional": true,
24668             "field": "username",
24669             "description": ""
24670           },
24671           {
24672             "group": "Body",
24673             "type": "String",
24674             "optional": true,
24675             "field": "password",
24676             "description": ""
24677           },
24678           {
24679             "group": "Body",
24680             "type": "String",
24681             "optional": true,
24682             "field": "remoteUri",
24683             "description": ""
24684           },
24685           {
24686             "group": "Body",
24687             "type": "String",
24688             "optional": true,
24689             "field": "serverUrl",
24690             "description": ""
24691           }
24692         ]
24693       }
24694     },
24695     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24696     "version": "0.0.0",
24697     "filename": "server/api/intSugarcrmAccount/index.js",
24698     "groupTitle": "Sugarcrm_Accounts"
24699   },
24700   {
24701     "type": "delete",
24702     "url": "/api/integrations/sugarcrm/accounts/{id}",
24703     "title": "Deletes a Sugarcrm Account",
24704     "examples": [
24705       {
24706         "title": "Example usage:",
24707         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password} -X DELETE",
24708         "type": "json"
24709       }
24710     ],
24711     "name": "DeleteSugarcrm_Accounts",
24712     "group": "Sugarcrm_Accounts",
24713     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24714     "version": "0.0.0",
24715     "filename": "server/api/intSugarcrmAccount/index.js",
24716     "groupTitle": "Sugarcrm_Accounts"
24717   },
24718   {
24719     "type": "get",
24720     "url": "/api/integrations/sugarcrm/accounts",
24721     "title": "Gets a list of Sugarcrm Accounts",
24722     "examples": [
24723       {
24724         "title": "Example usage:",
24725         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts -v -u {name}:{password}",
24726         "type": "json"
24727       }
24728     ],
24729     "name": "GetSugarcrm_Accounts",
24730     "group": "Sugarcrm_Accounts",
24731     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
24732     "version": "0.0.0",
24733     "filename": "server/api/intSugarcrmAccount/index.js",
24734     "groupTitle": "Sugarcrm_Accounts"
24735   },
24736   {
24737     "type": "get",
24738     "url": "/api/integrations/sugarcrm/accounts/{id}",
24739     "title": "Gets a single Sugarcrm Account",
24740     "examples": [
24741       {
24742         "title": "Example usage:",
24743         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id} -v -u {name}:{password}",
24744         "type": "json"
24745       }
24746     ],
24747     "name": "ShowSugarcrm_Accounts",
24748     "group": "Sugarcrm_Accounts",
24749     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24750     "version": "0.0.0",
24751     "filename": "server/api/intSugarcrmAccount/index.js",
24752     "groupTitle": "Sugarcrm_Accounts"
24753   },
24754   {
24755     "type": "post",
24756     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
24757     "title": "Creates new configuration",
24758     "examples": [
24759       {
24760         "title": "Example usage:",
24761         "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",
24762         "type": "json"
24763       }
24764     ],
24765     "name": "addConfiguration",
24766     "group": "Sugarcrm_Accounts",
24767     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24768     "version": "0.0.0",
24769     "filename": "server/api/intSugarcrmAccount/index.js",
24770     "groupTitle": "Sugarcrm_Accounts"
24771   },
24772   {
24773     "type": "get",
24774     "url": "/api/integrations/sugarcrm/accounts/{id}/configurations",
24775     "title": "Gets account configurations",
24776     "examples": [
24777       {
24778         "title": "Example usage:",
24779         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/configurations -v -u {name}:{password} -X GET",
24780         "type": "json"
24781       }
24782     ],
24783     "name": "getConfigurations",
24784     "group": "Sugarcrm_Accounts",
24785     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24786     "version": "0.0.0",
24787     "filename": "server/api/intSugarcrmAccount/index.js",
24788     "groupTitle": "Sugarcrm_Accounts"
24789   },
24790   {
24791     "type": "get",
24792     "url": "/api/integrations/sugarcrm/accounts/{id}/fields",
24793     "title": "Gets account fields",
24794     "examples": [
24795       {
24796         "title": "Example usage:",
24797         "content": "curl https://{domain}/api/integrations/sugarcrm/accounts/{id}/fields -v -u {name}:{password} -X GET",
24798         "type": "json"
24799       }
24800     ],
24801     "name": "getFields",
24802     "group": "Sugarcrm_Accounts",
24803     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24804     "version": "0.0.0",
24805     "filename": "server/api/intSugarcrmAccount/index.js",
24806     "groupTitle": "Sugarcrm_Accounts"
24807   },
24808   {
24809     "type": "put",
24810     "url": "/api/integrations/sugarcrm/accounts/{id}",
24811     "title": "Update an existing Sugarcrm Account",
24812     "examples": [
24813       {
24814         "title": "Example usage:",
24815         "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",
24816         "type": "json"
24817       }
24818     ],
24819     "name": "updateSugarcrm_Accounts",
24820     "group": "Sugarcrm_Accounts",
24821     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24822     "version": "0.0.0",
24823     "filename": "server/api/intSugarcrmAccount/index.js",
24824     "groupTitle": "Sugarcrm_Accounts"
24825   },
24826   {
24827     "type": "get",
24828     "url": "/api/integrations/sugarcrm/configurations/{id}/descriptions",
24829     "title": "Gets configurations descriptions",
24830     "examples": [
24831       {
24832         "title": "Example usage:",
24833         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
24834         "type": "json"
24835       }
24836     ],
24837     "name": "getDescriptions",
24838     "group": "Sugarcrm_Configurations",
24839     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24840     "version": "0.0.0",
24841     "filename": "server/api/intSugarcrmConfiguration/index.js",
24842     "groupTitle": "Sugarcrm_Configurations"
24843   },
24844   {
24845     "type": "get",
24846     "url": "/api/integrations/sugarcrm/configurations/{id}/fields",
24847     "title": "Gets configurations fields",
24848     "examples": [
24849       {
24850         "title": "Example usage:",
24851         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/fields -v -u {name}:{password} -X GET",
24852         "type": "json"
24853       }
24854     ],
24855     "name": "getFields",
24856     "group": "Sugarcrm_Configurations",
24857     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24858     "version": "0.0.0",
24859     "filename": "server/api/intSugarcrmConfiguration/index.js",
24860     "groupTitle": "Sugarcrm_Configurations"
24861   },
24862   {
24863     "type": "get",
24864     "url": "/api/integrations/sugarcrm/configurations/{id}/subjects",
24865     "title": "Gets configurations subjects",
24866     "examples": [
24867       {
24868         "title": "Example usage:",
24869         "content": "curl https://{domain}/api/integrations/sugarcrm/configurations/{id}/subjects -v -u {name}:{password} -X GET",
24870         "type": "json"
24871       }
24872     ],
24873     "name": "getSubjects",
24874     "group": "Sugarcrm_Configurations",
24875     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24876     "version": "0.0.0",
24877     "filename": "server/api/intSugarcrmConfiguration/index.js",
24878     "groupTitle": "Sugarcrm_Configurations"
24879   },
24880   {
24881     "type": "post",
24882     "url": "/api/integrations/sugarcrm/fields",
24883     "title": "Creates a new Sugarcrm Field",
24884     "examples": [
24885       {
24886         "title": "Example usage:",
24887         "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",
24888         "type": "json"
24889       }
24890     ],
24891     "name": "CreateSugarcrm_Fields",
24892     "group": "Sugarcrm_Fields",
24893     "parameter": {
24894       "fields": {
24895         "Body": [
24896           {
24897             "group": "Body",
24898             "type": "String",
24899             "allowedValues": [
24900               "\"string\"",
24901               "\"variable\"",
24902               "\"customVariable\"",
24903               "\"keyValue\""
24904             ],
24905             "optional": true,
24906             "field": "type",
24907             "description": ""
24908           },
24909           {
24910             "group": "Body",
24911             "type": "String",
24912             "optional": true,
24913             "field": "content",
24914             "description": ""
24915           },
24916           {
24917             "group": "Body",
24918             "type": "String",
24919             "optional": true,
24920             "field": "key",
24921             "description": ""
24922           },
24923           {
24924             "group": "Body",
24925             "type": "String",
24926             "allowedValues": [
24927               "\"string\"",
24928               "\"variable\"",
24929               "\"customVariable\""
24930             ],
24931             "optional": true,
24932             "field": "keyType",
24933             "description": ""
24934           },
24935           {
24936             "group": "Body",
24937             "type": "String",
24938             "optional": true,
24939             "field": "keyContent",
24940             "description": ""
24941           },
24942           {
24943             "group": "Body",
24944             "type": "String",
24945             "optional": true,
24946             "field": "idField",
24947             "description": ""
24948           },
24949           {
24950             "group": "Body",
24951             "type": "String",
24952             "optional": true,
24953             "field": "nameField",
24954             "description": ""
24955           },
24956           {
24957             "group": "Body",
24958             "type": "Boolean",
24959             "optional": true,
24960             "field": "customField",
24961             "description": ""
24962           },
24963           {
24964             "group": "Body",
24965             "type": "String",
24966             "optional": true,
24967             "field": "variableName",
24968             "description": ""
24969           }
24970         ]
24971       }
24972     },
24973     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24974     "version": "0.0.0",
24975     "filename": "server/api/intSugarcrmField/index.js",
24976     "groupTitle": "Sugarcrm_Fields"
24977   },
24978   {
24979     "type": "delete",
24980     "url": "/api/integrations/sugarcrm/fields/{id}",
24981     "title": "Deletes a Sugarcrm Field",
24982     "examples": [
24983       {
24984         "title": "Example usage:",
24985         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password} -X DELETE",
24986         "type": "json"
24987       }
24988     ],
24989     "name": "DeleteSugarcrm_Fields",
24990     "group": "Sugarcrm_Fields",
24991     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
24992     "version": "0.0.0",
24993     "filename": "server/api/intSugarcrmField/index.js",
24994     "groupTitle": "Sugarcrm_Fields"
24995   },
24996   {
24997     "type": "get",
24998     "url": "/api/integrations/sugarcrm/fields",
24999     "title": "Gets a list of Sugarcrm Fields",
25000     "examples": [
25001       {
25002         "title": "Example usage:",
25003         "content": "curl https://{domain}/api/integrations/sugarcrm/fields -v -u {name}:{password}",
25004         "type": "json"
25005       }
25006     ],
25007     "name": "GetSugarcrm_Fields",
25008     "group": "Sugarcrm_Fields",
25009     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25010     "version": "0.0.0",
25011     "filename": "server/api/intSugarcrmField/index.js",
25012     "groupTitle": "Sugarcrm_Fields"
25013   },
25014   {
25015     "type": "get",
25016     "url": "/api/integrations/sugarcrm/fields/{id}",
25017     "title": "Gets a single Sugarcrm Field",
25018     "examples": [
25019       {
25020         "title": "Example usage:",
25021         "content": "curl https://{domain}/api/integrations/sugarcrm/fields/{id} -v -u {name}:{password}",
25022         "type": "json"
25023       }
25024     ],
25025     "name": "ShowSugarcrm_Fields",
25026     "group": "Sugarcrm_Fields",
25027     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25028     "version": "0.0.0",
25029     "filename": "server/api/intSugarcrmField/index.js",
25030     "groupTitle": "Sugarcrm_Fields"
25031   },
25032   {
25033     "type": "put",
25034     "url": "/api/integrations/sugarcrm/fields/{id}",
25035     "title": "Update an existing Sugarcrm Field",
25036     "examples": [
25037       {
25038         "title": "Example usage:",
25039         "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",
25040         "type": "json"
25041       }
25042     ],
25043     "name": "updateSugarcrm_Fields",
25044     "group": "Sugarcrm_Fields",
25045     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25046     "version": "0.0.0",
25047     "filename": "server/api/intSugarcrmField/index.js",
25048     "groupTitle": "Sugarcrm_Fields"
25049   },
25050   {
25051     "type": "get",
25052     "url": "/api/system",
25053     "title": "Gets system information",
25054     "examples": [
25055       {
25056         "title": "Example usage:",
25057         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25058         "type": "json"
25059       }
25060     ],
25061     "name": "GetSystemInformation",
25062     "group": "System_Information",
25063     "description": "<p>Motion returns the system information.</p>",
25064     "version": "0.0.0",
25065     "filename": "server/api/system/index.js",
25066     "groupTitle": "System_Information"
25067   },
25068   {
25069     "type": "get",
25070     "url": "/api/system/process",
25071     "title": "Gets system information",
25072     "examples": [
25073       {
25074         "title": "Example usage:",
25075         "content": "curl https://{domain}/api/system -v -u {name}:{password}",
25076         "type": "json"
25077       }
25078     ],
25079     "name": "GetSystemInformation",
25080     "group": "System_Information",
25081     "description": "<p>Motion returns the system information.</p>",
25082     "version": "0.0.0",
25083     "filename": "server/api/system/index.js",
25084     "groupTitle": "System_Information"
25085   },
25086   {
25087     "type": "post",
25088     "url": "/api/tags",
25089     "title": "Creates a new Tag",
25090     "examples": [
25091       {
25092         "title": "Example usage:",
25093         "content": "curl https://{domain}/api/tags -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25094         "type": "json"
25095       }
25096     ],
25097     "name": "CreateTags",
25098     "group": "Tags",
25099     "parameter": {
25100       "fields": {
25101         "Body": [
25102           {
25103             "group": "Body",
25104             "type": "String",
25105             "optional": false,
25106             "field": "name",
25107             "description": ""
25108           },
25109           {
25110             "group": "Body",
25111             "type": "String",
25112             "optional": true,
25113             "field": "color",
25114             "description": ""
25115           },
25116           {
25117             "group": "Body",
25118             "type": "String",
25119             "optional": true,
25120             "field": "description",
25121             "description": ""
25122           }
25123         ]
25124       }
25125     },
25126     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25127     "version": "0.0.0",
25128     "filename": "server/api/tag/index.js",
25129     "groupTitle": "Tags"
25130   },
25131   {
25132     "type": "delete",
25133     "url": "/api/tags/{id}",
25134     "title": "Deletes a Tag",
25135     "examples": [
25136       {
25137         "title": "Example usage:",
25138         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password} -X DELETE",
25139         "type": "json"
25140       }
25141     ],
25142     "name": "DeleteTags",
25143     "group": "Tags",
25144     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25145     "version": "0.0.0",
25146     "filename": "server/api/tag/index.js",
25147     "groupTitle": "Tags"
25148   },
25149   {
25150     "type": "get",
25151     "url": "/api/tags",
25152     "title": "Gets a list of Tags",
25153     "examples": [
25154       {
25155         "title": "Example usage:",
25156         "content": "curl https://{domain}/api/tags -v -u {name}:{password}",
25157         "type": "json"
25158       }
25159     ],
25160     "name": "GetTags",
25161     "group": "Tags",
25162     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25163     "version": "0.0.0",
25164     "filename": "server/api/tag/index.js",
25165     "groupTitle": "Tags"
25166   },
25167   {
25168     "type": "get",
25169     "url": "/api/tags/{id}",
25170     "title": "Gets a single Tag",
25171     "examples": [
25172       {
25173         "title": "Example usage:",
25174         "content": "curl https://{domain}/api/tags/{id} -v -u {name}:{password}",
25175         "type": "json"
25176       }
25177     ],
25178     "name": "ShowTags",
25179     "group": "Tags",
25180     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25181     "version": "0.0.0",
25182     "filename": "server/api/tag/index.js",
25183     "groupTitle": "Tags"
25184   },
25185   {
25186     "type": "put",
25187     "url": "/api/tags/{id}",
25188     "title": "Update an existing Tag",
25189     "examples": [
25190       {
25191         "title": "Example usage:",
25192         "content": "curl https://{domain}/api/tags/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25193         "type": "json"
25194       }
25195     ],
25196     "name": "updateTags",
25197     "group": "Tags",
25198     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25199     "version": "0.0.0",
25200     "filename": "server/api/tag/index.js",
25201     "groupTitle": "Tags"
25202   },
25203   {
25204     "type": "post",
25205     "url": "/api/teams/{id}/queues",
25206     "title": "Add queues to a team",
25207     "examples": [
25208       {
25209         "title": "Example usage:",
25210         "content": "curl https://{domain}/api/teams/{id}/queues -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25211         "type": "json"
25212       }
25213     ],
25214     "name": "AddQueues",
25215     "group": "Teams",
25216     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25217     "version": "0.0.0",
25218     "filename": "server/api/team/index.js",
25219     "groupTitle": "Teams"
25220   },
25221   {
25222     "type": "post",
25223     "url": "/api/teams",
25224     "title": "Creates a new Team",
25225     "examples": [
25226       {
25227         "title": "Example usage:",
25228         "content": "curl https://{domain}/api/teams -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25229         "type": "json"
25230       }
25231     ],
25232     "name": "CreateTeams",
25233     "group": "Teams",
25234     "parameter": {
25235       "fields": {
25236         "Body": [
25237           {
25238             "group": "Body",
25239             "type": "String",
25240             "optional": false,
25241             "field": "name",
25242             "description": ""
25243           },
25244           {
25245             "group": "Body",
25246             "type": "String",
25247             "optional": true,
25248             "field": "description",
25249             "description": ""
25250           }
25251         ]
25252       }
25253     },
25254     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25255     "version": "0.0.0",
25256     "filename": "server/api/team/index.js",
25257     "groupTitle": "Teams"
25258   },
25259   {
25260     "type": "delete",
25261     "url": "/api/teams/{id}",
25262     "title": "Deletes a Team",
25263     "examples": [
25264       {
25265         "title": "Example usage:",
25266         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password} -X DELETE",
25267         "type": "json"
25268       }
25269     ],
25270     "name": "DeleteTeams",
25271     "group": "Teams",
25272     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25273     "version": "0.0.0",
25274     "filename": "server/api/team/index.js",
25275     "groupTitle": "Teams"
25276   },
25277   {
25278     "type": "get",
25279     "url": "/api/teams/{id}/users",
25280     "title": "Gets agents from team",
25281     "examples": [
25282       {
25283         "title": "Example usage:",
25284         "content": "curl https://{domain}/api/teams/{id}/users -v -u {name}:{password} -X GET",
25285         "type": "json"
25286       }
25287     ],
25288     "name": "GetAgents",
25289     "group": "Teams",
25290     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25291     "version": "0.0.0",
25292     "filename": "server/api/team/index.js",
25293     "groupTitle": "Teams"
25294   },
25295   {
25296     "type": "get",
25297     "url": "/api/teams/{id}/queues?channel={channel}",
25298     "title": "Gets Queues list",
25299     "examples": [
25300       {
25301         "title": "Example usage:",
25302         "content": "curl https://{domain}/api/teams/{id}/queues?channel={channel} -v -u {name}:{password}",
25303         "type": "json"
25304       }
25305     ],
25306     "name": "GetQueues",
25307     "group": "Teams",
25308     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <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/team/index.js",
25311     "groupTitle": "Teams"
25312   },
25313   {
25314     "type": "get",
25315     "url": "/api/teams",
25316     "title": "Gets a list of Teams",
25317     "examples": [
25318       {
25319         "title": "Example usage:",
25320         "content": "curl https://{domain}/api/teams -v -u {name}:{password}",
25321         "type": "json"
25322       }
25323     ],
25324     "name": "GetTeams",
25325     "group": "Teams",
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/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>",
25327     "version": "0.0.0",
25328     "filename": "server/api/team/index.js",
25329     "groupTitle": "Teams"
25330   },
25331   {
25332     "type": "delete",
25333     "url": "/api/teams/{id}/users",
25334     "title": "Removes agents from a team",
25335     "examples": [
25336       {
25337         "title": "Example usage:",
25338         "content": "curl https://{domain}/api/teams/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25339         "type": "json"
25340       }
25341     ],
25342     "name": "RemoveAgents",
25343     "group": "Teams",
25344     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/team/index.js",
25347     "groupTitle": "Teams"
25348   },
25349   {
25350     "type": "delete",
25351     "url": "/api/teams/{id}/queues",
25352     "title": "Remove queues to a team",
25353     "examples": [
25354       {
25355         "title": "Example usage:",
25356         "content": "curl https://{domain}/api/teams/{id}/queues?channel=voice&ids=1&ids=2 -v -u {name}:{password} -X DELETE",
25357         "type": "json"
25358       }
25359     ],
25360     "name": "RemoveQueues",
25361     "group": "Teams",
25362     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25363     "version": "0.0.0",
25364     "filename": "server/api/team/index.js",
25365     "groupTitle": "Teams"
25366   },
25367   {
25368     "type": "delete",
25369     "url": "/api/fax/queues/{id}/teams",
25370     "title": "Remove teams from a queue",
25371     "examples": [
25372       {
25373         "title": "Example usage:",
25374         "content": "curl https://{domain}/api/fax/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25375         "type": "json"
25376       }
25377     ],
25378     "name": "RemoveTeams",
25379     "group": "Teams",
25380     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/faxQueue/index.js",
25383     "groupTitle": "Teams"
25384   },
25385   {
25386     "type": "delete",
25387     "url": "/api/mail/queues/{id}/teams",
25388     "title": "Remove teams from a queue",
25389     "examples": [
25390       {
25391         "title": "Example usage:",
25392         "content": "curl https://{domain}/api/mail/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25393         "type": "json"
25394       }
25395     ],
25396     "name": "RemoveTeams",
25397     "group": "Teams",
25398     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/mailQueue/index.js",
25401     "groupTitle": "Teams"
25402   },
25403   {
25404     "type": "delete",
25405     "url": "/api/voice/queues/{id}/teams",
25406     "title": "Remove teams from a queue",
25407     "examples": [
25408       {
25409         "title": "Example usage:",
25410         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25411         "type": "json"
25412       }
25413     ],
25414     "name": "RemoveTeams",
25415     "group": "Teams",
25416     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/voiceQueue/index.js",
25419     "groupTitle": "Teams"
25420   },
25421   {
25422     "type": "delete",
25423     "url": "/api/chat/queues/{id}/teams",
25424     "title": "Remove teams from a queue",
25425     "examples": [
25426       {
25427         "title": "Example usage:",
25428         "content": "curl https://{domain}/api/chat/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25429         "type": "json"
25430       }
25431     ],
25432     "name": "RemoveTeams",
25433     "group": "Teams",
25434     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/chatQueue/index.js",
25437     "groupTitle": "Teams"
25438   },
25439   {
25440     "type": "delete",
25441     "url": "/api/sms/queues/{id}/teams",
25442     "title": "Remove teams from a queue",
25443     "examples": [
25444       {
25445         "title": "Example usage:",
25446         "content": "curl https://{domain}/api/sms/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25447         "type": "json"
25448       }
25449     ],
25450     "name": "RemoveTeams",
25451     "group": "Teams",
25452     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/smsQueue/index.js",
25455     "groupTitle": "Teams"
25456   },
25457   {
25458     "type": "delete",
25459     "url": "/api/openchannel/queues/{id}/teams",
25460     "title": "Remove teams from a queue",
25461     "examples": [
25462       {
25463         "title": "Example usage:",
25464         "content": "curl https://{domain}/api/openchannel/queues/{id}/teams -v -u {name}:{password} -X DELETE",
25465         "type": "json"
25466       }
25467     ],
25468     "name": "RemoveTeams",
25469     "group": "Teams",
25470     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/openchannelQueue/index.js",
25473     "groupTitle": "Teams"
25474   },
25475   {
25476     "type": "get",
25477     "url": "/api/teams/{id}",
25478     "title": "Gets a single Team",
25479     "examples": [
25480       {
25481         "title": "Example usage:",
25482         "content": "curl https://{domain}/api/teams/{id} -v -u {name}:{password}",
25483         "type": "json"
25484       }
25485     ],
25486     "name": "ShowTeams",
25487     "group": "Teams",
25488     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25489     "version": "0.0.0",
25490     "filename": "server/api/team/index.js",
25491     "groupTitle": "Teams"
25492   },
25493   {
25494     "type": "post",
25495     "url": "/api/teams/{id}/users",
25496     "title": "Adds agents to a team",
25497     "examples": [
25498       {
25499         "title": "Example usage:",
25500         "content": "curl https://{domain}/api/teams/{id}/users -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25501         "type": "json"
25502       }
25503     ],
25504     "name": "addAgents",
25505     "group": "Teams",
25506     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25507     "version": "0.0.0",
25508     "filename": "server/api/team/index.js",
25509     "groupTitle": "Teams"
25510   },
25511   {
25512     "type": "put",
25513     "url": "/api/teams/{id}",
25514     "title": "Update an existing Team",
25515     "examples": [
25516       {
25517         "title": "Example usage:",
25518         "content": "curl https://{domain}/api/teams/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25519         "type": "json"
25520       }
25521     ],
25522     "name": "updateTeams",
25523     "group": "Teams",
25524     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25525     "version": "0.0.0",
25526     "filename": "server/api/team/index.js",
25527     "groupTitle": "Teams"
25528   },
25529   {
25530     "type": "post",
25531     "url": "/api/templates",
25532     "title": "Creates a new Template",
25533     "examples": [
25534       {
25535         "title": "Example usage:",
25536         "content": "curl https://{domain}/api/templates -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25537         "type": "json"
25538       }
25539     ],
25540     "name": "CreateTemplates",
25541     "group": "Templates",
25542     "parameter": {
25543       "fields": {
25544         "Body": [
25545           {
25546             "group": "Body",
25547             "type": "String",
25548             "optional": true,
25549             "field": "name",
25550             "description": ""
25551           },
25552           {
25553             "group": "Body",
25554             "type": "String",
25555             "optional": true,
25556             "field": "description",
25557             "description": ""
25558           },
25559           {
25560             "group": "Body",
25561             "type": "Text",
25562             "optional": true,
25563             "field": "html",
25564             "description": ""
25565           }
25566         ]
25567       }
25568     },
25569     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25570     "version": "0.0.0",
25571     "filename": "server/api/template/index.js",
25572     "groupTitle": "Templates"
25573   },
25574   {
25575     "type": "delete",
25576     "url": "/api/templates/{id}",
25577     "title": "Deletes a Template",
25578     "examples": [
25579       {
25580         "title": "Example usage:",
25581         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password} -X DELETE",
25582         "type": "json"
25583       }
25584     ],
25585     "name": "DeleteTemplates",
25586     "group": "Templates",
25587     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25588     "version": "0.0.0",
25589     "filename": "server/api/template/index.js",
25590     "groupTitle": "Templates"
25591   },
25592   {
25593     "type": "get",
25594     "url": "/api/templates",
25595     "title": "Gets a list of Templates",
25596     "examples": [
25597       {
25598         "title": "Example usage:",
25599         "content": "curl https://{domain}/api/templates -v -u {name}:{password}",
25600         "type": "json"
25601       }
25602     ],
25603     "name": "GetTemplates",
25604     "group": "Templates",
25605     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25606     "version": "0.0.0",
25607     "filename": "server/api/template/index.js",
25608     "groupTitle": "Templates"
25609   },
25610   {
25611     "type": "get",
25612     "url": "/api/templates/{id}",
25613     "title": "Gets a single Template",
25614     "examples": [
25615       {
25616         "title": "Example usage:",
25617         "content": "curl https://{domain}/api/templates/{id} -v -u {name}:{password}",
25618         "type": "json"
25619       }
25620     ],
25621     "name": "ShowTemplates",
25622     "group": "Templates",
25623     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25624     "version": "0.0.0",
25625     "filename": "server/api/template/index.js",
25626     "groupTitle": "Templates"
25627   },
25628   {
25629     "type": "put",
25630     "url": "/api/templates/{id}",
25631     "title": "Update an existing Template",
25632     "examples": [
25633       {
25634         "title": "Example usage:",
25635         "content": "curl https://{domain}/api/templates/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
25636         "type": "json"
25637       }
25638     ],
25639     "name": "updateTemplates",
25640     "group": "Templates",
25641     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25642     "version": "0.0.0",
25643     "filename": "server/api/template/index.js",
25644     "groupTitle": "Templates"
25645   },
25646   {
25647     "type": "post",
25648     "url": "/api/triggers",
25649     "title": "Creates a new Trigger",
25650     "examples": [
25651       {
25652         "title": "Example usage:",
25653         "content": "curl https://{domain}/api/triggers -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
25654         "type": "json"
25655       }
25656     ],
25657     "name": "CreateTriggers",
25658     "group": "Triggers",
25659     "parameter": {
25660       "fields": {
25661         "Body": [
25662           {
25663             "group": "Body",
25664             "type": "String",
25665             "optional": true,
25666             "field": "name",
25667             "description": ""
25668           },
25669           {
25670             "group": "Body",
25671             "type": "String",
25672             "optional": true,
25673             "field": "channel",
25674             "description": ""
25675           },
25676           {
25677             "group": "Body",
25678             "type": "String",
25679             "optional": true,
25680             "field": "description",
25681             "description": ""
25682           },
25683           {
25684             "group": "Body",
25685             "type": "Boolean",
25686             "optional": true,
25687             "field": "status",
25688             "description": ""
25689           }
25690         ]
25691       }
25692     },
25693     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25694     "version": "0.0.0",
25695     "filename": "server/api/trigger/index.js",
25696     "groupTitle": "Triggers"
25697   },
25698   {
25699     "type": "delete",
25700     "url": "/api/triggers/{id}",
25701     "title": "Deletes a Trigger",
25702     "examples": [
25703       {
25704         "title": "Example usage:",
25705         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password} -X DELETE",
25706         "type": "json"
25707       }
25708     ],
25709     "name": "DeleteTriggers",
25710     "group": "Triggers",
25711     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25712     "version": "0.0.0",
25713     "filename": "server/api/trigger/index.js",
25714     "groupTitle": "Triggers"
25715   },
25716   {
25717     "type": "get",
25718     "url": "/api/triggers",
25719     "title": "Gets a list of Triggers",
25720     "examples": [
25721       {
25722         "title": "Example usage:",
25723         "content": "curl https://{domain}/api/triggers -v -u {name}:{password}",
25724         "type": "json"
25725       }
25726     ],
25727     "name": "GetTriggers",
25728     "group": "Triggers",
25729     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
25730     "version": "0.0.0",
25731     "filename": "server/api/trigger/index.js",
25732     "groupTitle": "Triggers"
25733   },
25734   {
25735     "type": "get",
25736     "url": "/api/triggers/{id}",
25737     "title": "Gets a single Trigger",
25738     "examples": [
25739       {
25740         "title": "Example usage:",
25741         "content": "curl https://{domain}/api/triggers/{id} -v -u {name}:{password}",
25742         "type": "json"
25743       }
25744     ],
25745     "name": "ShowTriggers",
25746     "group": "Triggers",
25747     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25748     "version": "0.0.0",
25749     "filename": "server/api/trigger/index.js",
25750     "groupTitle": "Triggers"
25751   },
25752   {
25753     "type": "post",
25754     "url": "/api/triggers/{id}/actions",
25755     "title": "Creates new actions",
25756     "examples": [
25757       {
25758         "title": "Example usage:",
25759         "content": "curl https://{domain}/api/triggers/{id}/actions -d '{\"action\": \"contactManager\",\"data1\": \"1\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
25760         "type": "json"
25761       }
25762     ],
25763     "name": "addAction",
25764     "group": "Triggers",
25765     "parameter": {
25766       "fields": {
25767         "Body": [
25768           {
25769             "group": "Body",
25770             "type": "Virtual",
25771             "optional": true,
25772             "field": "name",
25773             "description": ""
25774           },
25775           {
25776             "group": "Body",
25777             "type": "String",
25778             "optional": false,
25779             "field": "action",
25780             "description": "<p>Allowed values: contactManager, integration, motionbar, jscripty, urlForward, browser, bot, script</p>"
25781           },
25782           {
25783             "group": "Body",
25784             "type": "String",
25785             "optional": true,
25786             "field": "data1",
25787             "description": "<p>contactManager[ListId], integration[intName(zendesk)], motionbar[Popup(0),URL(1),WinApp(2)], urlForward[GET,POST], browser[TemplateId(0),URL(1)]</p>"
25788           },
25789           {
25790             "group": "Body",
25791             "type": "String",
25792             "optional": true,
25793             "field": "data2",
25794             "description": "<p>integration[AccountId], motionbar[TemplateId,URL,WinAppPath], urlForward[URL]</p>"
25795           },
25796           {
25797             "group": "Body",
25798             "type": "String",
25799             "optional": true,
25800             "field": "data3",
25801             "description": "<p>motionbar[NULL,NULL,WinAppArguments]</p>"
25802           },
25803           {
25804             "group": "Body",
25805             "type": "String",
25806             "optional": true,
25807             "field": "data4",
25808             "description": ""
25809           },
25810           {
25811             "group": "Body",
25812             "type": "String",
25813             "optional": true,
25814             "field": "data5",
25815             "description": ""
25816           },
25817           {
25818             "group": "Body",
25819             "type": "String",
25820             "optional": true,
25821             "field": "data6",
25822             "description": ""
25823           },
25824           {
25825             "group": "Body",
25826             "type": "Text",
25827             "optional": true,
25828             "field": "data7",
25829             "description": ""
25830           }
25831         ]
25832       }
25833     },
25834     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25835     "version": "0.0.0",
25836     "filename": "server/api/trigger/index.js",
25837     "groupTitle": "Triggers"
25838   },
25839   {
25840     "type": "post",
25841     "url": "/api/triggers/{id}/all_conditions",
25842     "title": "Creates a new \"AND\"condition",
25843     "examples": [
25844       {
25845         "title": "Example usage:",
25846         "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",
25847         "type": "json"
25848       }
25849     ],
25850     "name": "addAllCondition",
25851     "group": "Triggers",
25852     "parameter": {
25853       "fields": {
25854         "Body": [
25855           {
25856             "group": "Body",
25857             "type": "Virtual",
25858             "optional": true,
25859             "field": "name",
25860             "description": ""
25861           },
25862           {
25863             "group": "Body",
25864             "type": "String",
25865             "optional": false,
25866             "field": "field",
25867             "description": ""
25868           },
25869           {
25870             "group": "Body",
25871             "type": "String",
25872             "optional": false,
25873             "field": "operator",
25874             "description": ""
25875           },
25876           {
25877             "group": "Body",
25878             "type": "String",
25879             "optional": false,
25880             "field": "value",
25881             "description": ""
25882           }
25883         ]
25884       }
25885     },
25886     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25887     "version": "0.0.0",
25888     "filename": "server/api/trigger/index.js",
25889     "groupTitle": "Triggers"
25890   },
25891   {
25892     "type": "post",
25893     "url": "/api/triggers/{id}/any_conditions",
25894     "title": "Creates a new \"OR\"condition",
25895     "examples": [
25896       {
25897         "title": "Example usage:",
25898         "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",
25899         "type": "json"
25900       }
25901     ],
25902     "name": "addAnyCondition",
25903     "group": "Triggers",
25904     "parameter": {
25905       "fields": {
25906         "Body": [
25907           {
25908             "group": "Body",
25909             "type": "Virtual",
25910             "optional": true,
25911             "field": "name",
25912             "description": ""
25913           },
25914           {
25915             "group": "Body",
25916             "type": "String",
25917             "optional": false,
25918             "field": "field",
25919             "description": ""
25920           },
25921           {
25922             "group": "Body",
25923             "type": "String",
25924             "optional": false,
25925             "field": "operator",
25926             "description": ""
25927           },
25928           {
25929             "group": "Body",
25930             "type": "String",
25931             "optional": false,
25932             "field": "value",
25933             "description": ""
25934           }
25935         ]
25936       }
25937     },
25938     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25939     "version": "0.0.0",
25940     "filename": "server/api/trigger/index.js",
25941     "groupTitle": "Triggers"
25942   },
25943   {
25944     "type": "get",
25945     "url": "/api/triggers/{id}/actions",
25946     "title": "Gets Trigger Actions",
25947     "examples": [
25948       {
25949         "title": "Example usage:",
25950         "content": "curl https://{domain}/api/triggers/{id}/actions -v -u {name}:{password} -X GET",
25951         "type": "json"
25952       }
25953     ],
25954     "name": "getActions",
25955     "group": "Triggers",
25956     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25957     "version": "0.0.0",
25958     "filename": "server/api/trigger/index.js",
25959     "groupTitle": "Triggers"
25960   },
25961   {
25962     "type": "get",
25963     "url": "/api/triggers/{id}/all_conditions",
25964     "title": "Gets \"AND\" Trigger Conditions",
25965     "examples": [
25966       {
25967         "title": "Example usage:",
25968         "content": "curl https://{domain}/api/triggers/{id}/all_conditions -v -u {name}:{password} -X GET",
25969         "type": "json"
25970       }
25971     ],
25972     "name": "getAllConditions",
25973     "group": "Triggers",
25974     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25975     "version": "0.0.0",
25976     "filename": "server/api/trigger/index.js",
25977     "groupTitle": "Triggers"
25978   },
25979   {
25980     "type": "get",
25981     "url": "/api/triggers/{id}/any_conditions",
25982     "title": "Gets \"OR\" Trigger Conditions",
25983     "examples": [
25984       {
25985         "title": "Example usage:",
25986         "content": "curl https://{domain}/api/triggers/{id}/any_conditions -v -u {name}:{password} -X GET",
25987         "type": "json"
25988       }
25989     ],
25990     "name": "getAnyConditions",
25991     "group": "Triggers",
25992     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
25993     "version": "0.0.0",
25994     "filename": "server/api/trigger/index.js",
25995     "groupTitle": "Triggers"
25996   },
25997   {
25998     "type": "put",
25999     "url": "/api/triggers/{id}",
26000     "title": "Update an existing Trigger",
26001     "examples": [
26002       {
26003         "title": "Example usage:",
26004         "content": "curl https://{domain}/api/triggers/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
26005         "type": "json"
26006       }
26007     ],
26008     "name": "updateTriggers",
26009     "group": "Triggers",
26010     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26011     "version": "0.0.0",
26012     "filename": "server/api/trigger/index.js",
26013     "groupTitle": "Triggers"
26014   },
26015   {
26016     "type": "post",
26017     "url": "/api/trunks/clone",
26018     "title": "Clone an existing Trunk",
26019     "examples": [
26020       {
26021         "title": "Example usage:",
26022         "content": "curl https://{domain}/api/trunks/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
26023         "type": "json"
26024       }
26025     ],
26026     "name": "CloneTrunks",
26027     "group": "Trunks",
26028     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26029     "version": "0.0.0",
26030     "filename": "server/api/trunk/index.js",
26031     "groupTitle": "Trunks"
26032   },
26033   {
26034     "type": "post",
26035     "url": "/api/trunks",
26036     "title": "Create a new trunk",
26037     "examples": [
26038       {
26039         "title": "Example usage:",
26040         "content": "curl https://{domain}/api/trunks -v -u {name}:{password} -X POST",
26041         "type": "json"
26042       }
26043     ],
26044     "name": "Create",
26045     "group": "Trunks",
26046     "parameter": {
26047       "fields": {
26048         "Body": [
26049           {
26050             "group": "Body",
26051             "type": "String",
26052             "optional": false,
26053             "field": "name",
26054             "description": ""
26055           },
26056           {
26057             "group": "Body",
26058             "type": "String",
26059             "allowedValues": [
26060               "\"friend\"",
26061               "\"user\"",
26062               "\"peer\""
26063             ],
26064             "optional": false,
26065             "field": "type",
26066             "description": ""
26067           },
26068           {
26069             "group": "Body",
26070             "type": "String",
26071             "optional": false,
26072             "field": "context",
26073             "description": ""
26074           },
26075           {
26076             "group": "Body",
26077             "type": "String",
26078             "allowedValues": [
26079               "\"ALLOWED_NOT_SCREENED\"",
26080               "\"ALLOWED_PASSED_SCREEN\"",
26081               "\"ALLOWED_FAILED_SCREEN\"",
26082               "\"ALLOWED\"",
26083               "\"PROHIB_NOT_SCREENED\"",
26084               "\"PROHIB_PASSED_SCREEN\"",
26085               "\"PROHIB_FAILED_SCREEN\"",
26086               "\"PROHIB\""
26087             ],
26088             "optional": true,
26089             "field": "callingpres",
26090             "description": ""
26091           },
26092           {
26093             "group": "Body",
26094             "type": "String",
26095             "optional": true,
26096             "field": "deny",
26097             "description": ""
26098           },
26099           {
26100             "group": "Body",
26101             "type": "String",
26102             "optional": true,
26103             "field": "permit",
26104             "description": ""
26105           },
26106           {
26107             "group": "Body",
26108             "type": "String",
26109             "optional": true,
26110             "field": "secret",
26111             "description": ""
26112           },
26113           {
26114             "group": "Body",
26115             "type": "String",
26116             "optional": true,
26117             "field": "md5secret",
26118             "description": ""
26119           },
26120           {
26121             "group": "Body",
26122             "type": "String",
26123             "optional": true,
26124             "field": "remotesecret",
26125             "description": ""
26126           },
26127           {
26128             "group": "Body",
26129             "type": "String",
26130             "optional": true,
26131             "field": "transport",
26132             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
26133           },
26134           {
26135             "group": "Body",
26136             "type": "String",
26137             "allowedValues": [
26138               "\"rfc2833\"",
26139               "\"info\"",
26140               "\"shortinfo\"",
26141               "\"inband\"",
26142               "\"auto\""
26143             ],
26144             "optional": true,
26145             "field": "dtmfmode",
26146             "description": ""
26147           },
26148           {
26149             "group": "Body",
26150             "type": "String",
26151             "allowedValues": [
26152               "\"yes\"",
26153               "\"no\"",
26154               "\"nonat\"",
26155               "\"update\"",
26156               "\"outgoing\""
26157             ],
26158             "optional": true,
26159             "field": "directmedia",
26160             "description": ""
26161           },
26162           {
26163             "group": "Body",
26164             "type": "String",
26165             "allowedValues": [
26166               "\"yes\"",
26167               "\"no\""
26168             ],
26169             "optional": true,
26170             "field": "directrtpsetup",
26171             "description": ""
26172           },
26173           {
26174             "group": "Body",
26175             "type": "String",
26176             "optional": true,
26177             "field": "directmediapermit",
26178             "description": ""
26179           },
26180           {
26181             "group": "Body",
26182             "type": "String",
26183             "optional": true,
26184             "field": "directmediadeny",
26185             "description": ""
26186           },
26187           {
26188             "group": "Body",
26189             "type": "String",
26190             "optional": true,
26191             "field": "nat",
26192             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
26193           },
26194           {
26195             "group": "Body",
26196             "type": "String",
26197             "optional": true,
26198             "field": "callgroup",
26199             "description": ""
26200           },
26201           {
26202             "group": "Body",
26203             "type": "String",
26204             "optional": true,
26205             "field": "namedcallgroup",
26206             "description": ""
26207           },
26208           {
26209             "group": "Body",
26210             "type": "String",
26211             "optional": true,
26212             "field": "pickupgroup",
26213             "description": ""
26214           },
26215           {
26216             "group": "Body",
26217             "type": "String",
26218             "optional": true,
26219             "field": "namedpickupgroup",
26220             "description": ""
26221           },
26222           {
26223             "group": "Body",
26224             "type": "String",
26225             "optional": true,
26226             "field": "language",
26227             "description": ""
26228           },
26229           {
26230             "group": "Body",
26231             "type": "String",
26232             "optional": true,
26233             "field": "tonezone",
26234             "description": ""
26235           },
26236           {
26237             "group": "Body",
26238             "type": "String",
26239             "optional": true,
26240             "field": "disallow",
26241             "description": ""
26242           },
26243           {
26244             "group": "Body",
26245             "type": "String",
26246             "optional": false,
26247             "field": "allow",
26248             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;alaw&quot;]</p>"
26249           },
26250           {
26251             "group": "Body",
26252             "type": "String",
26253             "allowedValues": [
26254               "\"yes\"",
26255               "\"no\""
26256             ],
26257             "optional": true,
26258             "field": "autoframing",
26259             "description": ""
26260           },
26261           {
26262             "group": "Body",
26263             "type": "String",
26264             "optional": true,
26265             "field": "insecure",
26266             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
26267           },
26268           {
26269             "group": "Body",
26270             "type": "String",
26271             "allowedValues": [
26272               "\"yes\"",
26273               "\"no\""
26274             ],
26275             "optional": true,
26276             "field": "trustrpid",
26277             "description": ""
26278           },
26279           {
26280             "group": "Body",
26281             "type": "String",
26282             "allowedValues": [
26283               "\"yes\"",
26284               "\"no\""
26285             ],
26286             "optional": true,
26287             "field": "trust_id_outbound",
26288             "description": ""
26289           },
26290           {
26291             "group": "Body",
26292             "type": "String",
26293             "allowedValues": [
26294               "\"yes\"",
26295               "\"no\"",
26296               "\"never\""
26297             ],
26298             "optional": true,
26299             "field": "progressinband",
26300             "description": ""
26301           },
26302           {
26303             "group": "Body",
26304             "type": "String",
26305             "allowedValues": [
26306               "\"yes\"",
26307               "\"no\""
26308             ],
26309             "optional": true,
26310             "field": "promiscredir",
26311             "description": ""
26312           },
26313           {
26314             "group": "Body",
26315             "type": "String",
26316             "allowedValues": [
26317               "\"yes\"",
26318               "\"no\""
26319             ],
26320             "optional": true,
26321             "field": "useclientcode",
26322             "description": ""
26323           },
26324           {
26325             "group": "Body",
26326             "type": "Integer",
26327             "optional": true,
26328             "field": "accountcode",
26329             "description": ""
26330           },
26331           {
26332             "group": "Body",
26333             "type": "String",
26334             "optional": true,
26335             "field": "setvar",
26336             "description": ""
26337           },
26338           {
26339             "group": "Body",
26340             "type": "String",
26341             "optional": true,
26342             "field": "callerid",
26343             "description": ""
26344           },
26345           {
26346             "group": "Body",
26347             "type": "String",
26348             "optional": true,
26349             "field": "amaflags",
26350             "description": ""
26351           },
26352           {
26353             "group": "Body",
26354             "type": "String",
26355             "allowedValues": [
26356               "\"yes\"",
26357               "\"no\""
26358             ],
26359             "optional": true,
26360             "field": "callcounter",
26361             "description": ""
26362           },
26363           {
26364             "group": "Body",
26365             "type": "Integer",
26366             "optional": true,
26367             "field": "busylevel",
26368             "description": ""
26369           },
26370           {
26371             "group": "Body",
26372             "type": "String",
26373             "allowedValues": [
26374               "\"yes\"",
26375               "\"no\""
26376             ],
26377             "optional": true,
26378             "field": "allowoverlap",
26379             "description": ""
26380           },
26381           {
26382             "group": "Body",
26383             "type": "String",
26384             "allowedValues": [
26385               "\"yes\"",
26386               "\"no\""
26387             ],
26388             "optional": true,
26389             "field": "allowsubscribe",
26390             "description": ""
26391           },
26392           {
26393             "group": "Body",
26394             "type": "String",
26395             "allowedValues": [
26396               "\"yes\"",
26397               "\"no\""
26398             ],
26399             "optional": true,
26400             "field": "allowtransfer",
26401             "description": ""
26402           },
26403           {
26404             "group": "Body",
26405             "type": "String",
26406             "allowedValues": [
26407               "\"yes\"",
26408               "\"no\""
26409             ],
26410             "optional": true,
26411             "field": "ignoresdpversion",
26412             "description": ""
26413           },
26414           {
26415             "group": "Body",
26416             "type": "String",
26417             "optional": true,
26418             "field": "subscribecontext",
26419             "description": ""
26420           },
26421           {
26422             "group": "Body",
26423             "type": "String",
26424             "optional": true,
26425             "field": "template",
26426             "description": ""
26427           },
26428           {
26429             "group": "Body",
26430             "type": "String",
26431             "allowedValues": [
26432               "\"yes\"",
26433               "\"no\"",
26434               "\"always\""
26435             ],
26436             "optional": true,
26437             "field": "videosupport",
26438             "description": ""
26439           },
26440           {
26441             "group": "Body",
26442             "type": "Integer",
26443             "optional": true,
26444             "field": "maxcallbitrate",
26445             "description": ""
26446           },
26447           {
26448             "group": "Body",
26449             "type": "String",
26450             "allowedValues": [
26451               "\"yes\"",
26452               "\"no\""
26453             ],
26454             "optional": true,
26455             "field": "rfc2833compensate",
26456             "description": ""
26457           },
26458           {
26459             "group": "Body",
26460             "type": "String",
26461             "optional": true,
26462             "field": "mailbox",
26463             "description": ""
26464           },
26465           {
26466             "group": "Body",
26467             "type": "String",
26468             "allowedValues": [
26469               "\"accept\"",
26470               "\"refuse\"",
26471               "\"originate\""
26472             ],
26473             "optional": true,
26474             "field": "session_timers",
26475             "description": ""
26476           },
26477           {
26478             "group": "Body",
26479             "type": "Integer",
26480             "optional": true,
26481             "field": "session_expires",
26482             "description": ""
26483           },
26484           {
26485             "group": "Body",
26486             "type": "Integer",
26487             "optional": true,
26488             "field": "session_minse",
26489             "description": ""
26490           },
26491           {
26492             "group": "Body",
26493             "type": "String",
26494             "allowedValues": [
26495               "\"uac\"",
26496               "\"uas\""
26497             ],
26498             "optional": true,
26499             "field": "session_refresher",
26500             "description": ""
26501           },
26502           {
26503             "group": "Body",
26504             "type": "String",
26505             "optional": true,
26506             "field": "t38pt_usertpsource",
26507             "description": ""
26508           },
26509           {
26510             "group": "Body",
26511             "type": "String",
26512             "optional": true,
26513             "field": "regexten",
26514             "description": ""
26515           },
26516           {
26517             "group": "Body",
26518             "type": "String",
26519             "optional": true,
26520             "field": "fromdomain",
26521             "description": ""
26522           },
26523           {
26524             "group": "Body",
26525             "type": "String",
26526             "optional": true,
26527             "field": "fromuser",
26528             "description": ""
26529           },
26530           {
26531             "group": "Body",
26532             "type": "Integer",
26533             "optional": true,
26534             "field": "port",
26535             "description": ""
26536           },
26537           {
26538             "group": "Body",
26539             "type": "String",
26540             "allowedValues": [
26541               "\"yes\"",
26542               "\"no\""
26543             ],
26544             "optional": true,
26545             "field": "qualify",
26546             "description": ""
26547           },
26548           {
26549             "group": "Body",
26550             "type": "Integer",
26551             "optional": true,
26552             "field": "keepalive",
26553             "description": ""
26554           },
26555           {
26556             "group": "Body",
26557             "type": "String",
26558             "optional": true,
26559             "field": "defaultip",
26560             "description": ""
26561           },
26562           {
26563             "group": "Body",
26564             "type": "String",
26565             "optional": true,
26566             "field": "defaultuser",
26567             "description": ""
26568           },
26569           {
26570             "group": "Body",
26571             "type": "Integer",
26572             "optional": true,
26573             "field": "rtptimeout",
26574             "description": ""
26575           },
26576           {
26577             "group": "Body",
26578             "type": "Integer",
26579             "optional": true,
26580             "field": "rtpholdtimeout",
26581             "description": ""
26582           },
26583           {
26584             "group": "Body",
26585             "type": "Integer",
26586             "optional": true,
26587             "field": "rtpkeepalive",
26588             "description": ""
26589           },
26590           {
26591             "group": "Body",
26592             "type": "String",
26593             "allowedValues": [
26594               "\"yes\"",
26595               "\"no\"",
26596               "\"pai\""
26597             ],
26598             "optional": true,
26599             "field": "sendrpid",
26600             "description": ""
26601           },
26602           {
26603             "group": "Body",
26604             "type": "String",
26605             "optional": true,
26606             "field": "outboundproxy",
26607             "description": ""
26608           },
26609           {
26610             "group": "Body",
26611             "type": "String",
26612             "optional": true,
26613             "field": "callbackextension",
26614             "description": ""
26615           },
26616           {
26617             "group": "Body",
26618             "type": "Integer",
26619             "optional": true,
26620             "field": "timert1",
26621             "description": ""
26622           },
26623           {
26624             "group": "Body",
26625             "type": "Integer",
26626             "optional": true,
26627             "field": "timerb",
26628             "description": ""
26629           },
26630           {
26631             "group": "Body",
26632             "type": "Integer",
26633             "optional": true,
26634             "field": "qualifyfreq",
26635             "description": ""
26636           },
26637           {
26638             "group": "Body",
26639             "type": "String",
26640             "optional": true,
26641             "field": "contactpermit",
26642             "description": ""
26643           },
26644           {
26645             "group": "Body",
26646             "type": "String",
26647             "optional": true,
26648             "field": "contactdeny",
26649             "description": ""
26650           },
26651           {
26652             "group": "Body",
26653             "type": "String",
26654             "optional": true,
26655             "field": "contactacl",
26656             "description": ""
26657           },
26658           {
26659             "group": "Body",
26660             "type": "String",
26661             "optional": true,
26662             "field": "unsolicited_mailbox",
26663             "description": ""
26664           },
26665           {
26666             "group": "Body",
26667             "type": "String",
26668             "optional": true,
26669             "field": "use_q850_reason",
26670             "description": ""
26671           },
26672           {
26673             "group": "Body",
26674             "type": "Integer",
26675             "optional": true,
26676             "field": "maxforwards",
26677             "description": ""
26678           },
26679           {
26680             "group": "Body",
26681             "type": "String",
26682             "allowedValues": [
26683               "\"yes\"",
26684               "\"no\""
26685             ],
26686             "optional": true,
26687             "field": "encryption",
26688             "description": ""
26689           },
26690           {
26691             "group": "Body",
26692             "type": "String",
26693             "allowedValues": [
26694               "\"yes\"",
26695               "\"no\""
26696             ],
26697             "optional": true,
26698             "field": "avpf",
26699             "description": ""
26700           },
26701           {
26702             "group": "Body",
26703             "type": "String",
26704             "allowedValues": [
26705               "\"yes\"",
26706               "\"no\""
26707             ],
26708             "optional": true,
26709             "field": "force_avp",
26710             "description": ""
26711           },
26712           {
26713             "group": "Body",
26714             "type": "String",
26715             "allowedValues": [
26716               "\"yes\"",
26717               "\"no\""
26718             ],
26719             "optional": true,
26720             "field": "icesupport",
26721             "description": ""
26722           },
26723           {
26724             "group": "Body",
26725             "type": "String",
26726             "allowedValues": [
26727               "\"yes\"",
26728               "\"no\""
26729             ],
26730             "optional": true,
26731             "field": "dtlsenable",
26732             "description": ""
26733           },
26734           {
26735             "group": "Body",
26736             "type": "String",
26737             "allowedValues": [
26738               "\"yes\"",
26739               "\"no\"",
26740               "\"fingerprint\"",
26741               "\"certificate\""
26742             ],
26743             "optional": true,
26744             "field": "dtlsverify",
26745             "description": ""
26746           },
26747           {
26748             "group": "Body",
26749             "type": "Integer",
26750             "optional": true,
26751             "field": "dtlsrekey",
26752             "description": ""
26753           },
26754           {
26755             "group": "Body",
26756             "type": "String",
26757             "optional": true,
26758             "field": "dtlscertfile",
26759             "description": ""
26760           },
26761           {
26762             "group": "Body",
26763             "type": "String",
26764             "optional": true,
26765             "field": "dtlsprivatekey",
26766             "description": ""
26767           },
26768           {
26769             "group": "Body",
26770             "type": "String",
26771             "optional": true,
26772             "field": "dtlscipher",
26773             "description": ""
26774           },
26775           {
26776             "group": "Body",
26777             "type": "String",
26778             "optional": true,
26779             "field": "dtlscafile",
26780             "description": ""
26781           },
26782           {
26783             "group": "Body",
26784             "type": "String",
26785             "optional": true,
26786             "field": "dtlscapath",
26787             "description": ""
26788           },
26789           {
26790             "group": "Body",
26791             "type": "String",
26792             "allowedValues": [
26793               "\"active\"",
26794               "\"passive\"",
26795               "\"actpass\""
26796             ],
26797             "optional": true,
26798             "field": "dtlssetup",
26799             "description": ""
26800           },
26801           {
26802             "group": "Body",
26803             "type": "String",
26804             "optional": true,
26805             "field": "dtlsfingerprint",
26806             "description": ""
26807           },
26808           {
26809             "group": "Body",
26810             "type": "String",
26811             "allowedValues": [
26812               "\"yes\"",
26813               "\"no\""
26814             ],
26815             "optional": true,
26816             "field": "usereqphone",
26817             "description": ""
26818           },
26819           {
26820             "group": "Body",
26821             "type": "String",
26822             "optional": true,
26823             "field": "recordonfeature",
26824             "description": ""
26825           },
26826           {
26827             "group": "Body",
26828             "type": "String",
26829             "optional": true,
26830             "field": "recordofffeature",
26831             "description": ""
26832           },
26833           {
26834             "group": "Body",
26835             "type": "Integer",
26836             "optional": true,
26837             "field": "call_limit",
26838             "description": ""
26839           },
26840           {
26841             "group": "Body",
26842             "type": "String",
26843             "allowedValues": [
26844               "\"yes\"",
26845               "\"no\""
26846             ],
26847             "optional": true,
26848             "field": "registertrying",
26849             "description": ""
26850           },
26851           {
26852             "group": "Body",
26853             "type": "String",
26854             "allowedValues": [
26855               "\"yes\"",
26856               "\"no\""
26857             ],
26858             "optional": true,
26859             "field": "subscribemwi",
26860             "description": ""
26861           },
26862           {
26863             "group": "Body",
26864             "type": "String",
26865             "optional": true,
26866             "field": "vmexten",
26867             "description": ""
26868           },
26869           {
26870             "group": "Body",
26871             "type": "String",
26872             "optional": true,
26873             "field": "mohinterpret",
26874             "description": ""
26875           },
26876           {
26877             "group": "Body",
26878             "type": "String",
26879             "optional": true,
26880             "field": "mohsuggest",
26881             "description": ""
26882           },
26883           {
26884             "group": "Body",
26885             "type": "String",
26886             "optional": true,
26887             "field": "parkinglot",
26888             "description": ""
26889           },
26890           {
26891             "group": "Body",
26892             "type": "String",
26893             "optional": true,
26894             "field": "description",
26895             "description": ""
26896           },
26897           {
26898             "group": "Body",
26899             "type": "String",
26900             "optional": true,
26901             "field": "host",
26902             "description": ""
26903           },
26904           {
26905             "group": "Body",
26906             "type": "String",
26907             "allowedValues": [
26908               "\"yes\"",
26909               "\"no\"",
26910               "\"nonat\"",
26911               "\"update\"",
26912               "\"update,nonat\""
26913             ],
26914             "optional": true,
26915             "field": "canreinvite",
26916             "description": ""
26917           },
26918           {
26919             "group": "Body",
26920             "type": "String",
26921             "optional": true,
26922             "field": "registry",
26923             "description": ""
26924           },
26925           {
26926             "group": "Body",
26927             "type": "String",
26928             "optional": true,
26929             "field": "otherFields",
26930             "description": ""
26931           },
26932           {
26933             "group": "Body",
26934             "type": "Boolean",
26935             "optional": false,
26936             "field": "active",
26937             "description": ""
26938           },
26939           {
26940             "group": "Body",
26941             "type": "String",
26942             "optional": true,
26943             "field": "t38pt_udptl",
26944             "description": ""
26945           }
26946         ]
26947       }
26948     },
26949     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26950     "version": "0.0.0",
26951     "filename": "server/api/trunk/index.js",
26952     "groupTitle": "Trunks"
26953   },
26954   {
26955     "type": "delete",
26956     "url": "/api/trunks/{id}",
26957     "title": "Deletes a trunk",
26958     "examples": [
26959       {
26960         "title": "Example usage:",
26961         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X DELETE",
26962         "type": "json"
26963       }
26964     ],
26965     "name": "Delete",
26966     "group": "Trunks",
26967     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
26968     "version": "0.0.0",
26969     "filename": "server/api/trunk/index.js",
26970     "groupTitle": "Trunks"
26971   },
26972   {
26973     "type": "get",
26974     "url": "/api/trunks",
26975     "title": "Gets a list of Trunks",
26976     "examples": [
26977       {
26978         "title": "Example usage:",
26979         "content": "curl https://{domain}/api/trunks -v -u {name}:{password}",
26980         "type": "json"
26981       }
26982     ],
26983     "name": "GetTrunks",
26984     "group": "Trunks",
26985     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
26986     "version": "0.0.0",
26987     "filename": "server/api/trunk/index.js",
26988     "groupTitle": "Trunks"
26989   },
26990   {
26991     "type": "get",
26992     "url": "/api/trunks/{id}",
26993     "title": "Gets a single Trunk",
26994     "examples": [
26995       {
26996         "title": "Example usage:",
26997         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password}",
26998         "type": "json"
26999       }
27000     ],
27001     "name": "ShowTrunks",
27002     "group": "Trunks",
27003     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27004     "version": "0.0.0",
27005     "filename": "server/api/trunk/index.js",
27006     "groupTitle": "Trunks"
27007   },
27008   {
27009     "type": "put",
27010     "url": "/api/trunks/{id}",
27011     "title": "Update an existing trunk",
27012     "examples": [
27013       {
27014         "title": "Example usage:",
27015         "content": "curl https://{domain}/api/trunks/{id} -v -u {name}:{password} -X PUT",
27016         "type": "json"
27017       }
27018     ],
27019     "name": "Update",
27020     "group": "Trunks",
27021     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27022     "version": "0.0.0",
27023     "filename": "server/api/trunk/index.js",
27024     "groupTitle": "Trunks"
27025   },
27026   {
27027     "type": "post",
27028     "url": "/api/userProfile/resources",
27029     "title": "Creates a new User Profile Resource",
27030     "examples": [
27031       {
27032         "title": "Example usage:",
27033         "content": "curl https://{domain}/api/userProfile/resources -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27034         "type": "json"
27035       }
27036     ],
27037     "name": "CreateUser_Profile_Resources",
27038     "group": "User_Profile_Resources",
27039     "parameter": {
27040       "fields": {
27041         "Body": [
27042           {
27043             "group": "Body",
27044             "type": "String",
27045             "optional": false,
27046             "field": "name",
27047             "description": ""
27048           },
27049           {
27050             "group": "Body",
27051             "type": "Integer",
27052             "optional": false,
27053             "field": "resourceId",
27054             "description": ""
27055           },
27056           {
27057             "group": "Body",
27058             "type": "String",
27059             "optional": false,
27060             "field": "type",
27061             "description": ""
27062           }
27063         ]
27064       }
27065     },
27066     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27067     "version": "0.0.0",
27068     "filename": "server/api/userProfileResource/index.js",
27069     "groupTitle": "User_Profile_Resources"
27070   },
27071   {
27072     "type": "delete",
27073     "url": "/api/userProfile/resources/{id}",
27074     "title": "Deletes a User Profile Resource",
27075     "examples": [
27076       {
27077         "title": "Example usage:",
27078         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password} -X DELETE",
27079         "type": "json"
27080       }
27081     ],
27082     "name": "DeleteUser_Profile_Resources",
27083     "group": "User_Profile_Resources",
27084     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27085     "version": "0.0.0",
27086     "filename": "server/api/userProfileResource/index.js",
27087     "groupTitle": "User_Profile_Resources"
27088   },
27089   {
27090     "type": "get",
27091     "url": "/api/userProfile/resources/describe",
27092     "title": "Gets table info about User Profile Resources",
27093     "examples": [
27094       {
27095         "title": "Example usage:",
27096         "content": "curl https://{domain}/api/userProfile/resources/describe -v -u {name}:{password}",
27097         "type": "json"
27098       }
27099     ],
27100     "name": "DescribeUser_Profile_Resources",
27101     "group": "User_Profile_Resources",
27102     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27103     "version": "0.0.0",
27104     "filename": "server/api/userProfileResource/index.js",
27105     "groupTitle": "User_Profile_Resources"
27106   },
27107   {
27108     "type": "get",
27109     "url": "/api/userProfile/resources",
27110     "title": "Gets a list of User Profile Resources",
27111     "examples": [
27112       {
27113         "title": "Example usage:",
27114         "content": "curl https://{domain}/api/userProfile/resources -v -u {name}:{password}",
27115         "type": "json"
27116       }
27117     ],
27118     "name": "GetUser_Profile_Resources",
27119     "group": "User_Profile_Resources",
27120     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27121     "version": "0.0.0",
27122     "filename": "server/api/userProfileResource/index.js",
27123     "groupTitle": "User_Profile_Resources"
27124   },
27125   {
27126     "type": "get",
27127     "url": "/api/userProfile/resources/{id}",
27128     "title": "Gets a single User Profile Resource",
27129     "examples": [
27130       {
27131         "title": "Example usage:",
27132         "content": "curl https://{domain}/api/userProfile/resources/{id} -v -u {name}:{password}",
27133         "type": "json"
27134       }
27135     ],
27136     "name": "ShowUser_Profile_Resources",
27137     "group": "User_Profile_Resources",
27138     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27139     "version": "0.0.0",
27140     "filename": "server/api/userProfileResource/index.js",
27141     "groupTitle": "User_Profile_Resources"
27142   },
27143   {
27144     "type": "put",
27145     "url": "/api/userProfile/resources/{id}",
27146     "title": "Update an existing User Profile Resource",
27147     "examples": [
27148       {
27149         "title": "Example usage:",
27150         "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",
27151         "type": "json"
27152       }
27153     ],
27154     "name": "updateUser_Profile_Resources",
27155     "group": "User_Profile_Resources",
27156     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27157     "version": "0.0.0",
27158     "filename": "server/api/userProfileResource/index.js",
27159     "groupTitle": "User_Profile_Resources"
27160   },
27161   {
27162     "type": "post",
27163     "url": "/api/userProfile/sections",
27164     "title": "Creates a new User Profile Section",
27165     "examples": [
27166       {
27167         "title": "Example usage:",
27168         "content": "curl https://{domain}/api/userProfile/sections -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27169         "type": "json"
27170       }
27171     ],
27172     "name": "CreateUser_Profile_Sections",
27173     "group": "User_Profile_Sections",
27174     "parameter": {
27175       "fields": {
27176         "Body": [
27177           {
27178             "group": "Body",
27179             "type": "String",
27180             "optional": false,
27181             "field": "name",
27182             "description": ""
27183           },
27184           {
27185             "group": "Body",
27186             "type": "String",
27187             "optional": false,
27188             "field": "category",
27189             "description": ""
27190           },
27191           {
27192             "group": "Body",
27193             "type": "Integer",
27194             "optional": false,
27195             "field": "sectionId",
27196             "description": ""
27197           },
27198           {
27199             "group": "Body",
27200             "type": "Boolean",
27201             "optional": true,
27202             "field": "enabled",
27203             "description": ""
27204           },
27205           {
27206             "group": "Body",
27207             "type": "Boolean",
27208             "optional": true,
27209             "field": "autoAssociation",
27210             "description": ""
27211           },
27212           {
27213             "group": "Body",
27214             "type": "String",
27215             "optional": true,
27216             "field": "crudPermissions",
27217             "description": ""
27218           }
27219         ]
27220       }
27221     },
27222     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27223     "version": "0.0.0",
27224     "filename": "server/api/userProfileSection/index.js",
27225     "groupTitle": "User_Profile_Sections"
27226   },
27227   {
27228     "type": "delete",
27229     "url": "/api/userProfile/sections/{id}",
27230     "title": "Deletes a User Profile Section",
27231     "examples": [
27232       {
27233         "title": "Example usage:",
27234         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password} -X DELETE",
27235         "type": "json"
27236       }
27237     ],
27238     "name": "DeleteUser_Profile_Sections",
27239     "group": "User_Profile_Sections",
27240     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27241     "version": "0.0.0",
27242     "filename": "server/api/userProfileSection/index.js",
27243     "groupTitle": "User_Profile_Sections"
27244   },
27245   {
27246     "type": "get",
27247     "url": "/api/userProfile/sections/describe",
27248     "title": "Gets table info about User Profile Sections",
27249     "examples": [
27250       {
27251         "title": "Example usage:",
27252         "content": "curl https://{domain}/api/userProfile/sections/describe -v -u {name}:{password}",
27253         "type": "json"
27254       }
27255     ],
27256     "name": "DescribeUser_Profile_Sections",
27257     "group": "User_Profile_Sections",
27258     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27259     "version": "0.0.0",
27260     "filename": "server/api/userProfileSection/index.js",
27261     "groupTitle": "User_Profile_Sections"
27262   },
27263   {
27264     "type": "get",
27265     "url": "/api/userProfile/sections",
27266     "title": "Gets a list of User Profile Sections",
27267     "examples": [
27268       {
27269         "title": "Example usage:",
27270         "content": "curl https://{domain}/api/userProfile/sections -v -u {name}:{password}",
27271         "type": "json"
27272       }
27273     ],
27274     "name": "GetUser_Profile_Sections",
27275     "group": "User_Profile_Sections",
27276     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27277     "version": "0.0.0",
27278     "filename": "server/api/userProfileSection/index.js",
27279     "groupTitle": "User_Profile_Sections"
27280   },
27281   {
27282     "type": "get",
27283     "url": "/api/userProfile/sections/{id}",
27284     "title": "Gets a single User Profile Section",
27285     "examples": [
27286       {
27287         "title": "Example usage:",
27288         "content": "curl https://{domain}/api/userProfile/sections/{id} -v -u {name}:{password}",
27289         "type": "json"
27290       }
27291     ],
27292     "name": "ShowUser_Profile_Sections",
27293     "group": "User_Profile_Sections",
27294     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27295     "version": "0.0.0",
27296     "filename": "server/api/userProfileSection/index.js",
27297     "groupTitle": "User_Profile_Sections"
27298   },
27299   {
27300     "type": "put",
27301     "url": "/api/userProfile/sections/{id}",
27302     "title": "Update an existing User Profile Section",
27303     "examples": [
27304       {
27305         "title": "Example usage:",
27306         "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",
27307         "type": "json"
27308       }
27309     ],
27310     "name": "updateUser_Profile_Sections",
27311     "group": "User_Profile_Sections",
27312     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27313     "version": "0.0.0",
27314     "filename": "server/api/userProfileSection/index.js",
27315     "groupTitle": "User_Profile_Sections"
27316   },
27317   {
27318     "type": "post",
27319     "url": "/api/userProfiles/{id}/resources",
27320     "title": "Add resources' permissions to User Profile",
27321     "examples": [
27322       {
27323         "title": "Example usage:",
27324         "content": "curl https://{domain}/api/userProfiles/{id}/resources -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27325         "type": "json"
27326       }
27327     ],
27328     "name": "AddResources",
27329     "group": "User_Profiles",
27330     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27331     "version": "0.0.0",
27332     "filename": "server/api/userProfile/index.js",
27333     "groupTitle": "User_Profiles"
27334   },
27335   {
27336     "type": "post",
27337     "url": "/api/userProfiles/{id}/sections",
27338     "title": "Add sections' permissions to User Profile",
27339     "examples": [
27340       {
27341         "title": "Example usage:",
27342         "content": "curl https://{domain}/api/userProfiles/{id}/sections -d '[{\"sectionId\": \"name\", \"...\": \"...\"}]' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27343         "type": "json"
27344       }
27345     ],
27346     "name": "AddSections",
27347     "group": "User_Profiles",
27348     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27349     "version": "0.0.0",
27350     "filename": "server/api/userProfile/index.js",
27351     "groupTitle": "User_Profiles"
27352   },
27353   {
27354     "type": "post",
27355     "url": "/api/userProfiles/clone",
27356     "title": "Clone an existing User Profile",
27357     "examples": [
27358       {
27359         "title": "Example usage:",
27360         "content": "curl https://{domain}/api/userProfiles/clone -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27361         "type": "json"
27362       }
27363     ],
27364     "name": "CloneUser_Profiles",
27365     "group": "User_Profiles",
27366     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27367     "version": "0.0.0",
27368     "filename": "server/api/userProfile/index.js",
27369     "groupTitle": "User_Profiles"
27370   },
27371   {
27372     "type": "post",
27373     "url": "/api/userProfiles",
27374     "title": "Creates a new User Profile",
27375     "examples": [
27376       {
27377         "title": "Example usage:",
27378         "content": "curl https://{domain}/api/userProfiles -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27379         "type": "json"
27380       }
27381     ],
27382     "name": "CreateUser_Profiles",
27383     "group": "User_Profiles",
27384     "parameter": {
27385       "fields": {
27386         "Body": [
27387           {
27388             "group": "Body",
27389             "type": "String",
27390             "optional": false,
27391             "field": "name",
27392             "description": ""
27393           },
27394           {
27395             "group": "Body",
27396             "type": "String",
27397             "optional": false,
27398             "field": "crudPermissions",
27399             "description": ""
27400           },
27401           {
27402             "group": "Body",
27403             "type": "String",
27404             "optional": true,
27405             "field": "description",
27406             "description": ""
27407           }
27408         ]
27409       }
27410     },
27411     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27412     "version": "0.0.0",
27413     "filename": "server/api/userProfile/index.js",
27414     "groupTitle": "User_Profiles"
27415   },
27416   {
27417     "type": "delete",
27418     "url": "/api/userProfiles/{id}",
27419     "title": "Deletes a User Profile",
27420     "examples": [
27421       {
27422         "title": "Example usage:",
27423         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password} -X DELETE",
27424         "type": "json"
27425       }
27426     ],
27427     "name": "DeleteUser_Profiles",
27428     "group": "User_Profiles",
27429     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27430     "version": "0.0.0",
27431     "filename": "server/api/userProfile/index.js",
27432     "groupTitle": "User_Profiles"
27433   },
27434   {
27435     "type": "get",
27436     "url": "/api/userProfiles/describe",
27437     "title": "Gets table info about User Profiles",
27438     "examples": [
27439       {
27440         "title": "Example usage:",
27441         "content": "curl https://{domain}/api/userProfiles/describe -v -u {name}:{password}",
27442         "type": "json"
27443       }
27444     ],
27445     "name": "DescribeUser_Profiles",
27446     "group": "User_Profiles",
27447     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27448     "version": "0.0.0",
27449     "filename": "server/api/userProfile/index.js",
27450     "groupTitle": "User_Profiles"
27451   },
27452   {
27453     "type": "get",
27454     "url": "/api/userProfiles/{id}/resources?section={section}",
27455     "title": "Get Resources assigned to a Section",
27456     "examples": [
27457       {
27458         "title": "Example usage:",
27459         "content": "curl https://{domain}/api/userProfiles/{id}/resources?section={section} -v -u {name}:{password} -X GET",
27460         "type": "json"
27461       }
27462     ],
27463     "name": "GetResources",
27464     "group": "User_Profiles",
27465     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27466     "version": "0.0.0",
27467     "filename": "server/api/userProfile/index.js",
27468     "groupTitle": "User_Profiles"
27469   },
27470   {
27471     "type": "get",
27472     "url": "/api/userProfiles/{id}/sections",
27473     "title": "Get sections associated to a User Profile",
27474     "examples": [
27475       {
27476         "title": "Example usage:",
27477         "content": "curl https://{domain}/api/userProfiles/{id}/sections -v -u {name}:{password} -X GET",
27478         "type": "json"
27479       }
27480     ],
27481     "name": "GetSections",
27482     "group": "User_Profiles",
27483     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27484     "version": "0.0.0",
27485     "filename": "server/api/userProfile/index.js",
27486     "groupTitle": "User_Profiles"
27487   },
27488   {
27489     "type": "get",
27490     "url": "/api/userProfiles",
27491     "title": "Gets a list of User Profiles",
27492     "examples": [
27493       {
27494         "title": "Example usage:",
27495         "content": "curl https://{domain}/api/userProfiles -v -u {name}:{password}",
27496         "type": "json"
27497       }
27498     ],
27499     "name": "GetUser_Profiles",
27500     "group": "User_Profiles",
27501     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
27502     "version": "0.0.0",
27503     "filename": "server/api/userProfile/index.js",
27504     "groupTitle": "User_Profiles"
27505   },
27506   {
27507     "type": "delete",
27508     "url": "/api/userProfiles/{id}/resources",
27509     "title": "Removes resources' permissions from User Profile",
27510     "examples": [
27511       {
27512         "title": "Example usage:",
27513         "content": "curl https://{domain}/api/userProfiles/{id}/resources?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
27514         "type": "json"
27515       }
27516     ],
27517     "name": "RemoveResources",
27518     "group": "User_Profiles",
27519     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27520     "version": "0.0.0",
27521     "filename": "server/api/userProfile/index.js",
27522     "groupTitle": "User_Profiles"
27523   },
27524   {
27525     "type": "delete",
27526     "url": "/api/userProfiles/{id}/sections",
27527     "title": "Removes sections' permissions from User Profile",
27528     "examples": [
27529       {
27530         "title": "Example usage:",
27531         "content": "curl https://{domain}/api/userProfiles/{id}/sections?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
27532         "type": "json"
27533       }
27534     ],
27535     "name": "RemoveSections",
27536     "group": "User_Profiles",
27537     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27538     "version": "0.0.0",
27539     "filename": "server/api/userProfile/index.js",
27540     "groupTitle": "User_Profiles"
27541   },
27542   {
27543     "type": "get",
27544     "url": "/api/userProfiles/{id}",
27545     "title": "Gets a single User Profile",
27546     "examples": [
27547       {
27548         "title": "Example usage:",
27549         "content": "curl https://{domain}/api/userProfiles/{id} -v -u {name}:{password}",
27550         "type": "json"
27551       }
27552     ],
27553     "name": "ShowUser_Profiles",
27554     "group": "User_Profiles",
27555     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27556     "version": "0.0.0",
27557     "filename": "server/api/userProfile/index.js",
27558     "groupTitle": "User_Profiles"
27559   },
27560   {
27561     "type": "put",
27562     "url": "/api/userProfiles/{id}",
27563     "title": "Update an existing User Profile",
27564     "examples": [
27565       {
27566         "title": "Example usage:",
27567         "content": "curl https://{domain}/api/userProfiles/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
27568         "type": "json"
27569       }
27570     ],
27571     "name": "updateUser_Profiles",
27572     "group": "User_Profiles",
27573     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27574     "version": "0.0.0",
27575     "filename": "server/api/userProfile/index.js",
27576     "groupTitle": "User_Profiles"
27577   },
27578   {
27579     "type": "post",
27580     "url": "/api/users/{id}/chat_interactions",
27581     "title": "Add chat interaction tabs to an agent",
27582     "examples": [
27583       {
27584         "title": "Example usage:",
27585         "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",
27586         "type": "json"
27587       }
27588     ],
27589     "name": "AddChatInteractions",
27590     "group": "Users",
27591     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27592     "version": "0.0.0",
27593     "filename": "server/api/user/index.js",
27594     "groupTitle": "Users"
27595   },
27596   {
27597     "type": "post",
27598     "url": "/api/users/{id}/chat_websites",
27599     "title": "Add a Chat Website to a user",
27600     "examples": [
27601       {
27602         "title": "Example usage:",
27603         "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",
27604         "type": "json"
27605       }
27606     ],
27607     "name": "AddChatWebsites",
27608     "group": "Users",
27609     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27610     "version": "0.0.0",
27611     "filename": "server/api/user/index.js",
27612     "groupTitle": "Users"
27613   },
27614   {
27615     "type": "post",
27616     "url": "/api/users/{id}/contacts",
27617     "title": "Add contacts to a user",
27618     "examples": [
27619       {
27620         "title": "Example usage:",
27621         "content": "curl https://{domain}/api/users/{id}/contacts -d '{\"ids\": [1,2]}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27622         "type": "json"
27623       }
27624     ],
27625     "name": "AddContacts",
27626     "group": "Users",
27627     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27628     "version": "0.0.0",
27629     "filename": "server/api/user/index.js",
27630     "groupTitle": "Users"
27631   },
27632   {
27633     "type": "post",
27634     "url": "/api/users/{id}/fax_accounts",
27635     "title": "Add a Fax Account to a user",
27636     "examples": [
27637       {
27638         "title": "Example usage:",
27639         "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",
27640         "type": "json"
27641       }
27642     ],
27643     "name": "AddFaxAccounts",
27644     "group": "Users",
27645     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27646     "version": "0.0.0",
27647     "filename": "server/api/user/index.js",
27648     "groupTitle": "Users"
27649   },
27650   {
27651     "type": "post",
27652     "url": "/api/users/{id}/fax_interactions",
27653     "title": "Add fax interaction tabs to an agent",
27654     "examples": [
27655       {
27656         "title": "Example usage:",
27657         "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",
27658         "type": "json"
27659       }
27660     ],
27661     "name": "AddFaxInteractions",
27662     "group": "Users",
27663     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27664     "version": "0.0.0",
27665     "filename": "server/api/user/index.js",
27666     "groupTitle": "Users"
27667   },
27668   {
27669     "type": "post",
27670     "url": "/api/users/{id}/mail_accounts",
27671     "title": "Add a Mail Account to a user",
27672     "examples": [
27673       {
27674         "title": "Example usage:",
27675         "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",
27676         "type": "json"
27677       }
27678     ],
27679     "name": "AddMailAccounts",
27680     "group": "Users",
27681     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27682     "version": "0.0.0",
27683     "filename": "server/api/user/index.js",
27684     "groupTitle": "Users"
27685   },
27686   {
27687     "type": "post",
27688     "url": "/api/users/{id}/mail_interactions",
27689     "title": "Add mail interaction tabs to an agent",
27690     "examples": [
27691       {
27692         "title": "Example usage:",
27693         "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",
27694         "type": "json"
27695       }
27696     ],
27697     "name": "AddMailInteractions",
27698     "group": "Users",
27699     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27700     "version": "0.0.0",
27701     "filename": "server/api/user/index.js",
27702     "groupTitle": "Users"
27703   },
27704   {
27705     "type": "post",
27706     "url": "/api/users/{id}/openchannel_accounts",
27707     "title": "Add a Open Channel Account to a user",
27708     "examples": [
27709       {
27710         "title": "Example usage:",
27711         "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",
27712         "type": "json"
27713       }
27714     ],
27715     "name": "AddOpenchannelAccounts",
27716     "group": "Users",
27717     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27718     "version": "0.0.0",
27719     "filename": "server/api/user/index.js",
27720     "groupTitle": "Users"
27721   },
27722   {
27723     "type": "post",
27724     "url": "/api/users/{id}/openchannel_interactions",
27725     "title": "Add openchannel interaction tabs to an agent",
27726     "examples": [
27727       {
27728         "title": "Example usage:",
27729         "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",
27730         "type": "json"
27731       }
27732     ],
27733     "name": "AddOpenchannelInteractions",
27734     "group": "Users",
27735     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27736     "version": "0.0.0",
27737     "filename": "server/api/user/index.js",
27738     "groupTitle": "Users"
27739   },
27740   {
27741     "type": "post",
27742     "url": "/api/users/{id}/queues",
27743     "title": "Add queues to an agent",
27744     "examples": [
27745       {
27746         "title": "Example usage:",
27747         "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",
27748         "type": "json"
27749       }
27750     ],
27751     "name": "AddQueues",
27752     "group": "Users",
27753     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27754     "version": "0.0.0",
27755     "filename": "server/api/user/index.js",
27756     "groupTitle": "Users"
27757   },
27758   {
27759     "type": "post",
27760     "url": "/api/users/{id}/sms_accounts",
27761     "title": "Add a Sms Account to a user",
27762     "examples": [
27763       {
27764         "title": "Example usage:",
27765         "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",
27766         "type": "json"
27767       }
27768     ],
27769     "name": "AddSmsAccounts",
27770     "group": "Users",
27771     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27772     "version": "0.0.0",
27773     "filename": "server/api/user/index.js",
27774     "groupTitle": "Users"
27775   },
27776   {
27777     "type": "post",
27778     "url": "/api/users/{id}/sms_interactions",
27779     "title": "Add sms interaction tabs to an agent",
27780     "examples": [
27781       {
27782         "title": "Example usage:",
27783         "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",
27784         "type": "json"
27785       }
27786     ],
27787     "name": "AddSmsInteractions",
27788     "group": "Users",
27789     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27790     "version": "0.0.0",
27791     "filename": "server/api/user/index.js",
27792     "groupTitle": "Users"
27793   },
27794   {
27795     "type": "post",
27796     "url": "/api/users/{id}/square_projects",
27797     "title": "Add a Square Project to a user",
27798     "examples": [
27799       {
27800         "title": "Example usage:",
27801         "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",
27802         "type": "json"
27803       }
27804     ],
27805     "name": "AddSquareProjects",
27806     "group": "Users",
27807     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27808     "version": "0.0.0",
27809     "filename": "server/api/user/index.js",
27810     "groupTitle": "Users"
27811   },
27812   {
27813     "type": "post",
27814     "url": "/api/users/{id}/teams",
27815     "title": "Add teams to an agent",
27816     "examples": [
27817       {
27818         "title": "Example usage:",
27819         "content": "curl https://{domain}/api/users/{id}/teams -d '{\"ids\": [1,2]}' \\ \n -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
27820         "type": "json"
27821       }
27822     ],
27823     "name": "AddTeams",
27824     "group": "Users",
27825     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
27826     "version": "0.0.0",
27827     "filename": "server/api/user/index.js",
27828     "groupTitle": "Users"
27829   },
27830   {
27831     "type": "post",
27832     "url": "/api/users/create_many",
27833     "title": "Creates many Users",
27834     "examples": [
27835       {
27836         "title": "Example usage:",
27837         "content": "curl https://{domain}/api/users/create_many -d '[{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}]' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
27838         "type": "json"
27839       }
27840     ],
27841     "name": "BulkCreateUsers",
27842     "group": "Users",
27843     "parameter": {
27844       "fields": {
27845         "Body": [
27846           {
27847             "group": "Body",
27848             "type": "String",
27849             "optional": false,
27850             "field": "name",
27851             "description": "<p>The name of the user</p>"
27852           },
27853           {
27854             "group": "Body",
27855             "type": "String",
27856             "optional": false,
27857             "field": "fullname",
27858             "description": ""
27859           },
27860           {
27861             "group": "Body",
27862             "type": "String",
27863             "optional": true,
27864             "field": "alias",
27865             "description": ""
27866           },
27867           {
27868             "group": "Body",
27869             "type": "String",
27870             "optional": false,
27871             "field": "email",
27872             "description": ""
27873           },
27874           {
27875             "group": "Body",
27876             "type": "String",
27877             "allowedValues": [
27878               "\"admin\"",
27879               "\"user\"",
27880               "\"agent\"",
27881               "\"telephone\""
27882             ],
27883             "optional": false,
27884             "field": "role",
27885             "description": ""
27886           },
27887           {
27888             "group": "Body",
27889             "type": "String",
27890             "optional": false,
27891             "field": "password",
27892             "description": ""
27893           },
27894           {
27895             "group": "Body",
27896             "type": "String",
27897             "optional": true,
27898             "field": "provider",
27899             "description": ""
27900           },
27901           {
27902             "group": "Body",
27903             "type": "Integer",
27904             "optional": false,
27905             "field": "internal",
27906             "description": ""
27907           },
27908           {
27909             "group": "Body",
27910             "type": "String",
27911             "optional": true,
27912             "field": "salt",
27913             "description": ""
27914           },
27915           {
27916             "group": "Body",
27917             "type": "String",
27918             "optional": true,
27919             "field": "phone",
27920             "description": ""
27921           },
27922           {
27923             "group": "Body",
27924             "type": "String",
27925             "optional": true,
27926             "field": "mobile",
27927             "description": ""
27928           },
27929           {
27930             "group": "Body",
27931             "type": "String",
27932             "optional": true,
27933             "field": "address",
27934             "description": ""
27935           },
27936           {
27937             "group": "Body",
27938             "type": "String",
27939             "optional": true,
27940             "field": "zipcode",
27941             "description": ""
27942           },
27943           {
27944             "group": "Body",
27945             "type": "String",
27946             "optional": true,
27947             "field": "userpic",
27948             "description": ""
27949           },
27950           {
27951             "group": "Body",
27952             "type": "String",
27953             "optional": true,
27954             "field": "city",
27955             "description": ""
27956           },
27957           {
27958             "group": "Body",
27959             "type": "String",
27960             "optional": true,
27961             "field": "country",
27962             "description": ""
27963           },
27964           {
27965             "group": "Body",
27966             "type": "Boolean",
27967             "optional": true,
27968             "field": "online",
27969             "description": ""
27970           },
27971           {
27972             "group": "Body",
27973             "type": "String",
27974             "optional": true,
27975             "field": "lastLoginAt",
27976             "description": ""
27977           },
27978           {
27979             "group": "Body",
27980             "type": "Boolean",
27981             "optional": true,
27982             "field": "voicePause",
27983             "description": ""
27984           },
27985           {
27986             "group": "Body",
27987             "type": "Boolean",
27988             "optional": true,
27989             "field": "chatPause",
27990             "description": ""
27991           },
27992           {
27993             "group": "Body",
27994             "type": "Boolean",
27995             "optional": true,
27996             "field": "mailPause",
27997             "description": ""
27998           },
27999           {
28000             "group": "Body",
28001             "type": "Boolean",
28002             "optional": true,
28003             "field": "faxPause",
28004             "description": ""
28005           },
28006           {
28007             "group": "Body",
28008             "type": "Boolean",
28009             "optional": true,
28010             "field": "smsPause",
28011             "description": ""
28012           },
28013           {
28014             "group": "Body",
28015             "type": "Boolean",
28016             "optional": true,
28017             "field": "openchannelPause",
28018             "description": ""
28019           },
28020           {
28021             "group": "Body",
28022             "type": "String",
28023             "optional": true,
28024             "field": "pauseType",
28025             "description": ""
28026           },
28027           {
28028             "group": "Body",
28029             "type": "String",
28030             "optional": true,
28031             "field": "lastPauseAt",
28032             "description": ""
28033           },
28034           {
28035             "group": "Body",
28036             "type": "Integer",
28037             "optional": true,
28038             "field": "chatCapacity",
28039             "description": ""
28040           },
28041           {
28042             "group": "Body",
28043             "type": "Integer",
28044             "optional": true,
28045             "field": "mailCapacity",
28046             "description": ""
28047           },
28048           {
28049             "group": "Body",
28050             "type": "Integer",
28051             "optional": true,
28052             "field": "faxCapacity",
28053             "description": ""
28054           },
28055           {
28056             "group": "Body",
28057             "type": "Integer",
28058             "optional": true,
28059             "field": "smsCapacity",
28060             "description": ""
28061           },
28062           {
28063             "group": "Body",
28064             "type": "Integer",
28065             "optional": true,
28066             "field": "openchannelCapacity",
28067             "description": ""
28068           },
28069           {
28070             "group": "Body",
28071             "type": "Boolean",
28072             "optional": true,
28073             "field": "phoneBarAutoAnswer",
28074             "description": ""
28075           },
28076           {
28077             "group": "Body",
28078             "type": "Boolean",
28079             "optional": true,
28080             "field": "phoneBarEnableSettings",
28081             "description": ""
28082           },
28083           {
28084             "group": "Body",
28085             "type": "Integer",
28086             "optional": true,
28087             "field": "phoneBarListenPort",
28088             "description": ""
28089           },
28090           {
28091             "group": "Body",
28092             "type": "Integer",
28093             "optional": true,
28094             "field": "phoneBarExpires",
28095             "description": ""
28096           },
28097           {
28098             "group": "Body",
28099             "type": "Boolean",
28100             "optional": true,
28101             "field": "phoneBarRemoteControl",
28102             "description": ""
28103           },
28104           {
28105             "group": "Body",
28106             "type": "Integer",
28107             "optional": true,
28108             "field": "phoneBarRemoteControlPort",
28109             "description": ""
28110           },
28111           {
28112             "group": "Body",
28113             "type": "Boolean",
28114             "optional": true,
28115             "field": "phoneBarEnableRecording",
28116             "description": ""
28117           },
28118           {
28119             "group": "Body",
28120             "type": "Boolean",
28121             "optional": true,
28122             "field": "phoneBarRingInUse",
28123             "description": ""
28124           },
28125           {
28126             "group": "Body",
28127             "type": "Boolean",
28128             "optional": true,
28129             "field": "chanspy",
28130             "description": ""
28131           },
28132           {
28133             "group": "Body",
28134             "type": "String",
28135             "optional": true,
28136             "field": "description",
28137             "description": ""
28138           },
28139           {
28140             "group": "Body",
28141             "type": "String",
28142             "optional": true,
28143             "field": "host",
28144             "description": ""
28145           },
28146           {
28147             "group": "Body",
28148             "type": "String",
28149             "optional": true,
28150             "field": "ipaddr",
28151             "description": ""
28152           },
28153           {
28154             "group": "Body",
28155             "type": "Integer",
28156             "optional": true,
28157             "field": "port",
28158             "description": ""
28159           },
28160           {
28161             "group": "Body",
28162             "type": "Integer",
28163             "optional": true,
28164             "field": "regseconds",
28165             "description": ""
28166           },
28167           {
28168             "group": "Body",
28169             "type": "String",
28170             "optional": true,
28171             "field": "fullcontact",
28172             "description": ""
28173           },
28174           {
28175             "group": "Body",
28176             "type": "String",
28177             "optional": true,
28178             "field": "regserver",
28179             "description": ""
28180           },
28181           {
28182             "group": "Body",
28183             "type": "String",
28184             "optional": true,
28185             "field": "useragent",
28186             "description": ""
28187           },
28188           {
28189             "group": "Body",
28190             "type": "Integer",
28191             "optional": true,
28192             "field": "lastms",
28193             "description": ""
28194           },
28195           {
28196             "group": "Body",
28197             "type": "String",
28198             "allowedValues": [
28199               "\"friend\"",
28200               "\"user\"",
28201               "\"peer\""
28202             ],
28203             "optional": true,
28204             "field": "type",
28205             "description": ""
28206           },
28207           {
28208             "group": "Body",
28209             "type": "String",
28210             "optional": true,
28211             "field": "context",
28212             "description": ""
28213           },
28214           {
28215             "group": "Body",
28216             "type": "String",
28217             "allowedValues": [
28218               "\"ALLOWED_NOT_SCREENED\"",
28219               "\"ALLOWED_PASSED_SCREEN\"",
28220               "\"ALLOWED_FAILED_SCREEN\"",
28221               "\"ALLOWED\"",
28222               "\"PROHIB_NOT_SCREENED\"",
28223               "\"PROHIB_PASSED_SCREEN\"",
28224               "\"PROHIB_FAILED_SCREEN\"",
28225               "\"PROHIB\""
28226             ],
28227             "optional": true,
28228             "field": "callingpres",
28229             "description": ""
28230           },
28231           {
28232             "group": "Body",
28233             "type": "String",
28234             "optional": true,
28235             "field": "deny",
28236             "description": ""
28237           },
28238           {
28239             "group": "Body",
28240             "type": "String",
28241             "optional": true,
28242             "field": "permit",
28243             "description": ""
28244           },
28245           {
28246             "group": "Body",
28247             "type": "String",
28248             "optional": true,
28249             "field": "secret",
28250             "description": ""
28251           },
28252           {
28253             "group": "Body",
28254             "type": "String",
28255             "optional": true,
28256             "field": "md5secret",
28257             "description": ""
28258           },
28259           {
28260             "group": "Body",
28261             "type": "String",
28262             "optional": true,
28263             "field": "remotesecret",
28264             "description": ""
28265           },
28266           {
28267             "group": "Body",
28268             "type": "String",
28269             "optional": true,
28270             "field": "transport",
28271             "description": "<p>String is deprecated. Please use an Array as [&quot;udp&quot;, &quot;tcp&quot;]</p>"
28272           },
28273           {
28274             "group": "Body",
28275             "type": "String",
28276             "allowedValues": [
28277               "\"rfc2833\"",
28278               "\"info\"",
28279               "\"shortinfo\"",
28280               "\"inband\"",
28281               "\"auto\""
28282             ],
28283             "optional": true,
28284             "field": "dtmfmode",
28285             "description": ""
28286           },
28287           {
28288             "group": "Body",
28289             "type": "String",
28290             "allowedValues": [
28291               "\"yes\"",
28292               "\"no\"",
28293               "\"nonat\"",
28294               "\"update\"",
28295               "\"outgoing\""
28296             ],
28297             "optional": true,
28298             "field": "directmedia",
28299             "description": ""
28300           },
28301           {
28302             "group": "Body",
28303             "type": "String",
28304             "allowedValues": [
28305               "\"yes\"",
28306               "\"no\""
28307             ],
28308             "optional": true,
28309             "field": "directrtpsetup",
28310             "description": ""
28311           },
28312           {
28313             "group": "Body",
28314             "type": "String",
28315             "optional": true,
28316             "field": "directmediapermit",
28317             "description": ""
28318           },
28319           {
28320             "group": "Body",
28321             "type": "String",
28322             "optional": true,
28323             "field": "directmediadeny",
28324             "description": ""
28325           },
28326           {
28327             "group": "Body",
28328             "type": "String",
28329             "optional": true,
28330             "field": "nat",
28331             "description": "<p>String is deprecated. Please use an Array as [&quot;force_rport&quot;, &quot;comedia&quot;]</p>"
28332           },
28333           {
28334             "group": "Body",
28335             "type": "String",
28336             "optional": true,
28337             "field": "callgroup",
28338             "description": ""
28339           },
28340           {
28341             "group": "Body",
28342             "type": "String",
28343             "optional": true,
28344             "field": "namedcallgroup",
28345             "description": ""
28346           },
28347           {
28348             "group": "Body",
28349             "type": "String",
28350             "optional": true,
28351             "field": "pickupgroup",
28352             "description": ""
28353           },
28354           {
28355             "group": "Body",
28356             "type": "String",
28357             "optional": true,
28358             "field": "namedpickupgroup",
28359             "description": ""
28360           },
28361           {
28362             "group": "Body",
28363             "type": "String",
28364             "optional": true,
28365             "field": "language",
28366             "description": ""
28367           },
28368           {
28369             "group": "Body",
28370             "type": "String",
28371             "optional": true,
28372             "field": "tonezone",
28373             "description": ""
28374           },
28375           {
28376             "group": "Body",
28377             "type": "String",
28378             "optional": false,
28379             "field": "disallow",
28380             "description": ""
28381           },
28382           {
28383             "group": "Body",
28384             "type": "String",
28385             "optional": false,
28386             "field": "allow",
28387             "description": "<p>String is deprecated. Please use an Array as [&quot;ulaw&quot;, &quot;alaw&quot;, &quot;gsm&quot;]</p>"
28388           },
28389           {
28390             "group": "Body",
28391             "type": "String",
28392             "allowedValues": [
28393               "\"yes\"",
28394               "\"no\""
28395             ],
28396             "optional": true,
28397             "field": "autoframing",
28398             "description": ""
28399           },
28400           {
28401             "group": "Body",
28402             "type": "String",
28403             "optional": true,
28404             "field": "insecure",
28405             "description": "<p>String is deprecated. Please use an Array as [&quot;port&quot;, &quot;invite&quot;]</p>"
28406           },
28407           {
28408             "group": "Body",
28409             "type": "String",
28410             "allowedValues": [
28411               "\"yes\"",
28412               "\"no\""
28413             ],
28414             "optional": true,
28415             "field": "trustrpid",
28416             "description": ""
28417           },
28418           {
28419             "group": "Body",
28420             "type": "String",
28421             "allowedValues": [
28422               "\"yes\"",
28423               "\"no\""
28424             ],
28425             "optional": true,
28426             "field": "trust_id_outbound",
28427             "description": ""
28428           },
28429           {
28430             "group": "Body",
28431             "type": "String",
28432             "allowedValues": [
28433               "\"yes\"",
28434               "\"no\"",
28435               "\"never\""
28436             ],
28437             "optional": true,
28438             "field": "progressinband",
28439             "description": ""
28440           },
28441           {
28442             "group": "Body",
28443             "type": "String",
28444             "allowedValues": [
28445               "\"yes\"",
28446               "\"no\""
28447             ],
28448             "optional": true,
28449             "field": "promiscredir",
28450             "description": ""
28451           },
28452           {
28453             "group": "Body",
28454             "type": "String",
28455             "allowedValues": [
28456               "\"yes\"",
28457               "\"no\""
28458             ],
28459             "optional": true,
28460             "field": "useclientcode",
28461             "description": ""
28462           },
28463           {
28464             "group": "Body",
28465             "type": "Integer",
28466             "optional": true,
28467             "field": "accountcode",
28468             "description": ""
28469           },
28470           {
28471             "group": "Body",
28472             "type": "String",
28473             "optional": true,
28474             "field": "setvar",
28475             "description": ""
28476           },
28477           {
28478             "group": "Body",
28479             "type": "String",
28480             "optional": true,
28481             "field": "callerid",
28482             "description": ""
28483           },
28484           {
28485             "group": "Body",
28486             "type": "String",
28487             "optional": true,
28488             "field": "amaflags",
28489             "description": ""
28490           },
28491           {
28492             "group": "Body",
28493             "type": "String",
28494             "allowedValues": [
28495               "\"yes\"",
28496               "\"no\""
28497             ],
28498             "optional": true,
28499             "field": "callcounter",
28500             "description": ""
28501           },
28502           {
28503             "group": "Body",
28504             "type": "Integer",
28505             "optional": true,
28506             "field": "busylevel",
28507             "description": ""
28508           },
28509           {
28510             "group": "Body",
28511             "type": "String",
28512             "allowedValues": [
28513               "\"yes\"",
28514               "\"no\""
28515             ],
28516             "optional": true,
28517             "field": "allowoverlap",
28518             "description": ""
28519           },
28520           {
28521             "group": "Body",
28522             "type": "String",
28523             "allowedValues": [
28524               "\"yes\"",
28525               "\"no\""
28526             ],
28527             "optional": true,
28528             "field": "allowsubscribe",
28529             "description": ""
28530           },
28531           {
28532             "group": "Body",
28533             "type": "String",
28534             "allowedValues": [
28535               "\"yes\"",
28536               "\"no\""
28537             ],
28538             "optional": true,
28539             "field": "allowtransfer",
28540             "description": ""
28541           },
28542           {
28543             "group": "Body",
28544             "type": "String",
28545             "allowedValues": [
28546               "\"yes\"",
28547               "\"no\""
28548             ],
28549             "optional": true,
28550             "field": "ignoresdpversion",
28551             "description": ""
28552           },
28553           {
28554             "group": "Body",
28555             "type": "String",
28556             "optional": true,
28557             "field": "subscribecontext",
28558             "description": ""
28559           },
28560           {
28561             "group": "Body",
28562             "type": "String",
28563             "optional": true,
28564             "field": "template",
28565             "description": ""
28566           },
28567           {
28568             "group": "Body",
28569             "type": "String",
28570             "allowedValues": [
28571               "\"yes\"",
28572               "\"no\"",
28573               "\"always\""
28574             ],
28575             "optional": true,
28576             "field": "videosupport",
28577             "description": ""
28578           },
28579           {
28580             "group": "Body",
28581             "type": "Integer",
28582             "optional": true,
28583             "field": "maxcallbitrate",
28584             "description": ""
28585           },
28586           {
28587             "group": "Body",
28588             "type": "String",
28589             "allowedValues": [
28590               "\"yes\"",
28591               "\"no\""
28592             ],
28593             "optional": true,
28594             "field": "rfc2833compensate",
28595             "description": ""
28596           },
28597           {
28598             "group": "Body",
28599             "type": "String",
28600             "optional": true,
28601             "field": "mailbox",
28602             "description": ""
28603           },
28604           {
28605             "group": "Body",
28606             "type": "String",
28607             "allowedValues": [
28608               "\"accept\"",
28609               "\"refuse\"",
28610               "\"originate\""
28611             ],
28612             "optional": true,
28613             "field": "session_timers",
28614             "description": ""
28615           },
28616           {
28617             "group": "Body",
28618             "type": "Integer",
28619             "optional": true,
28620             "field": "session_expires",
28621             "description": ""
28622           },
28623           {
28624             "group": "Body",
28625             "type": "Integer",
28626             "optional": true,
28627             "field": "session_minse",
28628             "description": ""
28629           },
28630           {
28631             "group": "Body",
28632             "type": "String",
28633             "allowedValues": [
28634               "\"uac\"",
28635               "\"uas\""
28636             ],
28637             "optional": true,
28638             "field": "session_refresher",
28639             "description": ""
28640           },
28641           {
28642             "group": "Body",
28643             "type": "String",
28644             "optional": true,
28645             "field": "t38pt_usertpsource",
28646             "description": ""
28647           },
28648           {
28649             "group": "Body",
28650             "type": "String",
28651             "optional": true,
28652             "field": "regexten",
28653             "description": ""
28654           },
28655           {
28656             "group": "Body",
28657             "type": "String",
28658             "optional": true,
28659             "field": "fromdomain",
28660             "description": ""
28661           },
28662           {
28663             "group": "Body",
28664             "type": "String",
28665             "optional": true,
28666             "field": "fromuser",
28667             "description": ""
28668           },
28669           {
28670             "group": "Body",
28671             "type": "String",
28672             "allowedValues": [
28673               "\"yes\"",
28674               "\"no\""
28675             ],
28676             "optional": true,
28677             "field": "qualify",
28678             "description": ""
28679           },
28680           {
28681             "group": "Body",
28682             "type": "Integer",
28683             "optional": true,
28684             "field": "keepalive",
28685             "description": ""
28686           },
28687           {
28688             "group": "Body",
28689             "type": "String",
28690             "optional": true,
28691             "field": "defaultip",
28692             "description": ""
28693           },
28694           {
28695             "group": "Body",
28696             "type": "String",
28697             "optional": true,
28698             "field": "defaultuser",
28699             "description": ""
28700           },
28701           {
28702             "group": "Body",
28703             "type": "Integer",
28704             "optional": true,
28705             "field": "rtptimeout",
28706             "description": ""
28707           },
28708           {
28709             "group": "Body",
28710             "type": "Integer",
28711             "optional": true,
28712             "field": "rtpholdtimeout",
28713             "description": ""
28714           },
28715           {
28716             "group": "Body",
28717             "type": "Integer",
28718             "optional": true,
28719             "field": "rtpkeepalive",
28720             "description": ""
28721           },
28722           {
28723             "group": "Body",
28724             "type": "String",
28725             "allowedValues": [
28726               "\"yes\"",
28727               "\"no\""
28728             ],
28729             "optional": true,
28730             "field": "sendrpid",
28731             "description": ""
28732           },
28733           {
28734             "group": "Body",
28735             "type": "String",
28736             "optional": true,
28737             "field": "outboundproxy",
28738             "description": ""
28739           },
28740           {
28741             "group": "Body",
28742             "type": "String",
28743             "optional": true,
28744             "field": "callbackextension",
28745             "description": ""
28746           },
28747           {
28748             "group": "Body",
28749             "type": "Integer",
28750             "optional": true,
28751             "field": "timert1",
28752             "description": ""
28753           },
28754           {
28755             "group": "Body",
28756             "type": "Integer",
28757             "optional": true,
28758             "field": "timerb",
28759             "description": ""
28760           },
28761           {
28762             "group": "Body",
28763             "type": "Integer",
28764             "optional": true,
28765             "field": "qualifyfreq",
28766             "description": ""
28767           },
28768           {
28769             "group": "Body",
28770             "type": "String",
28771             "optional": true,
28772             "field": "contactpermit",
28773             "description": ""
28774           },
28775           {
28776             "group": "Body",
28777             "type": "String",
28778             "optional": true,
28779             "field": "contactdeny",
28780             "description": ""
28781           },
28782           {
28783             "group": "Body",
28784             "type": "String",
28785             "optional": true,
28786             "field": "contactacl",
28787             "description": ""
28788           },
28789           {
28790             "group": "Body",
28791             "type": "String",
28792             "optional": true,
28793             "field": "unsolicited_mailbox",
28794             "description": ""
28795           },
28796           {
28797             "group": "Body",
28798             "type": "String",
28799             "optional": true,
28800             "field": "use_q850_reason",
28801             "description": ""
28802           },
28803           {
28804             "group": "Body",
28805             "type": "Integer",
28806             "optional": true,
28807             "field": "maxforwards",
28808             "description": ""
28809           },
28810           {
28811             "group": "Body",
28812             "type": "String",
28813             "allowedValues": [
28814               "\"yes\"",
28815               "\"no\""
28816             ],
28817             "optional": true,
28818             "field": "encryption",
28819             "description": ""
28820           },
28821           {
28822             "group": "Body",
28823             "type": "String",
28824             "allowedValues": [
28825               "\"yes\"",
28826               "\"no\""
28827             ],
28828             "optional": true,
28829             "field": "avpf",
28830             "description": ""
28831           },
28832           {
28833             "group": "Body",
28834             "type": "String",
28835             "allowedValues": [
28836               "\"yes\"",
28837               "\"no\""
28838             ],
28839             "optional": true,
28840             "field": "force_avp",
28841             "description": ""
28842           },
28843           {
28844             "group": "Body",
28845             "type": "String",
28846             "allowedValues": [
28847               "\"yes\"",
28848               "\"no\""
28849             ],
28850             "optional": true,
28851             "field": "icesupport",
28852             "description": ""
28853           },
28854           {
28855             "group": "Body",
28856             "type": "String",
28857             "allowedValues": [
28858               "\"yes\"",
28859               "\"no\""
28860             ],
28861             "optional": true,
28862             "field": "dtlsenable",
28863             "description": ""
28864           },
28865           {
28866             "group": "Body",
28867             "type": "String",
28868             "allowedValues": [
28869               "\"yes\"",
28870               "\"no\"",
28871               "\"fingerprint\"",
28872               "\"certificate\""
28873             ],
28874             "optional": true,
28875             "field": "dtlsverify",
28876             "description": ""
28877           },
28878           {
28879             "group": "Body",
28880             "type": "Integer",
28881             "optional": true,
28882             "field": "dtlsrekey",
28883             "description": ""
28884           },
28885           {
28886             "group": "Body",
28887             "type": "String",
28888             "optional": true,
28889             "field": "dtlscertfile",
28890             "description": ""
28891           },
28892           {
28893             "group": "Body",
28894             "type": "String",
28895             "optional": true,
28896             "field": "dtlsprivatekey",
28897             "description": ""
28898           },
28899           {
28900             "group": "Body",
28901             "type": "String",
28902             "optional": true,
28903             "field": "dtlscipher",
28904             "description": ""
28905           },
28906           {
28907             "group": "Body",
28908             "type": "String",
28909             "optional": true,
28910             "field": "dtlscafile",
28911             "description": ""
28912           },
28913           {
28914             "group": "Body",
28915             "type": "String",
28916             "optional": true,
28917             "field": "dtlscapath",
28918             "description": ""
28919           },
28920           {
28921             "group": "Body",
28922             "type": "String",
28923             "allowedValues": [
28924               "\"active\"",
28925               "\"passive\"",
28926               "\"actpass\""
28927             ],
28928             "optional": true,
28929             "field": "dtlssetup",
28930             "description": ""
28931           },
28932           {
28933             "group": "Body",
28934             "type": "String",
28935             "optional": true,
28936             "field": "dtlsfingerprint",
28937             "description": ""
28938           },
28939           {
28940             "group": "Body",
28941             "type": "String",
28942             "allowedValues": [
28943               "\"yes\"",
28944               "\"no\""
28945             ],
28946             "optional": true,
28947             "field": "usereqphone",
28948             "description": ""
28949           },
28950           {
28951             "group": "Body",
28952             "type": "String",
28953             "optional": true,
28954             "field": "recordonfeature",
28955             "description": ""
28956           },
28957           {
28958             "group": "Body",
28959             "type": "String",
28960             "optional": true,
28961             "field": "recordofffeature",
28962             "description": ""
28963           },
28964           {
28965             "group": "Body",
28966             "type": "Integer",
28967             "optional": true,
28968             "field": "call_limit",
28969             "description": ""
28970           },
28971           {
28972             "group": "Body",
28973             "type": "String",
28974             "allowedValues": [
28975               "\"yes\"",
28976               "\"no\""
28977             ],
28978             "optional": true,
28979             "field": "registertrying",
28980             "description": ""
28981           },
28982           {
28983             "group": "Body",
28984             "type": "String",
28985             "allowedValues": [
28986               "\"yes\"",
28987               "\"no\""
28988             ],
28989             "optional": true,
28990             "field": "subscribemwi",
28991             "description": ""
28992           },
28993           {
28994             "group": "Body",
28995             "type": "String",
28996             "optional": true,
28997             "field": "vmexten",
28998             "description": ""
28999           },
29000           {
29001             "group": "Body",
29002             "type": "String",
29003             "optional": true,
29004             "field": "mohinterpret",
29005             "description": ""
29006           },
29007           {
29008             "group": "Body",
29009             "type": "String",
29010             "optional": true,
29011             "field": "mohsuggest",
29012             "description": ""
29013           },
29014           {
29015             "group": "Body",
29016             "type": "String",
29017             "optional": true,
29018             "field": "parkinglot",
29019             "description": ""
29020           },
29021           {
29022             "group": "Body",
29023             "type": "String",
29024             "allowedValues": [
29025               "\"yes\"",
29026               "\"no\"",
29027               "\"nonat\"",
29028               "\"update\"",
29029               "\"update,nonat\""
29030             ],
29031             "optional": true,
29032             "field": "canreinvite",
29033             "description": ""
29034           },
29035           {
29036             "group": "Body",
29037             "type": "Boolean",
29038             "optional": true,
29039             "field": "loginInPause",
29040             "description": ""
29041           },
29042           {
29043             "group": "Body",
29044             "type": "String",
29045             "optional": true,
29046             "field": "resetPasswordToken",
29047             "description": ""
29048           },
29049           {
29050             "group": "Body",
29051             "type": "String",
29052             "optional": true,
29053             "field": "resetPasswordExpires",
29054             "description": ""
29055           },
29056           {
29057             "group": "Body",
29058             "type": "Integer",
29059             "optional": true,
29060             "field": "showWebBar",
29061             "description": ""
29062           },
29063           {
29064             "group": "Body",
29065             "type": "Text",
29066             "optional": true,
29067             "field": "permissions",
29068             "description": ""
29069           },
29070           {
29071             "group": "Body",
29072             "type": "String",
29073             "optional": true,
29074             "field": "phoneBarUnconditionalNumber",
29075             "description": ""
29076           },
29077           {
29078             "group": "Body",
29079             "type": "String",
29080             "optional": true,
29081             "field": "phoneBarNoReplyNumber",
29082             "description": ""
29083           },
29084           {
29085             "group": "Body",
29086             "type": "String",
29087             "optional": true,
29088             "field": "phoneBarBusyNumber",
29089             "description": ""
29090           },
29091           {
29092             "group": "Body",
29093             "type": "Boolean",
29094             "optional": true,
29095             "field": "phoneBarUnconditional",
29096             "description": ""
29097           },
29098           {
29099             "group": "Body",
29100             "type": "Boolean",
29101             "optional": true,
29102             "field": "phoneBarNoReply",
29103             "description": ""
29104           },
29105           {
29106             "group": "Body",
29107             "type": "Boolean",
29108             "optional": true,
29109             "field": "phoneBarBusy",
29110             "description": ""
29111           },
29112           {
29113             "group": "Body",
29114             "type": "Boolean",
29115             "optional": true,
29116             "field": "phoneBarDnd",
29117             "description": ""
29118           },
29119           {
29120             "group": "Body",
29121             "type": "Boolean",
29122             "optional": true,
29123             "field": "phoneBarUnansweredCallBadge",
29124             "description": ""
29125           },
29126           {
29127             "group": "Body",
29128             "type": "Boolean",
29129             "optional": true,
29130             "field": "phoneBarEnableDtmfTone",
29131             "description": ""
29132           },
29133           {
29134             "group": "Body",
29135             "type": "Integer",
29136             "optional": true,
29137             "field": "phoneBarAutoAnswerDelay",
29138             "description": ""
29139           },
29140           {
29141             "group": "Body",
29142             "type": "String",
29143             "optional": true,
29144             "field": "extensionMonitor",
29145             "description": ""
29146           },
29147           {
29148             "group": "Body",
29149             "type": "Integer",
29150             "optional": true,
29151             "field": "crudPermissions",
29152             "description": ""
29153           },
29154           {
29155             "group": "Body",
29156             "type": "String",
29157             "allowedValues": [
29158               "\"yes\"",
29159               "\"no\""
29160             ],
29161             "optional": true,
29162             "field": "rtcp_mux",
29163             "description": ""
29164           },
29165           {
29166             "group": "Body",
29167             "type": "Boolean",
29168             "optional": true,
29169             "field": "allowmessenger",
29170             "description": ""
29171           },
29172           {
29173             "group": "Body",
29174             "type": "String",
29175             "optional": true,
29176             "field": "phoneBarOutboundProxy",
29177             "description": ""
29178           },
29179           {
29180             "group": "Body",
29181             "type": "String",
29182             "optional": true,
29183             "field": "passwordResetAt",
29184             "description": ""
29185           },
29186           {
29187             "group": "Body",
29188             "type": "Boolean",
29189             "optional": true,
29190             "field": "phoneBarEnableJaws",
29191             "description": ""
29192           },
29193           {
29194             "group": "Body",
29195             "type": "Boolean",
29196             "optional": true,
29197             "field": "phoneBarEnableScreenRecordingByAgent",
29198             "description": ""
29199           },
29200           {
29201             "group": "Body",
29202             "type": "Virtual",
29203             "optional": true,
29204             "field": "phoneBarEnableVideoRecording",
29205             "description": ""
29206           },
29207           {
29208             "group": "Body",
29209             "type": "Boolean",
29210             "optional": true,
29211             "field": "phoneBarEnableAutomaticScreenRecording",
29212             "description": ""
29213           },
29214           {
29215             "group": "Body",
29216             "type": "Boolean",
29217             "optional": true,
29218             "field": "phoneBarPrefixRequired",
29219             "description": ""
29220           },
29221           {
29222             "group": "Body",
29223             "type": "Boolean",
29224             "optional": true,
29225             "field": "hotdesk",
29226             "description": ""
29227           },
29228           {
29229             "group": "Body",
29230             "type": "String",
29231             "optional": true,
29232             "field": "interface",
29233             "description": ""
29234           },
29235           {
29236             "group": "Body",
29237             "type": "Boolean",
29238             "optional": true,
29239             "field": "privacyEnabled",
29240             "description": ""
29241           },
29242           {
29243             "group": "Body",
29244             "type": "String",
29245             "optional": true,
29246             "field": "apiKeyNonce",
29247             "description": ""
29248           },
29249           {
29250             "group": "Body",
29251             "type": "String",
29252             "optional": true,
29253             "field": "apiKeyIat",
29254             "description": ""
29255           },
29256           {
29257             "group": "Body",
29258             "type": "Boolean",
29259             "optional": true,
29260             "field": "screenrecording",
29261             "description": ""
29262           },
29263           {
29264             "group": "Body",
29265             "type": "Boolean",
29266             "optional": true,
29267             "field": "blocked",
29268             "description": ""
29269           },
29270           {
29271             "group": "Body",
29272             "type": "String",
29273             "optional": true,
29274             "field": "blockedAt",
29275             "description": ""
29276           },
29277           {
29278             "group": "Body",
29279             "type": "Integer",
29280             "optional": true,
29281             "field": "loginAttempts",
29282             "description": ""
29283           },
29284           {
29285             "group": "Body",
29286             "type": "Boolean",
29287             "optional": true,
29288             "field": "disabled",
29289             "description": ""
29290           }
29291         ]
29292       }
29293     },
29294     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29295     "version": "0.0.0",
29296     "filename": "server/api/user/index.js",
29297     "groupTitle": "Users"
29298   },
29299   {
29300     "type": "put",
29301     "url": "/api/users/{id}/password",
29302     "title": "Change user password",
29303     "examples": [
29304       {
29305         "title": "Example usage:",
29306         "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",
29307         "type": "json"
29308       }
29309     ],
29310     "name": "ChangePwd",
29311     "group": "Users",
29312     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29313     "version": "0.0.0",
29314     "filename": "server/api/user/index.js",
29315     "groupTitle": "Users"
29316   },
29317   {
29318     "type": "post",
29319     "url": "/api/users",
29320     "title": "Create a new user",
29321     "examples": [
29322       {
29323         "title": "Example usage:",
29324         "content": "curl https://{domain}/api/users -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29325         "type": "json"
29326       }
29327     ],
29328     "name": "Create",
29329     "group": "Users",
29330     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29331     "version": "0.0.0",
29332     "filename": "server/api/user/index.js",
29333     "groupTitle": "Users"
29334   },
29335   {
29336     "type": "post",
29337     "url": "/api/users/{id}/api_key",
29338     "title": "Create a new API access key for the user",
29339     "examples": [
29340       {
29341         "title": "Example usage:",
29342         "content": "curl https://{domain}/api/users/:id/api_key -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
29343         "type": "json"
29344       }
29345     ],
29346     "name": "CreateApiKey",
29347     "group": "Users",
29348     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29349     "version": "0.0.0",
29350     "filename": "server/api/user/index.js",
29351     "groupTitle": "Users"
29352   },
29353   {
29354     "type": "delete",
29355     "url": "/api/users/{id}",
29356     "title": "Deletes a user",
29357     "examples": [
29358       {
29359         "title": "Example usage:",
29360         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password} -X DELETE",
29361         "type": "json"
29362       }
29363     ],
29364     "name": "Delete",
29365     "group": "Users",
29366     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29367     "version": "0.0.0",
29368     "filename": "server/api/user/index.js",
29369     "groupTitle": "Users"
29370   },
29371   {
29372     "type": "get",
29373     "url": "/api/users/describe",
29374     "title": "Gets table info about Users",
29375     "examples": [
29376       {
29377         "title": "Example usage:",
29378         "content": "curl https://{domain}/api/users/describe -v -u {name}:{password}",
29379         "type": "json"
29380       }
29381     ],
29382     "name": "DescribeUsers",
29383     "group": "Users",
29384     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29385     "version": "0.0.0",
29386     "filename": "server/api/user/index.js",
29387     "groupTitle": "Users"
29388   },
29389   {
29390     "type": "get",
29391     "url": "/api/users/{id}/agents",
29392     "title": "GetAgents",
29393     "examples": [
29394       {
29395         "title": "Example usage:",
29396         "content": "curl https://{domain}/api/users/{id}/agents -v -u {name}:{password} -X GET",
29397         "type": "json"
29398       }
29399     ],
29400     "name": "GetAgents",
29401     "group": "Users",
29402     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29403     "version": "0.0.0",
29404     "filename": "server/api/user/index.js",
29405     "groupTitle": "Users"
29406   },
29407   {
29408     "type": "get",
29409     "url": "/api/users/{id}/api_key",
29410     "title": "Get the API access key for the user",
29411     "examples": [
29412       {
29413         "title": "Example usage:",
29414         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X GET",
29415         "type": "json"
29416       }
29417     ],
29418     "name": "GetApiKey",
29419     "group": "Users",
29420     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29421     "version": "0.0.0",
29422     "filename": "server/api/user/index.js",
29423     "groupTitle": "Users"
29424   },
29425   {
29426     "type": "get",
29427     "url": "/api/users/{id}/groups",
29428     "title": "GetChatGroups",
29429     "examples": [
29430       {
29431         "title": "Example usage:",
29432         "content": "curl https://{domain}/api/users/{id}/groups -v -u {name}:{password} -X GET",
29433         "type": "json"
29434       }
29435     ],
29436     "name": "GetChatGroups",
29437     "group": "Users",
29438     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29439     "version": "0.0.0",
29440     "filename": "server/api/user/index.js",
29441     "groupTitle": "Users"
29442   },
29443   {
29444     "type": "get",
29445     "url": "/api/users/{id}/chat/interactions",
29446     "title": "GetChatInteractions",
29447     "examples": [
29448       {
29449         "title": "Example usage:",
29450         "content": "curl https://{domain}/api/users/{id}/chat/interactions -v -u {name}:{password} -X GET",
29451         "type": "json"
29452       }
29453     ],
29454     "name": "GetChatInteractions",
29455     "group": "Users",
29456     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29457     "version": "0.0.0",
29458     "filename": "server/api/user/index.js",
29459     "groupTitle": "Users"
29460   },
29461   {
29462     "type": "get",
29463     "url": "/api/users/{id}/chat_websites",
29464     "title": "GetChatWebsites",
29465     "examples": [
29466       {
29467         "title": "Example usage:",
29468         "content": "curl https://{domain}/api/users/{id}/chat_websites -v -u {name}:{password} -X GET",
29469         "type": "json"
29470       }
29471     ],
29472     "name": "GetChatWebsites",
29473     "group": "Users",
29474     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29475     "version": "0.0.0",
29476     "filename": "server/api/user/index.js",
29477     "groupTitle": "Users"
29478   },
29479   {
29480     "type": "get",
29481     "url": "/api/users/{id}/contacts",
29482     "title": "GetContacts",
29483     "examples": [
29484       {
29485         "title": "Example usage:",
29486         "content": "curl https://{domain}/api/users/{id}/contacts -v -u {name}:{password} -X GET",
29487         "type": "json"
29488       }
29489     ],
29490     "name": "GetContacts",
29491     "group": "Users",
29492     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29493     "version": "0.0.0",
29494     "filename": "server/api/user/index.js",
29495     "groupTitle": "Users"
29496   },
29497   {
29498     "type": "get",
29499     "url": "/api/users/{id}/fax_accounts",
29500     "title": "GetFaxAccounts",
29501     "examples": [
29502       {
29503         "title": "Example usage:",
29504         "content": "curl https://{domain}/api/users/{id}/fax_accounts -v -u {name}:{password} -X GET",
29505         "type": "json"
29506       }
29507     ],
29508     "name": "GetFaxAccounts",
29509     "group": "Users",
29510     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29511     "version": "0.0.0",
29512     "filename": "server/api/user/index.js",
29513     "groupTitle": "Users"
29514   },
29515   {
29516     "type": "get",
29517     "url": "/api/users/{id}/fax/interactions",
29518     "title": "GetFaxInteractions",
29519     "examples": [
29520       {
29521         "title": "Example usage:",
29522         "content": "curl https://{domain}/api/users/{id}/fax/interactions -v -u {name}:{password} -X GET",
29523         "type": "json"
29524       }
29525     ],
29526     "name": "GetFaxInteractions",
29527     "group": "Users",
29528     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29529     "version": "0.0.0",
29530     "filename": "server/api/user/index.js",
29531     "groupTitle": "Users"
29532   },
29533   {
29534     "type": "get",
29535     "url": "/api/users/{id}/lists",
29536     "title": "GetLists",
29537     "examples": [
29538       {
29539         "title": "Example usage:",
29540         "content": "curl https://{domain}/api/users/{id}/lists -v -u {name}:{password} -X GET",
29541         "type": "json"
29542       }
29543     ],
29544     "name": "GetLists",
29545     "group": "Users",
29546     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29547     "version": "0.0.0",
29548     "filename": "server/api/user/index.js",
29549     "groupTitle": "Users"
29550   },
29551   {
29552     "type": "get",
29553     "url": "/api/users/{id}/mail_accounts",
29554     "title": "GetMailAccounts",
29555     "examples": [
29556       {
29557         "title": "Example usage:",
29558         "content": "curl https://{domain}/api/users/{id}/mail_accounts -v -u {name}:{password} -X GET",
29559         "type": "json"
29560       }
29561     ],
29562     "name": "GetMailAccounts",
29563     "group": "Users",
29564     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29565     "version": "0.0.0",
29566     "filename": "server/api/user/index.js",
29567     "groupTitle": "Users"
29568   },
29569   {
29570     "type": "get",
29571     "url": "/api/users/{id}/mail/interactions",
29572     "title": "GetMailInteractions",
29573     "examples": [
29574       {
29575         "title": "Example usage:",
29576         "content": "curl https://{domain}/api/users/{id}/mail/interactions -v -u {name}:{password} -X GET",
29577         "type": "json"
29578       }
29579     ],
29580     "name": "GetMailInteractions",
29581     "group": "Users",
29582     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29583     "version": "0.0.0",
29584     "filename": "server/api/user/index.js",
29585     "groupTitle": "Users"
29586   },
29587   {
29588     "type": "get",
29589     "url": "/api/users/{id}/openchannel_accounts",
29590     "title": "GetOpenchannelAccounts",
29591     "examples": [
29592       {
29593         "title": "Example usage:",
29594         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts -v -u {name}:{password} -X GET",
29595         "type": "json"
29596       }
29597     ],
29598     "name": "GetOpenchannelAccounts",
29599     "group": "Users",
29600     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29601     "version": "0.0.0",
29602     "filename": "server/api/user/index.js",
29603     "groupTitle": "Users"
29604   },
29605   {
29606     "type": "get",
29607     "url": "/api/users/{id}/openchannel/interactions",
29608     "title": "GetOpenchannelInteractions",
29609     "examples": [
29610       {
29611         "title": "Example usage:",
29612         "content": "curl https://{domain}/api/users/{id}/openchannel/interactions -v -u {name}:{password}",
29613         "type": "json"
29614       }
29615     ],
29616     "name": "GetOpenchannelInteractions",
29617     "group": "Users",
29618     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29619     "version": "0.0.0",
29620     "filename": "server/api/user/index.js",
29621     "groupTitle": "Users"
29622   },
29623   {
29624     "type": "get",
29625     "url": "/api/users/{id}/prefixes",
29626     "title": "GetPrefixes",
29627     "examples": [
29628       {
29629         "title": "Example usage:",
29630         "content": "curl https://{domain}/api/users/{id}/prefixes -v -u {name}:{password} -X GET",
29631         "type": "json"
29632       }
29633     ],
29634     "name": "GetPrefixes",
29635     "group": "Users",
29636     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29637     "version": "0.0.0",
29638     "filename": "server/api/user/index.js",
29639     "groupTitle": "Users"
29640   },
29641   {
29642     "type": "get",
29643     "url": "/api/users/{id}/queues?channel={channel}",
29644     "title": "Gets Queues list",
29645     "examples": [
29646       {
29647         "title": "Example usage:",
29648         "content": "curl https://{domain}/api/users/{id}/queues/?channel={channel} -v -u {name}:{password} -X GET",
29649         "type": "json"
29650       }
29651     ],
29652     "name": "GetQueues",
29653     "group": "Users",
29654     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29655     "version": "0.0.0",
29656     "filename": "server/api/user/index.js",
29657     "groupTitle": "Users"
29658   },
29659   {
29660     "type": "get",
29661     "url": "/api/users/{id}/recordings",
29662     "title": "GetRecordings",
29663     "examples": [
29664       {
29665         "title": "Example usage:",
29666         "content": "curl https://{domain}/api/users/{id}/recordings -v -u {name}:{password} -X GET",
29667         "type": "json"
29668       }
29669     ],
29670     "name": "GetRecordings",
29671     "group": "Users",
29672     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29673     "version": "0.0.0",
29674     "filename": "server/api/user/index.js",
29675     "groupTitle": "Users"
29676   },
29677   {
29678     "type": "get",
29679     "url": "/api/users/{id}/scheduled_calls",
29680     "title": "GetScheduledCalls",
29681     "examples": [
29682       {
29683         "title": "Example usage:",
29684         "content": "curl https://{domain}/api/users/{id}/scheduled_calls -v -u {name}:{password} -X GET",
29685         "type": "json"
29686       }
29687     ],
29688     "name": "GetScheduledCalls",
29689     "group": "Users",
29690     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29691     "version": "0.0.0",
29692     "filename": "server/api/user/index.js",
29693     "groupTitle": "Users"
29694   },
29695   {
29696     "type": "get",
29697     "url": "/api/users/{id}/screen_recordings",
29698     "title": "GetScreenRecordings",
29699     "examples": [
29700       {
29701         "title": "Example usage:",
29702         "content": "curl https://{domain}/api/users/{id}/screen_recordings -v -u {name}:{password} -X GET",
29703         "type": "json"
29704       }
29705     ],
29706     "name": "GetScreenRecordings",
29707     "group": "Users",
29708     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29709     "version": "0.0.0",
29710     "filename": "server/api/user/index.js",
29711     "groupTitle": "Users"
29712   },
29713   {
29714     "type": "get",
29715     "url": "/api/users/{id}/sms_accounts",
29716     "title": "GetSmsAccounts",
29717     "examples": [
29718       {
29719         "title": "Example usage:",
29720         "content": "curl https://{domain}/api/users/{id}/sms_accounts -v -u {name}:{password} -X GET",
29721         "type": "json"
29722       }
29723     ],
29724     "name": "GetSmsAccounts",
29725     "group": "Users",
29726     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29727     "version": "0.0.0",
29728     "filename": "server/api/user/index.js",
29729     "groupTitle": "Users"
29730   },
29731   {
29732     "type": "get",
29733     "url": "/api/users/{id}/sms/interactions",
29734     "title": "GetSmsInteractions",
29735     "examples": [
29736       {
29737         "title": "Example usage:",
29738         "content": "curl https://{domain}/api/users/{id}/sms/interactions -v -u {name}:{password} -X GET",
29739         "type": "json"
29740       }
29741     ],
29742     "name": "GetSmsInteractions",
29743     "group": "Users",
29744     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29745     "version": "0.0.0",
29746     "filename": "server/api/user/index.js",
29747     "groupTitle": "Users"
29748   },
29749   {
29750     "type": "get",
29751     "url": "/api/users/{id}/square_projects",
29752     "title": "GetSquareProjects",
29753     "examples": [
29754       {
29755         "title": "Example usage:",
29756         "content": "curl https://{domain}/api/users/{id}/square_projects -v -u {name}:{password} -X GET",
29757         "type": "json"
29758       }
29759     ],
29760     "name": "GetSquareProjects",
29761     "group": "Users",
29762     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29763     "version": "0.0.0",
29764     "filename": "server/api/user/index.js",
29765     "groupTitle": "Users"
29766   },
29767   {
29768     "type": "get",
29769     "url": "/api/users/{id}/teams",
29770     "title": "GetTeams",
29771     "examples": [
29772       {
29773         "title": "Example usage:",
29774         "content": "curl https://{domain}/api/users/{id}/teams -v -u {name}:{password} -X GET",
29775         "type": "json"
29776       }
29777     ],
29778     "name": "GetTeams",
29779     "group": "Users",
29780     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29781     "version": "0.0.0",
29782     "filename": "server/api/user/index.js",
29783     "groupTitle": "Users"
29784   },
29785   {
29786     "type": "get",
29787     "url": "/api/users",
29788     "title": "Gets a list of Users",
29789     "examples": [
29790       {
29791         "title": "Example usage:",
29792         "content": "curl https://{domain}/api/users -v -u {name}:{password}",
29793         "type": "json"
29794       }
29795     ],
29796     "name": "GetUsers",
29797     "group": "Users",
29798     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
29799     "version": "0.0.0",
29800     "filename": "server/api/user/index.js",
29801     "groupTitle": "Users"
29802   },
29803   {
29804     "type": "get",
29805     "url": "/api/users/{id}/queues_rt",
29806     "title": "GetVoiceQueuesRt",
29807     "examples": [
29808       {
29809         "title": "Example usage:",
29810         "content": "curl https://{domain}/api/users/{id}/queues_rt -v -u {name}:{password} -X GET",
29811         "type": "json"
29812       }
29813     ],
29814     "name": "GetVoiceQueuesRt",
29815     "group": "Users",
29816     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29817     "version": "0.0.0",
29818     "filename": "server/api/user/index.js",
29819     "groupTitle": "Users"
29820   },
29821   {
29822     "type": "post",
29823     "url": "/api/users/{id}/login",
29824     "title": "Login",
29825     "examples": [
29826       {
29827         "title": "Example usage:",
29828         "content": "curl https://{domain}/api/users/{id}/login  -v -u {name}:{password} -X POST",
29829         "type": "json"
29830       }
29831     ],
29832     "name": "Login",
29833     "group": "Users",
29834     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29835     "version": "0.0.0",
29836     "filename": "server/api/user/index.js",
29837     "groupTitle": "Users"
29838   },
29839   {
29840     "type": "post",
29841     "url": "/api/users/{id}/logout",
29842     "title": "Logout",
29843     "examples": [
29844       {
29845         "title": "Example usage:",
29846         "content": "curl https://{domain}/api/users/{id}/logout -v -u {name}:{password} -X POST",
29847         "type": "json"
29848       }
29849     ],
29850     "name": "Logout",
29851     "group": "Users",
29852     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29853     "version": "0.0.0",
29854     "filename": "server/api/user/index.js",
29855     "groupTitle": "Users"
29856   },
29857   {
29858     "type": "post",
29859     "url": "/api/users/{id}/pause",
29860     "title": "Pause",
29861     "examples": [
29862       {
29863         "title": "Example usage:",
29864         "content": "curl https://{domain}/api/users/{id}/pause -v -u {name}:{password} -X POST",
29865         "type": "json"
29866       }
29867     ],
29868     "name": "Pause",
29869     "group": "Users",
29870     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29871     "version": "0.0.0",
29872     "filename": "server/api/user/index.js",
29873     "groupTitle": "Users"
29874   },
29875   {
29876     "type": "delete",
29877     "url": "/api/users/{id}/api_key",
29878     "title": "Remove API access key for the user",
29879     "examples": [
29880       {
29881         "title": "Example usage:",
29882         "content": "curl https://{domain}/api/users/:id/api_key -v -u {name}:{password} -X DELETE",
29883         "type": "json"
29884       }
29885     ],
29886     "name": "RemoveApiKey",
29887     "group": "Users",
29888     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29889     "version": "0.0.0",
29890     "filename": "server/api/user/index.js",
29891     "groupTitle": "Users"
29892   },
29893   {
29894     "type": "delete",
29895     "url": "/api/users/{id}/chat_interactions",
29896     "title": "Removes interactions from an agent",
29897     "examples": [
29898       {
29899         "title": "Example usage:",
29900         "content": "curl https://{domain}/api/users/{id}/chat_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29901         "type": "json"
29902       }
29903     ],
29904     "name": "RemoveChatInteractions",
29905     "group": "Users",
29906     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29907     "version": "0.0.0",
29908     "filename": "server/api/user/index.js",
29909     "groupTitle": "Users"
29910   },
29911   {
29912     "type": "delete",
29913     "url": "/api/users/{id}/chat_websites",
29914     "title": "Removes a Chat Website from a user",
29915     "examples": [
29916       {
29917         "title": "Example usage:",
29918         "content": "curl https://{domain}/api/users/{id}/chat_websites?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29919         "type": "json"
29920       }
29921     ],
29922     "name": "RemoveChatWebsites",
29923     "group": "Users",
29924     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29925     "version": "0.0.0",
29926     "filename": "server/api/user/index.js",
29927     "groupTitle": "Users"
29928   },
29929   {
29930     "type": "delete",
29931     "url": "/api/users/{id}/fax_accounts",
29932     "title": "Removes a Fax Account from a user",
29933     "examples": [
29934       {
29935         "title": "Example usage:",
29936         "content": "curl https://{domain}/api/users/{id}/fax_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29937         "type": "json"
29938       }
29939     ],
29940     "name": "RemoveFaxAccounts",
29941     "group": "Users",
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/user/index.js",
29945     "groupTitle": "Users"
29946   },
29947   {
29948     "type": "delete",
29949     "url": "/api/users/{id}/fax_interactions",
29950     "title": "Removes interactions from an agent",
29951     "examples": [
29952       {
29953         "title": "Example usage:",
29954         "content": "curl https://{domain}/api/users/{id}/fax_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29955         "type": "json"
29956       }
29957     ],
29958     "name": "RemoveFaxInteractions",
29959     "group": "Users",
29960     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
29961     "version": "0.0.0",
29962     "filename": "server/api/user/index.js",
29963     "groupTitle": "Users"
29964   },
29965   {
29966     "type": "delete",
29967     "url": "/api/users/{id}/mail_accounts",
29968     "title": "Removes a Mail Account from a user",
29969     "examples": [
29970       {
29971         "title": "Example usage:",
29972         "content": "curl https://{domain}/api/users/{id}/mail_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29973         "type": "json"
29974       }
29975     ],
29976     "name": "RemoveMailAccounts",
29977     "group": "Users",
29978     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/user/index.js",
29981     "groupTitle": "Users"
29982   },
29983   {
29984     "type": "delete",
29985     "url": "/api/users/{id}/mail_interactions",
29986     "title": "Removes interactions from an agent",
29987     "examples": [
29988       {
29989         "title": "Example usage:",
29990         "content": "curl https://{domain}/api/users/{id}/mail_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
29991         "type": "json"
29992       }
29993     ],
29994     "name": "RemoveMailInteractions",
29995     "group": "Users",
29996     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <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/user/index.js",
29999     "groupTitle": "Users"
30000   },
30001   {
30002     "type": "delete",
30003     "url": "/api/users/{id}/openchannel_accounts",
30004     "title": "Removes a Open Channel Account from a user",
30005     "examples": [
30006       {
30007         "title": "Example usage:",
30008         "content": "curl https://{domain}/api/users/{id}/openchannel_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30009         "type": "json"
30010       }
30011     ],
30012     "name": "RemoveOpenchannelAccounts",
30013     "group": "Users",
30014     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30015     "version": "0.0.0",
30016     "filename": "server/api/user/index.js",
30017     "groupTitle": "Users"
30018   },
30019   {
30020     "type": "delete",
30021     "url": "/api/users/{id}/openchannel_interactions",
30022     "title": "Removes openchannel interactions from an agent",
30023     "examples": [
30024       {
30025         "title": "Example usage:",
30026         "content": "curl https://{domain}/api/users/{id}/openchannel_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30027         "type": "json"
30028       }
30029     ],
30030     "name": "RemoveOpenchannelInteractions",
30031     "group": "Users",
30032     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30033     "version": "0.0.0",
30034     "filename": "server/api/user/index.js",
30035     "groupTitle": "Users"
30036   },
30037   {
30038     "type": "delete",
30039     "url": "/api/users/{id}/queues",
30040     "title": "Remove queues to an agent",
30041     "examples": [
30042       {
30043         "title": "Example usage:",
30044         "content": "curl https://{domain}/api/users/{id}/queues?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30045         "type": "json"
30046       }
30047     ],
30048     "name": "RemoveQueues",
30049     "group": "Users",
30050     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30051     "version": "0.0.0",
30052     "filename": "server/api/user/index.js",
30053     "groupTitle": "Users"
30054   },
30055   {
30056     "type": "delete",
30057     "url": "/api/users/{id}/sms_accounts",
30058     "title": "Removes a Sms Account from a user",
30059     "examples": [
30060       {
30061         "title": "Example usage:",
30062         "content": "curl https://{domain}/api/users/{id}/sms_accounts?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30063         "type": "json"
30064       }
30065     ],
30066     "name": "RemoveSmsAccounts",
30067     "group": "Users",
30068     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30069     "version": "0.0.0",
30070     "filename": "server/api/user/index.js",
30071     "groupTitle": "Users"
30072   },
30073   {
30074     "type": "delete",
30075     "url": "/api/users/{id}/sms_interactions",
30076     "title": "Removes interactions from an agent",
30077     "examples": [
30078       {
30079         "title": "Example usage:",
30080         "content": "curl https://{domain}/api/users/{id}/sms_interactions?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30081         "type": "json"
30082       }
30083     ],
30084     "name": "RemoveSmsInteractions",
30085     "group": "Users",
30086     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30087     "version": "0.0.0",
30088     "filename": "server/api/user/index.js",
30089     "groupTitle": "Users"
30090   },
30091   {
30092     "type": "delete",
30093     "url": "/api/users/{id}/square_projects",
30094     "title": "Removes a Square Project from a user",
30095     "examples": [
30096       {
30097         "title": "Example usage:",
30098         "content": "curl https://{domain}/api/users/{id}/square_projects?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30099         "type": "json"
30100       }
30101     ],
30102     "name": "RemoveSquareProjects",
30103     "group": "Users",
30104     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30105     "version": "0.0.0",
30106     "filename": "server/api/user/index.js",
30107     "groupTitle": "Users"
30108   },
30109   {
30110     "type": "delete",
30111     "url": "/api/users/{id}/teams",
30112     "title": "Removes teams from an agent",
30113     "examples": [
30114       {
30115         "title": "Example usage:",
30116         "content": "curl https://{domain}/api/users/{id}/teams?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
30117         "type": "json"
30118       }
30119     ],
30120     "name": "RemoveTeams",
30121     "group": "Users",
30122     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30123     "version": "0.0.0",
30124     "filename": "server/api/user/index.js",
30125     "groupTitle": "Users"
30126   },
30127   {
30128     "type": "get",
30129     "url": "/api/users/{id}",
30130     "title": "Gets a single User",
30131     "examples": [
30132       {
30133         "title": "Example usage:",
30134         "content": "curl https://{domain}/api/users/{id} -v -u {name}:{password}",
30135         "type": "json"
30136       }
30137     ],
30138     "name": "ShowUsers",
30139     "group": "Users",
30140     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30141     "version": "0.0.0",
30142     "filename": "server/api/user/index.js",
30143     "groupTitle": "Users"
30144   },
30145   {
30146     "type": "post",
30147     "url": "/api/users/{id}/unpause",
30148     "title": "Unpause",
30149     "examples": [
30150       {
30151         "title": "Example usage:",
30152         "content": "curl https://{domain}/api/users/{id}/unpause -v -u {name}:{password} -X POST",
30153         "type": "json"
30154       }
30155     ],
30156     "name": "Unpause",
30157     "group": "Users",
30158     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30159     "version": "0.0.0",
30160     "filename": "server/api/user/index.js",
30161     "groupTitle": "Users"
30162   },
30163   {
30164     "type": "get",
30165     "url": "/api/users/whoami",
30166     "title": "WhoAmI",
30167     "examples": [
30168       {
30169         "title": "Example usage:",
30170         "content": "curl https://{domain}/api/users/whoami -v -u {name}:{password} -X GET",
30171         "type": "json"
30172       }
30173     ],
30174     "name": "WhoAmI",
30175     "group": "Users",
30176     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30177     "version": "0.0.0",
30178     "filename": "server/api/user/index.js",
30179     "groupTitle": "Users"
30180   },
30181   {
30182     "type": "post",
30183     "url": "/api/users/{id}/avatar",
30184     "title": "Add avatar",
30185     "examples": [
30186       {
30187         "title": "Example usage:",
30188         "content": "curl https://{domain}/api/users/{id}/avatar -H 'Content-Type: multipart/form-data' -F 'file=@{filename}' -v -u {name}:{password} -X POST",
30189         "type": "json"
30190       }
30191     ],
30192     "name": "addAvatar",
30193     "group": "Users",
30194     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30195     "version": "0.0.0",
30196     "filename": "server/api/user/index.js",
30197     "groupTitle": "Users"
30198   },
30199   {
30200     "type": "get",
30201     "url": "/api/users/{id}/avatar",
30202     "title": "Get avatar",
30203     "examples": [
30204       {
30205         "title": "Example usage:",
30206         "content": "curl https://{domain}/api/users/{id}/avatar -v -u {name}:{password} -X GET",
30207         "type": "json"
30208       }
30209     ],
30210     "name": "getAvatar",
30211     "group": "Users",
30212     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30213     "version": "0.0.0",
30214     "filename": "server/api/user/index.js",
30215     "groupTitle": "Users"
30216   },
30217   {
30218     "type": "put",
30219     "url": "/api/users/{id}",
30220     "title": "Update an existing User",
30221     "examples": [
30222       {
30223         "title": "Example usage:",
30224         "content": "curl https://{domain}/api/users/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30225         "type": "json"
30226       }
30227     ],
30228     "name": "updateUsers",
30229     "group": "Users",
30230     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30231     "version": "0.0.0",
30232     "filename": "server/api/user/index.js",
30233     "groupTitle": "Users"
30234   },
30235   {
30236     "type": "post",
30237     "url": "/api/variables",
30238     "title": "Creates a new Variable",
30239     "examples": [
30240       {
30241         "title": "Example usage:",
30242         "content": "curl https://{domain}/api/variables -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30243         "type": "json"
30244       }
30245     ],
30246     "name": "CreateVariables",
30247     "group": "Variables",
30248     "parameter": {
30249       "fields": {
30250         "Body": [
30251           {
30252             "group": "Body",
30253             "type": "String",
30254             "optional": false,
30255             "field": "name",
30256             "description": ""
30257           },
30258           {
30259             "group": "Body",
30260             "type": "String",
30261             "optional": true,
30262             "field": "description",
30263             "description": ""
30264           }
30265         ]
30266       }
30267     },
30268     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30269     "version": "0.0.0",
30270     "filename": "server/api/variable/index.js",
30271     "groupTitle": "Variables"
30272   },
30273   {
30274     "type": "delete",
30275     "url": "/api/variables/{id}",
30276     "title": "Deletes a Variable",
30277     "examples": [
30278       {
30279         "title": "Example usage:",
30280         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password} -X DELETE",
30281         "type": "json"
30282       }
30283     ],
30284     "name": "DeleteVariables",
30285     "group": "Variables",
30286     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30287     "version": "0.0.0",
30288     "filename": "server/api/variable/index.js",
30289     "groupTitle": "Variables"
30290   },
30291   {
30292     "type": "get",
30293     "url": "/api/variables",
30294     "title": "Gets a list of Variables",
30295     "examples": [
30296       {
30297         "title": "Example usage:",
30298         "content": "curl https://{domain}/api/variables -v -u {name}:{password}",
30299         "type": "json"
30300       }
30301     ],
30302     "name": "GetVariables",
30303     "group": "Variables",
30304     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30305     "version": "0.0.0",
30306     "filename": "server/api/variable/index.js",
30307     "groupTitle": "Variables"
30308   },
30309   {
30310     "type": "get",
30311     "url": "/api/variables/{id}",
30312     "title": "Gets a single Variable",
30313     "examples": [
30314       {
30315         "title": "Example usage:",
30316         "content": "curl https://{domain}/api/variables/{id} -v -u {name}:{password}",
30317         "type": "json"
30318       }
30319     ],
30320     "name": "ShowVariables",
30321     "group": "Variables",
30322     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30323     "version": "0.0.0",
30324     "filename": "server/api/variable/index.js",
30325     "groupTitle": "Variables"
30326   },
30327   {
30328     "type": "put",
30329     "url": "/api/variables/{id}",
30330     "title": "Update an existing Variable",
30331     "examples": [
30332       {
30333         "title": "Example usage:",
30334         "content": "curl https://{domain}/api/variables/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
30335         "type": "json"
30336       }
30337     ],
30338     "name": "updateVariables",
30339     "group": "Variables",
30340     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30341     "version": "0.0.0",
30342     "filename": "server/api/variable/index.js",
30343     "groupTitle": "Variables"
30344   },
30345   {
30346     "type": "get",
30347     "url": "/api/version/fetch",
30348     "title": "Fetch git version",
30349     "examples": [
30350       {
30351         "title": "Example usage:",
30352         "content": "curl https://{domain}/api/version/fetch -v -u {name}:{password}",
30353         "type": "json"
30354       }
30355     ],
30356     "name": "FetchVersion",
30357     "group": "Version",
30358     "description": "<p>Motion run the following command: git fetch origin master</p>",
30359     "version": "0.0.0",
30360     "filename": "server/api/version/index.js",
30361     "groupTitle": "Version"
30362   },
30363   {
30364     "type": "get",
30365     "url": "/api/version",
30366     "title": "Gets version",
30367     "examples": [
30368       {
30369         "title": "Example usage:",
30370         "content": "curl https://{domain}/api/version -v -u {name}:{password}",
30371         "type": "json"
30372       }
30373     ],
30374     "name": "GetVersion",
30375     "group": "Version",
30376     "description": "<p>Motion returns the current and latest motion version.</p>",
30377     "version": "0.0.0",
30378     "filename": "server/api/version/index.js",
30379     "groupTitle": "Version"
30380   },
30381   {
30382     "type": "get",
30383     "url": "/api/version/migrations",
30384     "title": "Launch database migrations",
30385     "examples": [
30386       {
30387         "title": "Example usage:",
30388         "content": "curl https://{domain}/api/version/migrations -v -u {name}:{password}",
30389         "type": "json"
30390       }
30391     ],
30392     "name": "MigrateVersion",
30393     "group": "Version",
30394     "description": "<p>Motion launch the database migrations, according to the application version</p>",
30395     "version": "0.0.0",
30396     "filename": "server/api/version/index.js",
30397     "groupTitle": "Version"
30398   },
30399   {
30400     "type": "get",
30401     "url": "/api/version/pull",
30402     "title": "Pull git version",
30403     "examples": [
30404       {
30405         "title": "Example usage:",
30406         "content": "curl https://{domain}/api/version/pull -v -u {name}:{password}",
30407         "type": "json"
30408       }
30409     ],
30410     "name": "PullVersion",
30411     "group": "Version",
30412     "description": "<p>Motion run the following command: git pull</p>",
30413     "version": "0.0.0",
30414     "filename": "server/api/version/index.js",
30415     "groupTitle": "Version"
30416   },
30417   {
30418     "type": "get",
30419     "url": "/api/version/reset",
30420     "title": "Reset git version",
30421     "examples": [
30422       {
30423         "title": "Example usage:",
30424         "content": "curl https://{domain}/api/version/reset -v -u {name}:{password}",
30425         "type": "json"
30426       }
30427     ],
30428     "name": "ResetVersion",
30429     "group": "Version",
30430     "description": "<p>Motion run the following command: git reset --hard FETCH_HEAD</p>",
30431     "version": "0.0.0",
30432     "filename": "server/api/version/index.js",
30433     "groupTitle": "Version"
30434   },
30435   {
30436     "type": "get",
30437     "url": "/api/version/restart",
30438     "title": "Restart motion2 after update",
30439     "examples": [
30440       {
30441         "title": "Example usage:",
30442         "content": "curl https://{domain}/api/version/restart -v -u {name}:{password}",
30443         "type": "json"
30444       }
30445     ],
30446     "name": "RestartVersion",
30447     "group": "Version",
30448     "description": "<p>Motion run the following command: pm2 restart motion</p>",
30449     "version": "0.0.0",
30450     "filename": "server/api/version/index.js",
30451     "groupTitle": "Version"
30452   },
30453   {
30454     "type": "get",
30455     "url": "/api/voice/agents/reports/describe",
30456     "title": "Gets table info about Agent Reports",
30457     "examples": [
30458       {
30459         "title": "Example usage:",
30460         "content": "curl https://{domain}/api/voice/agents/reports/describe -v -u {name}:{password}",
30461         "type": "json"
30462       }
30463     ],
30464     "name": "DescribeAgent_Reports",
30465     "group": "Voice_Agent_Reports",
30466     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30467     "version": "0.0.0",
30468     "filename": "server/api/voiceAgentReport/index.js",
30469     "groupTitle": "Voice_Agent_Reports"
30470   },
30471   {
30472     "type": "get",
30473     "url": "/api/voice/agents/reports",
30474     "title": "Gets a list of Agent Reports",
30475     "examples": [
30476       {
30477         "title": "Example usage:",
30478         "content": "curl https://{domain}/api/voice/agents/reports -v -u {name}:{password}",
30479         "type": "json"
30480       }
30481     ],
30482     "name": "GetAgent_Reports",
30483     "group": "Voice_Agent_Reports",
30484     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>A call returning only <code>id</code> and <code>name</code> for a result set would look like this.</p> <p><code>GET /api/voice/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>",
30485     "version": "0.0.0",
30486     "filename": "server/api/voiceAgentReport/index.js",
30487     "groupTitle": "Voice_Agent_Reports"
30488   },
30489   {
30490     "type": "get",
30491     "url": "/api/voice/agents/reports/{id}",
30492     "title": "Gets a single Agent Report",
30493     "examples": [
30494       {
30495         "title": "Example usage:",
30496         "content": "curl https://{domain}/api/voice/agents/reports/{id} -v -u {name}:{password}",
30497         "type": "json"
30498       }
30499     ],
30500     "name": "ShowAgent_Reports",
30501     "group": "Voice_Agent_Reports",
30502     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30503     "version": "0.0.0",
30504     "filename": "server/api/voiceAgentReport/index.js",
30505     "groupTitle": "Voice_Agent_Reports"
30506   },
30507   {
30508     "type": "get",
30509     "url": "/api/voice/calls/reports/describe",
30510     "title": "Gets table info about Call Reports",
30511     "examples": [
30512       {
30513         "title": "Example usage:",
30514         "content": "curl https://{domain}/api/voice/calls/reports/describe -v -u {name}:{password}",
30515         "type": "json"
30516       }
30517     ],
30518     "name": "DescribeCall_Reports",
30519     "group": "Voice_Call_Reports",
30520     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30521     "version": "0.0.0",
30522     "filename": "server/api/voiceCallReport/index.js",
30523     "groupTitle": "Voice_Call_Reports"
30524   },
30525   {
30526     "type": "get",
30527     "url": "/api/voice/calls/reports",
30528     "title": "Gets a list of Call Reports",
30529     "examples": [
30530       {
30531         "title": "Example usage:",
30532         "content": "curl https://{domain}/api/voice/calls/reports -v -u {name}:{password}",
30533         "type": "json"
30534       }
30535     ],
30536     "name": "GetCall_Reports",
30537     "group": "Voice_Call_Reports",
30538     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30539     "version": "0.0.0",
30540     "filename": "server/api/voiceCallReport/index.js",
30541     "groupTitle": "Voice_Call_Reports"
30542   },
30543   {
30544     "type": "get",
30545     "url": "/api/voice/calls/reports/{id}",
30546     "title": "Gets a single Call Report",
30547     "examples": [
30548       {
30549         "title": "Example usage:",
30550         "content": "curl https://{domain}/api/voice/calls/reports/{id} -v -u {name}:{password}",
30551         "type": "json"
30552       }
30553     ],
30554     "name": "ShowCall_Reports",
30555     "group": "Voice_Call_Reports",
30556     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30557     "version": "0.0.0",
30558     "filename": "server/api/voiceCallReport/index.js",
30559     "groupTitle": "Voice_Call_Reports"
30560   },
30561   {
30562     "type": "put",
30563     "url": "/api/voice/calls/reports/{id}",
30564     "title": "Update a single cdr",
30565     "examples": [
30566       {
30567         "title": "Example usage:",
30568         "content": "curl https://{domain}/api/voice/calls/reports/{id} -d '{\"userDispositio\": \"OK\"}' -v -u {name}:{password} -X PUT",
30569         "type": "json"
30570       }
30571     ],
30572     "name": "update",
30573     "group": "Voice_Call_Reports",
30574     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30575     "version": "0.0.0",
30576     "filename": "server/api/voiceCallReport/index.js",
30577     "groupTitle": "Voice_Call_Reports"
30578   },
30579   {
30580     "type": "post",
30581     "url": "/api/voice/chanspy",
30582     "title": "Creates a new ChanSpy",
30583     "examples": [
30584       {
30585         "title": "Example usage:",
30586         "content": "curl https://{domain}/api/voice/chanspy -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
30587         "type": "json"
30588       }
30589     ],
30590     "name": "CreateChanSpy",
30591     "group": "Voice_ChanSpy",
30592     "parameter": {
30593       "fields": {
30594         "Body": [
30595           {
30596             "group": "Body",
30597             "type": "String",
30598             "optional": true,
30599             "field": "name",
30600             "description": ""
30601           },
30602           {
30603             "group": "Body",
30604             "type": "String",
30605             "optional": false,
30606             "field": "prefix",
30607             "description": ""
30608           },
30609           {
30610             "group": "Body",
30611             "type": "String",
30612             "optional": true,
30613             "field": "options",
30614             "description": ""
30615           },
30616           {
30617             "group": "Body",
30618             "type": "Boolean",
30619             "optional": true,
30620             "field": "auth",
30621             "description": ""
30622           },
30623           {
30624             "group": "Body",
30625             "type": "String",
30626             "optional": true,
30627             "field": "password",
30628             "description": ""
30629           },
30630           {
30631             "group": "Body",
30632             "type": "Boolean",
30633             "optional": true,
30634             "field": "record",
30635             "description": ""
30636           },
30637           {
30638             "group": "Body",
30639             "type": "String",
30640             "optional": true,
30641             "field": "recordingFormat",
30642             "description": ""
30643           },
30644           {
30645             "group": "Body",
30646             "type": "String",
30647             "optional": true,
30648             "field": "description",
30649             "description": ""
30650           }
30651         ]
30652       }
30653     },
30654     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30655     "version": "0.0.0",
30656     "filename": "server/api/voiceChanSpy/index.js",
30657     "groupTitle": "Voice_ChanSpy"
30658   },
30659   {
30660     "type": "delete",
30661     "url": "/api/voice/chanspy/{id}",
30662     "title": "Deletes a ChanSpy",
30663     "examples": [
30664       {
30665         "title": "Example usage:",
30666         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password} -X DELETE",
30667         "type": "json"
30668       }
30669     ],
30670     "name": "DeleteChanSpy",
30671     "group": "Voice_ChanSpy",
30672     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30673     "version": "0.0.0",
30674     "filename": "server/api/voiceChanSpy/index.js",
30675     "groupTitle": "Voice_ChanSpy"
30676   },
30677   {
30678     "type": "get",
30679     "url": "/api/voice/chanspy",
30680     "title": "Gets a list of ChanSpy",
30681     "examples": [
30682       {
30683         "title": "Example usage:",
30684         "content": "curl https://{domain}/api/voice/chanspy -v -u {name}:{password}",
30685         "type": "json"
30686       }
30687     ],
30688     "name": "GetChanSpy",
30689     "group": "Voice_ChanSpy",
30690     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30691     "version": "0.0.0",
30692     "filename": "server/api/voiceChanSpy/index.js",
30693     "groupTitle": "Voice_ChanSpy"
30694   },
30695   {
30696     "type": "get",
30697     "url": "/api/voice/chanspy/{id}",
30698     "title": "Gets a single ChanSpy",
30699     "examples": [
30700       {
30701         "title": "Example usage:",
30702         "content": "curl https://{domain}/api/voice/chanspy/{id} -v -u {name}:{password}",
30703         "type": "json"
30704       }
30705     ],
30706     "name": "ShowChanSpy",
30707     "group": "Voice_ChanSpy",
30708     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30709     "version": "0.0.0",
30710     "filename": "server/api/voiceChanSpy/index.js",
30711     "groupTitle": "Voice_ChanSpy"
30712   },
30713   {
30714     "type": "put",
30715     "url": "/api/voice/chanspy/{id}",
30716     "title": "Update an existing ChanSpy",
30717     "examples": [
30718       {
30719         "title": "Example usage:",
30720         "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",
30721         "type": "json"
30722       }
30723     ],
30724     "name": "updateChanSpy",
30725     "group": "Voice_ChanSpy",
30726     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30727     "version": "0.0.0",
30728     "filename": "server/api/voiceChanSpy/index.js",
30729     "groupTitle": "Voice_ChanSpy"
30730   },
30731   {
30732     "type": "post",
30733     "url": "/api/voice/contexts",
30734     "title": "Create a new context",
30735     "examples": [
30736       {
30737         "title": "Example usage:",
30738         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password} -X POST",
30739         "type": "json"
30740       }
30741     ],
30742     "name": "Create",
30743     "group": "Voice_Contexts",
30744     "parameter": {
30745       "fields": {
30746         "Body": [
30747           {
30748             "group": "Body",
30749             "type": "String",
30750             "optional": true,
30751             "field": "name",
30752             "description": ""
30753           },
30754           {
30755             "group": "Body",
30756             "type": "String",
30757             "optional": true,
30758             "field": "description",
30759             "description": ""
30760           },
30761           {
30762             "group": "Body",
30763             "type": "Boolean",
30764             "optional": true,
30765             "field": "defaultEntry",
30766             "description": ""
30767           }
30768         ]
30769       }
30770     },
30771     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30772     "version": "0.0.0",
30773     "filename": "server/api/voiceContext/index.js",
30774     "groupTitle": "Voice_Contexts"
30775   },
30776   {
30777     "type": "delete",
30778     "url": "/api/voice/contexts/{id}",
30779     "title": "Deletes a context",
30780     "examples": [
30781       {
30782         "title": "Example usage:",
30783         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X DELETE",
30784         "type": "json"
30785       }
30786     ],
30787     "name": "Delete",
30788     "group": "Voice_Contexts",
30789     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30790     "version": "0.0.0",
30791     "filename": "server/api/voiceContext/index.js",
30792     "groupTitle": "Voice_Contexts"
30793   },
30794   {
30795     "type": "get",
30796     "url": "/api/voice/contexts",
30797     "title": "Gets a list of Contexts",
30798     "examples": [
30799       {
30800         "title": "Example usage:",
30801         "content": "curl https://{domain}/api/voice/contexts -v -u {name}:{password}",
30802         "type": "json"
30803       }
30804     ],
30805     "name": "GetContexts",
30806     "group": "Voice_Contexts",
30807     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30808     "version": "0.0.0",
30809     "filename": "server/api/voiceContext/index.js",
30810     "groupTitle": "Voice_Contexts"
30811   },
30812   {
30813     "type": "get",
30814     "url": "/api/voice/contexts/{id}",
30815     "title": "Gets a single Context",
30816     "examples": [
30817       {
30818         "title": "Example usage:",
30819         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password}",
30820         "type": "json"
30821       }
30822     ],
30823     "name": "ShowContexts",
30824     "group": "Voice_Contexts",
30825     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30826     "version": "0.0.0",
30827     "filename": "server/api/voiceContext/index.js",
30828     "groupTitle": "Voice_Contexts"
30829   },
30830   {
30831     "type": "put",
30832     "url": "/api/voice/contexts/{id}",
30833     "title": "Update an existing context",
30834     "examples": [
30835       {
30836         "title": "Example usage:",
30837         "content": "curl https://{domain}/api/voice/contexts/{id} -v -u {name}:{password} -X PUT",
30838         "type": "json"
30839       }
30840     ],
30841     "name": "Update",
30842     "group": "Voice_Contexts",
30843     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30844     "version": "0.0.0",
30845     "filename": "server/api/voiceContext/index.js",
30846     "groupTitle": "Voice_Contexts"
30847   },
30848   {
30849     "type": "get",
30850     "url": "/api/voice/dials/reports/describe",
30851     "title": "Gets table info about Dial Reports",
30852     "examples": [
30853       {
30854         "title": "Example usage:",
30855         "content": "curl https://{domain}/api/voice/dials/reports/describe -v -u {name}:{password}",
30856         "type": "json"
30857       }
30858     ],
30859     "name": "DescribeDial_Reports",
30860     "group": "Voice_Dial_Reports",
30861     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30862     "version": "0.0.0",
30863     "filename": "server/api/voiceDialReport/index.js",
30864     "groupTitle": "Voice_Dial_Reports"
30865   },
30866   {
30867     "type": "get",
30868     "url": "/api/voice/dials/reports",
30869     "title": "Gets a list of Dial Reports",
30870     "examples": [
30871       {
30872         "title": "Example usage:",
30873         "content": "curl https://{domain}/api/voice/dials/reports -v -u {name}:{password}",
30874         "type": "json"
30875       }
30876     ],
30877     "name": "GetDial_Reports",
30878     "group": "Voice_Dial_Reports",
30879     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30880     "version": "0.0.0",
30881     "filename": "server/api/voiceDialReport/index.js",
30882     "groupTitle": "Voice_Dial_Reports"
30883   },
30884   {
30885     "type": "get",
30886     "url": "/api/voice/dials/reports/{id}",
30887     "title": "Gets a single Dial Report",
30888     "examples": [
30889       {
30890         "title": "Example usage:",
30891         "content": "curl https://{domain}/api/voice/dials/reports/{id} -v -u {name}:{password}",
30892         "type": "json"
30893       }
30894     ],
30895     "name": "ShowDial_Reports",
30896     "group": "Voice_Dial_Reports",
30897     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30898     "version": "0.0.0",
30899     "filename": "server/api/voiceDialReport/index.js",
30900     "groupTitle": "Voice_Dial_Reports"
30901   },
30902   {
30903     "type": "delete",
30904     "url": "/api/voice/extensions/{id}",
30905     "title": "Deletes a Extension",
30906     "examples": [
30907       {
30908         "title": "Example usage:",
30909         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password} -X DELETE",
30910         "type": "json"
30911       }
30912     ],
30913     "name": "DeleteExtensions",
30914     "group": "Voice_Extensions",
30915     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30916     "version": "0.0.0",
30917     "filename": "server/api/voiceExtension/index.js",
30918     "groupTitle": "Voice_Extensions"
30919   },
30920   {
30921     "type": "get",
30922     "url": "/api/voice/extensions",
30923     "title": "Gets a list of Extensions",
30924     "examples": [
30925       {
30926         "title": "Example usage:",
30927         "content": "curl https://{domain}/api/voice/extensions -v -u {name}:{password}",
30928         "type": "json"
30929       }
30930     ],
30931     "name": "GetExtensions",
30932     "group": "Voice_Extensions",
30933     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
30934     "version": "0.0.0",
30935     "filename": "server/api/voiceExtension/index.js",
30936     "groupTitle": "Voice_Extensions"
30937   },
30938   {
30939     "type": "get",
30940     "url": "/api/voice/extensions/{id}",
30941     "title": "Gets a single Extension",
30942     "examples": [
30943       {
30944         "title": "Example usage:",
30945         "content": "curl https://{domain}/api/voice/extensions/{id} -v -u {name}:{password}",
30946         "type": "json"
30947       }
30948     ],
30949     "name": "ShowExtensions",
30950     "group": "Voice_Extensions",
30951     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30952     "version": "0.0.0",
30953     "filename": "server/api/voiceExtension/index.js",
30954     "groupTitle": "Voice_Extensions"
30955   },
30956   {
30957     "type": "post",
30958     "url": "/api/voice/extensions",
30959     "title": "Create new applications",
30960     "examples": [
30961       {
30962         "title": "Example usage:",
30963         "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",
30964         "type": "json"
30965       }
30966     ],
30967     "name": "addApplications",
30968     "group": "Voice_Extensions",
30969     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30970     "version": "0.0.0",
30971     "filename": "server/api/voiceExtension/index.js",
30972     "groupTitle": "Voice_Extensions"
30973   },
30974   {
30975     "type": "post",
30976     "url": "/api/voice/extensions",
30977     "title": "Create an extension",
30978     "examples": [
30979       {
30980         "title": "Example usage:",
30981         "content": "curl https://{domain}/api/voice/extensions -d '{\"exten\": \"12345\", \"context\": \"from-custom\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
30982         "type": "json"
30983       }
30984     ],
30985     "name": "create",
30986     "group": "Voice_Extensions",
30987     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
30988     "version": "0.0.0",
30989     "filename": "server/api/voiceExtension/index.js",
30990     "groupTitle": "Voice_Extensions"
30991   },
30992   {
30993     "type": "put",
30994     "url": "/api/voice/extensions/{id}",
30995     "title": "Update an extension",
30996     "examples": [
30997       {
30998         "title": "Example usage:",
30999         "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",
31000         "type": "json"
31001       }
31002     ],
31003     "name": "update",
31004     "group": "Voice_Extensions",
31005     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31006     "version": "0.0.0",
31007     "filename": "server/api/voiceExtension/index.js",
31008     "groupTitle": "Voice_Extensions"
31009   },
31010   {
31011     "type": "post",
31012     "url": "/api/voice/mohs",
31013     "title": "Create a new a new MOH",
31014     "examples": [
31015       {
31016         "title": "Example usage:",
31017         "content": "curl https://{domain}/api/voice/mohs -d '{\"name\": \"xmas_musics\"}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31018         "type": "json"
31019       }
31020     ],
31021     "name": "AddMoh",
31022     "group": "Voice_MOHs",
31023     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31024     "version": "0.0.0",
31025     "filename": "server/api/voiceMusicOnHold/index.js",
31026     "groupTitle": "Voice_MOHs"
31027   },
31028   {
31029     "type": "post",
31030     "url": "/api/voice/mohs/{id}/sounds",
31031     "title": "Add sound to MOH",
31032     "examples": [
31033       {
31034         "title": "Example usage:",
31035         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -d '{\"id\": 1}' -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31036         "type": "json"
31037       }
31038     ],
31039     "name": "AddSound",
31040     "group": "Voice_MOHs",
31041     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31042     "version": "0.0.0",
31043     "filename": "server/api/voiceMusicOnHold/index.js",
31044     "groupTitle": "Voice_MOHs"
31045   },
31046   {
31047     "type": "delete",
31048     "url": "/api/voice/mohs/{id}",
31049     "title": "Deletes an MOH",
31050     "examples": [
31051       {
31052         "title": "Example usage:",
31053         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password} -X DELETE",
31054         "type": "json"
31055       }
31056     ],
31057     "name": "DestroyMoh",
31058     "group": "Voice_MOHs",
31059     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31060     "version": "0.0.0",
31061     "filename": "server/api/voiceMusicOnHold/index.js",
31062     "groupTitle": "Voice_MOHs"
31063   },
31064   {
31065     "type": "get",
31066     "url": "/api/voice/mohs",
31067     "title": "Gets a list of Music On Holds",
31068     "examples": [
31069       {
31070         "title": "Example usage:",
31071         "content": "curl https://{domain}/api/voice/mohs -v -u {name}:{password}",
31072         "type": "json"
31073       }
31074     ],
31075     "name": "GetMusic_On_Holds",
31076     "group": "Voice_MOHs",
31077     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31078     "version": "0.0.0",
31079     "filename": "server/api/voiceMusicOnHold/index.js",
31080     "groupTitle": "Voice_MOHs"
31081   },
31082   {
31083     "type": "get",
31084     "url": "/api/voice/mohs/{id}/sounds",
31085     "title": "Gets sounds from MOH",
31086     "examples": [
31087       {
31088         "title": "Example usage:",
31089         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds -v -u {name}:{password} -X DELETE",
31090         "type": "json"
31091       }
31092     ],
31093     "name": "GetSounds",
31094     "group": "Voice_MOHs",
31095     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31096     "version": "0.0.0",
31097     "filename": "server/api/voiceMusicOnHold/index.js",
31098     "groupTitle": "Voice_MOHs"
31099   },
31100   {
31101     "type": "delete",
31102     "url": "/api/voice/mohs/{id}/sounds/{id2}",
31103     "title": "Remove sound from MOH",
31104     "examples": [
31105       {
31106         "title": "Example usage:",
31107         "content": "curl https://{domain}/api/voice/mohs/{id}/sounds/{id2} -v -u {name}:{password} -X DELETE",
31108         "type": "json"
31109       }
31110     ],
31111     "name": "RemoveSound",
31112     "group": "Voice_MOHs",
31113     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31114     "version": "0.0.0",
31115     "filename": "server/api/voiceMusicOnHold/index.js",
31116     "groupTitle": "Voice_MOHs"
31117   },
31118   {
31119     "type": "get",
31120     "url": "/api/voice/mohs/{id}",
31121     "title": "Gets a single Music On Hold",
31122     "examples": [
31123       {
31124         "title": "Example usage:",
31125         "content": "curl https://{domain}/api/voice/mohs/{id} -v -u {name}:{password}",
31126         "type": "json"
31127       }
31128     ],
31129     "name": "ShowMusic_On_Holds",
31130     "group": "Voice_MOHs",
31131     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31132     "version": "0.0.0",
31133     "filename": "server/api/voiceMusicOnHold/index.js",
31134     "groupTitle": "Voice_MOHs"
31135   },
31136   {
31137     "type": "put",
31138     "url": "/api/voice/mohs/{id}",
31139     "title": "Update an existing Music On Hold",
31140     "examples": [
31141       {
31142         "title": "Example usage:",
31143         "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",
31144         "type": "json"
31145       }
31146     ],
31147     "name": "updateMusic_On_Holds",
31148     "group": "Voice_MOHs",
31149     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31150     "version": "0.0.0",
31151     "filename": "server/api/voiceMusicOnHold/index.js",
31152     "groupTitle": "Voice_MOHs"
31153   },
31154   {
31155     "type": "post",
31156     "url": "/api/voice/mails",
31157     "title": "Creates a new Mail",
31158     "examples": [
31159       {
31160         "title": "Example usage:",
31161         "content": "curl https://{domain}/api/voice/mails -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
31162         "type": "json"
31163       }
31164     ],
31165     "name": "CreateMails",
31166     "group": "Voice_Mails",
31167     "parameter": {
31168       "fields": {
31169         "Body": [
31170           {
31171             "group": "Body",
31172             "type": "String",
31173             "optional": true,
31174             "field": "customer_id",
31175             "description": ""
31176           },
31177           {
31178             "group": "Body",
31179             "type": "String",
31180             "optional": true,
31181             "field": "context",
31182             "description": ""
31183           },
31184           {
31185             "group": "Body",
31186             "type": "String",
31187             "optional": false,
31188             "field": "mailbox",
31189             "description": ""
31190           },
31191           {
31192             "group": "Body",
31193             "type": "String",
31194             "optional": true,
31195             "field": "password",
31196             "description": ""
31197           },
31198           {
31199             "group": "Body",
31200             "type": "String",
31201             "optional": true,
31202             "field": "fullname",
31203             "description": ""
31204           },
31205           {
31206             "group": "Body",
31207             "type": "String",
31208             "optional": true,
31209             "field": "email",
31210             "description": ""
31211           },
31212           {
31213             "group": "Body",
31214             "type": "String",
31215             "optional": true,
31216             "field": "pager",
31217             "description": ""
31218           },
31219           {
31220             "group": "Body",
31221             "type": "String",
31222             "optional": true,
31223             "field": "tz",
31224             "description": ""
31225           },
31226           {
31227             "group": "Body",
31228             "type": "String",
31229             "allowedValues": [
31230               "\"yes\"",
31231               "\"no\""
31232             ],
31233             "optional": false,
31234             "field": "attach",
31235             "description": ""
31236           },
31237           {
31238             "group": "Body",
31239             "type": "String",
31240             "allowedValues": [
31241               "\"yes\"",
31242               "\"no\""
31243             ],
31244             "optional": false,
31245             "field": "saycid",
31246             "description": ""
31247           },
31248           {
31249             "group": "Body",
31250             "type": "String",
31251             "optional": true,
31252             "field": "dialout",
31253             "description": ""
31254           },
31255           {
31256             "group": "Body",
31257             "type": "String",
31258             "optional": true,
31259             "field": "callback",
31260             "description": ""
31261           },
31262           {
31263             "group": "Body",
31264             "type": "String",
31265             "allowedValues": [
31266               "\"yes\"",
31267               "\"no\""
31268             ],
31269             "optional": false,
31270             "field": "review",
31271             "description": ""
31272           },
31273           {
31274             "group": "Body",
31275             "type": "String",
31276             "allowedValues": [
31277               "\"yes\"",
31278               "\"no\""
31279             ],
31280             "optional": false,
31281             "field": "operator",
31282             "description": ""
31283           },
31284           {
31285             "group": "Body",
31286             "type": "String",
31287             "allowedValues": [
31288               "\"yes\"",
31289               "\"no\""
31290             ],
31291             "optional": false,
31292             "field": "envelope",
31293             "description": ""
31294           },
31295           {
31296             "group": "Body",
31297             "type": "String",
31298             "allowedValues": [
31299               "\"yes\"",
31300               "\"no\""
31301             ],
31302             "optional": false,
31303             "field": "sayduration",
31304             "description": ""
31305           },
31306           {
31307             "group": "Body",
31308             "type": "String",
31309             "optional": false,
31310             "field": "saydurationm",
31311             "description": ""
31312           },
31313           {
31314             "group": "Body",
31315             "type": "String",
31316             "allowedValues": [
31317               "\"yes\"",
31318               "\"no\""
31319             ],
31320             "optional": false,
31321             "field": "sendvoicemail",
31322             "description": ""
31323           },
31324           {
31325             "group": "Body",
31326             "type": "String",
31327             "allowedValues": [
31328               "\"yes\"",
31329               "\"no\""
31330             ],
31331             "optional": false,
31332             "field": "delete",
31333             "description": ""
31334           },
31335           {
31336             "group": "Body",
31337             "type": "String",
31338             "allowedValues": [
31339               "\"yes\"",
31340               "\"no\""
31341             ],
31342             "optional": false,
31343             "field": "nextaftercmd",
31344             "description": ""
31345           },
31346           {
31347             "group": "Body",
31348             "type": "String",
31349             "allowedValues": [
31350               "\"yes\"",
31351               "\"no\""
31352             ],
31353             "optional": false,
31354             "field": "forcename",
31355             "description": ""
31356           },
31357           {
31358             "group": "Body",
31359             "type": "String",
31360             "allowedValues": [
31361               "\"yes\"",
31362               "\"no\""
31363             ],
31364             "optional": false,
31365             "field": "forcegreetings",
31366             "description": ""
31367           },
31368           {
31369             "group": "Body",
31370             "type": "String",
31371             "allowedValues": [
31372               "\"yes\"",
31373               "\"no\""
31374             ],
31375             "optional": false,
31376             "field": "hidefromdir",
31377             "description": ""
31378           },
31379           {
31380             "group": "Body",
31381             "type": "String",
31382             "optional": true,
31383             "field": "stamp",
31384             "description": ""
31385           },
31386           {
31387             "group": "Body",
31388             "type": "String",
31389             "optional": true,
31390             "field": "emailsubject",
31391             "description": ""
31392           },
31393           {
31394             "group": "Body",
31395             "type": "String",
31396             "optional": true,
31397             "field": "emailbody",
31398             "description": ""
31399           },
31400           {
31401             "group": "Body",
31402             "type": "Integer",
31403             "optional": false,
31404             "field": "maxsecs",
31405             "description": ""
31406           },
31407           {
31408             "group": "Body",
31409             "type": "Integer",
31410             "optional": false,
31411             "field": "maxmsg",
31412             "description": ""
31413           },
31414           {
31415             "group": "Body",
31416             "type": "Virtual",
31417             "optional": true,
31418             "field": "name",
31419             "description": ""
31420           }
31421         ]
31422       }
31423     },
31424     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31425     "version": "0.0.0",
31426     "filename": "server/api/voiceMail/index.js",
31427     "groupTitle": "Voice_Mails"
31428   },
31429   {
31430     "type": "delete",
31431     "url": "/api/voice/mails/{id}",
31432     "title": "Deletes a Mail",
31433     "examples": [
31434       {
31435         "title": "Example usage:",
31436         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password} -X DELETE",
31437         "type": "json"
31438       }
31439     ],
31440     "name": "DeleteMails",
31441     "group": "Voice_Mails",
31442     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31443     "version": "0.0.0",
31444     "filename": "server/api/voiceMail/index.js",
31445     "groupTitle": "Voice_Mails"
31446   },
31447   {
31448     "type": "get",
31449     "url": "/api/voice/mails",
31450     "title": "Gets a list of Mails",
31451     "examples": [
31452       {
31453         "title": "Example usage:",
31454         "content": "curl https://{domain}/api/voice/mails -v -u {name}:{password}",
31455         "type": "json"
31456       }
31457     ],
31458     "name": "GetMails",
31459     "group": "Voice_Mails",
31460     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31461     "version": "0.0.0",
31462     "filename": "server/api/voiceMail/index.js",
31463     "groupTitle": "Voice_Mails"
31464   },
31465   {
31466     "type": "get",
31467     "url": "/api/voice/mails/{id}",
31468     "title": "Gets a single Mail",
31469     "examples": [
31470       {
31471         "title": "Example usage:",
31472         "content": "curl https://{domain}/api/voice/mails/{id} -v -u {name}:{password}",
31473         "type": "json"
31474       }
31475     ],
31476     "name": "ShowMails",
31477     "group": "Voice_Mails",
31478     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31479     "version": "0.0.0",
31480     "filename": "server/api/voiceMail/index.js",
31481     "groupTitle": "Voice_Mails"
31482   },
31483   {
31484     "type": "get",
31485     "url": "/api/voice/mails/{id}/messages",
31486     "title": "Gets voice mail messages",
31487     "examples": [
31488       {
31489         "title": "Example usage:",
31490         "content": "curl https://{domain}/api/voice/mails/{id}/messages -v -u {name}:{password} -X GET",
31491         "type": "json"
31492       }
31493     ],
31494     "name": "getMessages",
31495     "group": "Voice_Mails",
31496     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31497     "version": "0.0.0",
31498     "filename": "server/api/voiceMail/index.js",
31499     "groupTitle": "Voice_Mails"
31500   },
31501   {
31502     "type": "put",
31503     "url": "/api/voice/mails/{id}",
31504     "title": "Update an existing Mail",
31505     "examples": [
31506       {
31507         "title": "Example usage:",
31508         "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",
31509         "type": "json"
31510       }
31511     ],
31512     "name": "updateMails",
31513     "group": "Voice_Mails",
31514     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31515     "version": "0.0.0",
31516     "filename": "server/api/voiceMail/index.js",
31517     "groupTitle": "Voice_Mails"
31518   },
31519   {
31520     "type": "post",
31521     "url": "/api/voice/mails/messages",
31522     "title": "Creates a new Message",
31523     "examples": [
31524       {
31525         "title": "Example usage:",
31526         "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",
31527         "type": "json"
31528       }
31529     ],
31530     "name": "CreateMessages",
31531     "group": "Voice_Messages",
31532     "parameter": {
31533       "fields": {
31534         "Body": [
31535           {
31536             "group": "Body",
31537             "type": "Virtual",
31538             "optional": true,
31539             "field": "name",
31540             "description": ""
31541           },
31542           {
31543             "group": "Body",
31544             "type": "Integer",
31545             "optional": false,
31546             "field": "msgnum",
31547             "description": ""
31548           },
31549           {
31550             "group": "Body",
31551             "type": "String",
31552             "optional": true,
31553             "field": "dir",
31554             "description": ""
31555           },
31556           {
31557             "group": "Body",
31558             "type": "String",
31559             "optional": true,
31560             "field": "context",
31561             "description": ""
31562           },
31563           {
31564             "group": "Body",
31565             "type": "String",
31566             "optional": true,
31567             "field": "macrocontext",
31568             "description": ""
31569           },
31570           {
31571             "group": "Body",
31572             "type": "String",
31573             "optional": true,
31574             "field": "callerid",
31575             "description": ""
31576           },
31577           {
31578             "group": "Body",
31579             "type": "String",
31580             "optional": true,
31581             "field": "origtime",
31582             "description": ""
31583           },
31584           {
31585             "group": "Body",
31586             "type": "String",
31587             "optional": true,
31588             "field": "duration",
31589             "description": ""
31590           },
31591           {
31592             "group": "Body",
31593             "type": "String",
31594             "optional": true,
31595             "field": "mailboxuser",
31596             "description": ""
31597           },
31598           {
31599             "group": "Body",
31600             "type": "String",
31601             "optional": true,
31602             "field": "mailboxcontext",
31603             "description": ""
31604           },
31605           {
31606             "group": "Body",
31607             "type": "Blob",
31608             "optional": true,
31609             "field": "recording",
31610             "description": ""
31611           },
31612           {
31613             "group": "Body",
31614             "type": "String",
31615             "optional": true,
31616             "field": "flag",
31617             "description": ""
31618           },
31619           {
31620             "group": "Body",
31621             "type": "String",
31622             "optional": true,
31623             "field": "msg_id",
31624             "description": ""
31625           },
31626           {
31627             "group": "Body",
31628             "type": "String",
31629             "optional": false,
31630             "field": "stamp",
31631             "description": ""
31632           }
31633         ]
31634       }
31635     },
31636     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31637     "version": "0.0.0",
31638     "filename": "server/api/voiceMailMessage/index.js",
31639     "groupTitle": "Voice_Messages"
31640   },
31641   {
31642     "type": "delete",
31643     "url": "/api/voice/mails/messages/{id}",
31644     "title": "Deletes a Message",
31645     "examples": [
31646       {
31647         "title": "Example usage:",
31648         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password} -X DELETE",
31649         "type": "json"
31650       }
31651     ],
31652     "name": "DeleteMessages",
31653     "group": "Voice_Messages",
31654     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31655     "version": "0.0.0",
31656     "filename": "server/api/voiceMailMessage/index.js",
31657     "groupTitle": "Voice_Messages"
31658   },
31659   {
31660     "type": "get",
31661     "url": "/api/voice/mails/messages",
31662     "title": "Gets a list of Messages",
31663     "examples": [
31664       {
31665         "title": "Example usage:",
31666         "content": "curl https://{domain}/api/voice/mails/messages -v -u {name}:{password}",
31667         "type": "json"
31668       }
31669     ],
31670     "name": "GetMessages",
31671     "group": "Voice_Messages",
31672     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31673     "version": "0.0.0",
31674     "filename": "server/api/voiceMailMessage/index.js",
31675     "groupTitle": "Voice_Messages"
31676   },
31677   {
31678     "type": "get",
31679     "url": "/api/voice/mails/messages/{id}",
31680     "title": "Gets a single Message",
31681     "examples": [
31682       {
31683         "title": "Example usage:",
31684         "content": "curl https://{domain}/api/voice/mails/messages/{id} -v -u {name}:{password}",
31685         "type": "json"
31686       }
31687     ],
31688     "name": "ShowMessages",
31689     "group": "Voice_Messages",
31690     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31691     "version": "0.0.0",
31692     "filename": "server/api/voiceMailMessage/index.js",
31693     "groupTitle": "Voice_Messages"
31694   },
31695   {
31696     "type": "get",
31697     "url": "voice/mails/messages/{id}/download",
31698     "title": "Download Voice Message",
31699     "examples": [
31700       {
31701         "title": "Example usage:",
31702         "content": "curl https://{domain}voice/mails/messages/{id}/download -v -u {name}:{password} -X GET",
31703         "type": "json"
31704       }
31705     ],
31706     "name": "download",
31707     "group": "Voice_Messages",
31708     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31709     "version": "0.0.0",
31710     "filename": "server/api/voiceMailMessage/index.js",
31711     "groupTitle": "Voice_Messages"
31712   },
31713   {
31714     "type": "put",
31715     "url": "/api/voice/mails/messages/{id}",
31716     "title": "Update an existing Message",
31717     "examples": [
31718       {
31719         "title": "Example usage:",
31720         "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",
31721         "type": "json"
31722       }
31723     ],
31724     "name": "updateMessages",
31725     "group": "Voice_Messages",
31726     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31727     "version": "0.0.0",
31728     "filename": "server/api/voiceMailMessage/index.js",
31729     "groupTitle": "Voice_Messages"
31730   },
31731   {
31732     "type": "post",
31733     "url": "/api/voice/prefixes/{id}/users",
31734     "title": "Add agents to a prefix",
31735     "examples": [
31736       {
31737         "title": "Example usage:",
31738         "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",
31739         "type": "json"
31740       }
31741     ],
31742     "name": "AddAgents",
31743     "group": "Voice_Prefixes",
31744     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31745     "version": "0.0.0",
31746     "filename": "server/api/voicePrefix/index.js",
31747     "groupTitle": "Voice_Prefixes"
31748   },
31749   {
31750     "type": "delete",
31751     "url": "/api/voice/prefixes/{id}",
31752     "title": "Deletes a Prefix",
31753     "examples": [
31754       {
31755         "title": "Example usage:",
31756         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X DELETE",
31757         "type": "json"
31758       }
31759     ],
31760     "name": "DeletePrefixes",
31761     "group": "Voice_Prefixes",
31762     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31763     "version": "0.0.0",
31764     "filename": "server/api/voicePrefix/index.js",
31765     "groupTitle": "Voice_Prefixes"
31766   },
31767   {
31768     "type": "get",
31769     "url": "/api/voice/prefixes/describe",
31770     "title": "Gets table info about Prefixes",
31771     "examples": [
31772       {
31773         "title": "Example usage:",
31774         "content": "curl https://{domain}/api/voice/prefixes/describe -v -u {name}:{password}",
31775         "type": "json"
31776       }
31777     ],
31778     "name": "DescribePrefixes",
31779     "group": "Voice_Prefixes",
31780     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31781     "version": "0.0.0",
31782     "filename": "server/api/voicePrefix/index.js",
31783     "groupTitle": "Voice_Prefixes"
31784   },
31785   {
31786     "type": "get",
31787     "url": "/api/voice/prefixes/{id}/users",
31788     "title": "Gets agents from prefix",
31789     "examples": [
31790       {
31791         "title": "Example usage:",
31792         "content": "curl https://{domain}/api/voice/prefixes/{id}/users -v -u {name}:{password} -X GET",
31793         "type": "json"
31794       }
31795     ],
31796     "name": "GetAgents",
31797     "group": "Voice_Prefixes",
31798     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31799     "version": "0.0.0",
31800     "filename": "server/api/voicePrefix/index.js",
31801     "groupTitle": "Voice_Prefixes"
31802   },
31803   {
31804     "type": "get",
31805     "url": "/api/voice/prefixes",
31806     "title": "Gets a list of Prefixes",
31807     "examples": [
31808       {
31809         "title": "Example usage:",
31810         "content": "curl https://{domain}/api/voice/prefixes -v -u {name}:{password}",
31811         "type": "json"
31812       }
31813     ],
31814     "name": "GetPrefixes",
31815     "group": "Voice_Prefixes",
31816     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31817     "version": "0.0.0",
31818     "filename": "server/api/voicePrefix/index.js",
31819     "groupTitle": "Voice_Prefixes"
31820   },
31821   {
31822     "type": "delete",
31823     "url": "/api/voice/prefixes/{id}/users",
31824     "title": "Removes agents from a prefix",
31825     "examples": [
31826       {
31827         "title": "Example usage:",
31828         "content": "curl https://{domain}/api/voice/prefixes/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
31829         "type": "json"
31830       }
31831     ],
31832     "name": "RemoveAgents",
31833     "group": "Voice_Prefixes",
31834     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31835     "version": "0.0.0",
31836     "filename": "server/api/voicePrefix/index.js",
31837     "groupTitle": "Voice_Prefixes"
31838   },
31839   {
31840     "type": "get",
31841     "url": "/api/voice/prefixes/{id}",
31842     "title": "Gets a single Prefix",
31843     "examples": [
31844       {
31845         "title": "Example usage:",
31846         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password}",
31847         "type": "json"
31848       }
31849     ],
31850     "name": "ShowPrefixes",
31851     "group": "Voice_Prefixes",
31852     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31853     "version": "0.0.0",
31854     "filename": "server/api/voicePrefix/index.js",
31855     "groupTitle": "Voice_Prefixes"
31856   },
31857   {
31858     "type": "put",
31859     "url": "/api/voice/prefixes/{id}",
31860     "title": "Update an existing prefix",
31861     "examples": [
31862       {
31863         "title": "Example usage:",
31864         "content": "curl https://{domain}/api/voice/prefixes/{id} -v -u {name}:{password} -X PUT",
31865         "type": "json"
31866       }
31867     ],
31868     "name": "Update",
31869     "group": "Voice_Prefixes",
31870     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31871     "version": "0.0.0",
31872     "filename": "server/api/voicePrefix/index.js",
31873     "groupTitle": "Voice_Prefixes"
31874   },
31875   {
31876     "type": "post",
31877     "url": "/api/voice/prefixes",
31878     "title": "Create a prefix",
31879     "examples": [
31880       {
31881         "title": "Example usage:",
31882         "content": "curl https://{domain}/api/voice/prefixes -H 'Content-Type: application/json' -v -u {name}:{password} -X POST",
31883         "type": "json"
31884       }
31885     ],
31886     "name": "create",
31887     "group": "Voice_Prefixes",
31888     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31889     "version": "0.0.0",
31890     "filename": "server/api/voicePrefix/index.js",
31891     "groupTitle": "Voice_Prefixes"
31892   },
31893   {
31894     "type": "get",
31895     "url": "/api/voice/queues/reports/describe",
31896     "title": "Gets table info about Queue Reports",
31897     "examples": [
31898       {
31899         "title": "Example usage:",
31900         "content": "curl https://{domain}/api/voice/queues/reports/describe -v -u {name}:{password}",
31901         "type": "json"
31902       }
31903     ],
31904     "name": "DescribeQueue_Reports",
31905     "group": "Voice_Queue_Reports",
31906     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31907     "version": "0.0.0",
31908     "filename": "server/api/voiceQueueReport/index.js",
31909     "groupTitle": "Voice_Queue_Reports"
31910   },
31911   {
31912     "type": "get",
31913     "url": "/api/voice/queues/reports",
31914     "title": "Gets a list of Queue Reports",
31915     "examples": [
31916       {
31917         "title": "Example usage:",
31918         "content": "curl https://{domain}/api/voice/queues/reports -v -u {name}:{password}",
31919         "type": "json"
31920       }
31921     ],
31922     "name": "GetQueue_Reports",
31923     "group": "Voice_Queue_Reports",
31924     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
31925     "version": "0.0.0",
31926     "filename": "server/api/voiceQueueReport/index.js",
31927     "groupTitle": "Voice_Queue_Reports"
31928   },
31929   {
31930     "type": "get",
31931     "url": "/api/voice/queues/reports/{id}",
31932     "title": "Gets a single Queue Report",
31933     "examples": [
31934       {
31935         "title": "Example usage:",
31936         "content": "curl https://{domain}/api/voice/queues/reports/{id} -v -u {name}:{password}",
31937         "type": "json"
31938       }
31939     ],
31940     "name": "ShowQueue_Reports",
31941     "group": "Voice_Queue_Reports",
31942     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31943     "version": "0.0.0",
31944     "filename": "server/api/voiceQueueReport/index.js",
31945     "groupTitle": "Voice_Queue_Reports"
31946   },
31947   {
31948     "type": "get",
31949     "url": "/api/voice/queues/reports/index",
31950     "title": "Get Voice Queues Report",
31951     "examples": [
31952       {
31953         "title": "Example usage:",
31954         "content": "curl https://{domain}/api/voice/queues/reports/index -v -u {name}:{password} -X GET",
31955         "type": "json"
31956       }
31957     ],
31958     "name": "getVoiceQueuesReport",
31959     "group": "Voice_Queue_Reports",
31960     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31961     "version": "0.0.0",
31962     "filename": "server/api/voiceQueueReport/index.js",
31963     "groupTitle": "Voice_Queue_Reports"
31964   },
31965   {
31966     "type": "post",
31967     "url": "/api/voice/queues/{id}/users",
31968     "title": "Add agents to queue",
31969     "examples": [
31970       {
31971         "title": "Example usage:",
31972         "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",
31973         "type": "json"
31974       }
31975     ],
31976     "name": "AddAgents",
31977     "group": "Voice_Queues",
31978     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31979     "version": "0.0.0",
31980     "filename": "server/api/voiceQueue/index.js",
31981     "groupTitle": "Voice_Queues"
31982   },
31983   {
31984     "type": "post",
31985     "url": "/api/voice/queues/{id}/blacklists",
31986     "title": "Add blacklists to a queue",
31987     "examples": [
31988       {
31989         "title": "Example usage:",
31990         "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",
31991         "type": "json"
31992       }
31993     ],
31994     "name": "AddBlackLists",
31995     "group": "Voice_Queues",
31996     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
31997     "version": "0.0.0",
31998     "filename": "server/api/voiceQueue/index.js",
31999     "groupTitle": "Voice_Queues"
32000   },
32001   {
32002     "type": "post",
32003     "url": "/api/voice/queues/{id}/lists",
32004     "title": "Add lists to a queue",
32005     "examples": [
32006       {
32007         "title": "Example usage:",
32008         "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",
32009         "type": "json"
32010       }
32011     ],
32012     "name": "AddLists",
32013     "group": "Voice_Queues",
32014     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32015     "version": "0.0.0",
32016     "filename": "server/api/voiceQueue/index.js",
32017     "groupTitle": "Voice_Queues"
32018   },
32019   {
32020     "type": "post",
32021     "url": "/api/voice/queues/{id}/teams",
32022     "title": "Add teams to queue",
32023     "examples": [
32024       {
32025         "title": "Example usage:",
32026         "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",
32027         "type": "json"
32028       }
32029     ],
32030     "name": "AddTeams",
32031     "group": "Voice_Queues",
32032     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32033     "version": "0.0.0",
32034     "filename": "server/api/voiceQueue/index.js",
32035     "groupTitle": "Voice_Queues"
32036   },
32037   {
32038     "type": "post",
32039     "url": "/api/voice/queues/clone",
32040     "title": "Clone an existing Queue",
32041     "examples": [
32042       {
32043         "title": "Example usage:",
32044         "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",
32045         "type": "json"
32046       }
32047     ],
32048     "name": "CloneQueues",
32049     "group": "Voice_Queues",
32050     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32051     "version": "0.0.0",
32052     "filename": "server/api/voiceQueue/index.js",
32053     "groupTitle": "Voice_Queues"
32054   },
32055   {
32056     "type": "post",
32057     "url": "/api/voice/queues",
32058     "title": "Creates a new Queue",
32059     "examples": [
32060       {
32061         "title": "Example usage:",
32062         "content": "curl https://{domain}/api/voice/queues -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
32063         "type": "json"
32064       }
32065     ],
32066     "name": "CreateQueues",
32067     "group": "Voice_Queues",
32068     "parameter": {
32069       "fields": {
32070         "Body": [
32071           {
32072             "group": "Body",
32073             "type": "String",
32074             "optional": false,
32075             "field": "name",
32076             "description": ""
32077           },
32078           {
32079             "group": "Body",
32080             "type": "String",
32081             "allowedValues": [
32082               "\"inbound\"",
32083               "\"outbound\""
32084             ],
32085             "optional": false,
32086             "field": "type",
32087             "description": ""
32088           },
32089           {
32090             "group": "Body",
32091             "type": "String",
32092             "optional": true,
32093             "field": "musiconhold",
32094             "description": ""
32095           },
32096           {
32097             "group": "Body",
32098             "type": "String",
32099             "optional": true,
32100             "field": "announce",
32101             "description": ""
32102           },
32103           {
32104             "group": "Body",
32105             "type": "String",
32106             "allowedValues": [
32107               "\"rr\"",
32108               "\"ringall\"",
32109               "\"leastrecent\"",
32110               "\"fewestcalls\"",
32111               "\"random\"",
32112               "\"rrmemory\"",
32113               "\"linear\"",
32114               "\"wrandom\"",
32115               "\"rrordered\""
32116             ],
32117             "optional": false,
32118             "field": "strategy",
32119             "description": ""
32120           },
32121           {
32122             "group": "Body",
32123             "type": "Integer",
32124             "optional": true,
32125             "field": "servicelevel",
32126             "description": ""
32127           },
32128           {
32129             "group": "Body",
32130             "type": "String",
32131             "optional": true,
32132             "field": "context",
32133             "description": ""
32134           },
32135           {
32136             "group": "Body",
32137             "type": "Integer",
32138             "optional": true,
32139             "field": "penaltymemberslimit",
32140             "description": ""
32141           },
32142           {
32143             "group": "Body",
32144             "type": "Integer",
32145             "optional": true,
32146             "field": "timeout",
32147             "description": ""
32148           },
32149           {
32150             "group": "Body",
32151             "type": "Integer",
32152             "optional": true,
32153             "field": "retry",
32154             "description": ""
32155           },
32156           {
32157             "group": "Body",
32158             "type": "String",
32159             "optional": true,
32160             "field": "timeoutpriority",
32161             "description": ""
32162           },
32163           {
32164             "group": "Body",
32165             "type": "Integer",
32166             "optional": true,
32167             "field": "weight",
32168             "description": ""
32169           },
32170           {
32171             "group": "Body",
32172             "type": "Integer",
32173             "optional": true,
32174             "field": "wrapuptime",
32175             "description": ""
32176           },
32177           {
32178             "group": "Body",
32179             "type": "String",
32180             "allowedValues": [
32181               "\"yes\"",
32182               "\"no\""
32183             ],
32184             "optional": true,
32185             "field": "autofill",
32186             "description": ""
32187           },
32188           {
32189             "group": "Body",
32190             "type": "String",
32191             "allowedValues": [
32192               "\"yes\"",
32193               "\"no\"",
32194               "\"all\""
32195             ],
32196             "optional": true,
32197             "field": "autopause",
32198             "description": ""
32199           },
32200           {
32201             "group": "Body",
32202             "type": "Integer",
32203             "optional": true,
32204             "field": "autopausedelay",
32205             "description": ""
32206           },
32207           {
32208             "group": "Body",
32209             "type": "String",
32210             "allowedValues": [
32211               "\"yes\"",
32212               "\"no\""
32213             ],
32214             "optional": true,
32215             "field": "autopausebusy",
32216             "description": ""
32217           },
32218           {
32219             "group": "Body",
32220             "type": "String",
32221             "allowedValues": [
32222               "\"yes\"",
32223               "\"no\""
32224             ],
32225             "optional": true,
32226             "field": "autopauseunavail",
32227             "description": ""
32228           },
32229           {
32230             "group": "Body",
32231             "type": "Integer",
32232             "optional": true,
32233             "field": "maxlen",
32234             "description": ""
32235           },
32236           {
32237             "group": "Body",
32238             "type": "String",
32239             "allowedValues": [
32240               "\"yes\"",
32241               "\"no\""
32242             ],
32243             "optional": true,
32244             "field": "setinterfacevar",
32245             "description": ""
32246           },
32247           {
32248             "group": "Body",
32249             "type": "String",
32250             "allowedValues": [
32251               "\"yes\"",
32252               "\"no\""
32253             ],
32254             "optional": true,
32255             "field": "setqueueentryvar",
32256             "description": ""
32257           },
32258           {
32259             "group": "Body",
32260             "type": "String",
32261             "allowedValues": [
32262               "\"yes\"",
32263               "\"no\""
32264             ],
32265             "optional": true,
32266             "field": "setqueuevar",
32267             "description": ""
32268           },
32269           {
32270             "group": "Body",
32271             "type": "String",
32272             "allowedValues": [
32273               "\"yes\"",
32274               "\"no\""
32275             ],
32276             "optional": true,
32277             "field": "eventmemberstatus",
32278             "description": ""
32279           },
32280           {
32281             "group": "Body",
32282             "type": "String",
32283             "optional": true,
32284             "field": "membermacro",
32285             "description": ""
32286           },
32287           {
32288             "group": "Body",
32289             "type": "String",
32290             "optional": true,
32291             "field": "membergosub",
32292             "description": ""
32293           },
32294           {
32295             "group": "Body",
32296             "type": "Integer",
32297             "optional": true,
32298             "field": "announce_frequency",
32299             "description": ""
32300           },
32301           {
32302             "group": "Body",
32303             "type": "Integer",
32304             "optional": true,
32305             "field": "min_announce_frequency",
32306             "description": ""
32307           },
32308           {
32309             "group": "Body",
32310             "type": "Integer",
32311             "optional": true,
32312             "field": "periodic_announce_frequency",
32313             "description": ""
32314           },
32315           {
32316             "group": "Body",
32317             "type": "String",
32318             "allowedValues": [
32319               "\"yes\"",
32320               "\"no\""
32321             ],
32322             "optional": true,
32323             "field": "random_periodic_announce",
32324             "description": ""
32325           },
32326           {
32327             "group": "Body",
32328             "type": "String",
32329             "allowedValues": [
32330               "\"yes\"",
32331               "\"no\""
32332             ],
32333             "optional": true,
32334             "field": "relative_periodic_announce",
32335             "description": ""
32336           },
32337           {
32338             "group": "Body",
32339             "type": "String",
32340             "allowedValues": [
32341               "\"yes\"",
32342               "\"no\"",
32343               "\"once\""
32344             ],
32345             "optional": true,
32346             "field": "announce_holdtime",
32347             "description": ""
32348           },
32349           {
32350             "group": "Body",
32351             "type": "String",
32352             "optional": true,
32353             "field": "announce_position",
32354             "description": ""
32355           },
32356           {
32357             "group": "Body",
32358             "type": "String",
32359             "allowedValues": [
32360               "\"yes\"",
32361               "\"no\""
32362             ],
32363             "optional": true,
32364             "field": "announce_to_first_user",
32365             "description": ""
32366           },
32367           {
32368             "group": "Body",
32369             "type": "Integer",
32370             "optional": true,
32371             "field": "announce_position_limit",
32372             "description": ""
32373           },
32374           {
32375             "group": "Body",
32376             "type": "String",
32377             "allowedValues": [
32378               "\"0\"",
32379               "\"5\"",
32380               "\"10\"",
32381               "\"15\"",
32382               "\"20\"",
32383               "\"30\""
32384             ],
32385             "optional": true,
32386             "field": "announce_round_seconds",
32387             "description": ""
32388           },
32389           {
32390             "group": "Body",
32391             "type": "String",
32392             "optional": true,
32393             "field": "monitor_format",
32394             "description": ""
32395           },
32396           {
32397             "group": "Body",
32398             "type": "String",
32399             "optional": true,
32400             "field": "monitor_type",
32401             "description": ""
32402           },
32403           {
32404             "group": "Body",
32405             "type": "String",
32406             "optional": true,
32407             "field": "queue_youarenext",
32408             "description": ""
32409           },
32410           {
32411             "group": "Body",
32412             "type": "String",
32413             "optional": true,
32414             "field": "queue_thereare",
32415             "description": ""
32416           },
32417           {
32418             "group": "Body",
32419             "type": "String",
32420             "optional": true,
32421             "field": "queue_callswaiting",
32422             "description": ""
32423           },
32424           {
32425             "group": "Body",
32426             "type": "String",
32427             "optional": true,
32428             "field": "queue_holdtime",
32429             "description": ""
32430           },
32431           {
32432             "group": "Body",
32433             "type": "String",
32434             "optional": true,
32435             "field": "queue_minute",
32436             "description": ""
32437           },
32438           {
32439             "group": "Body",
32440             "type": "String",
32441             "optional": true,
32442             "field": "queue_minutes",
32443             "description": ""
32444           },
32445           {
32446             "group": "Body",
32447             "type": "String",
32448             "optional": true,
32449             "field": "queue_seconds",
32450             "description": ""
32451           },
32452           {
32453             "group": "Body",
32454             "type": "String",
32455             "optional": true,
32456             "field": "queue_thankyou",
32457             "description": ""
32458           },
32459           {
32460             "group": "Body",
32461             "type": "String",
32462             "optional": true,
32463             "field": "queue_reporthold",
32464             "description": ""
32465           },
32466           {
32467             "group": "Body",
32468             "type": "String",
32469             "optional": true,
32470             "field": "queue_quantity1",
32471             "description": ""
32472           },
32473           {
32474             "group": "Body",
32475             "type": "String",
32476             "optional": true,
32477             "field": "queue_quantity2",
32478             "description": ""
32479           },
32480           {
32481             "group": "Body",
32482             "type": "String",
32483             "optional": true,
32484             "field": "queue_periodic_announce",
32485             "description": ""
32486           },
32487           {
32488             "group": "Body",
32489             "type": "String",
32490             "optional": true,
32491             "field": "queue_less_than",
32492             "description": ""
32493           },
32494           {
32495             "group": "Body",
32496             "type": "Text",
32497             "optional": true,
32498             "field": "periodic_announce",
32499             "description": ""
32500           },
32501           {
32502             "group": "Body",
32503             "type": "String",
32504             "optional": true,
32505             "field": "joinempty",
32506             "description": ""
32507           },
32508           {
32509             "group": "Body",
32510             "type": "String",
32511             "optional": true,
32512             "field": "leavewhenempty",
32513             "description": ""
32514           },
32515           {
32516             "group": "Body",
32517             "type": "String",
32518             "allowedValues": [
32519               "\"yes\"",
32520               "\"no\""
32521             ],
32522             "optional": true,
32523             "field": "reportholdtime",
32524             "description": ""
32525           },
32526           {
32527             "group": "Body",
32528             "type": "String",
32529             "allowedValues": [
32530               "\"yes\"",
32531               "\"no\""
32532             ],
32533             "optional": true,
32534             "field": "ringinuse",
32535             "description": ""
32536           },
32537           {
32538             "group": "Body",
32539             "type": "Integer",
32540             "optional": true,
32541             "field": "memberdelay",
32542             "description": ""
32543           },
32544           {
32545             "group": "Body",
32546             "type": "String",
32547             "allowedValues": [
32548               "\"yes\"",
32549               "\"no\""
32550             ],
32551             "optional": true,
32552             "field": "timeoutrestart",
32553             "description": ""
32554           },
32555           {
32556             "group": "Body",
32557             "type": "String",
32558             "optional": true,
32559             "field": "defaultrule",
32560             "description": ""
32561           },
32562           {
32563             "group": "Body",
32564             "type": "String",
32565             "optional": true,
32566             "field": "description",
32567             "description": ""
32568           },
32569           {
32570             "group": "Body",
32571             "type": "Boolean",
32572             "optional": true,
32573             "field": "acw",
32574             "description": ""
32575           },
32576           {
32577             "group": "Body",
32578             "type": "Integer",
32579             "optional": true,
32580             "field": "acwTimeout",
32581             "description": ""
32582           },
32583           {
32584             "group": "Body",
32585             "type": "Boolean",
32586             "optional": true,
32587             "field": "dialActive",
32588             "description": "<p>Active/Disactive Campaign</p>"
32589           },
32590           {
32591             "group": "Body",
32592             "type": "String",
32593             "allowedValues": [
32594               "\"preview\"",
32595               "\"progressive\"",
32596               "\"power\"",
32597               "\"predictive\"",
32598               "\"booked\""
32599             ],
32600             "optional": true,
32601             "field": "dialMethod",
32602             "description": "<p>Dial Method.</p>"
32603           },
32604           {
32605             "group": "Body",
32606             "type": "Integer",
32607             "optional": true,
32608             "field": "dialLimitChannel",
32609             "description": "<p>Max 9999 channels, 0 means unlimited.</p>"
32610           },
32611           {
32612             "group": "Body",
32613             "type": "Integer",
32614             "optional": true,
32615             "field": "dialLimitQueue",
32616             "description": "<p>Max 9999 member in queue(min:1, max:9999), 0 means unlimited.</p>"
32617           },
32618           {
32619             "group": "Body",
32620             "type": "Float",
32621             "optional": true,
32622             "field": "dialPowerLevel",
32623             "description": "<p>Power Level: Calls for agents (min:1, max:10).</p>"
32624           },
32625           {
32626             "group": "Body",
32627             "type": "String",
32628             "allowedValues": [
32629               "\"agentBusyFactor\"",
32630               "\"dropRate\""
32631             ],
32632             "optional": true,
32633             "field": "dialPredictiveOptimization",
32634             "description": "<p>Only for predictive method.</p>"
32635           },
32636           {
32637             "group": "Body",
32638             "type": "Float",
32639             "optional": true,
32640             "field": "dialPredictiveOptimizationPercentage",
32641             "description": "<p>Predictive Optimization Percentage (min: 1, max: 95)</p>"
32642           },
32643           {
32644             "group": "Body",
32645             "type": "Integer",
32646             "optional": true,
32647             "field": "dialPredictiveInterval",
32648             "description": "<p>Interval Predictive Minutes (min:5 max:30)</p>"
32649           },
32650           {
32651             "group": "Body",
32652             "type": "String",
32653             "optional": true,
32654             "field": "dialOriginateCallerIdName",
32655             "description": ""
32656           },
32657           {
32658             "group": "Body",
32659             "type": "String",
32660             "optional": true,
32661             "field": "dialOriginateCallerIdNumber",
32662             "description": ""
32663           },
32664           {
32665             "group": "Body",
32666             "type": "Integer",
32667             "optional": true,
32668             "field": "dialOriginateTimeout",
32669             "description": "<p>Originate Timeout Seconds (min:1, max:999)</p>"
32670           },
32671           {
32672             "group": "Body",
32673             "type": "String",
32674             "optional": true,
32675             "field": "dialQueueOptions",
32676             "description": "<p>https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Queue</p>"
32677           },
32678           {
32679             "group": "Body",
32680             "type": "Integer",
32681             "optional": true,
32682             "field": "dialQueueTimeout",
32683             "description": "<p>Queue Timeout Seconds (min:1, max:999)</p>"
32684           },
32685           {
32686             "group": "Body",
32687             "type": "String",
32688             "optional": true,
32689             "field": "dialQueueProject",
32690             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32691           },
32692           {
32693             "group": "Body",
32694             "type": "Integer",
32695             "optional": true,
32696             "field": "dialCongestionMaxRetry",
32697             "description": "<p>#Congestion Retry (min:1, max:999)</p>"
32698           },
32699           {
32700             "group": "Body",
32701             "type": "Integer",
32702             "optional": true,
32703             "field": "dialCongestionRetryFrequency",
32704             "description": "<p>Congestion Retry Frequency Minutes (min:1, max:99999)</p>"
32705           },
32706           {
32707             "group": "Body",
32708             "type": "Integer",
32709             "optional": true,
32710             "field": "dialBusyMaxRetry",
32711             "description": "<p>#Busy Retry (min:1, max:999)</p>"
32712           },
32713           {
32714             "group": "Body",
32715             "type": "Integer",
32716             "optional": true,
32717             "field": "dialBusyRetryFrequency",
32718             "description": "<p>Busy Retry Frequency Minutes (min:1, max:99999)</p>"
32719           },
32720           {
32721             "group": "Body",
32722             "type": "Integer",
32723             "optional": true,
32724             "field": "dialNoAnswerMaxRetry",
32725             "description": "<p>#NoAnswer Retry (min:1, max:999)</p>"
32726           },
32727           {
32728             "group": "Body",
32729             "type": "Integer",
32730             "optional": true,
32731             "field": "dialNoAnswerRetryFrequency",
32732             "description": "<p>NoAnswer Retry Frequency Minutes (min:1, max:99999)</p>"
32733           },
32734           {
32735             "group": "Body",
32736             "type": "Integer",
32737             "optional": true,
32738             "field": "dialGlobalMaxRetry",
32739             "description": "<p>#Global Max Retry (min:1, max:999)</p>"
32740           },
32741           {
32742             "group": "Body",
32743             "type": "String",
32744             "optional": true,
32745             "field": "dialTimezone",
32746             "description": ""
32747           },
32748           {
32749             "group": "Body",
32750             "type": "String",
32751             "optional": true,
32752             "field": "dialGlobalInterval",
32753             "description": ""
32754           },
32755           {
32756             "group": "Body",
32757             "type": "String",
32758             "optional": true,
32759             "field": "dialPrefix",
32760             "description": ""
32761           },
32762           {
32763             "group": "Body",
32764             "type": "String",
32765             "allowedValues": [
32766               "\"always\"",
32767               "\"never\"",
32768               "\"onlyIfOpen\""
32769             ],
32770             "optional": true,
32771             "field": "dialCheckDuplicateType",
32772             "description": ""
32773           },
32774           {
32775             "group": "Body",
32776             "type": "Boolean",
32777             "optional": true,
32778             "field": "dialAMDActive",
32779             "description": "<p>Active/Disactive AMD</p>"
32780           },
32781           {
32782             "group": "Body",
32783             "type": "Integer",
32784             "optional": true,
32785             "field": "dialAMDInitialSilence",
32786             "description": "<p>#AMD Initial Silence</p>"
32787           },
32788           {
32789             "group": "Body",
32790             "type": "Integer",
32791             "optional": true,
32792             "field": "dialAMDGreeting",
32793             "description": "<p>#AMD Greeting</p>"
32794           },
32795           {
32796             "group": "Body",
32797             "type": "Integer",
32798             "optional": true,
32799             "field": "dialAMDAfterGreetingSilence",
32800             "description": "<p>#AMD After Greeting Silence</p>"
32801           },
32802           {
32803             "group": "Body",
32804             "type": "Integer",
32805             "optional": true,
32806             "field": "dialAMDTotalAnalysisTime",
32807             "description": "<p>#AMD Total Analysis Time</p>"
32808           },
32809           {
32810             "group": "Body",
32811             "type": "Integer",
32812             "optional": true,
32813             "field": "dialAMDMinWordLength",
32814             "description": "<p>#AMD Min Word Length</p>"
32815           },
32816           {
32817             "group": "Body",
32818             "type": "Integer",
32819             "optional": true,
32820             "field": "dialAMDBetweenWordsSilence",
32821             "description": "<p>#AMD Between Words Silence</p>"
32822           },
32823           {
32824             "group": "Body",
32825             "type": "Integer",
32826             "optional": true,
32827             "field": "dialAMDMaximumNumberOfWords",
32828             "description": "<p>#AMD Maximum Number Of Words</p>"
32829           },
32830           {
32831             "group": "Body",
32832             "type": "Integer",
32833             "optional": true,
32834             "field": "dialAMDSilenceThreshold",
32835             "description": "<p>#AMD Silence Threshold (min:0, max:32767)</p>"
32836           },
32837           {
32838             "group": "Body",
32839             "type": "Integer",
32840             "optional": true,
32841             "field": "dialAMDMaximumWordLength",
32842             "description": "<p>#AMD Maximum Word Length</p>"
32843           },
32844           {
32845             "group": "Body",
32846             "type": "Integer",
32847             "optional": true,
32848             "field": "dialRecallMeTimeout",
32849             "description": "<p>#RecallMe Timeout (min:1)</p>"
32850           },
32851           {
32852             "group": "Body",
32853             "type": "Boolean",
32854             "optional": true,
32855             "field": "dialRecallInQueue",
32856             "description": "<p>Active/Disactive Recall In Queue</p>"
32857           },
32858           {
32859             "group": "Body",
32860             "type": "String",
32861             "allowedValues": [
32862               "\"DESC\"",
32863               "\"ASC\""
32864             ],
32865             "optional": true,
32866             "field": "dialOrderByScheduledAt",
32867             "description": ""
32868           },
32869           {
32870             "group": "Body",
32871             "type": "String",
32872             "optional": true,
32873             "field": "dialQueueProject2",
32874             "description": "<p>AGI queue option (use: agi://127.0.0.1/square,&lt;project_name&gt;)</p>"
32875           },
32876           {
32877             "group": "Body",
32878             "type": "Boolean",
32879             "optional": true,
32880             "field": "dialAgiAfterHangupClient",
32881             "description": ""
32882           },
32883           {
32884             "group": "Body",
32885             "type": "Boolean",
32886             "optional": true,
32887             "field": "dialAgiAfterHangupAgent",
32888             "description": ""
32889           },
32890           {
32891             "group": "Body",
32892             "type": "Integer",
32893             "optional": true,
32894             "field": "dialRandomLastDigitCallerIdNumber",
32895             "description": "<p>Random Last Digit (min:1, max:15)</p>"
32896           },
32897           {
32898             "group": "Body",
32899             "type": "Integer",
32900             "optional": true,
32901             "field": "dialCutDigit",
32902             "description": "<p>Cut Digit (min:1, max:15)</p>"
32903           },
32904           {
32905             "group": "Body",
32906             "type": "Integer",
32907             "optional": true,
32908             "field": "mandatoryDispositionPauseId",
32909             "description": "<p>Status to put when mandatory disposition is enabled</p>"
32910           },
32911           {
32912             "group": "Body",
32913             "type": "Boolean",
32914             "optional": true,
32915             "field": "mandatoryDisposition",
32916             "description": "<p>Enabled/disables mandatory dispo on a queue</p>"
32917           },
32918           {
32919             "group": "Body",
32920             "type": "Integer",
32921             "optional": true,
32922             "field": "dialPredictiveIntervalMaxThreshold",
32923             "description": ""
32924           },
32925           {
32926             "group": "Body",
32927             "type": "Integer",
32928             "optional": true,
32929             "field": "dialPredictiveIntervalMinThreshold",
32930             "description": ""
32931           }
32932         ]
32933       }
32934     },
32935     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32936     "version": "0.0.0",
32937     "filename": "server/api/voiceQueue/index.js",
32938     "groupTitle": "Voice_Queues"
32939   },
32940   {
32941     "type": "delete",
32942     "url": "/api/voice/queues/{id}",
32943     "title": "Deletes a Queue",
32944     "examples": [
32945       {
32946         "title": "Example usage:",
32947         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password} -X DELETE",
32948         "type": "json"
32949       }
32950     ],
32951     "name": "DeleteQueues",
32952     "group": "Voice_Queues",
32953     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32954     "version": "0.0.0",
32955     "filename": "server/api/voiceQueue/index.js",
32956     "groupTitle": "Voice_Queues"
32957   },
32958   {
32959     "type": "get",
32960     "url": "/api/voice/queues/{id}/users",
32961     "title": "Gets queue agents",
32962     "examples": [
32963       {
32964         "title": "Example usage:",
32965         "content": "curl https://{domain}/api/voice/queues/{id}/users -v -u {name}:{password} -X GET",
32966         "type": "json"
32967       }
32968     ],
32969     "name": "GetAgents",
32970     "group": "Voice_Queues",
32971     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32972     "version": "0.0.0",
32973     "filename": "server/api/voiceQueue/index.js",
32974     "groupTitle": "Voice_Queues"
32975   },
32976   {
32977     "type": "get",
32978     "url": "/api/voice/queues/{id}/blacklists",
32979     "title": "Get queue blacklists",
32980     "examples": [
32981       {
32982         "title": "Example usage:",
32983         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists -v -u {name}:{password} -X GET",
32984         "type": "json"
32985       }
32986     ],
32987     "name": "GetBlackLists",
32988     "group": "Voice_Queues",
32989     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
32990     "version": "0.0.0",
32991     "filename": "server/api/voiceQueue/index.js",
32992     "groupTitle": "Voice_Queues"
32993   },
32994   {
32995     "type": "get",
32996     "url": "/api/voice/queues/{id}/finals",
32997     "title": "Gets queue hopper finals",
32998     "examples": [
32999       {
33000         "title": "Example usage:",
33001         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_finals -v -u {name}:{password}  -X GET",
33002         "type": "json"
33003       }
33004     ],
33005     "name": "GetHopperFinals",
33006     "group": "Voice_Queues",
33007     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33008     "version": "0.0.0",
33009     "filename": "server/api/voiceQueue/index.js",
33010     "groupTitle": "Voice_Queues"
33011   },
33012   {
33013     "type": "get",
33014     "url": "/api/voice/queues/{id}/hopper_histories",
33015     "title": "Gets queue hopper histories",
33016     "examples": [
33017       {
33018         "title": "Example usage:",
33019         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_histories -v -u {name}:{password} -X GET",
33020         "type": "json"
33021       }
33022     ],
33023     "name": "GetHopperHistories",
33024     "group": "Voice_Queues",
33025     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33026     "version": "0.0.0",
33027     "filename": "server/api/voiceQueue/index.js",
33028     "groupTitle": "Voice_Queues"
33029   },
33030   {
33031     "type": "get",
33032     "url": "/api/voice/queues/{id}/hoppers",
33033     "title": "Gets queue hoppers",
33034     "examples": [
33035       {
33036         "title": "Example usage:",
33037         "content": "curl https://{domain}/api/voice/queues/{id}/hoppers -v -u {name}:{password} -X GET",
33038         "type": "json"
33039       }
33040     ],
33041     "name": "GetHoppers",
33042     "group": "Voice_Queues",
33043     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33044     "version": "0.0.0",
33045     "filename": "server/api/voiceQueue/index.js",
33046     "groupTitle": "Voice_Queues"
33047   },
33048   {
33049     "type": "get",
33050     "url": "/api/voice/queues/{id}/lists",
33051     "title": "Get queue lists",
33052     "examples": [
33053       {
33054         "title": "Example usage:",
33055         "content": "curl https://{domain}/api/voice/queues/{id}/lists -v -u {name}:{password} -X GET",
33056         "type": "json"
33057       }
33058     ],
33059     "name": "GetLists",
33060     "group": "Voice_Queues",
33061     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33062     "version": "0.0.0",
33063     "filename": "server/api/voiceQueue/index.js",
33064     "groupTitle": "Voice_Queues"
33065   },
33066   {
33067     "type": "get",
33068     "url": "/api/voice/queues/{id}/members",
33069     "title": "Gets queue members",
33070     "examples": [
33071       {
33072         "title": "Example usage:",
33073         "content": "curl https://{domain}/api/voice/queues/{id}/members -v -u {name}:{password} -X GET",
33074         "type": "json"
33075       }
33076     ],
33077     "name": "GetMembers",
33078     "group": "Voice_Queues",
33079     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33080     "version": "0.0.0",
33081     "filename": "server/api/voiceQueue/index.js",
33082     "groupTitle": "Voice_Queues"
33083   },
33084   {
33085     "type": "get",
33086     "url": "/api/voice/queues",
33087     "title": "Gets a list of Queues",
33088     "examples": [
33089       {
33090         "title": "Example usage:",
33091         "content": "curl https://{domain}/api/voice/queues -v -u {name}:{password}",
33092         "type": "json"
33093       }
33094     ],
33095     "name": "GetQueues",
33096     "group": "Voice_Queues",
33097     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33098     "version": "0.0.0",
33099     "filename": "server/api/voiceQueue/index.js",
33100     "groupTitle": "Voice_Queues"
33101   },
33102   {
33103     "type": "get",
33104     "url": "/api/voice/queues/{id}/teams",
33105     "title": "Gets queue team",
33106     "examples": [
33107       {
33108         "title": "Example usage:",
33109         "content": "curl https://{domain}/api/voice/queues/{id}/teams -v -u {name}:{password}  -X GET",
33110         "type": "json"
33111       }
33112     ],
33113     "name": "GetTeams",
33114     "group": "Voice_Queues",
33115     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33116     "version": "0.0.0",
33117     "filename": "server/api/voiceQueue/index.js",
33118     "groupTitle": "Voice_Queues"
33119   },
33120   {
33121     "type": "delete",
33122     "url": "/api/voice/queues/{id}/users",
33123     "title": "Removes agents from a queue",
33124     "examples": [
33125       {
33126         "title": "Example usage:",
33127         "content": "curl https://{domain}/api/voice/queues/{id}/users?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33128         "type": "json"
33129       }
33130     ],
33131     "name": "RemoveAgents",
33132     "group": "Voice_Queues",
33133     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33134     "version": "0.0.0",
33135     "filename": "server/api/voiceQueue/index.js",
33136     "groupTitle": "Voice_Queues"
33137   },
33138   {
33139     "type": "delete",
33140     "url": "/api/voice/queues/{id}/blacklists",
33141     "title": "Remove blacklists from a queue",
33142     "examples": [
33143       {
33144         "title": "Example usage:",
33145         "content": "curl https://{domain}/api/voice/queues/{id}/blacklists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33146         "type": "json"
33147       }
33148     ],
33149     "name": "RemoveBlackLists",
33150     "group": "Voice_Queues",
33151     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33152     "version": "0.0.0",
33153     "filename": "server/api/voiceQueue/index.js",
33154     "groupTitle": "Voice_Queues"
33155   },
33156   {
33157     "type": "delete",
33158     "url": "/api/voice/queues/{id}/lists",
33159     "title": "Remove lists from a queue",
33160     "examples": [
33161       {
33162         "title": "Example usage:",
33163         "content": "curl https://{domain}/api/voice/queues/{id}/lists?ids=1&ids=2 -v -u {name}:{password} -X DELETE",
33164         "type": "json"
33165       }
33166     ],
33167     "name": "RemoveLists",
33168     "group": "Voice_Queues",
33169     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33170     "version": "0.0.0",
33171     "filename": "server/api/voiceQueue/index.js",
33172     "groupTitle": "Voice_Queues"
33173   },
33174   {
33175     "type": "get",
33176     "url": "/api/voice/queues/{id}",
33177     "title": "Gets a single Queue",
33178     "examples": [
33179       {
33180         "title": "Example usage:",
33181         "content": "curl https://{domain}/api/voice/queues/{id} -v -u {name}:{password}",
33182         "type": "json"
33183       }
33184     ],
33185     "name": "ShowQueues",
33186     "group": "Voice_Queues",
33187     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33188     "version": "0.0.0",
33189     "filename": "server/api/voiceQueue/index.js",
33190     "groupTitle": "Voice_Queues"
33191   },
33192   {
33193     "type": "get",
33194     "url": "/api/voice/queues/{id}/blacks",
33195     "title": "Gets queue hopper blacks",
33196     "examples": [
33197       {
33198         "title": "Example usage:",
33199         "content": "curl https://{domain}/api/voice/queues/{id}/hopper_black -v -u {name}:{password}  -X GET",
33200         "type": "json"
33201       }
33202     ],
33203     "name": "getHopperBlacks",
33204     "group": "Voice_Queues",
33205     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33206     "version": "0.0.0",
33207     "filename": "server/api/voiceQueue/index.js",
33208     "groupTitle": "Voice_Queues"
33209   },
33210   {
33211     "type": "put",
33212     "url": "/api/voice/queues/{id}",
33213     "title": "Update an existing Queue",
33214     "examples": [
33215       {
33216         "title": "Example usage:",
33217         "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",
33218         "type": "json"
33219       }
33220     ],
33221     "name": "updateQueues",
33222     "group": "Voice_Queues",
33223     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33224     "version": "0.0.0",
33225     "filename": "server/api/voiceQueue/index.js",
33226     "groupTitle": "Voice_Queues"
33227   },
33228   {
33229     "type": "post",
33230     "url": "/api/voice/recordings",
33231     "title": "Creates a new Recording",
33232     "examples": [
33233       {
33234         "title": "Example usage:",
33235         "content": "curl https://{domain}/api/voice/recordings -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
33236         "type": "json"
33237       }
33238     ],
33239     "name": "CreateRecordings",
33240     "group": "Voice_Recordings",
33241     "parameter": {
33242       "fields": {
33243         "Body": [
33244           {
33245             "group": "Body",
33246             "type": "Virtual",
33247             "optional": true,
33248             "field": "format",
33249             "description": ""
33250           },
33251           {
33252             "group": "Body",
33253             "type": "String",
33254             "optional": true,
33255             "field": "uniqueid",
33256             "description": ""
33257           },
33258           {
33259             "group": "Body",
33260             "type": "String",
33261             "optional": true,
33262             "field": "channel",
33263             "description": ""
33264           },
33265           {
33266             "group": "Body",
33267             "type": "String",
33268             "optional": true,
33269             "field": "membername",
33270             "description": ""
33271           },
33272           {
33273             "group": "Body",
33274             "type": "String",
33275             "optional": true,
33276             "field": "calleridnum",
33277             "description": ""
33278           },
33279           {
33280             "group": "Body",
33281             "type": "String",
33282             "optional": true,
33283             "field": "calleridname",
33284             "description": ""
33285           },
33286           {
33287             "group": "Body",
33288             "type": "String",
33289             "optional": true,
33290             "field": "connectedlinenum",
33291             "description": ""
33292           },
33293           {
33294             "group": "Body",
33295             "type": "String",
33296             "optional": true,
33297             "field": "connectedlinename",
33298             "description": ""
33299           },
33300           {
33301             "group": "Body",
33302             "type": "String",
33303             "optional": true,
33304             "field": "accountcode",
33305             "description": ""
33306           },
33307           {
33308             "group": "Body",
33309             "type": "String",
33310             "optional": true,
33311             "field": "context",
33312             "description": ""
33313           },
33314           {
33315             "group": "Body",
33316             "type": "String",
33317             "optional": true,
33318             "field": "exten",
33319             "description": ""
33320           },
33321           {
33322             "group": "Body",
33323             "type": "String",
33324             "optional": true,
33325             "field": "value",
33326             "description": ""
33327           },
33328           {
33329             "group": "Body",
33330             "type": "String",
33331             "optional": true,
33332             "field": "type",
33333             "description": ""
33334           },
33335           {
33336             "group": "Body",
33337             "type": "Integer",
33338             "optional": true,
33339             "field": "rating",
33340             "description": ""
33341           },
33342           {
33343             "group": "Body",
33344             "type": "String",
33345             "optional": true,
33346             "field": "queue",
33347             "description": ""
33348           },
33349           {
33350             "group": "Body",
33351             "type": "String",
33352             "optional": true,
33353             "field": "userDisposition",
33354             "description": ""
33355           },
33356           {
33357             "group": "Body",
33358             "type": "String",
33359             "optional": true,
33360             "field": "createdAt",
33361             "description": ""
33362           },
33363           {
33364             "group": "Body",
33365             "type": "String",
33366             "optional": true,
33367             "field": "updatedAt",
33368             "description": ""
33369           }
33370         ]
33371       }
33372     },
33373     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33374     "version": "0.0.0",
33375     "filename": "server/api/voiceRecording/index.js",
33376     "groupTitle": "Voice_Recordings"
33377   },
33378   {
33379     "type": "get",
33380     "url": "/api/voice/recordings/describe",
33381     "title": "Gets table info about Recordings",
33382     "examples": [
33383       {
33384         "title": "Example usage:",
33385         "content": "curl https://{domain}/api/voice/recordings/describe -v -u {name}:{password}",
33386         "type": "json"
33387       }
33388     ],
33389     "name": "DescribeRecordings",
33390     "group": "Voice_Recordings",
33391     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33392     "version": "0.0.0",
33393     "filename": "server/api/voiceRecording/index.js",
33394     "groupTitle": "Voice_Recordings"
33395   },
33396   {
33397     "type": "get",
33398     "url": "/api/voice/recordings",
33399     "title": "Gets a list of Recordings",
33400     "examples": [
33401       {
33402         "title": "Example usage:",
33403         "content": "curl https://{domain}/api/voice/recordings -v -u {name}:{password}",
33404         "type": "json"
33405       }
33406     ],
33407     "name": "GetRecordings",
33408     "group": "Voice_Recordings",
33409     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33410     "version": "0.0.0",
33411     "filename": "server/api/voiceRecording/index.js",
33412     "groupTitle": "Voice_Recordings"
33413   },
33414   {
33415     "type": "get",
33416     "url": "/api/voice/recordings/{id}",
33417     "title": "Gets a single Recording",
33418     "examples": [
33419       {
33420         "title": "Example usage:",
33421         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password}",
33422         "type": "json"
33423       }
33424     ],
33425     "name": "ShowRecordings",
33426     "group": "Voice_Recordings",
33427     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33428     "version": "0.0.0",
33429     "filename": "server/api/voiceRecording/index.js",
33430     "groupTitle": "Voice_Recordings"
33431   },
33432   {
33433     "type": "delete",
33434     "url": "/api/voice/recordings/{id}",
33435     "title": "Delete voice recording",
33436     "examples": [
33437       {
33438         "title": "Example usage:",
33439         "content": "curl https://{domain}/api/voice/recordings/{id} -v -u {name}:{password} -X DELETE",
33440         "type": "json"
33441       }
33442     ],
33443     "name": "destroy",
33444     "group": "Voice_Recordings",
33445     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33446     "version": "0.0.0",
33447     "filename": "server/api/voiceRecording/index.js",
33448     "groupTitle": "Voice_Recordings"
33449   },
33450   {
33451     "type": "get",
33452     "url": "/api/voice/recordings/{id}/download",
33453     "title": "Download Recording",
33454     "examples": [
33455       {
33456         "title": "Example usage:",
33457         "content": "curl https://{domain}/api/voice/recordings/{id}/download -v -u {name}:{password} -X GET",
33458         "type": "json"
33459       }
33460     ],
33461     "name": "download",
33462     "group": "Voice_Recordings",
33463     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33464     "version": "0.0.0",
33465     "filename": "server/api/voiceRecording/index.js",
33466     "groupTitle": "Voice_Recordings"
33467   },
33468   {
33469     "type": "get",
33470     "url": "/api/voice/recordings/{id}/downloads",
33471     "title": "Download Recording",
33472     "examples": [
33473       {
33474         "title": "Example usage:",
33475         "content": "curl https://{domain}/api/voice/recordings/{id}/downloads -v -u {name}:{password} -X GET",
33476         "type": "json"
33477       }
33478     ],
33479     "name": "downloads",
33480     "group": "Voice_Recordings",
33481     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33482     "version": "0.0.0",
33483     "filename": "server/api/voiceRecording/index.js",
33484     "groupTitle": "Voice_Recordings"
33485   },
33486   {
33487     "type": "put",
33488     "url": "/api/voice/recordings/{id}",
33489     "title": "Update an existing Recording",
33490     "examples": [
33491       {
33492         "title": "Example usage:",
33493         "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",
33494         "type": "json"
33495       }
33496     ],
33497     "name": "updateRecordings",
33498     "group": "Voice_Recordings",
33499     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33500     "version": "0.0.0",
33501     "filename": "server/api/voiceRecording/index.js",
33502     "groupTitle": "Voice_Recordings"
33503   },
33504   {
33505     "type": "post",
33506     "url": "/api/voice/transfers/reports",
33507     "title": "Creates a new Transfer Report",
33508     "examples": [
33509       {
33510         "title": "Example usage:",
33511         "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",
33512         "type": "json"
33513       }
33514     ],
33515     "name": "CreateTransfer_Reports",
33516     "group": "Voice_Transfer_Reports",
33517     "parameter": {
33518       "fields": {
33519         "Body": [
33520           {
33521             "group": "Body",
33522             "type": "String",
33523             "allowedValues": [
33524               "\"blind\"",
33525               "\"attended\""
33526             ],
33527             "optional": true,
33528             "field": "type",
33529             "description": ""
33530           },
33531           {
33532             "group": "Body",
33533             "type": "String",
33534             "optional": true,
33535             "field": "result",
33536             "description": ""
33537           },
33538           {
33539             "group": "Body",
33540             "type": "String",
33541             "optional": true,
33542             "field": "transfererchannel",
33543             "description": ""
33544           },
33545           {
33546             "group": "Body",
33547             "type": "String",
33548             "optional": true,
33549             "field": "transferercalleridnum",
33550             "description": ""
33551           },
33552           {
33553             "group": "Body",
33554             "type": "String",
33555             "optional": true,
33556             "field": "transferercalleridname",
33557             "description": ""
33558           },
33559           {
33560             "group": "Body",
33561             "type": "String",
33562             "optional": true,
33563             "field": "transfererconnectedlinenum",
33564             "description": ""
33565           },
33566           {
33567             "group": "Body",
33568             "type": "String",
33569             "optional": true,
33570             "field": "transfererconnectedlinename",
33571             "description": ""
33572           },
33573           {
33574             "group": "Body",
33575             "type": "String",
33576             "optional": true,
33577             "field": "transfereraccountcode",
33578             "description": ""
33579           },
33580           {
33581             "group": "Body",
33582             "type": "String",
33583             "optional": true,
33584             "field": "transferercontext",
33585             "description": ""
33586           },
33587           {
33588             "group": "Body",
33589             "type": "String",
33590             "optional": true,
33591             "field": "transfererexten",
33592             "description": ""
33593           },
33594           {
33595             "group": "Body",
33596             "type": "String",
33597             "optional": true,
33598             "field": "transfererlinkedid",
33599             "description": ""
33600           },
33601           {
33602             "group": "Body",
33603             "type": "String",
33604             "optional": true,
33605             "field": "transfereechannel",
33606             "description": ""
33607           },
33608           {
33609             "group": "Body",
33610             "type": "String",
33611             "optional": true,
33612             "field": "transfereecalleridnum",
33613             "description": ""
33614           },
33615           {
33616             "group": "Body",
33617             "type": "String",
33618             "optional": true,
33619             "field": "transfereecalleridname",
33620             "description": ""
33621           },
33622           {
33623             "group": "Body",
33624             "type": "String",
33625             "optional": true,
33626             "field": "transfereeconnectedlinenum",
33627             "description": ""
33628           },
33629           {
33630             "group": "Body",
33631             "type": "String",
33632             "optional": true,
33633             "field": "transfereeconnectedlinename",
33634             "description": ""
33635           },
33636           {
33637             "group": "Body",
33638             "type": "String",
33639             "optional": true,
33640             "field": "transfereeaccountcode",
33641             "description": ""
33642           },
33643           {
33644             "group": "Body",
33645             "type": "String",
33646             "optional": true,
33647             "field": "transfereecontext",
33648             "description": ""
33649           },
33650           {
33651             "group": "Body",
33652             "type": "String",
33653             "optional": true,
33654             "field": "transfereeexten",
33655             "description": ""
33656           },
33657           {
33658             "group": "Body",
33659             "type": "String",
33660             "optional": true,
33661             "field": "transfereelinkedid",
33662             "description": ""
33663           },
33664           {
33665             "group": "Body",
33666             "type": "String",
33667             "allowedValues": [
33668               "\"Yes\"",
33669               "\"No\""
33670             ],
33671             "optional": true,
33672             "field": "isexternal",
33673             "description": ""
33674           },
33675           {
33676             "group": "Body",
33677             "type": "String",
33678             "optional": true,
33679             "field": "context",
33680             "description": ""
33681           },
33682           {
33683             "group": "Body",
33684             "type": "String",
33685             "optional": true,
33686             "field": "extension",
33687             "description": ""
33688           }
33689         ]
33690       }
33691     },
33692     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33693     "version": "0.0.0",
33694     "filename": "server/api/voiceTransferReport/index.js",
33695     "groupTitle": "Voice_Transfer_Reports"
33696   },
33697   {
33698     "type": "delete",
33699     "url": "/api/voice/transfers/reports/{id}",
33700     "title": "Deletes a Transfer Report",
33701     "examples": [
33702       {
33703         "title": "Example usage:",
33704         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password} -X DELETE",
33705         "type": "json"
33706       }
33707     ],
33708     "name": "DeleteTransfer_Reports",
33709     "group": "Voice_Transfer_Reports",
33710     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33711     "version": "0.0.0",
33712     "filename": "server/api/voiceTransferReport/index.js",
33713     "groupTitle": "Voice_Transfer_Reports"
33714   },
33715   {
33716     "type": "get",
33717     "url": "/api/voice/transfers/reports",
33718     "title": "Gets a list of Transfer Reports",
33719     "examples": [
33720       {
33721         "title": "Example usage:",
33722         "content": "curl https://{domain}/api/voice/transfers/reports -v -u {name}:{password}",
33723         "type": "json"
33724       }
33725     ],
33726     "name": "GetTransfer_Reports",
33727     "group": "Voice_Transfer_Reports",
33728     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33729     "version": "0.0.0",
33730     "filename": "server/api/voiceTransferReport/index.js",
33731     "groupTitle": "Voice_Transfer_Reports"
33732   },
33733   {
33734     "type": "get",
33735     "url": "/api/voice/transfers/reports/{id}",
33736     "title": "Gets a single Transfer Report",
33737     "examples": [
33738       {
33739         "title": "Example usage:",
33740         "content": "curl https://{domain}/api/voice/transfers/reports/{id} -v -u {name}:{password}",
33741         "type": "json"
33742       }
33743     ],
33744     "name": "ShowTransfer_Reports",
33745     "group": "Voice_Transfer_Reports",
33746     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33747     "version": "0.0.0",
33748     "filename": "server/api/voiceTransferReport/index.js",
33749     "groupTitle": "Voice_Transfer_Reports"
33750   },
33751   {
33752     "type": "put",
33753     "url": "/api/voice/transfers/reports/{id}",
33754     "title": "Update an existing Transfer Report",
33755     "examples": [
33756       {
33757         "title": "Example usage:",
33758         "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",
33759         "type": "json"
33760       }
33761     ],
33762     "name": "updateTransfer_Reports",
33763     "group": "Voice_Transfer_Reports",
33764     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33765     "version": "0.0.0",
33766     "filename": "server/api/voiceTransferReport/index.js",
33767     "groupTitle": "Voice_Transfer_Reports"
33768   },
33769   {
33770     "type": "post",
33771     "url": "/api/integrations/vtiger/accounts",
33772     "title": "Creates a new Vtiger Account",
33773     "examples": [
33774       {
33775         "title": "Example usage:",
33776         "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",
33777         "type": "json"
33778       }
33779     ],
33780     "name": "CreateVtiger_Accounts",
33781     "group": "Vtiger_Accounts",
33782     "parameter": {
33783       "fields": {
33784         "Body": [
33785           {
33786             "group": "Body",
33787             "type": "String",
33788             "optional": false,
33789             "field": "name",
33790             "description": ""
33791           },
33792           {
33793             "group": "Body",
33794             "type": "String",
33795             "optional": true,
33796             "field": "description",
33797             "description": ""
33798           },
33799           {
33800             "group": "Body",
33801             "type": "String",
33802             "optional": false,
33803             "field": "username",
33804             "description": ""
33805           },
33806           {
33807             "group": "Body",
33808             "type": "String",
33809             "optional": false,
33810             "field": "moduleName",
33811             "description": ""
33812           },
33813           {
33814             "group": "Body",
33815             "type": "String",
33816             "optional": false,
33817             "field": "remoteUri",
33818             "description": ""
33819           },
33820           {
33821             "group": "Body",
33822             "type": "String",
33823             "optional": true,
33824             "field": "serverUrl",
33825             "description": ""
33826           },
33827           {
33828             "group": "Body",
33829             "type": "String",
33830             "optional": false,
33831             "field": "accessKey",
33832             "description": ""
33833           }
33834         ]
33835       }
33836     },
33837     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33838     "version": "0.0.0",
33839     "filename": "server/api/intVtigerAccount/index.js",
33840     "groupTitle": "Vtiger_Accounts"
33841   },
33842   {
33843     "type": "delete",
33844     "url": "/api/integrations/vtiger/accounts/{id}",
33845     "title": "Deletes a Vtiger Account",
33846     "examples": [
33847       {
33848         "title": "Example usage:",
33849         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password} -X DELETE",
33850         "type": "json"
33851       }
33852     ],
33853     "name": "DeleteVtiger_Accounts",
33854     "group": "Vtiger_Accounts",
33855     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33856     "version": "0.0.0",
33857     "filename": "server/api/intVtigerAccount/index.js",
33858     "groupTitle": "Vtiger_Accounts"
33859   },
33860   {
33861     "type": "get",
33862     "url": "/api/integrations/vtiger/accounts",
33863     "title": "Gets a list of Vtiger Accounts",
33864     "examples": [
33865       {
33866         "title": "Example usage:",
33867         "content": "curl https://{domain}/api/integrations/vtiger/accounts -v -u {name}:{password}",
33868         "type": "json"
33869       }
33870     ],
33871     "name": "GetVtiger_Accounts",
33872     "group": "Vtiger_Accounts",
33873     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
33874     "version": "0.0.0",
33875     "filename": "server/api/intVtigerAccount/index.js",
33876     "groupTitle": "Vtiger_Accounts"
33877   },
33878   {
33879     "type": "get",
33880     "url": "/api/integrations/vtiger/accounts/{id}",
33881     "title": "Gets a single Vtiger Account",
33882     "examples": [
33883       {
33884         "title": "Example usage:",
33885         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id} -v -u {name}:{password}",
33886         "type": "json"
33887       }
33888     ],
33889     "name": "ShowVtiger_Accounts",
33890     "group": "Vtiger_Accounts",
33891     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33892     "version": "0.0.0",
33893     "filename": "server/api/intVtigerAccount/index.js",
33894     "groupTitle": "Vtiger_Accounts"
33895   },
33896   {
33897     "type": "post",
33898     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33899     "title": "Creates new configuration",
33900     "examples": [
33901       {
33902         "title": "Example usage:",
33903         "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",
33904         "type": "json"
33905       }
33906     ],
33907     "name": "addConfiguration",
33908     "group": "Vtiger_Accounts",
33909     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33910     "version": "0.0.0",
33911     "filename": "server/api/intVtigerAccount/index.js",
33912     "groupTitle": "Vtiger_Accounts"
33913   },
33914   {
33915     "type": "get",
33916     "url": "/api/integrations/vtiger/accounts/{id}/configurations",
33917     "title": "Gets account configurations",
33918     "examples": [
33919       {
33920         "title": "Example usage:",
33921         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/configurations -v -u {name}:{password} -X GET",
33922         "type": "json"
33923       }
33924     ],
33925     "name": "getConfigurations",
33926     "group": "Vtiger_Accounts",
33927     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33928     "version": "0.0.0",
33929     "filename": "server/api/intVtigerAccount/index.js",
33930     "groupTitle": "Vtiger_Accounts"
33931   },
33932   {
33933     "type": "get",
33934     "url": "/api/integrations/vtiger/accounts/{id}/fields",
33935     "title": "Gets account fields",
33936     "examples": [
33937       {
33938         "title": "Example usage:",
33939         "content": "curl https://{domain}/api/integrations/vtiger/accounts/{id}/fields -v -u {name}:{password} -X GET",
33940         "type": "json"
33941       }
33942     ],
33943     "name": "getFields",
33944     "group": "Vtiger_Accounts",
33945     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33946     "version": "0.0.0",
33947     "filename": "server/api/intVtigerAccount/index.js",
33948     "groupTitle": "Vtiger_Accounts"
33949   },
33950   {
33951     "type": "put",
33952     "url": "/api/integrations/vtiger/accounts/{id}",
33953     "title": "Update an existing Vtiger Account",
33954     "examples": [
33955       {
33956         "title": "Example usage:",
33957         "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",
33958         "type": "json"
33959       }
33960     ],
33961     "name": "updateVtiger_Accounts",
33962     "group": "Vtiger_Accounts",
33963     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
33964     "version": "0.0.0",
33965     "filename": "server/api/intVtigerAccount/index.js",
33966     "groupTitle": "Vtiger_Accounts"
33967   },
33968   {
33969     "type": "post",
33970     "url": "/api/integrations/vtiger/configurations",
33971     "title": "Creates a new Vtiger Configuration",
33972     "examples": [
33973       {
33974         "title": "Example usage:",
33975         "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",
33976         "type": "json"
33977       }
33978     ],
33979     "name": "CreateVtiger_Configurations",
33980     "group": "Vtiger_Configurations",
33981     "parameter": {
33982       "fields": {
33983         "Body": [
33984           {
33985             "group": "Body",
33986             "type": "String",
33987             "optional": true,
33988             "field": "name",
33989             "description": ""
33990           },
33991           {
33992             "group": "Body",
33993             "type": "String",
33994             "optional": true,
33995             "field": "description",
33996             "description": ""
33997           }
33998         ]
33999       }
34000     },
34001     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34002     "version": "0.0.0",
34003     "filename": "server/api/intVtigerConfiguration/index.js",
34004     "groupTitle": "Vtiger_Configurations"
34005   },
34006   {
34007     "type": "delete",
34008     "url": "/api/integrations/vtiger/configurations/{id}",
34009     "title": "Deletes a Vtiger Configuration",
34010     "examples": [
34011       {
34012         "title": "Example usage:",
34013         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password} -X DELETE",
34014         "type": "json"
34015       }
34016     ],
34017     "name": "DeleteVtiger_Configurations",
34018     "group": "Vtiger_Configurations",
34019     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34020     "version": "0.0.0",
34021     "filename": "server/api/intVtigerConfiguration/index.js",
34022     "groupTitle": "Vtiger_Configurations"
34023   },
34024   {
34025     "type": "get",
34026     "url": "/api/integrations/vtiger/configurations",
34027     "title": "Gets a list of Vtiger Configurations",
34028     "examples": [
34029       {
34030         "title": "Example usage:",
34031         "content": "curl https://{domain}/api/integrations/vtiger/configurations -v -u {name}:{password}",
34032         "type": "json"
34033       }
34034     ],
34035     "name": "GetVtiger_Configurations",
34036     "group": "Vtiger_Configurations",
34037     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34038     "version": "0.0.0",
34039     "filename": "server/api/intVtigerConfiguration/index.js",
34040     "groupTitle": "Vtiger_Configurations"
34041   },
34042   {
34043     "type": "get",
34044     "url": "/api/integrations/vtiger/configurations/{id}",
34045     "title": "Gets a single Vtiger Configuration",
34046     "examples": [
34047       {
34048         "title": "Example usage:",
34049         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id} -v -u {name}:{password}",
34050         "type": "json"
34051       }
34052     ],
34053     "name": "ShowVtiger_Configurations",
34054     "group": "Vtiger_Configurations",
34055     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34056     "version": "0.0.0",
34057     "filename": "server/api/intVtigerConfiguration/index.js",
34058     "groupTitle": "Vtiger_Configurations"
34059   },
34060   {
34061     "type": "get",
34062     "url": "/api/integrations/vtiger/configurations/{id}/descriptions",
34063     "title": "Gets configurations descriptions",
34064     "examples": [
34065       {
34066         "title": "Example usage:",
34067         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34068         "type": "json"
34069       }
34070     ],
34071     "name": "getDescriptions",
34072     "group": "Vtiger_Configurations",
34073     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34074     "version": "0.0.0",
34075     "filename": "server/api/intVtigerConfiguration/index.js",
34076     "groupTitle": "Vtiger_Configurations"
34077   },
34078   {
34079     "type": "get",
34080     "url": "/api/integrations/vtiger/configurations/{id}/fields",
34081     "title": "Gets configurations fields",
34082     "examples": [
34083       {
34084         "title": "Example usage:",
34085         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/fields -v -u {name}:{password} -X GET",
34086         "type": "json"
34087       }
34088     ],
34089     "name": "getFields",
34090     "group": "Vtiger_Configurations",
34091     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34092     "version": "0.0.0",
34093     "filename": "server/api/intVtigerConfiguration/index.js",
34094     "groupTitle": "Vtiger_Configurations"
34095   },
34096   {
34097     "type": "get",
34098     "url": "/api/integrations/vtiger/configurations/{id}/subjects",
34099     "title": "Gets configurations subjects",
34100     "examples": [
34101       {
34102         "title": "Example usage:",
34103         "content": "curl https://{domain}/api/integrations/vtiger/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34104         "type": "json"
34105       }
34106     ],
34107     "name": "getSubjects",
34108     "group": "Vtiger_Configurations",
34109     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34110     "version": "0.0.0",
34111     "filename": "server/api/intVtigerConfiguration/index.js",
34112     "groupTitle": "Vtiger_Configurations"
34113   },
34114   {
34115     "type": "put",
34116     "url": "/api/integrations/vtiger/configurations/{id}",
34117     "title": "Update an existing Vtiger Configuration",
34118     "examples": [
34119       {
34120         "title": "Example usage:",
34121         "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",
34122         "type": "json"
34123       }
34124     ],
34125     "name": "updateVtiger_Configurations",
34126     "group": "Vtiger_Configurations",
34127     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34128     "version": "0.0.0",
34129     "filename": "server/api/intVtigerConfiguration/index.js",
34130     "groupTitle": "Vtiger_Configurations"
34131   },
34132   {
34133     "type": "post",
34134     "url": "/api/integrations/vtiger/fields",
34135     "title": "Creates a new Vtiger Field",
34136     "examples": [
34137       {
34138         "title": "Example usage:",
34139         "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",
34140         "type": "json"
34141       }
34142     ],
34143     "name": "CreateVtiger_Fields",
34144     "group": "Vtiger_Fields",
34145     "parameter": {
34146       "fields": {
34147         "Body": [
34148           {
34149             "group": "Body",
34150             "type": "String",
34151             "allowedValues": [
34152               "\"string\"",
34153               "\"variable\"",
34154               "\"customVariable\"",
34155               "\"keyValue\""
34156             ],
34157             "optional": true,
34158             "field": "type",
34159             "description": ""
34160           },
34161           {
34162             "group": "Body",
34163             "type": "String",
34164             "optional": true,
34165             "field": "content",
34166             "description": ""
34167           },
34168           {
34169             "group": "Body",
34170             "type": "String",
34171             "optional": true,
34172             "field": "key",
34173             "description": ""
34174           },
34175           {
34176             "group": "Body",
34177             "type": "String",
34178             "allowedValues": [
34179               "\"string\"",
34180               "\"variable\"",
34181               "\"customVariable\""
34182             ],
34183             "optional": true,
34184             "field": "keyType",
34185             "description": ""
34186           },
34187           {
34188             "group": "Body",
34189             "type": "String",
34190             "optional": true,
34191             "field": "keyContent",
34192             "description": ""
34193           },
34194           {
34195             "group": "Body",
34196             "type": "String",
34197             "optional": true,
34198             "field": "idField",
34199             "description": ""
34200           },
34201           {
34202             "group": "Body",
34203             "type": "String",
34204             "optional": true,
34205             "field": "nameField",
34206             "description": ""
34207           },
34208           {
34209             "group": "Body",
34210             "type": "Boolean",
34211             "optional": true,
34212             "field": "customField",
34213             "description": ""
34214           },
34215           {
34216             "group": "Body",
34217             "type": "String",
34218             "optional": true,
34219             "field": "variableName",
34220             "description": ""
34221           }
34222         ]
34223       }
34224     },
34225     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34226     "version": "0.0.0",
34227     "filename": "server/api/intVtigerField/index.js",
34228     "groupTitle": "Vtiger_Fields"
34229   },
34230   {
34231     "type": "delete",
34232     "url": "/api/integrations/vtiger/fields/{id}",
34233     "title": "Deletes a Vtiger Field",
34234     "examples": [
34235       {
34236         "title": "Example usage:",
34237         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password} -X DELETE",
34238         "type": "json"
34239       }
34240     ],
34241     "name": "DeleteVtiger_Fields",
34242     "group": "Vtiger_Fields",
34243     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34244     "version": "0.0.0",
34245     "filename": "server/api/intVtigerField/index.js",
34246     "groupTitle": "Vtiger_Fields"
34247   },
34248   {
34249     "type": "get",
34250     "url": "/api/integrations/vtiger/fields",
34251     "title": "Gets a list of Vtiger Fields",
34252     "examples": [
34253       {
34254         "title": "Example usage:",
34255         "content": "curl https://{domain}/api/integrations/vtiger/fields -v -u {name}:{password}",
34256         "type": "json"
34257       }
34258     ],
34259     "name": "GetVtiger_Fields",
34260     "group": "Vtiger_Fields",
34261     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34262     "version": "0.0.0",
34263     "filename": "server/api/intVtigerField/index.js",
34264     "groupTitle": "Vtiger_Fields"
34265   },
34266   {
34267     "type": "get",
34268     "url": "/api/integrations/vtiger/fields/{id}",
34269     "title": "Gets a single Vtiger Field",
34270     "examples": [
34271       {
34272         "title": "Example usage:",
34273         "content": "curl https://{domain}/api/integrations/vtiger/fields/{id} -v -u {name}:{password}",
34274         "type": "json"
34275       }
34276     ],
34277     "name": "ShowVtiger_Fields",
34278     "group": "Vtiger_Fields",
34279     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34280     "version": "0.0.0",
34281     "filename": "server/api/intVtigerField/index.js",
34282     "groupTitle": "Vtiger_Fields"
34283   },
34284   {
34285     "type": "put",
34286     "url": "/api/integrations/vtiger/fields/{id}",
34287     "title": "Update an existing Vtiger Field",
34288     "examples": [
34289       {
34290         "title": "Example usage:",
34291         "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",
34292         "type": "json"
34293       }
34294     ],
34295     "name": "updateVtiger_Fields",
34296     "group": "Vtiger_Fields",
34297     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34298     "version": "0.0.0",
34299     "filename": "server/api/intVtigerField/index.js",
34300     "groupTitle": "Vtiger_Fields"
34301   },
34302   {
34303     "type": "post",
34304     "url": "/api/integrations/zendesk/accounts",
34305     "title": "Creates a new Zendesk Account",
34306     "examples": [
34307       {
34308         "title": "Example usage:",
34309         "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",
34310         "type": "json"
34311       }
34312     ],
34313     "name": "CreateZendesk_Accounts",
34314     "group": "Zendesk_Accounts",
34315     "parameter": {
34316       "fields": {
34317         "Body": [
34318           {
34319             "group": "Body",
34320             "type": "String",
34321             "optional": true,
34322             "field": "name",
34323             "description": ""
34324           },
34325           {
34326             "group": "Body",
34327             "type": "String",
34328             "optional": true,
34329             "field": "description",
34330             "description": ""
34331           },
34332           {
34333             "group": "Body",
34334             "type": "String",
34335             "optional": true,
34336             "field": "username",
34337             "description": ""
34338           },
34339           {
34340             "group": "Body",
34341             "type": "String",
34342             "optional": true,
34343             "field": "password",
34344             "description": ""
34345           },
34346           {
34347             "group": "Body",
34348             "type": "String",
34349             "optional": true,
34350             "field": "token",
34351             "description": ""
34352           },
34353           {
34354             "group": "Body",
34355             "type": "String",
34356             "optional": true,
34357             "field": "remoteUri",
34358             "description": ""
34359           },
34360           {
34361             "group": "Body",
34362             "type": "String",
34363             "allowedValues": [
34364               "\"password\"",
34365               "\"token\""
34366             ],
34367             "optional": true,
34368             "field": "authType",
34369             "description": ""
34370           },
34371           {
34372             "group": "Body",
34373             "type": "String",
34374             "optional": true,
34375             "field": "serverUrl",
34376             "description": ""
34377           },
34378           {
34379             "group": "Body",
34380             "type": "String",
34381             "allowedValues": [
34382               "\"integrationTab\"",
34383               "\"newTab\""
34384             ],
34385             "optional": true,
34386             "field": "type",
34387             "description": ""
34388           }
34389         ]
34390       }
34391     },
34392     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34393     "version": "0.0.0",
34394     "filename": "server/api/intZendeskAccount/index.js",
34395     "groupTitle": "Zendesk_Accounts"
34396   },
34397   {
34398     "type": "delete",
34399     "url": "/api/integrations/zendesk/accounts/{id}",
34400     "title": "Deletes a Zendesk Account",
34401     "examples": [
34402       {
34403         "title": "Example usage:",
34404         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password} -X DELETE",
34405         "type": "json"
34406       }
34407     ],
34408     "name": "DeleteZendesk_Accounts",
34409     "group": "Zendesk_Accounts",
34410     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34411     "version": "0.0.0",
34412     "filename": "server/api/intZendeskAccount/index.js",
34413     "groupTitle": "Zendesk_Accounts"
34414   },
34415   {
34416     "type": "get",
34417     "url": "/api/integrations/zendesk/accounts",
34418     "title": "Gets a list of Zendesk Accounts",
34419     "examples": [
34420       {
34421         "title": "Example usage:",
34422         "content": "curl https://{domain}/api/integrations/zendesk/accounts -v -u {name}:{password}",
34423         "type": "json"
34424       }
34425     ],
34426     "name": "GetZendesk_Accounts",
34427     "group": "Zendesk_Accounts",
34428     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34429     "version": "0.0.0",
34430     "filename": "server/api/intZendeskAccount/index.js",
34431     "groupTitle": "Zendesk_Accounts"
34432   },
34433   {
34434     "type": "get",
34435     "url": "/api/integrations/zendesk/accounts/{id}",
34436     "title": "Gets a single Zendesk Account",
34437     "examples": [
34438       {
34439         "title": "Example usage:",
34440         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id} -v -u {name}:{password}",
34441         "type": "json"
34442       }
34443     ],
34444     "name": "ShowZendesk_Accounts",
34445     "group": "Zendesk_Accounts",
34446     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34447     "version": "0.0.0",
34448     "filename": "server/api/intZendeskAccount/index.js",
34449     "groupTitle": "Zendesk_Accounts"
34450   },
34451   {
34452     "type": "post",
34453     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
34454     "title": "Creates new configuration",
34455     "examples": [
34456       {
34457         "title": "Example usage:",
34458         "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",
34459         "type": "json"
34460       }
34461     ],
34462     "name": "addConfiguration",
34463     "group": "Zendesk_Accounts",
34464     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34465     "version": "0.0.0",
34466     "filename": "server/api/intZendeskAccount/index.js",
34467     "groupTitle": "Zendesk_Accounts"
34468   },
34469   {
34470     "type": "get",
34471     "url": "/api/integrations/zendesk/accounts/{id}/configurations",
34472     "title": "Gets account configurations",
34473     "examples": [
34474       {
34475         "title": "Example usage:",
34476         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/configurations -v -u {name}:{password} -X GET",
34477         "type": "json"
34478       }
34479     ],
34480     "name": "getConfigurations",
34481     "group": "Zendesk_Accounts",
34482     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34483     "version": "0.0.0",
34484     "filename": "server/api/intZendeskAccount/index.js",
34485     "groupTitle": "Zendesk_Accounts"
34486   },
34487   {
34488     "type": "get",
34489     "url": "/api/integrations/zendesk/accounts/{id}/fields",
34490     "title": "Gets account fields",
34491     "examples": [
34492       {
34493         "title": "Example usage:",
34494         "content": "curl https://{domain}/api/integrations/zendesk/accounts/{id}/fields -v -u {name}:{password} -X GET",
34495         "type": "json"
34496       }
34497     ],
34498     "name": "getFields",
34499     "group": "Zendesk_Accounts",
34500     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34501     "version": "0.0.0",
34502     "filename": "server/api/intZendeskAccount/index.js",
34503     "groupTitle": "Zendesk_Accounts"
34504   },
34505   {
34506     "type": "put",
34507     "url": "/api/integrations/zendesk/accounts/{id}",
34508     "title": "Update an existing Zendesk Account",
34509     "examples": [
34510       {
34511         "title": "Example usage:",
34512         "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",
34513         "type": "json"
34514       }
34515     ],
34516     "name": "updateZendesk_Accounts",
34517     "group": "Zendesk_Accounts",
34518     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34519     "version": "0.0.0",
34520     "filename": "server/api/intZendeskAccount/index.js",
34521     "groupTitle": "Zendesk_Accounts"
34522   },
34523   {
34524     "type": "post",
34525     "url": "/api/integrations/zendesk/configurations",
34526     "title": "Creates a new Zendesk Configuration",
34527     "examples": [
34528       {
34529         "title": "Example usage:",
34530         "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",
34531         "type": "json"
34532       }
34533     ],
34534     "name": "CreateZendesk_Configurations",
34535     "group": "Zendesk_Configurations",
34536     "parameter": {
34537       "fields": {
34538         "Body": [
34539           {
34540             "group": "Body",
34541             "type": "String",
34542             "optional": true,
34543             "field": "name",
34544             "description": ""
34545           },
34546           {
34547             "group": "Body",
34548             "type": "String",
34549             "optional": true,
34550             "field": "description",
34551             "description": ""
34552           }
34553         ]
34554       }
34555     },
34556     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34557     "version": "0.0.0",
34558     "filename": "server/api/intZendeskConfiguration/index.js",
34559     "groupTitle": "Zendesk_Configurations"
34560   },
34561   {
34562     "type": "delete",
34563     "url": "/api/integrations/zendesk/configurations/{id}",
34564     "title": "Deletes a Zendesk Configuration",
34565     "examples": [
34566       {
34567         "title": "Example usage:",
34568         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password} -X DELETE",
34569         "type": "json"
34570       }
34571     ],
34572     "name": "DeleteZendesk_Configurations",
34573     "group": "Zendesk_Configurations",
34574     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34575     "version": "0.0.0",
34576     "filename": "server/api/intZendeskConfiguration/index.js",
34577     "groupTitle": "Zendesk_Configurations"
34578   },
34579   {
34580     "type": "get",
34581     "url": "/api/integrations/zendesk/configurations",
34582     "title": "Gets a list of Zendesk Configurations",
34583     "examples": [
34584       {
34585         "title": "Example usage:",
34586         "content": "curl https://{domain}/api/integrations/zendesk/configurations -v -u {name}:{password}",
34587         "type": "json"
34588       }
34589     ],
34590     "name": "GetZendesk_Configurations",
34591     "group": "Zendesk_Configurations",
34592     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34593     "version": "0.0.0",
34594     "filename": "server/api/intZendeskConfiguration/index.js",
34595     "groupTitle": "Zendesk_Configurations"
34596   },
34597   {
34598     "type": "get",
34599     "url": "/api/integrations/zendesk/configurations/{id}",
34600     "title": "Gets a single Zendesk Configuration",
34601     "examples": [
34602       {
34603         "title": "Example usage:",
34604         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id} -v -u {name}:{password}",
34605         "type": "json"
34606       }
34607     ],
34608     "name": "ShowZendesk_Configurations",
34609     "group": "Zendesk_Configurations",
34610     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34611     "version": "0.0.0",
34612     "filename": "server/api/intZendeskConfiguration/index.js",
34613     "groupTitle": "Zendesk_Configurations"
34614   },
34615   {
34616     "type": "get",
34617     "url": "/api/integrations/zendesk/configurations/{id}/descriptions",
34618     "title": "Gets configurations descriptions",
34619     "examples": [
34620       {
34621         "title": "Example usage:",
34622         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
34623         "type": "json"
34624       }
34625     ],
34626     "name": "getDescriptions",
34627     "group": "Zendesk_Configurations",
34628     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34629     "version": "0.0.0",
34630     "filename": "server/api/intZendeskConfiguration/index.js",
34631     "groupTitle": "Zendesk_Configurations"
34632   },
34633   {
34634     "type": "get",
34635     "url": "/api/integrations/zendesk/configurations/{id}/fields",
34636     "title": "Gets configurations fields",
34637     "examples": [
34638       {
34639         "title": "Example usage:",
34640         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/fields -v -u {name}:{password} -X GET",
34641         "type": "json"
34642       }
34643     ],
34644     "name": "getFields",
34645     "group": "Zendesk_Configurations",
34646     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34647     "version": "0.0.0",
34648     "filename": "server/api/intZendeskConfiguration/index.js",
34649     "groupTitle": "Zendesk_Configurations"
34650   },
34651   {
34652     "type": "get",
34653     "url": "/api/integrations/zendesk/configurations/{id}/subjects",
34654     "title": "Gets configurations subjects",
34655     "examples": [
34656       {
34657         "title": "Example usage:",
34658         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/subjects -v -u {name}:{password} -X GET",
34659         "type": "json"
34660       }
34661     ],
34662     "name": "getSubjects",
34663     "group": "Zendesk_Configurations",
34664     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34665     "version": "0.0.0",
34666     "filename": "server/api/intZendeskConfiguration/index.js",
34667     "groupTitle": "Zendesk_Configurations"
34668   },
34669   {
34670     "type": "get",
34671     "url": "/api/integrations/zendesk/configurations/{id}/tags",
34672     "title": "Gets configurations tags",
34673     "examples": [
34674       {
34675         "title": "Example usage:",
34676         "content": "curl https://{domain}/api/integrations/zendesk/configurations/{id}/tags -v -u {name}:{password} -X GET",
34677         "type": "json"
34678       }
34679     ],
34680     "name": "getTags",
34681     "group": "Zendesk_Configurations",
34682     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34683     "version": "0.0.0",
34684     "filename": "server/api/intZendeskConfiguration/index.js",
34685     "groupTitle": "Zendesk_Configurations"
34686   },
34687   {
34688     "type": "post",
34689     "url": "/api/integrations/zendesk/configurations/{id}/tags",
34690     "title": "Sets new tags",
34691     "examples": [
34692       {
34693         "title": "Example usage:",
34694         "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",
34695         "type": "json"
34696       }
34697     ],
34698     "name": "setTags",
34699     "group": "Zendesk_Configurations",
34700     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34701     "version": "0.0.0",
34702     "filename": "server/api/intZendeskConfiguration/index.js",
34703     "groupTitle": "Zendesk_Configurations"
34704   },
34705   {
34706     "type": "put",
34707     "url": "/api/integrations/zendesk/configurations/{id}",
34708     "title": "Update an existing Zendesk Configuration",
34709     "examples": [
34710       {
34711         "title": "Example usage:",
34712         "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",
34713         "type": "json"
34714       }
34715     ],
34716     "name": "updateZendesk_Configurations",
34717     "group": "Zendesk_Configurations",
34718     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34719     "version": "0.0.0",
34720     "filename": "server/api/intZendeskConfiguration/index.js",
34721     "groupTitle": "Zendesk_Configurations"
34722   },
34723   {
34724     "type": "post",
34725     "url": "/api/integrations/zendesk/fields",
34726     "title": "Creates a new Zendesk Field",
34727     "examples": [
34728       {
34729         "title": "Example usage:",
34730         "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",
34731         "type": "json"
34732       }
34733     ],
34734     "name": "CreateZendesk_Fields",
34735     "group": "Zendesk_Fields",
34736     "parameter": {
34737       "fields": {
34738         "Body": [
34739           {
34740             "group": "Body",
34741             "type": "String",
34742             "allowedValues": [
34743               "\"string\"",
34744               "\"variable\"",
34745               "\"customVariable\"",
34746               "\"keyValue\""
34747             ],
34748             "optional": true,
34749             "field": "type",
34750             "description": ""
34751           },
34752           {
34753             "group": "Body",
34754             "type": "String",
34755             "optional": true,
34756             "field": "content",
34757             "description": ""
34758           },
34759           {
34760             "group": "Body",
34761             "type": "String",
34762             "optional": true,
34763             "field": "key",
34764             "description": ""
34765           },
34766           {
34767             "group": "Body",
34768             "type": "String",
34769             "allowedValues": [
34770               "\"string\"",
34771               "\"variable\"",
34772               "\"customVariable\""
34773             ],
34774             "optional": true,
34775             "field": "keyType",
34776             "description": ""
34777           },
34778           {
34779             "group": "Body",
34780             "type": "String",
34781             "optional": true,
34782             "field": "keyContent",
34783             "description": ""
34784           },
34785           {
34786             "group": "Body",
34787             "type": "String",
34788             "optional": true,
34789             "field": "idField",
34790             "description": ""
34791           },
34792           {
34793             "group": "Body",
34794             "type": "String",
34795             "optional": true,
34796             "field": "nameField",
34797             "description": ""
34798           },
34799           {
34800             "group": "Body",
34801             "type": "Boolean",
34802             "optional": true,
34803             "field": "customField",
34804             "description": ""
34805           },
34806           {
34807             "group": "Body",
34808             "type": "String",
34809             "optional": true,
34810             "field": "variableName",
34811             "description": ""
34812           }
34813         ]
34814       }
34815     },
34816     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34817     "version": "0.0.0",
34818     "filename": "server/api/intZendeskField/index.js",
34819     "groupTitle": "Zendesk_Fields"
34820   },
34821   {
34822     "type": "delete",
34823     "url": "/api/integrations/zendesk/fields/{id}",
34824     "title": "Deletes a Zendesk Field",
34825     "examples": [
34826       {
34827         "title": "Example usage:",
34828         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password} -X DELETE",
34829         "type": "json"
34830       }
34831     ],
34832     "name": "DeleteZendesk_Fields",
34833     "group": "Zendesk_Fields",
34834     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34835     "version": "0.0.0",
34836     "filename": "server/api/intZendeskField/index.js",
34837     "groupTitle": "Zendesk_Fields"
34838   },
34839   {
34840     "type": "get",
34841     "url": "/api/integrations/zendesk/fields",
34842     "title": "Gets a list of Zendesk Fields",
34843     "examples": [
34844       {
34845         "title": "Example usage:",
34846         "content": "curl https://{domain}/api/integrations/zendesk/fields -v -u {name}:{password}",
34847         "type": "json"
34848       }
34849     ],
34850     "name": "GetZendesk_Fields",
34851     "group": "Zendesk_Fields",
34852     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
34853     "version": "0.0.0",
34854     "filename": "server/api/intZendeskField/index.js",
34855     "groupTitle": "Zendesk_Fields"
34856   },
34857   {
34858     "type": "get",
34859     "url": "/api/integrations/zendesk/fields/{id}",
34860     "title": "Gets a single Zendesk Field",
34861     "examples": [
34862       {
34863         "title": "Example usage:",
34864         "content": "curl https://{domain}/api/integrations/zendesk/fields/{id} -v -u {name}:{password}",
34865         "type": "json"
34866       }
34867     ],
34868     "name": "ShowZendesk_Fields",
34869     "group": "Zendesk_Fields",
34870     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34871     "version": "0.0.0",
34872     "filename": "server/api/intZendeskField/index.js",
34873     "groupTitle": "Zendesk_Fields"
34874   },
34875   {
34876     "type": "put",
34877     "url": "/api/integrations/zendesk/fields/{id}",
34878     "title": "Update an existing Zendesk Field",
34879     "examples": [
34880       {
34881         "title": "Example usage:",
34882         "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",
34883         "type": "json"
34884       }
34885     ],
34886     "name": "updateZendesk_Fields",
34887     "group": "Zendesk_Fields",
34888     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34889     "version": "0.0.0",
34890     "filename": "server/api/intZendeskField/index.js",
34891     "groupTitle": "Zendesk_Fields"
34892   },
34893   {
34894     "type": "post",
34895     "url": "/api/integrations/zoho/accounts",
34896     "title": "Creates a new Zoho Account",
34897     "examples": [
34898       {
34899         "title": "Example usage:",
34900         "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",
34901         "type": "json"
34902       }
34903     ],
34904     "name": "CreateZoho_Accounts",
34905     "group": "Zoho_Accounts",
34906     "parameter": {
34907       "fields": {
34908         "Body": [
34909           {
34910             "group": "Body",
34911             "type": "String",
34912             "optional": true,
34913             "field": "name",
34914             "description": ""
34915           },
34916           {
34917             "group": "Body",
34918             "type": "String",
34919             "optional": true,
34920             "field": "description",
34921             "description": ""
34922           },
34923           {
34924             "group": "Body",
34925             "type": "String",
34926             "optional": true,
34927             "field": "host",
34928             "description": ""
34929           },
34930           {
34931             "group": "Body",
34932             "type": "String",
34933             "optional": true,
34934             "field": "zone",
34935             "description": ""
34936           },
34937           {
34938             "group": "Body",
34939             "type": "String",
34940             "optional": true,
34941             "field": "clientId",
34942             "description": ""
34943           },
34944           {
34945             "group": "Body",
34946             "type": "String",
34947             "optional": true,
34948             "field": "clientSecret",
34949             "description": ""
34950           },
34951           {
34952             "group": "Body",
34953             "type": "String",
34954             "optional": true,
34955             "field": "serverUrl",
34956             "description": ""
34957           },
34958           {
34959             "group": "Body",
34960             "type": "String",
34961             "optional": true,
34962             "field": "code",
34963             "description": ""
34964           },
34965           {
34966             "group": "Body",
34967             "type": "String",
34968             "optional": true,
34969             "field": "refreshToken",
34970             "description": ""
34971           }
34972         ]
34973       }
34974     },
34975     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34976     "version": "0.0.0",
34977     "filename": "server/api/intZohoAccount/index.js",
34978     "groupTitle": "Zoho_Accounts"
34979   },
34980   {
34981     "type": "delete",
34982     "url": "/api/integrations/zoho/accounts/{id}",
34983     "title": "Deletes a Zoho Account",
34984     "examples": [
34985       {
34986         "title": "Example usage:",
34987         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password} -X DELETE",
34988         "type": "json"
34989       }
34990     ],
34991     "name": "DeleteZoho_Accounts",
34992     "group": "Zoho_Accounts",
34993     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
34994     "version": "0.0.0",
34995     "filename": "server/api/intZohoAccount/index.js",
34996     "groupTitle": "Zoho_Accounts"
34997   },
34998   {
34999     "type": "get",
35000     "url": "/api/integrations/zoho/accounts",
35001     "title": "Gets a list of Zoho Accounts",
35002     "examples": [
35003       {
35004         "title": "Example usage:",
35005         "content": "curl https://{domain}/api/integrations/zoho/accounts -v -u {name}:{password}",
35006         "type": "json"
35007       }
35008     ],
35009     "name": "GetZoho_Accounts",
35010     "group": "Zoho_Accounts",
35011     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35012     "version": "0.0.0",
35013     "filename": "server/api/intZohoAccount/index.js",
35014     "groupTitle": "Zoho_Accounts"
35015   },
35016   {
35017     "type": "get",
35018     "url": "/api/integrations/zoho/accounts/{id}",
35019     "title": "Gets a single Zoho Account",
35020     "examples": [
35021       {
35022         "title": "Example usage:",
35023         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id} -v -u {name}:{password}",
35024         "type": "json"
35025       }
35026     ],
35027     "name": "ShowZoho_Accounts",
35028     "group": "Zoho_Accounts",
35029     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35030     "version": "0.0.0",
35031     "filename": "server/api/intZohoAccount/index.js",
35032     "groupTitle": "Zoho_Accounts"
35033   },
35034   {
35035     "type": "post",
35036     "url": "/api/integrations/zoho/accounts/{id}/configurations",
35037     "title": "Creates new configuration",
35038     "examples": [
35039       {
35040         "title": "Example usage:",
35041         "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",
35042         "type": "json"
35043       }
35044     ],
35045     "name": "addConfiguration",
35046     "group": "Zoho_Accounts",
35047     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35048     "version": "0.0.0",
35049     "filename": "server/api/intZohoAccount/index.js",
35050     "groupTitle": "Zoho_Accounts"
35051   },
35052   {
35053     "type": "get",
35054     "url": "/api/integrations/zoho/accounts/{id}/configurations",
35055     "title": "Gets account configurations",
35056     "examples": [
35057       {
35058         "title": "Example usage:",
35059         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/configurations -v -u {name}:{password} -X GET",
35060         "type": "json"
35061       }
35062     ],
35063     "name": "getConfigurations",
35064     "group": "Zoho_Accounts",
35065     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35066     "version": "0.0.0",
35067     "filename": "server/api/intZohoAccount/index.js",
35068     "groupTitle": "Zoho_Accounts"
35069   },
35070   {
35071     "type": "get",
35072     "url": "/api/integrations/zoho/accounts/{id}/fields",
35073     "title": "Gets account fields",
35074     "examples": [
35075       {
35076         "title": "Example usage:",
35077         "content": "curl https://{domain}/api/integrations/zoho/accounts/{id}/fields -v -u {name}:{password} -X GET",
35078         "type": "json"
35079       }
35080     ],
35081     "name": "getFields",
35082     "group": "Zoho_Accounts",
35083     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35084     "version": "0.0.0",
35085     "filename": "server/api/intZohoAccount/index.js",
35086     "groupTitle": "Zoho_Accounts"
35087   },
35088   {
35089     "type": "put",
35090     "url": "/api/integrations/zoho/accounts/{id}",
35091     "title": "Update an existing Zoho Account",
35092     "examples": [
35093       {
35094         "title": "Example usage:",
35095         "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",
35096         "type": "json"
35097       }
35098     ],
35099     "name": "updateZoho_Accounts",
35100     "group": "Zoho_Accounts",
35101     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35102     "version": "0.0.0",
35103     "filename": "server/api/intZohoAccount/index.js",
35104     "groupTitle": "Zoho_Accounts"
35105   },
35106   {
35107     "type": "post",
35108     "url": "/api/integrations/zoho/configurations",
35109     "title": "Creates a new Zoho Configuration",
35110     "examples": [
35111       {
35112         "title": "Example usage:",
35113         "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",
35114         "type": "json"
35115       }
35116     ],
35117     "name": "CreateZoho_Configurations",
35118     "group": "Zoho_Configurations",
35119     "parameter": {
35120       "fields": {
35121         "Body": [
35122           {
35123             "group": "Body",
35124             "type": "String",
35125             "optional": true,
35126             "field": "name",
35127             "description": ""
35128           },
35129           {
35130             "group": "Body",
35131             "type": "String",
35132             "allowedValues": [
35133               "\"lead\"",
35134               "\"contact\"",
35135               "\"nothing\""
35136             ],
35137             "optional": true,
35138             "field": "moduleCreate",
35139             "description": ""
35140           },
35141           {
35142             "group": "Body",
35143             "type": "String",
35144             "allowedValues": [
35145               "\"contact_lead\"",
35146               "\"contact\"",
35147               "\"lead\""
35148             ],
35149             "optional": true,
35150             "field": "moduleSearch",
35151             "description": ""
35152           },
35153           {
35154             "group": "Body",
35155             "type": "String",
35156             "optional": true,
35157             "field": "description",
35158             "description": ""
35159           }
35160         ]
35161       }
35162     },
35163     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35164     "version": "0.0.0",
35165     "filename": "server/api/intZohoConfiguration/index.js",
35166     "groupTitle": "Zoho_Configurations"
35167   },
35168   {
35169     "type": "delete",
35170     "url": "/api/integrations/zoho/configurations/{id}",
35171     "title": "Deletes a Zoho Configuration",
35172     "examples": [
35173       {
35174         "title": "Example usage:",
35175         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password} -X DELETE",
35176         "type": "json"
35177       }
35178     ],
35179     "name": "DeleteZoho_Configurations",
35180     "group": "Zoho_Configurations",
35181     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35182     "version": "0.0.0",
35183     "filename": "server/api/intZohoConfiguration/index.js",
35184     "groupTitle": "Zoho_Configurations"
35185   },
35186   {
35187     "type": "get",
35188     "url": "/api/integrations/zoho/configurations",
35189     "title": "Gets a list of Zoho Configurations",
35190     "examples": [
35191       {
35192         "title": "Example usage:",
35193         "content": "curl https://{domain}/api/integrations/zoho/configurations -v -u {name}:{password}",
35194         "type": "json"
35195       }
35196     ],
35197     "name": "GetZoho_Configurations",
35198     "group": "Zoho_Configurations",
35199     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35200     "version": "0.0.0",
35201     "filename": "server/api/intZohoConfiguration/index.js",
35202     "groupTitle": "Zoho_Configurations"
35203   },
35204   {
35205     "type": "get",
35206     "url": "/api/integrations/zoho/configurations/{id}",
35207     "title": "Gets a single Zoho Configuration",
35208     "examples": [
35209       {
35210         "title": "Example usage:",
35211         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id} -v -u {name}:{password}",
35212         "type": "json"
35213       }
35214     ],
35215     "name": "ShowZoho_Configurations",
35216     "group": "Zoho_Configurations",
35217     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35218     "version": "0.0.0",
35219     "filename": "server/api/intZohoConfiguration/index.js",
35220     "groupTitle": "Zoho_Configurations"
35221   },
35222   {
35223     "type": "get",
35224     "url": "/api/integrations/zoho/configurations/{id}/descriptions",
35225     "title": "Gets configurations descriptions",
35226     "examples": [
35227       {
35228         "title": "Example usage:",
35229         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/descriptions -v -u {name}:{password} -X GET",
35230         "type": "json"
35231       }
35232     ],
35233     "name": "getDescriptions",
35234     "group": "Zoho_Configurations",
35235     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35236     "version": "0.0.0",
35237     "filename": "server/api/intZohoConfiguration/index.js",
35238     "groupTitle": "Zoho_Configurations"
35239   },
35240   {
35241     "type": "get",
35242     "url": "/api/integrations/zoho/configurations/{id}/fields",
35243     "title": "Gets configurations fields",
35244     "examples": [
35245       {
35246         "title": "Example usage:",
35247         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/fields -v -u {name}:{password} -X GET",
35248         "type": "json"
35249       }
35250     ],
35251     "name": "getFields",
35252     "group": "Zoho_Configurations",
35253     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35254     "version": "0.0.0",
35255     "filename": "server/api/intZohoConfiguration/index.js",
35256     "groupTitle": "Zoho_Configurations"
35257   },
35258   {
35259     "type": "get",
35260     "url": "/api/integrations/zoho/configurations/{id}/subjects",
35261     "title": "Gets configurations subjects",
35262     "examples": [
35263       {
35264         "title": "Example usage:",
35265         "content": "curl https://{domain}/api/integrations/zoho/configurations/{id}/subjects -v -u {name}:{password} -X GET",
35266         "type": "json"
35267       }
35268     ],
35269     "name": "getSubjects",
35270     "group": "Zoho_Configurations",
35271     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35272     "version": "0.0.0",
35273     "filename": "server/api/intZohoConfiguration/index.js",
35274     "groupTitle": "Zoho_Configurations"
35275   },
35276   {
35277     "type": "put",
35278     "url": "/api/integrations/zoho/configurations/{id}",
35279     "title": "Update an existing Zoho Configuration",
35280     "examples": [
35281       {
35282         "title": "Example usage:",
35283         "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",
35284         "type": "json"
35285       }
35286     ],
35287     "name": "updateZoho_Configurations",
35288     "group": "Zoho_Configurations",
35289     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35290     "version": "0.0.0",
35291     "filename": "server/api/intZohoConfiguration/index.js",
35292     "groupTitle": "Zoho_Configurations"
35293   },
35294   {
35295     "type": "post",
35296     "url": "/api/integrations/zoho/fields",
35297     "title": "Creates a new Zoho Field",
35298     "examples": [
35299       {
35300         "title": "Example usage:",
35301         "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",
35302         "type": "json"
35303       }
35304     ],
35305     "name": "CreateZoho_Fields",
35306     "group": "Zoho_Fields",
35307     "parameter": {
35308       "fields": {
35309         "Body": [
35310           {
35311             "group": "Body",
35312             "type": "String",
35313             "allowedValues": [
35314               "\"string\"",
35315               "\"variable\"",
35316               "\"customVariable\"",
35317               "\"keyValue\""
35318             ],
35319             "optional": true,
35320             "field": "type",
35321             "description": ""
35322           },
35323           {
35324             "group": "Body",
35325             "type": "String",
35326             "optional": true,
35327             "field": "content",
35328             "description": ""
35329           },
35330           {
35331             "group": "Body",
35332             "type": "String",
35333             "optional": true,
35334             "field": "key",
35335             "description": ""
35336           },
35337           {
35338             "group": "Body",
35339             "type": "String",
35340             "allowedValues": [
35341               "\"string\"",
35342               "\"variable\"",
35343               "\"customVariable\""
35344             ],
35345             "optional": true,
35346             "field": "keyType",
35347             "description": ""
35348           },
35349           {
35350             "group": "Body",
35351             "type": "String",
35352             "optional": true,
35353             "field": "keyContent",
35354             "description": ""
35355           },
35356           {
35357             "group": "Body",
35358             "type": "String",
35359             "optional": true,
35360             "field": "idField",
35361             "description": ""
35362           },
35363           {
35364             "group": "Body",
35365             "type": "String",
35366             "optional": true,
35367             "field": "nameField",
35368             "description": ""
35369           },
35370           {
35371             "group": "Body",
35372             "type": "Boolean",
35373             "optional": true,
35374             "field": "customField",
35375             "description": ""
35376           },
35377           {
35378             "group": "Body",
35379             "type": "String",
35380             "optional": true,
35381             "field": "variableName",
35382             "description": ""
35383           }
35384         ]
35385       }
35386     },
35387     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35388     "version": "0.0.0",
35389     "filename": "server/api/intZohoField/index.js",
35390     "groupTitle": "Zoho_Fields"
35391   },
35392   {
35393     "type": "delete",
35394     "url": "/api/integrations/zoho/fields/{id}",
35395     "title": "Deletes a Zoho Field",
35396     "examples": [
35397       {
35398         "title": "Example usage:",
35399         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password} -X DELETE",
35400         "type": "json"
35401       }
35402     ],
35403     "name": "DeleteZoho_Fields",
35404     "group": "Zoho_Fields",
35405     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35406     "version": "0.0.0",
35407     "filename": "server/api/intZohoField/index.js",
35408     "groupTitle": "Zoho_Fields"
35409   },
35410   {
35411     "type": "get",
35412     "url": "/api/integrations/zoho/fields",
35413     "title": "Gets a list of Zoho Fields",
35414     "examples": [
35415       {
35416         "title": "Example usage:",
35417         "content": "curl https://{domain}/api/integrations/zoho/fields -v -u {name}:{password}",
35418         "type": "json"
35419       }
35420     ],
35421     "name": "GetZoho_Fields",
35422     "group": "Zoho_Fields",
35423     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35424     "version": "0.0.0",
35425     "filename": "server/api/intZohoField/index.js",
35426     "groupTitle": "Zoho_Fields"
35427   },
35428   {
35429     "type": "get",
35430     "url": "/api/integrations/zoho/fields/{id}",
35431     "title": "Gets a single Zoho Field",
35432     "examples": [
35433       {
35434         "title": "Example usage:",
35435         "content": "curl https://{domain}/api/integrations/zoho/fields/{id} -v -u {name}:{password}",
35436         "type": "json"
35437       }
35438     ],
35439     "name": "ShowZoho_Fields",
35440     "group": "Zoho_Fields",
35441     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35442     "version": "0.0.0",
35443     "filename": "server/api/intZohoField/index.js",
35444     "groupTitle": "Zoho_Fields"
35445   },
35446   {
35447     "type": "put",
35448     "url": "/api/integrations/zoho/fields/{id}",
35449     "title": "Update an existing Zoho Field",
35450     "examples": [
35451       {
35452         "title": "Example usage:",
35453         "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",
35454         "type": "json"
35455       }
35456     ],
35457     "name": "updateZoho_Fields",
35458     "group": "Zoho_Fields",
35459     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35460     "version": "0.0.0",
35461     "filename": "server/api/intZohoField/index.js",
35462     "groupTitle": "Zoho_Fields"
35463   },
35464   {
35465     "type": "post",
35466     "url": "/api/cdr",
35467     "title": "Creates a new Cdr",
35468     "examples": [
35469       {
35470         "title": "Example usage:",
35471         "content": "curl https://{domain}/api/cdr -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35472         "type": "json"
35473       }
35474     ],
35475     "name": "CreateCdrs",
35476     "group": "cdr",
35477     "parameter": {
35478       "fields": {
35479         "Body": [
35480           {
35481             "group": "Body",
35482             "type": "String",
35483             "optional": false,
35484             "field": "calldate",
35485             "description": ""
35486           },
35487           {
35488             "group": "Body",
35489             "type": "String",
35490             "optional": true,
35491             "field": "clid",
35492             "description": ""
35493           },
35494           {
35495             "group": "Body",
35496             "type": "String",
35497             "optional": true,
35498             "field": "src",
35499             "description": ""
35500           },
35501           {
35502             "group": "Body",
35503             "type": "String",
35504             "optional": true,
35505             "field": "dst",
35506             "description": ""
35507           },
35508           {
35509             "group": "Body",
35510             "type": "String",
35511             "optional": true,
35512             "field": "dcontext",
35513             "description": ""
35514           },
35515           {
35516             "group": "Body",
35517             "type": "String",
35518             "optional": true,
35519             "field": "channel",
35520             "description": ""
35521           },
35522           {
35523             "group": "Body",
35524             "type": "String",
35525             "optional": true,
35526             "field": "dstchannel",
35527             "description": ""
35528           },
35529           {
35530             "group": "Body",
35531             "type": "String",
35532             "optional": true,
35533             "field": "lastapp",
35534             "description": ""
35535           },
35536           {
35537             "group": "Body",
35538             "type": "String",
35539             "optional": true,
35540             "field": "lastdata",
35541             "description": ""
35542           },
35543           {
35544             "group": "Body",
35545             "type": "Integer",
35546             "optional": false,
35547             "field": "duration",
35548             "description": ""
35549           },
35550           {
35551             "group": "Body",
35552             "type": "Integer",
35553             "optional": false,
35554             "field": "billsec",
35555             "description": ""
35556           },
35557           {
35558             "group": "Body",
35559             "type": "String",
35560             "optional": true,
35561             "field": "disposition",
35562             "description": ""
35563           },
35564           {
35565             "group": "Body",
35566             "type": "Integer",
35567             "optional": false,
35568             "field": "amaflags",
35569             "description": ""
35570           },
35571           {
35572             "group": "Body",
35573             "type": "String",
35574             "optional": true,
35575             "field": "accountcode",
35576             "description": ""
35577           },
35578           {
35579             "group": "Body",
35580             "type": "String",
35581             "optional": true,
35582             "field": "userfield",
35583             "description": ""
35584           },
35585           {
35586             "group": "Body",
35587             "type": "String",
35588             "optional": true,
35589             "field": "uniqueid",
35590             "description": ""
35591           },
35592           {
35593             "group": "Body",
35594             "type": "String",
35595             "optional": true,
35596             "field": "linkedid",
35597             "description": ""
35598           },
35599           {
35600             "group": "Body",
35601             "type": "String",
35602             "optional": true,
35603             "field": "sequence",
35604             "description": ""
35605           },
35606           {
35607             "group": "Body",
35608             "type": "String",
35609             "optional": true,
35610             "field": "peeraccount",
35611             "description": ""
35612           },
35613           {
35614             "group": "Body",
35615             "type": "String",
35616             "optional": true,
35617             "field": "type",
35618             "description": ""
35619           },
35620           {
35621             "group": "Body",
35622             "type": "String",
35623             "optional": true,
35624             "field": "tag",
35625             "description": ""
35626           }
35627         ]
35628       }
35629     },
35630     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35631     "version": "0.0.0",
35632     "filename": "server/api/cdr/index.js",
35633     "groupTitle": "cdr"
35634   },
35635   {
35636     "type": "delete",
35637     "url": "/api/cdr/{id}",
35638     "title": "Deletes a Cdr",
35639     "examples": [
35640       {
35641         "title": "Example usage:",
35642         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password} -X DELETE",
35643         "type": "json"
35644       }
35645     ],
35646     "name": "DeleteCdrs",
35647     "group": "cdr",
35648     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35649     "version": "0.0.0",
35650     "filename": "server/api/cdr/index.js",
35651     "groupTitle": "cdr"
35652   },
35653   {
35654     "type": "get",
35655     "url": "/api/cdr/describe",
35656     "title": "Gets table info about Cdrs",
35657     "examples": [
35658       {
35659         "title": "Example usage:",
35660         "content": "curl https://{domain}/api/cdr/describe -v -u {name}:{password}",
35661         "type": "json"
35662       }
35663     ],
35664     "name": "DescribeCdrs",
35665     "group": "cdr",
35666     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35667     "version": "0.0.0",
35668     "filename": "server/api/cdr/index.js",
35669     "groupTitle": "cdr"
35670   },
35671   {
35672     "type": "get",
35673     "url": "/api/cdr",
35674     "title": "Gets a list of Cdrs",
35675     "examples": [
35676       {
35677         "title": "Example usage:",
35678         "content": "curl https://{domain}/api/cdr -v -u {name}:{password}",
35679         "type": "json"
35680       }
35681     ],
35682     "name": "GetCdrs",
35683     "group": "cdr",
35684     "description": "<p>Motion will always return paged results. Motion returns paging data in the <code>Content-Range</code> header in the form start - end / total.</p> <p>Upon success Motion will return a HTTP status code <code>200 OK</code> if the entire collection was returned otherwise it will return a HTTP status code <code>206</code> Partial Content.</p> <p>Motion renders the resulting JSON representation in the response body.</p> <h2>Retrieving Specific Fields</h2> <p>To return only specific fields for a result set you can utilize the <code>fields</code> parameter. This parameter accepts a comma-separated list.</p> <p>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>",
35685     "version": "0.0.0",
35686     "filename": "server/api/cdr/index.js",
35687     "groupTitle": "cdr"
35688   },
35689   {
35690     "type": "get",
35691     "url": "/api/cdr/{id}",
35692     "title": "Gets a single Cdr",
35693     "examples": [
35694       {
35695         "title": "Example usage:",
35696         "content": "curl https://{domain}/api/cdr/{id} -v -u {name}:{password}",
35697         "type": "json"
35698       }
35699     ],
35700     "name": "ShowCdrs",
35701     "group": "cdr",
35702     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35703     "version": "0.0.0",
35704     "filename": "server/api/cdr/index.js",
35705     "groupTitle": "cdr"
35706   },
35707   {
35708     "type": "put",
35709     "url": "/api/cdr/{id}",
35710     "title": "Update an existing Cdr",
35711     "examples": [
35712       {
35713         "title": "Example usage:",
35714         "content": "curl https://{domain}/api/cdr/{id} -d '{\"key1\": \"value1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X PUT",
35715         "type": "json"
35716       }
35717     ],
35718     "name": "updateCdrs",
35719     "group": "cdr",
35720     "description": "<p>Motion will return a HTTP status code <code>200</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35721     "version": "0.0.0",
35722     "filename": "server/api/cdr/index.js",
35723     "groupTitle": "cdr"
35724   },
35725   {
35726     "type": "post",
35727     "url": "/api/voiceQueuesLog",
35728     "title": "Creates a new VoiceQueuesLog",
35729     "examples": [
35730       {
35731         "title": "Example usage:",
35732         "content": "curl https://{domain}/api/voiceQueuesLog -d '{\"key1\": \"valu1\", \"key2\": \"value2\", \"...\": \"...\"}' \\\n -H \"Content-Type: application/json\" -v -u {name}:{password} -X POST",
35733         "type": "json"
35734       }
35735     ],
35736     "name": "CreateVoiceQueuesLogs",
35737     "group": "voiceQueuesLog",
35738     "parameter": {
35739       "fields": {
35740         "Body": [
35741           {
35742             "group": "Body",
35743             "type": "String",
35744             "optional": true,
35745             "field": "time",
35746             "description": ""
35747           },
35748           {
35749             "group": "Body",
35750             "type": "String",
35751             "optional": false,
35752             "field": "callid",
35753             "description": ""
35754           },
35755           {
35756             "group": "Body",
35757             "type": "String",
35758             "optional": false,
35759             "field": "queuename",
35760             "description": ""
35761           },
35762           {
35763             "group": "Body",
35764             "type": "String",
35765             "optional": false,
35766             "field": "agent",
35767             "description": ""
35768           },
35769           {
35770             "group": "Body",
35771             "type": "String",
35772             "optional": false,
35773             "field": "event",
35774             "description": ""
35775           },
35776           {
35777             "group": "Body",
35778             "type": "String",
35779             "optional": false,
35780             "field": "data",
35781             "description": ""
35782           },
35783           {
35784             "group": "Body",
35785             "type": "String",
35786             "optional": false,
35787             "field": "data1",
35788             "description": ""
35789           },
35790           {
35791             "group": "Body",
35792             "type": "String",
35793             "optional": false,
35794             "field": "data2",
35795             "description": ""
35796           },
35797           {
35798             "group": "Body",
35799             "type": "String",
35800             "optional": false,
35801             "field": "data3",
35802             "description": ""
35803           },
35804           {
35805             "group": "Body",
35806             "type": "String",
35807             "optional": false,
35808             "field": "data4",
35809             "description": ""
35810           },
35811           {
35812             "group": "Body",
35813             "type": "String",
35814             "optional": false,
35815             "field": "data5",
35816             "description": ""
35817           },
35818           {
35819             "group": "Body",
35820             "type": "String",
35821             "optional": false,
35822             "field": "dtm",
35823             "description": ""
35824           }
35825         ]
35826       }
35827     },
35828     "description": "<p>Motion will return a HTTP status code <code>201</code> upon success.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35829     "version": "0.0.0",
35830     "filename": "server/api/voiceQueuesLog/index.js",
35831     "groupTitle": "voiceQueuesLog"
35832   },
35833   {
35834     "type": "delete",
35835     "url": "/api/voiceQueuesLog/{id}",
35836     "title": "Deletes a VoiceQueuesLog",
35837     "examples": [
35838       {
35839         "title": "Example usage:",
35840         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password} -X DELETE",
35841         "type": "json"
35842       }
35843     ],
35844     "name": "DeleteVoiceQueuesLogs",
35845     "group": "voiceQueuesLog",
35846     "description": "<p>Motion will return a HTTP status code <code>204</code> upon success. Motion return a HTTP status code <code>404</code> if the corresponding record could not be located.</p> <p>Motion renders the resulting JSON representation in the response body.</p>",
35847     "version": "0.0.0",
35848     "filename": "server/api/voiceQueuesLog/index.js",
35849     "groupTitle": "voiceQueuesLog"
35850   },
35851   {
35852     "type": "get",
35853     "url": "/api/voiceQueuesLog",
35854     "title": "Gets a list of VoiceQueuesLogs",
35855     "examples": [
35856       {
35857         "title": "Example usage:",
35858         "content": "curl https://{domain}/api/voiceQueuesLog -v -u {name}:{password}",
35859         "type": "json"
35860       }
35861     ],
35862     "name": "GetVoiceQueuesLogs",
35863     "group": "voiceQueuesLog",
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/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>",
35865     "version": "0.0.0",
35866     "filename": "server/api/voiceQueuesLog/index.js",
35867     "groupTitle": "voiceQueuesLog"
35868   },
35869   {
35870     "type": "get",
35871     "url": "/api/voiceQueuesLog/{id}",
35872     "title": "Gets a single VoiceQueuesLog",
35873     "examples": [
35874       {
35875         "title": "Example usage:",
35876         "content": "curl https://{domain}/api/voiceQueuesLog/{id} -v -u {name}:{password}",
35877         "type": "json"
35878       }
35879     ],
35880     "name": "ShowVoiceQueuesLogs",
35881     "group": "voiceQueuesLog",
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/voiceQueuesLog/index.js",
35885     "groupTitle": "voiceQueuesLog"
35886   },
35887   {
35888     "type": "put",
35889     "url": "/api/voiceQueuesLog/{id}",
35890     "title": "Update an existing VoiceQueuesLog",
35891     "examples": [
35892       {
35893         "title": "Example usage:",
35894         "content": "curl https://{domain}/api/voiceQueuesLog/{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": "updateVoiceQueuesLogs",
35899     "group": "voiceQueuesLog",
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/voiceQueuesLog/index.js",
35903     "groupTitle": "voiceQueuesLog"
35904   }
35905 ]